/usr/include/openturns/PythonDistributionImplementation.hxx is in libopenturns-dev 1.7-3.
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 | // -*- C++ -*-
/**
* @brief This class binds a Python object to an OpenTURNS' 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/>.
*
*/
#ifndef OPENTURNS_PYTHONDISTRIBUTIONIMPLEMENTATION_HXX
#define OPENTURNS_PYTHONDISTRIBUTIONIMPLEMENTATION_HXX
#include <Python.h>
#include "DistributionImplementation.hxx"
BEGIN_NAMESPACE_OPENTURNS
/**
* @class PythonDistributionImplementation
*
* This class binds a Python object to an OpenTURNS' RandomVector
*/
class PythonDistributionImplementation
: public DistributionImplementation
{
CLASSNAME;
public:
/** Constructor from Python object*/
PythonDistributionImplementation(PyObject * pyObject);
/** Copy constructor */
PythonDistributionImplementation(const PythonDistributionImplementation & other);
/** Virtual constructor */
virtual PythonDistributionImplementation * clone() const;
/** Destructor */
virtual ~PythonDistributionImplementation();
/** Comparison operator */
Bool operator ==(const PythonDistributionImplementation & other) const;
/** String converter */
virtual String __repr__() const;
virtual String __str__(const String & offset) const;
/* Here is the interface that all derived class must implement */
/** Get one realization of the distribution */
NumericalPoint getRealization() const;
/** Get a numerical sample whose elements follow the distributionImplementation */
NumericalSample getSample(const UnsignedInteger size) const;
/** Get the DDF of the distribution */
NumericalPoint computeDDF(const NumericalPoint & point) const;
/** Get the PDF of the distribution */
NumericalScalar computePDF(const NumericalPoint & point) const;
NumericalScalar computeLogPDF(const NumericalPoint & point) const;
/** Get the CDF of the distribution */
NumericalScalar computeCDF(const NumericalPoint & point) const;
/** Get the complementary CDF of the distribution */
NumericalScalar computeComplementaryCDF(const NumericalPoint & point) const;
/** Get the quantile of the distributionImplementation */
virtual NumericalPoint computeQuantile(const NumericalScalar prob,
const Bool tail = false) const;
/** Get the characteristic function of the distribution, i.e. phi(u) = E(exp(I*u*X)) */
NumericalComplex computeCharacteristicFunction(const NumericalScalar x) 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;
/** Get the quantile of the distribution */
NumericalScalar computeScalarQuantile(const NumericalScalar prob,
const Bool tail = false) const;
/** Get the roughness, i.e. the L2-norm of the PDF */
NumericalScalar getRoughness() const;
/** Get the mean of the distribution */
NumericalPoint getMean() 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;
/** Get the raw moments of the standardized distribution */
NumericalPoint getStandardMoment(const UnsignedInteger n) const;
/** Get the raw moments of the distribution */
NumericalPoint getMoment(const UnsignedInteger n) const;
/** Get the centered moments of the distribution */
NumericalPoint getCenteredMoment(const UnsignedInteger n) const;
/** Parameters value and description accessor */
// NumericalPointWithDescriptionCollection getParametersCollection() const;
// void setParametersCollection(const NumericalPointCollection & parametersCollection);
//
/** Check if the distribution is a copula */
Bool isCopula() const;
/** Check if the distribution is elliptical */
Bool isElliptical() const;
/** Check if the distribution is continuous */
Bool isContinuous() const;
/** Check if the distribution is integral */
Bool isIntegral() const;
/** Tell if the distribution has elliptical copula */
Bool hasEllipticalCopula() const;
/** Tell if the distribution has independent copula */
Bool hasIndependentCopula() const;
/** Get the distribution of the marginal distribution corresponding to indices dimensions */
virtual Implementation getMarginal(const Indices & indices) const;
/** Method save() stores the object through the StorageManager */
virtual void save(Advocate & adv) const;
/** Method save() reloads the object from the StorageManager */
virtual void load(Advocate & adv);
/** Compute the numerical range of the distribution given the parameters values */
virtual void computeRange();
protected:
private:
friend class Factory<PythonDistributionImplementation>;
/** Default constructor */
PythonDistributionImplementation();
/** The underlying Python object */
PyObject * pyObj_;
}; /* class PythonDistributionImplementation */
END_NAMESPACE_OPENTURNS
#endif /* OPENTURNS_PYTHONDISTRIBUTIONIMPLEMENTATION_HXX */
|