Gadget
Public Member Functions | Protected Attributes | List of all members
Multinomial Class Reference

This is the class that calculates a log likelihood score by comparing 2 vectors based on a multinomial distribution. More...

#include <multinomial.h>

Collaboration diagram for Multinomial:
Collaboration graph

Public Member Functions

 Multinomial ()
 This is the default Multinomial constructor. More...
 
 ~Multinomial ()
 This is the default Multinomial destructor. More...
 
void setValue (double value)
 This function will set the minimum probability value. More...
 
void Reset ()
 This function will reset the log likelihood score. More...
 
double calcLogLikelihood (const DoubleVector &data, const DoubleVector &dist)
 This is the function that calculates a log likelihood score by comparing 2 vectors based on a multinomial distribution. More...
 
double getLogLikelihood () const
 This will return the log likelihood score. More...
 

Protected Attributes

double bigvalue
 This is used to calculate the default minimum probability for unlikely values. More...
 
double loglikelihood
 This is the log likelihood score. More...
 

Detailed Description

This is the class that calculates a log likelihood score by comparing 2 vectors based on a multinomial distribution.

Constructor & Destructor Documentation

◆ Multinomial()

Multinomial::Multinomial ( )
inline

This is the default Multinomial constructor.

◆ ~Multinomial()

Multinomial::~Multinomial ( )
inline

This is the default Multinomial destructor.

Member Function Documentation

◆ calcLogLikelihood()

double Multinomial::calcLogLikelihood ( const DoubleVector data,
const DoubleVector dist 
)

This is the function that calculates a log likelihood score by comparing 2 vectors based on a multinomial distribution.

Parameters
datais the DoubleVector containing the input data
distis the DoubleVector containing the modelled data
Returns
likelihood

◆ getLogLikelihood()

double Multinomial::getLogLikelihood ( ) const
inline

This will return the log likelihood score.

Returns
loglikelihood

◆ Reset()

void Multinomial::Reset ( )
inline

This function will reset the log likelihood score.

◆ setValue()

void Multinomial::setValue ( double  value)
inline

This function will set the minimum probability value.

Parameters
valueis the bigvalue used to calculate the minimum probabilty

Member Data Documentation

◆ bigvalue

double Multinomial::bigvalue
protected

This is used to calculate the default minimum probability for unlikely values.

◆ loglikelihood

double Multinomial::loglikelihood
protected

This is the log likelihood score.


The documentation for this class was generated from the following files: