/usr/include/openturns/NegativeBinomial.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 145 146 147 148 149 150 151 152 153 | // -*- C++ -*-
/**
* @file NegativeBinomial.hxx
* @brief The NegativeBinomial 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 dutka
* @date 2010-07-12 15:45:44 +0200 (lun. 12 juil. 2010)
*/
#ifndef OPENTURNS_NEGATIVEBINOMIAL_HXX
#define OPENTURNS_NEGATIVEBINOMIAL_HXX
#include "OTprivate.hxx"
#include "DiscreteDistribution.hxx"
BEGIN_NAMESPACE_OPENTURNS
/**
* @class NegativeBinomial
*
* The NegativeBinomial distribution.
*/
class OT_API NegativeBinomial
: public DiscreteDistribution
{
CLASSNAME;
public:
/** Default constructor */
NegativeBinomial();
/** Parameters constructor */
NegativeBinomial(const NumericalScalar r,
const NumericalScalar p);
/** Comparison operator */
Bool operator ==(const NegativeBinomial & other) const;
/** String converter */
String __repr__() const;
String __str__(const String & offset = "") const;
/* Interface inherited from Distribution */
/** Virtual constructor */
virtual NegativeBinomial * 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;
using DiscreteDistribution::computeComplementaryCDF;
NumericalScalar computeComplementaryCDF(const NumericalPoint & point) const;
/** Get the PDFGradient of the distribution */
using DiscreteDistribution::computePDFGradient;
NumericalPoint computePDFGradient(const NumericalPoint & point) const;
/** Get the CDFGradient of the distribution */
using DiscreteDistribution::computeCDFGradient;
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;
NumericalComplex computeLogCharacteristicFunction(const NumericalScalar x) const;
/** Compute the generating function, i.e. psi(z) = E(z^X) */
NumericalComplex computeGeneratingFunction(const NumericalComplex & z) const;
NumericalComplex computeLogGeneratingFunction(const NumericalComplex & z) const;
/** Get the support of a discrete distribution that intersect a given interval */
using DistributionImplementation::getSupport;
NumericalSample getSupport(const Interval & interval) const;
/** Get the standard deviation of the distribution */
NumericalPoint getStandardDeviation() const;
/** Get the skewness of the distribution */
NumericalPoint getSkewness() const;
/** Get the kurtosis of the distribution */
NumericalPoint getKurtosis() const;
/** Parameters value and description accessor */
NumericalPointWithDescriptionCollection getParametersCollection() const;
using DiscreteDistribution::setParametersCollection;
void setParametersCollection(const NumericalPointCollection & parametersCollection);
/* Interface specific to NegativeBinomial */
/** P accessor */
void setP(const NumericalScalar p);
NumericalScalar getP() const;
/** R accessor */
void setR(const NumericalScalar r);
NumericalScalar getR() 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;
/** Get the quantile of the distribution */
NumericalScalar computeScalarQuantile(const NumericalScalar prob,
const Bool tail = false) const;
/** Compute the numerical range of the distribution given the parameters values */
void computeRange();
/** The maximum value of the NegativeBinomial distribution */
NumericalScalar r_;
/** The probability parameter of the NegativeBinomial distribution */
NumericalScalar p_;
}; /* class NegativeBinomial */
END_NAMESPACE_OPENTURNS
#endif /* OPENTURNS_NEGATIVEBINOMIAL_HXX */
|