/usr/include/openturns/Skellam.hxx is in libopenturns-dev 1.9-5.
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 | // -*- C++ -*-
/**
* @brief The Skellam distribution
*
* Copyright 2005-2017 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/>.
*
*/
#ifndef OPENTURNS_SKELLAM_HXX
#define OPENTURNS_SKELLAM_HXX
#include "openturns/OTprivate.hxx"
#include "openturns/DiscreteDistribution.hxx"
BEGIN_NAMESPACE_OPENTURNS
/**
* @class Skellam
*
* The Skellam distribution.
*/
class OT_API Skellam
: public DiscreteDistribution
{
CLASSNAME;
public:
/** Default constructor */
Skellam();
/** Parameters constructor */
Skellam(const Scalar lambda1,
const Scalar lambda2);
/** Comparison operator */
Bool operator ==(const Skellam & other) const;
protected:
Bool equals(const DistributionImplementation & other) const;
public:
/** String converter */
String __repr__() const;
String __str__(const String & offset = "") const;
/* Interface inherited from Distribution */
/** Virtual constructor */
virtual Skellam * clone() const;
/** Get one realization of the distribution */
Point getRealization() const;
/** Get the PDF of the distribution */
using DiscreteDistribution::computePDF;
Scalar computePDF(const Point & point) const;
/** Get the CDF of the distribution */
using DiscreteDistribution::computeCDF;
Scalar computeCDF(const Point & point) const;
/** Get the PDFGradient of the distribution */
using DiscreteDistribution::computePDFGradient;
Point computePDFGradient(const Point & point) const;
/** Get the CDFGradient of the distribution */
using DiscreteDistribution::computeCDFGradient;
Point computeCDFGradient(const Point & point) const;
/** Compute the characteristic function, i.e. phi(u) = E(exp(I*u*X)) */
Complex computeCharacteristicFunction(const Scalar x) const;
Complex computeLogCharacteristicFunction(const Scalar x) const;
/** Compute the generating function, i.e. psi(z) = E(z^X) */
Complex computeGeneratingFunction(const Complex & z) const;
Complex computeLogGeneratingFunction(const Complex & z) const;
/** Get the quantile of the distribution */
Scalar computeScalarQuantile(const Scalar prob,
const Bool tail = false) const;
/** Get the support of a discrete distribution that intersect a given interval */
using DistributionImplementation::getSupport;
Sample getSupport(const Interval & interval) const;
/** Get the standard deviation of the distribution */
Point getStandardDeviation() const;
/** Get the skewness of the distribution */
Point getSkewness() const;
/** Get the kurtosis of the distribution */
Point getKurtosis() const;
/** Parameters value accessors */
void setParameter(const Point & parameter);
Point getParameter() const;
/** Parameters description accessor */
Description getParameterDescription() const;
/** Check if the distribution is elliptical */
Bool isElliptical() const;
/* Interface specific to Skellam */
/** Lambda1/Lambda2 accessor */
void setLambda1Lambda2(const Scalar lambda1,
const Scalar lambda2);
/** Lambda1 accessor */
void setLambda1(const Scalar lambda1);
Scalar getLambda1() const;
/** Lambda2 accessor */
void setLambda2(const Scalar lambda2);
Scalar getLambda2() 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;
/** The Lambda1 of the Skellam distribution */
Scalar lambda1_;
/** The Lambda2 of the Skellam distribution */
Scalar lambda2_;
/** The maximum iterations for the PDF and CDF computations */
UnsignedInteger maximumIteration_;
}; /* class Skellam */
END_NAMESPACE_OPENTURNS
#endif /* OPENTURNS_SKELLAM_HXX */
|