Marmote Core
The project aims at realizing the prototype of a software environment dedicated to modeling with Markov chains.
bernoulliDistribution.h
1 /* Marmote is free software: you can redistribute it and/or modify
2 it under the terms of the GNU General Public License as published by
3 the Free Software Foundation, either version 3 of the License, or
4 (at your option) any later version.
5 
6 Marmote is distributed in the hope that it will be useful,
7 but WITHOUT ANY WARRANTY; without even the implied warranty of
8 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
9 GNU General Public License for more details.
10 
11 You should have received a copy of the GNU General Public License
12 along with Marmote. If not, see <http://www.gnu.org/licenses/>.
13 
14 Copyright 2015 Alain Jean-Marie, Jean-Michel Fourneau, Jean-Marc Vincent, Issam Rabhi */
15 
16 #ifndef bernoulliDistribution_H
17 #define bernoulliDistribution_H
18 
19 #include "discreteDistribution.h"
20 
26 
27 public:
35  bernoulliDistribution( double ); // creation from a value
36 
37 private:
38  // private variables specific to the distribution
39  double _proba;
41 public:
42  // accessors to specific variables
49  double getParameter() { return _proba; }
56  double proba() { return _proba; }
57 
58 public:
59  // probabilistic member functions
63  double mean();
67  double rate();
71  double moment( int order );
75  double laplace( double s ); // Laplace transform at real points
79  double dLaplace( double s ); // derivative of the Laplace transform
83  double cdf( double x );
87  bool hasMoment( int order );
88 
96  bernoulliDistribution *rescale( double factor );
101 
105  double sample();
106 
107  public:
111  std::string toString();
115  void write( FILE *out, int mode );
116 
117 };
118 
119 #endif // bernoulliDistribution_H
std::string toString()
an utility to convert the distribution into a string.
Definition: bernoulliDistribution.cpp:168
bool hasMoment(int order)
test for the existence of moments of any order
Definition: bernoulliDistribution.cpp:92
double proba()
Accessor to the parameter of the distribution. Redundant with the accessor getParameter() but conform...
Definition: bernoulliDistribution.h:56
double laplace(double s)
computing the Laplace transform of the distribution at real point
Definition: bernoulliDistribution.cpp:103
double sample()
drawing a (pseudo)random value according to the distribution.
Definition: bernoulliDistribution.cpp:203
bernoulliDistribution * copy()
copying a distribution. Typically implemented as rescale(1.0).
Definition: bernoulliDistribution.cpp:195
void write(FILE *out, int mode)
an utility to write the distribution to some file, according to some format.
Definition: bernoulliDistribution.cpp:155
double mean()
computing the mathematical expectation or mean
Definition: bernoulliDistribution.cpp:46
double getParameter()
Accessor to the parameter of the distribution. Redundant with the standard accessor proba() but more ...
Definition: bernoulliDistribution.h:49
double dLaplace(double s)
computing the derivative of the Laplace transform at real points
Definition: bernoulliDistribution.cpp:117
The Bernoulli distribution with two values.
Definition: bernoulliDistribution.h:25
bernoulliDistribution * rescale(double factor)
Rescaling the distribution. Bernoulli distributions cannot be rescaled. Ac copy is returned and an er...
Definition: bernoulliDistribution.cpp:180
double cdf(double x)
computing the cumulative distribution function at some real point x. This is the probability that the...
Definition: bernoulliDistribution.cpp:131
double moment(int order)
Computing the moments of the distribution.
Definition: bernoulliDistribution.cpp:78
The general discrete distribution with finite support.
Definition: discreteDistribution.h:25
bernoulliDistribution(double)
Unique onstructor for a Bernoulli distribution from the probability that it is equal to 1...
Definition: bernoulliDistribution.cpp:21
double rate()
computing the "rate", defined as the inverse of the mean
Definition: bernoulliDistribution.cpp:57