jMEF.BinomialFixedN Class Reference

List of all members.

Public Member Functions

 BinomialFixedN ()
 Class constructor.
 BinomialFixedN (int n)
 Class constructor.
double F (PVector T)
 Computes the log normalizer $ F( \mathbf{\Theta} ) $.
PVector gradF (PVector T)
 Computes $ \nabla F ( \mathbf{\Theta} )$.
double G (PVector H)
 Computes $ G(\mathbf{H})$.
PVector gradG (PVector H)
 Computes $ \nabla G (\mathbf{H})$.
PVector t (PVector x)
 Computes the sufficient statistic $ t(x)$.
double k (PVector x)
 Computes the carrier measure $ k(x) $.
PVector Lambda2Theta (PVector L)
 Converts source parameters to natural parameters.
PVector Theta2Lambda (PVector T)
 Converts natural parameters to source parameters.
PVector Lambda2Eta (PVector L)
 Converts source parameters to expectation parameters.
PVector Eta2Lambda (PVector H)
 Converts expectation parameters to source parameters.
double density (PVector x, PVector param)
 Computes the density value $ f(x;p) $.
PVector drawRandomPoint (PVector L)
 Draws a point from the considered distribution.
double KLD (PVector L1, PVector L2)
 Computes the Kullback-Leibler divergence between two Binomial distributions.

Detailed Description

Author:
Vincent Garcia

Frank Nielsen

Version:
1.0

License

See file LICENSE.txt

Description

The Binomial distribution, with $ n $ fixed, is an exponential family and, as a consequence, the probability density function is given by

\[ f(x; \mathbf{\Theta}) = \exp \left( \langle t(x), \mathbf{\Theta} \rangle - F(\mathbf{\Theta}) + k(x) \right) \]

where $ \mathbf{\Theta} $ are the natural parameters. This class implements the different functions allowing to express a Binomial distribution as a member of an exponential family.

Parameters

The parameters of a given distribution are:

Constructor & Destructor Documentation

jMEF.BinomialFixedN.BinomialFixedN (  ) 

Class constructor.

jMEF.BinomialFixedN.BinomialFixedN ( int  n  ) 

Class constructor.

Parameters:
n parameter n

Member Function Documentation

double jMEF.BinomialFixedN.density ( PVector  x,
PVector  param 
)

Computes the density value $ f(x;p) $.

Parameters:
x a point
param parameters (source, natural, or expectation)
Returns:
$ f(x;p) = \frac{n!}{x!(n-x)!} p^x (1-p)^{n-x} $

PVector jMEF.BinomialFixedN.drawRandomPoint ( PVector  L  ) 

Draws a point from the considered distribution.

Parameters:
L source parameters $ \mathbf{\Lambda} = p $
Returns:
a point

PVector jMEF.BinomialFixedN.Eta2Lambda ( PVector  H  ) 

Converts expectation parameters to source parameters.

Parameters:
H expectation parameters $ \mathbf{H} = \eta$
Returns:
source parameters $ \mathbf{\Lambda} = \frac{\eta}{n} $

double jMEF.BinomialFixedN.F ( PVector  T  ) 

Computes the log normalizer $ F( \mathbf{\Theta} ) $.

Parameters:
T natural parameters $ \mathbf{\Theta} = \theta $
Returns:
$ F(\mathbf{\Theta}) = n \log (1 + \exp \theta) - \log (n!) $

double jMEF.BinomialFixedN.G ( PVector  H  ) 

Computes $ G(\mathbf{H})$.

Parameters:
H expectation parameters $ \mathbf{H} = \eta $
Returns:
$ G(\mathbf{H}) = \eta \log \left( \frac{\eta}{n-\eta} \right) - n \log\left( \frac{n}{n-\eta} \right) $

PVector jMEF.BinomialFixedN.gradF ( PVector  T  ) 

Computes $ \nabla F ( \mathbf{\Theta} )$.

Parameters:
T natural parameters $ \mathbf{\Theta} = \theta $
Returns:
$ \nabla F( \mathbf{\Theta} ) = \frac{n \exp \theta}{1 + \exp \theta} $

PVector jMEF.BinomialFixedN.gradG ( PVector  H  ) 

Computes $ \nabla G (\mathbf{H})$.

Parameters:
H expectation parameters $ \mathbf{H} = \eta $
Returns:
$ \nabla G( \mathbf{H} ) = \log \left( \frac{\eta}{n-\eta} \right) $

double jMEF.BinomialFixedN.k ( PVector  x  ) 

Computes the carrier measure $ k(x) $.

Parameters:
x a point
Returns:
$ k(x) = - \log (x! (n-x)!) $

double jMEF.BinomialFixedN.KLD ( PVector  L1,
PVector  L2 
)

Computes the Kullback-Leibler divergence between two Binomial distributions.

Parameters:
L1 source parameters $ \mathbf{\Lambda}_1 $
L2 source parameters $ \mathbf{\Lambda}_2 $
Returns:
$ D_{\mathrm{KL}}(f_1\|f_2) = n (1-p_1) \log \left( \frac{1-p_1}{1-p_2} \right) + n p_1 \log \left( \frac{p_1}{p_2} \right) $

PVector jMEF.BinomialFixedN.Lambda2Eta ( PVector  L  ) 

Converts source parameters to expectation parameters.

Parameters:
L source parameters $ \mathbf{\Lambda} = p $
Returns:
expectation parameters $ \mathbf{H} = np $

PVector jMEF.BinomialFixedN.Lambda2Theta ( PVector  L  ) 

Converts source parameters to natural parameters.

Parameters:
L source parameters $ \mathbf{\Lambda} = p $
Returns:
natural parameters $ \mathbf{\Theta} = \log \left( \frac{p}{1-p} \right) $

PVector jMEF.BinomialFixedN.t ( PVector  x  ) 

Computes the sufficient statistic $ t(x)$.

Parameters:
x a point
Returns:
$ t(x) = x $

PVector jMEF.BinomialFixedN.Theta2Lambda ( PVector  T  ) 

Converts natural parameters to source parameters.

Parameters:
T natural parameters $ \mathbf{\Theta} = \theta $
Returns:
source parameters $ \mathbf{\Lambda} = \frac{\exp \theta}{1 + \exp \theta} $

The documentation for this class was generated from the following file:
Generated on Mon Nov 23 15:46:25 2009 for jMEF by  doxygen 1.5.9