/usr/include/openturns/Rice.hxx is in libopenturns-dev 1.5-7build2.
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 | // -*- C++ -*-
/**
* @file Rice.hxx
* @brief The Rice distribution
*
* Copyright 2005-2015 Airbus-EDF-IMACS-Phimeca
*
* This library is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* along with this library. If not, see <http://www.gnu.org/licenses/>.
*
* @author lebrun
* @date 2008-09-09 23:26:29 +0200 (mar, 09 sep 2008)
*/
#ifndef OPENTURNS_RICE_HXX
#define OPENTURNS_RICE_HXX
#include "ContinuousDistribution.hxx"
BEGIN_NAMESPACE_OPENTURNS
/**
* @class Rice
*
* The Rice distribution.
*/
class OT_API Rice
: public ContinuousDistribution
{
CLASSNAME;
public:
typedef Pointer<DistributionImplementation> Implementation;
/** Default constructor */
Rice();
/** Parameters constructor */
explicit Rice(const NumericalScalar sigma,
const NumericalScalar nu = 0.0);
/** Comparison operator */
Bool operator ==(const Rice & other) const;
/** String converter */
String __repr__() const;
String __str__(const String & offset = "") const;
/* Interface inherited from Distribution */
/** Virtual constructor */
virtual Rice * clone() const;
/** Get one realization of the Rice distribution */
NumericalPoint getRealization() const;
/** Get the PDF of the distribution, i.e. P(point < X < point+dx) = PDF(point)dx + o(dx) */
using ContinuousDistribution::computePDF;
NumericalScalar computePDF(const NumericalPoint & point) const;
/** Get the logarithm of the PDF of the distribution */
using ContinuousDistribution::computeLogPDF;
NumericalScalar computeLogPDF(const NumericalPoint & point) const;
/** Get the CDF of the distribution, i.e. P(X <= point) = CDF(point). If tail=true, compute P(X >= point) */
using ContinuousDistribution::computeCDF;
NumericalScalar computeCDF(const NumericalPoint & point) const;
using ContinuousDistribution::computeComplementaryCDF;
NumericalScalar computeComplementaryCDF(const NumericalPoint & point) const;
/** Get the standard deviation of the distribution */
NumericalPoint getStandardDeviation() const;
/** Get the raw moments of the standardized distribution */
NumericalPoint getStandardMoment(const UnsignedInteger n) const;
/** Get the standard representative in the parametric family, associated with the standard moments */
Implementation getStandardRepresentative() const;
/** Parameters value and description accessor */
NumericalPointWithDescriptionCollection getParametersCollection() const;
using ContinuousDistribution::setParametersCollection;
void setParametersCollection(const NumericalPointCollection & parametersCollection);
/* Interface specific to Rice */
/** Sigma accessor */
void setSigma(const NumericalScalar sigma);
NumericalScalar getSigma() const;
/** Nu accessor */
void setNu(const NumericalScalar nu);
NumericalScalar getNu() const;
/** Maximum iterations accessor */
void setMaximumIteration(const UnsignedInteger maximumIteration);
UnsignedInteger getMaximumIteration() const;
/** Method save() stores the object through the StorageManager */
void save(Advocate & adv) const;
/** Method load() reloads the object from the StorageManager */
void load(Advocate & adv);
protected:
private:
/** Compute the mean of the distribution */
void computeMean() const;
/** Compute the covariance of the distribution */
void computeCovariance() const;
/** Compute the numerical range of the distribution given the parameters values */
void computeRange();
/** The dispersion parameter */
NumericalScalar sigma_;
/** The position parameter */
NumericalScalar nu_;
/** The maximum iterations for the PDF and CDF computations */
UnsignedInteger maximumIteration_;
}; /* class Rice */
END_NAMESPACE_OPENTURNS
#endif /* OPENTURNS_RICE_HXX */
|