/usr/include/openturns/LogNormal.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 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 | // -*- C++ -*-
/**
* @brief The LogNormal 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_LOGNORMAL_HXX
#define OPENTURNS_LOGNORMAL_HXX
#include "openturns/OTprivate.hxx"
#include "openturns/ContinuousDistribution.hxx"
#include "openturns/PersistentCollection.hxx"
BEGIN_NAMESPACE_OPENTURNS
/**
* @class LogNormal
*
* The LogNormal distribution.
*/
class OT_API LogNormal
: public ContinuousDistribution
{
CLASSNAME;
public:
typedef Pointer<DistributionImplementation> Implementation;
/** Default constructor */
LogNormal();
/** Parameters constructor */
LogNormal(const Scalar muLog,
const Scalar sigmaLog,
const Scalar gamma = 0.0);
/** Comparison operator */
Bool operator ==(const LogNormal & 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 LogNormal * clone() const;
/** Get one realization of the LogNormal distribution */
Point getRealization() const;
/** Get the DDF of the LogNormal distribution */
using ContinuousDistribution::computeDDF;
Point computeDDF(const Point & point) const;
/** Get the PDF of the LogNormal distribution */
using ContinuousDistribution::computePDF;
Scalar computePDF(const Point & point) const;
using ContinuousDistribution::computeLogPDF;
Scalar computeLogPDF(const Point & point) const;
/** Get the CDF of the LogNormal distribution */
using ContinuousDistribution::computeCDF;
Scalar computeCDF(const Point & point) const;
using ContinuousDistribution::computeComplementaryCDF;
Scalar computeComplementaryCDF(const Point & point) const;
/** Get the characteristic function of the distribution, i.e. phi(u) = E(exp(I*u*X)) */
Complex computeCharacteristicFunction(const Scalar x) const;
Complex computeLogCharacteristicFunction(const Scalar x) const;
/** Get the PDFGradient of the LogNormal distribution */
using ContinuousDistribution::computePDFGradient;
Point computePDFGradient(const Point & point) const;
/** Get the CDFGradient of the LogNormal distribution */
using ContinuousDistribution::computeCDFGradient;
Point computeCDFGradient(const Point & point) 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;
/** Get the raw moments of the standardized distribution */
Point getStandardMoment(const UnsignedInteger n) const;
/** Get the standard representative in the parametric family, associated with the standard moments */
Implementation getStandardRepresentative() const;
/** Parameters value accessors */
void setParameter(const Point & parameter);
Point getParameter() const;
/** Parameters description accessor */
Description getParameterDescription() const;
/* Interface specific to LogNormal */
/** MuLog accessor */
void setMuLog(const Scalar muLog);
Scalar getMuLog() const;
/** SigmaLog accessor */
void setSigmaLog(const Scalar sigmaLog);
Scalar getSigmaLog() const;
/** Gamma accessor */
void setGamma(const Scalar gamma);
Scalar getGamma() 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:
/** MuLogSigmaLog accessor */
void setMuLogSigmaLog(const Scalar muLog,
const Scalar sigmaLog);
private:
/** Compute the mean of the distribution */
void computeMean() const;
/** Compute the covariance of the distribution */
void computeCovariance() const;
/** Get the quantile of the LogNormal distribution */
Scalar computeScalarQuantile(const Scalar prob,
const Bool tail = false) const;
/** Compute the integrand that is involved in the computation of the characteristic function */
Complex characteristicIntegrand(const Scalar eta,
const Scalar sStar) const;
/** Compute the numerical range of the distribution given the parameters values */
void computeRange();
/** The main parameter set of the distribution */
Scalar muLog_;
Scalar sigmaLog_;
Scalar gamma_;
Scalar normalizationFactor_;
/** Normalization factor for the characteristic function */
Scalar H_;
/** Hermite integration */
mutable Point hermiteNodes_;
mutable Point hermiteWeights_;
}; /* class LogNormal */
END_NAMESPACE_OPENTURNS
#endif /* OPENTURNS_LOGNORMAL_HXX */
|