SHOGUN  v1.1.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
List of all members | Public Member Functions | Protected Attributes
CHistogram Class Reference

Detailed Description

Class Histogram computes a histogram over all 16bit unsigned integers in the features.

Values in histogram are absolute counts (logarithmic)

Definition at line 26 of file Histogram.h.

Inheritance diagram for CHistogram:
Inheritance graph
[legend]

Public Member Functions

 CHistogram ()
 CHistogram (CStringFeatures< uint16_t > *f)
virtual ~CHistogram ()
virtual bool train (CFeatures *data=NULL)
virtual int32_t get_num_model_parameters ()
virtual float64_t get_log_model_parameter (int32_t num_param)
virtual float64_t get_log_derivative (int32_t num_param, int32_t num_example)
virtual float64_t get_log_likelihood_example (int32_t num_example)
virtual bool set_histogram (SGVector< float64_t > histogram)
virtual SGVector< float64_tget_histogram ()
virtual const char * get_name () const
- Public Member Functions inherited from CDistribution
 CDistribution ()
virtual ~CDistribution ()
virtual int32_t get_num_relevant_model_parameters ()
virtual float64_t get_log_likelihood_sample ()
virtual SGVector< float64_tget_log_likelihood ()
virtual float64_t get_model_parameter (int32_t num_param)
virtual float64_t get_derivative (int32_t num_param, int32_t num_example)
virtual float64_t get_likelihood_example (int32_t num_example)
virtual void set_features (CFeatures *f)
virtual CFeaturesget_features ()
virtual void set_pseudo_count (float64_t pseudo)
virtual float64_t get_pseudo_count ()
- Public Member Functions inherited from CSGObject
 CSGObject ()
 CSGObject (const CSGObject &orig)
virtual ~CSGObject ()
virtual bool is_generic (EPrimitiveType *generic) const
template<class T >
void set_generic ()
void unset_generic ()
virtual void print_serializable (const char *prefix="")
virtual bool save_serializable (CSerializableFile *file, const char *prefix="")
virtual bool load_serializable (CSerializableFile *file, const char *prefix="")
void set_global_io (SGIO *io)
SGIOget_global_io ()
void set_global_parallel (Parallel *parallel)
Parallelget_global_parallel ()
void set_global_version (Version *version)
Versionget_global_version ()
SGVector< char * > get_modelsel_names ()
char * get_modsel_param_descr (const char *param_name)
index_t get_modsel_param_index (const char *param_name)

Protected Attributes

float64_thist
- Protected Attributes inherited from CDistribution
CFeaturesfeatures
float64_t pseudo_count

Additional Inherited Members

- Public Attributes inherited from CSGObject
SGIOio
Parallelparallel
Versionversion
Parameterm_parameters
Parameterm_model_selection_parameters
- Protected Member Functions inherited from CSGObject
virtual void load_serializable_pre () throw (ShogunException)
virtual void load_serializable_post () throw (ShogunException)
virtual void save_serializable_pre () throw (ShogunException)
virtual void save_serializable_post () throw (ShogunException)

Constructor & Destructor Documentation

default constructor

Definition at line 20 of file Histogram.cpp.

CHistogram ( CStringFeatures< uint16_t > *  f)

constructor

Parameters
fhistogram's features

Definition at line 26 of file Histogram.cpp.

~CHistogram ( )
virtual

Definition at line 33 of file Histogram.cpp.

Member Function Documentation

SGVector< float64_t > get_histogram ( )
virtual

get histogram

Returns
current histogram

Definition at line 160 of file Histogram.cpp.

float64_t get_log_derivative ( int32_t  num_param,
int32_t  num_example 
)
virtual

get logarithm of one example's derivative's likelihood

Parameters
num_paramwhich example's param
num_examplewhich example
Returns
logarithm of example's derivative's likelihood

Implements CDistribution.

Definition at line 104 of file Histogram.cpp.

float64_t get_log_likelihood_example ( int32_t  num_example)
virtual

get logarithm of one example's likelihood

Parameters
num_examplewhich example
Returns
logarithm of example's likelihood

Implements CDistribution.

Definition at line 82 of file Histogram.cpp.

float64_t get_log_model_parameter ( int32_t  num_param)
virtual

get logarithm of given model parameter

Parameters
num_paramwhich param
Returns
logarithm of given model parameter

Implements CDistribution.

Definition at line 143 of file Histogram.cpp.

virtual const char* get_name ( ) const
virtual
Returns
object name

Implements CSGObject.

Definition at line 92 of file Histogram.h.

virtual int32_t get_num_model_parameters ( )
virtual

get number of model parameters

Returns
number of model parameters

Implements CDistribution.

Definition at line 53 of file Histogram.h.

bool set_histogram ( SGVector< float64_t histogram)
virtual

set histogram

Parameters
histogramnew histogram

Definition at line 148 of file Histogram.cpp.

bool train ( CFeatures data = NULL)
virtual

learn distribution

Parameters
datatraining data (parameter can be avoided if distance or kernel-based classifiers are used and distance/kernels are initialized with train data)
Returns
whether training was successful

Implements CDistribution.

Definition at line 38 of file Histogram.cpp.

Member Data Documentation

float64_t* hist
protected

histogram

Definition at line 96 of file Histogram.h.


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

SHOGUN Machine Learning Toolbox - Documentation