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