/usr/include/openturns/Rice.hxx is in libopenturns-dev 0.15-2.
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 | // -*- C++ -*-
/**
* @file Rice.hxx
* @brief The Rice distribution
*
* (C) Copyright 2005-2011 EDF-EADS-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 2.1 of the License.
*
* 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
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
* @author: $LastChangedBy: lebrun $
* @date: $LastChangedDate: 2008-09-09 23:26:29 +0200 (mar, 09 sep 2008) $
* Id: $Id: Rice.hxx 924 2008-09-09 21:26:29Z lebrun $
*/
#ifndef OPENTURNS_RICE_HXX
#define OPENTURNS_RICE_HXX
#include "NonEllipticalDistribution.hxx"
namespace OpenTURNS {
namespace Uncertainty {
namespace Distribution {
/**
* @class Rice
*
* The Rice distribution.
*/
class Rice
: public Model::NonEllipticalDistribution
{
CLASSNAME;
public:
typedef Base::Common::InvalidArgumentException InvalidArgumentException;
typedef Model::NonEllipticalDistribution NonEllipticalDistribution; // required by SWIG
typedef NonEllipticalDistribution::NumericalPoint NumericalPoint;
typedef NonEllipticalDistribution::NumericalSample NumericalSample;
typedef NonEllipticalDistribution::CovarianceMatrix CovarianceMatrix;
typedef NonEllipticalDistribution::NumericalPointWithDescriptionCollection NumericalPointWithDescriptionCollection;
typedef NonEllipticalDistribution::NotDefinedException NotDefinedException;
typedef NonEllipticalDistribution::StorageManager StorageManager;
/** Default constructor */
Rice();
/** Parameters constructor */
Rice(const NumericalScalar sigma,
const NumericalScalar nu = 0.0)
/* throw (InvalidArgumentException) */;
/** 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 NonEllipticalDistribution::computePDF;
NumericalScalar computePDF(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 NonEllipticalDistribution::computeCDF;
NumericalScalar computeCDF(const NumericalPoint & point,
const Bool tail = false) const;
/** Get the standard deviation of the distribution */
NumericalPoint getStandardDeviation() const /* throw(NotDefinedException) */;
/** Parameters value and description accessor */
NumericalPointWithDescriptionCollection getParametersCollection() const;
using NonEllipticalDistribution::setParametersCollection;
void setParametersCollection(const NumericalPointCollection & parametersCollection);
/* Interface specific to Rice */
/** Sigma accessor */
void setSigma(const NumericalScalar sigma)
/* throw(InvalidArgumentException) */;
NumericalScalar getSigma() const;
/** Nu accessor */
void setNu(const NumericalScalar nu);
NumericalScalar getNu() const;
/** Method save() stores the object through the StorageManager */
void save(StorageManager::Advocate & adv) const;
/** Method load() reloads the object from the StorageManager */
void load(StorageManager::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_;
}; /* class Rice */
} /* namespace Distribution */
} /* namespace Uncertainty */
} /* namespace OpenTURNS */
#endif /* OPENTURNS_RICE_HXX */
|