CDistribution Class Reference

Inheritance diagram for CDistribution:

Inheritance graph
[legend]

List of all members.


Detailed Description

class Distribution

Definition at line 19 of file Distribution.h.


Public Member Functions

 CDistribution ()
virtual ~CDistribution ()
virtual bool train ()=0
virtual INT get_num_model_parameters ()=0
virtual INT get_num_relevant_model_parameters ()
virtual DREAL get_log_model_parameter (INT num_param)=0
virtual DREAL get_log_derivative (INT num_param, INT num_example)=0
virtual DREAL get_log_likelihood_example (INT num_example)=0
virtual DREAL get_log_likelihood_sample ()
virtual void get_log_likelihood (DREAL **dst, INT *num)
virtual DREAL get_model_parameter (INT num_param)
virtual DREAL get_derivative (INT num_param, INT num_example)
virtual DREAL get_likelihood_example (INT num_example)
virtual void set_features (CFeatures *f)
virtual CFeaturesget_features ()
virtual void set_pseudo_count (DREAL pseudo)
virtual DREAL get_pseudo_count ()

Static Public Attributes

static CParallel parallel
static CIO io
static CVersion version

Protected Attributes

CFeaturesfeatures
DREAL pseudo_count

Constructor & Destructor Documentation

CDistribution::CDistribution (  ) 

default constructor

Definition at line 14 of file Distribution.cpp.

CDistribution::~CDistribution (  )  [virtual]

Definition at line 20 of file Distribution.cpp.


Member Function Documentation

virtual bool CDistribution::train (  )  [pure virtual]

train distribution

abstrace base method

Returns:
if training was successful

Implemented in CHistogram, CGHMM, CHMM, and CLinearHMM.

virtual INT CDistribution::get_num_model_parameters (  )  [pure virtual]

get number of parameters in model

abstract base method

Returns:
number of parameters in model

Implemented in CHistogram, CGHMM, CHMM, and CLinearHMM.

INT CDistribution::get_num_relevant_model_parameters (  )  [virtual]

get number of parameters in model that are relevant, i.e. > ALMOST_NEG_INFTY

Returns:
number of relevant model parameters

Definition at line 48 of file Distribution.cpp.

virtual DREAL CDistribution::get_log_model_parameter ( INT  num_param  )  [pure virtual]

get model parameter (logarithmic)

abstrac base method

Returns:
model parameter (logarithmic)

Implemented in CHistogram, CGHMM, CHMM, and CLinearHMM.

virtual DREAL CDistribution::get_log_derivative ( INT  num_param,
INT  num_example 
) [pure virtual]

get derivative of likelihood function (logarithmic)

abstract base method

Parameters:
num_param which param
num_example which example
Returns:
derivative of likelihood (logarithmic)

Implemented in CHistogram, CGHMM, CHMM, and CLinearHMM.

virtual DREAL CDistribution::get_log_likelihood_example ( INT  num_example  )  [pure virtual]

compute log likelihood for example

abstract base method

Parameters:
num_example which example
Returns:
log likeliehood for example

Implemented in CHistogram, CGHMM, CHMM, and CLinearHMM.

DREAL CDistribution::get_log_likelihood_sample (  )  [virtual]

compute log likelihood for whole sample

Returns:
log likelihood for whole sample

Definition at line 24 of file Distribution.cpp.

void CDistribution::get_log_likelihood ( DREAL **  dst,
INT num 
) [virtual]

compute log likelihood for each example

Parameters:
dst where likelihood will be stored
num where number of likelihoods will be stored

Definition at line 35 of file Distribution.cpp.

virtual DREAL CDistribution::get_model_parameter ( INT  num_param  )  [virtual]

get model parameter

Parameters:
num_param which param
Returns:
model parameter

Definition at line 94 of file Distribution.h.

virtual DREAL CDistribution::get_derivative ( INT  num_param,
INT  num_example 
) [virtual]

get derivative of likelihood function

Parameters:
num_param which param
num_example which example
Returns:
derivative of likelihood function

Definition at line 105 of file Distribution.h.

virtual DREAL CDistribution::get_likelihood_example ( INT  num_example  )  [virtual]

compute likelihood for example

Parameters:
num_example which example
Returns:
likelihood for example

Definition at line 115 of file Distribution.h.

virtual void CDistribution::set_features ( CFeatures f  )  [virtual]

set feature vectors

Parameters:
f new feature vectors

Definition at line 124 of file Distribution.h.

virtual CFeatures* CDistribution::get_features (  )  [virtual]

get feature vectors

Returns:
feature vectors

Definition at line 130 of file Distribution.h.

virtual void CDistribution::set_pseudo_count ( DREAL  pseudo  )  [virtual]

set pseudo count

Parameters:
pseudo new pseudo count

Definition at line 136 of file Distribution.h.

virtual DREAL CDistribution::get_pseudo_count (  )  [virtual]

get pseudo count

Returns:
pseudo count

Definition at line 142 of file Distribution.h.


Member Data Documentation

feature vectors

Definition at line 146 of file Distribution.h.

pseudo count

Definition at line 148 of file Distribution.h.

CParallel CSGObject::parallel [static, inherited]

Definition at line 105 of file SGObject.h.

CIO CSGObject::io [static, inherited]

Definition at line 106 of file SGObject.h.

CVersion CSGObject::version [static, inherited]

Definition at line 107 of file SGObject.h.


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

SHOGUN Machine Learning Toolbox - Documentation