/usr/include/openturns/Binomial.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 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 | // -*- C++ -*-
/**
* @file Binomial.hxx
* @brief The Binomial 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: dutka $
* @date: $LastChangedDate: 2010-07-12 15:45:44 +0200 (lun. 12 juil. 2010) $
* Id: $Id: Binomial.hxx 1581 2010-07-12 13:45:44Z dutka $
*/
#ifndef OPENTURNS_BINOMIAL_HXX
#define OPENTURNS_BINOMIAL_HXX
#include "OTprivate.hxx"
#include "DiscreteDistribution.hxx"
#include "Exception.hxx"
namespace OpenTURNS {
namespace Uncertainty {
namespace Distribution {
/**
* @class Binomial
*
* The Binomial distribution.
*/
class Binomial
: public Model::DiscreteDistribution
{
CLASSNAME;
public:
typedef Base::Common::InvalidArgumentException InvalidArgumentException;
typedef Model::DiscreteDistribution DiscreteDistribution; // required by SWIG
typedef DiscreteDistribution::NumericalPoint NumericalPoint;
typedef DiscreteDistribution::NumericalSample NumericalSample;
typedef DiscreteDistribution::CovarianceMatrix CovarianceMatrix;
typedef DiscreteDistribution::NumericalPointWithDescriptionCollection NumericalPointWithDescriptionCollection;
typedef DiscreteDistribution::NotDefinedException NotDefinedException;
typedef DiscreteDistribution::StorageManager StorageManager;
/** Default constructor */
Binomial();
/** Parameters constructor */
Binomial(const UnsignedLong n,
const NumericalScalar p);
/** Comparison operator */
Bool operator ==(const Binomial & other) const;
/** String converter */
String __repr__() const;
String __str__(const String & offset = "") const;
/* Interface inherited from Distribution */
/** Virtual constructor */
virtual Binomial * clone() const;
/** Get one realization of the distribution */
NumericalPoint getRealization() const;
/** Get the PDF of the distribution */
using DiscreteDistribution::computePDF;
NumericalScalar computePDF(const NumericalPoint & point) const;
/** Get the CDF of the distribution */
using DiscreteDistribution::computeCDF;
NumericalScalar computeCDF(const NumericalPoint & point, const Bool tail = false) const;
/** Get the PDFGradient of the distribution */
NumericalPoint computePDFGradient(const NumericalPoint & point) const;
/** Get the CDFGradient of the distribution */
NumericalPoint computeCDFGradient(const NumericalPoint & point) const;
/** Compute the characteristic function, i.e. phi(u) = E(exp(I*u*X)) */
NumericalComplex computeCharacteristicFunction(const NumericalScalar x,
const Bool logScale = false) const;
/** Compute the generating function, i.e. psi(z) = E(z^X) */
NumericalComplex computeGeneratingFunction(const NumericalComplex & z,
const Bool logScale = false) const;
/** Get the support of a discrete distribution that intersect a given interval */
NumericalSample getSupport(const Interval & interval) const;
/** Get the standard deviation of the distribution */
NumericalPoint getStandardDeviation() const /* throw(NotDefinedException) */;
/** Get the skewness of the distribution */
NumericalPoint getSkewness() const /* throw(NotDefinedException) */;
/** Get the kurtosis of the distribution */
NumericalPoint getKurtosis() const /* throw(NotDefinedException) */;
/** Parameters value and description accessor */
NumericalPointWithDescriptionCollection getParametersCollection() const;
using DiscreteDistribution::setParametersCollection;
void setParametersCollection(const NumericalPointCollection & parametersCollection);
/* Interface specific to Binomial */
/** P accessor */
void setP(const NumericalScalar p);
NumericalScalar getP() const;
/** N accessor */
void setN(const UnsignedLong n);
UnsignedLong getN() 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;
/** Get the quantile of the distribution */
NumericalScalar computeScalarQuantile(const NumericalScalar prob,
const Bool tail = false,
const NumericalScalar precision = DefaultQuantileEpsilon) const;
/** Compute the numerical range of the distribution given the parameters values */
void computeRange();
/** The maximum value of the Binomial distribution */
UnsignedLong n_;
/** The probability parameter of the Binomial distribution */
NumericalScalar p_;
}; /* class Binomial */
} /* namespace Distribution */
} /* namespace Uncertainty */
} /* namespace OpenTURNS */
#endif /* OPENTURNS_BINOMIAL_HXX */
|