/usr/include/openturns/swig/TruncatedDistribution_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 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 | %feature("docstring") OT::TruncatedDistribution
"Truncated distribution.
Available constructors:
TruncatedDistribution(*distribution, lowerBound, upperBound, threshold=0.5*)
TruncatedDistribution(*distribution, bound, side=ot.TruncatedDistribution.LOWER, threshold=0.5*)
TruncatedDistribution(*distribution, truncationInterval, threshold=0.5*)
Parameters
----------
distribution : :class:`~openturns.Distribution`
The distribution to be truncated.
lowerBound, upperBound : float
Define a new distribution range :math:`[lowerBound, upperBound]` with
finite bounds. The upper bound must be strictly greater than the lower
bound.
bound : float
Scalar used when one of the bounds of the distribution is not finite.
If *side = ot.TruncatedDistribution.LOWER*: the interval
:math:`[bound, +\\\\infty)` is used to bound the distribution.
If *side = ot.TruncatedDistribution.LOWER*: the interval
:math:`(-\\\\infty, bound]` is used to bound the distribution.
side : int, optional
Integer used when one of the bounds of the distribution is not finite.
(Amongst ot.TruncatedDistribution.LOWER and ot.TruncatedDistribution.UPPER).
truncationInterval : :class:`~openturns.Interval`
Define a new distribution range :math:`[lowerBound, upperBound]` with
finite bounds.
threshold : float, :math:`\\\\tau \\\\in [0, 1]`
This threshold is used when generating an evaluation of the distribution.
We note :math:`F` the CDF of the non truncated distribution:
If :math:`F(upperBound)-F(lowerBound)<\\\\tau`: a CDF inversion is performed.
If :math:`F(upperBound)-F(lowerBound)>\\\\tau`: rejection.
Examples
--------
>>> import openturns as ot
>>> distribution = ot.TruncatedDistribution(ot.Normal(2.0, 1.5), 1.0, 4.0)
Draw a sample:
>>> sample = distribution.getSample(10)"
// ---------------------------------------------------------------------
%feature("docstring") OT::TruncatedDistribution::getDistribution
"Get the distribution.
Returns
-------
distribution : :class:`~openturns.Distribution`
The distribution to be truncated."
// ---------------------------------------------------------------------
%feature("docstring") OT::TruncatedDistribution::setDistribution
"Set the distribution.
Parameters
----------
distribution : :class:`~openturns.Distribution`
The distribution to be truncated."
// ---------------------------------------------------------------------
%feature("docstring") OT::TruncatedDistribution::getFiniteLowerBound
"Get the finite lower bound flag.
Returns
-------
isLowerBoundFinite : bool
Flag telling if the lower bound is finite or not."
// ---------------------------------------------------------------------
%feature("docstring") OT::TruncatedDistribution::setFiniteLowerBound
"Set the finite lower bound flag.
Parameters
----------
isLowerBoundFinite : bool
Flag telling if the lower bound is finite or not."
// ---------------------------------------------------------------------
%feature("docstring") OT::TruncatedDistribution::getFiniteUpperBound
"Get the finite upper bound flag.
Returns
-------
isUpperBoundFinite : bool
Flag telling if the upper bound is finite or not."
// ---------------------------------------------------------------------
%feature("docstring") OT::TruncatedDistribution::setFiniteUpperBound
"Set the finite upper bound flag.
Parameters
----------
isUpperBoundFinite : bool
Flag telling if the upper bound is finite or not."
// ---------------------------------------------------------------------
%feature("docstring") OT::TruncatedDistribution::getLowerBound
"Get the lower bound.
Returns
-------
lowerBound : float
Lower bound."
// ---------------------------------------------------------------------
%feature("docstring") OT::TruncatedDistribution::setLowerBound
"Set the lower bound.
Parameters
----------
lowerBound : float
Lower bound. The upper bound must be strictly greater than the lower bound. "
// ---------------------------------------------------------------------
%feature("docstring") OT::TruncatedDistribution::getUpperBound
"Get the upper bound.
Returns
-------
upperBound : float
Upper bound."
// ---------------------------------------------------------------------
%feature("docstring") OT::TruncatedDistribution::setUpperBound
"Set the upper bound.
Parameters
----------
upperBound : float
Upper bound. The upper bound must be strictly greater than the lower bound."
// ---------------------------------------------------------------------
%feature("docstring") OT::TruncatedDistribution::getThresholdRealization
"Get the threshold used when generating an evaluation of the distribution.
Returns
-------
threshold : float, :math:`\\\\tau \\\\in [0, 1]`
This threshold is used when generating an evaluation of the distribution.
We note :math:`F` the CDF of the non truncated distribution:
If :math:`F(upperBound)-F(lowerBound)<\\\\tau`: a CDF inversion is performed.
If :math:`F(upperBound)-F(lowerBound)>\\\\tau`: rejection."
// ---------------------------------------------------------------------
%feature("docstring") OT::TruncatedDistribution::setThresholdRealization
"Set the threshold used when generating an evaluation of the distribution.
Parameters
----------
threshold : float, :math:`\\\\tau \\\\in [0, 1]`
This threshold is used when generating an evaluation of the distribution.
We note :math:`F` the CDF of the non truncated distribution:
If :math:`F(upperBound)-F(lowerBound)<\\\\tau`: a CDF inversion is performed.
If :math:`F(upperBound)-F(lowerBound)>\\\\tau`: rejection."
|