/usr/include/openturns/VonMises.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 | // -*- C++ -*-
/**
* @brief The VonMises 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_VONMISES_HXX
#define OPENTURNS_VONMISES_HXX
#include "ContinuousDistribution.hxx"
BEGIN_NAMESPACE_OPENTURNS
/**
* @class VonMises
*
* The VonMises distribution.
*/
class OT_API VonMises
: public ContinuousDistribution
{
CLASSNAME;
public:
/** Default constructor */
VonMises();
/** Parameters constructor */
explicit VonMises(const NumericalScalar mu,
const NumericalScalar kappa);
/** Comparison operator */
Bool operator ==(const VonMises & other) const;
/** String converter */
String __repr__() const;
String __str__(const String & offset = "") const;
/* Interface inherited from Distribution */
/** Virtual constructor */
virtual VonMises * clone() const;
/** Get one realization of the distribution */
NumericalPoint getRealization() const;
/** Get the DDF of the distribution */
using ContinuousDistribution::computeDDF;
NumericalPoint computeDDF(const NumericalPoint & point) const;
/** Get the PDF of the distribution */
using ContinuousDistribution::computePDF;
NumericalScalar computePDF(const NumericalPoint & point) const;
using ContinuousDistribution::computeLogPDF;
NumericalScalar computeLogPDF(const NumericalPoint & point) const;
/** Parameters value accessors */
void setParameter(const NumericalPoint & parameter);
NumericalPoint getParameter() const;
/** Parameters description accessor */
Description getParameterDescription() const;
/* Interface specific to VonMises */
/** Mu accessor */
void setMu(const NumericalScalar mu);
NumericalScalar getMu() const;
/** Kappa accessor */
void setKappa(const NumericalScalar kappa);
NumericalScalar getKappa() const;
/** Circular moments accessor */
NumericalScalar getCircularMean() const;
NumericalScalar getCircularVariance() 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 numerical range of the distribution given the parameters values */
void computeRange();
/** Update the derivative attributes */
void update();
/** The main parameter set of the distribution */
NumericalScalar mu_;
NumericalScalar kappa_;
NumericalScalar normalizationFactor_;
NumericalScalar ratioOfUniformsBound_;
}; /* class VonMises */
END_NAMESPACE_OPENTURNS
#endif /* OPENTURNS_VONMISES_HXX */
|