1%feature("docstring") OT::Dirac
2"Dirac distribution.
3
4A possible usage is the modelling of deterministic parameters.
5
6Available constructors:
7    Dirac(*x=0.*)
8
9Parameters
10----------
11x : float, sequence of float, :math:`\vect{x} \in \Rset^n`
12    The deterministic value.
13
14Notes
15-----
16Its probability density function is defined as:
17
18.. math::
19
20    \Prob{\vect{X} = \vect{x}} = 1
21
22with :math:`\vect{x} \in \Rset^n`.
23
24Its first moments are:
25
26.. math::
27    :nowrap:
28
29    \begin{eqnarray*}
30        \Expect{\vect{X}} & = & \vect{x} \\
31        \Var{X_i} & = & 0, \quad i = 1, \ldots, n
32    \end{eqnarray*}
33
34Examples
35--------
36Create a distribution:
37
38>>> import openturns as ot
39>>> distribution = ot.Dirac([1.0, 2.0, 3.0])
40
41Draw a sample:
42
43>>> sample = distribution.getSample(2)
44>>> sample[0] == sample[1]
45True"
46
47// ---------------------------------------------------------------------
48
49%feature("docstring") OT::Dirac::getPoint
50"Accessor to the distribution's unique value.
51
52Returns
53-------
54x : float, :class:`~openturns.Point`
55    The deterministic value."
56
57// ---------------------------------------------------------------------
58
59%feature("docstring") OT::Dirac::setPoint
60"Accessor to the distribution's unique value.
61
62Parameters
63----------
64x : float, sequence of float, :math:`\vect{x} \in \Rset^n`
65    The deterministic value."
66