/usr/include/openturns/swig/Arcsine_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 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 | %feature("docstring") OT::Arcsine
"Arcsine distribution.
Available constructors:
Arcsine(*arg1=-1.0, arg2=1.0, parameters_set=ot.Arcsine.AB*)
Parameters
----------
arg1 : float
If *parameters_set == ot.Arcsine.AB*: lower bound (:math:`a`).
If *parameters_set == ot.Arcsine.MUSIGMA*: mean.
arg2 : float
If *parameters_set == ot.Arcsine.AB*: upper bound (:math:`b > a`).
If *parameters_set == ot.Arcsine.MUSIGMA*: standard deviation :math:`\\\\sigma > 0`.
parameters_set : int, optional
Integer telling which parameters set is used for defining the
distribution (amongst `ot.Arcsine.AB, ot.Arcsine.MUSIGMA`).
Notes
-----
Its probability density function is defined as:
.. math::
f_X(x) = \\\\frac{1}{\\\\pi \\\\sqrt{(x - a)(b - x)}},
\\\\quad x \\\\in [a, b]
with :math:`a < b`.
Its first moments are:
.. math::
:nowrap:
\\\\begin{eqnarray*}
\\\\Expect{X} & = & \\\\frac{a + b}{2} \\\\\\\\
\\\\Var{X} & = & \\\\frac{(b - a)^2}{8}
\\\\end{eqnarray*}
Examples
--------
Create a distribution:
>>> import openturns as ot
>>> distribution = ot.Arcsine(2., 3.)
Draw a sample:
>>> sample = distribution.getSample(10)"
// ---------------------------------------------------------------------
%feature("docstring") OT::Arcsine::getA
"Accessor to the distribution's lower bound.
Returns
-------
a : float
Lower bound."
// ---------------------------------------------------------------------
%feature("docstring") OT::Arcsine::getB
"Accessor to the distribution's upper bound.
Returns
-------
b : float
Upper bound."
// ---------------------------------------------------------------------
%feature("docstring") OT::Arcsine::getMu
"Accessor to the distribution's mean.
Returns
-------
mu : float
Mean."
// ---------------------------------------------------------------------
%feature("docstring") OT::Arcsine::getSigma
"Accessor to the distribution's standard deviation.
Returns
-------
sigma : float
Standard deviation."
// ---------------------------------------------------------------------
%feature("docstring") OT::Arcsine::setA
"Accessor to the distribution's lower bound.
Parameters
----------
a : float, :math:`a < b`
Lower bound."
// ---------------------------------------------------------------------
%feature("docstring") OT::Arcsine::setB
"Accessor to the distribution's upper bound.
Parameters
----------
b : float, :math:`a < b`
Upper bound."
// ---------------------------------------------------------------------
%feature("docstring") OT::Arcsine::setMu
"Accessor to the distribution's mean.
Parameters
----------
mu : float
Mean."
// ---------------------------------------------------------------------
%feature("docstring") OT::Arcsine::setSigma
"Accessor to the distribution's standard deviation.
Parameters
----------
sigma : float, :math:`\\\\sigma > 0`
Standard deviation."
|