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

Detailed Description

Pyramid Kernel over Chi2 matched histograms.

Definition at line 28 of file PyramidChi2.h.

Inheritance diagram for CPyramidChi2:
Inheritance graph
[legend]

Public Member Functions

 CPyramidChi2 ()
 CPyramidChi2 (int32_t size, int32_t num_cells2, float64_t *weights_foreach_cell2, int32_t width_computation_type2, float64_t width2)
 CPyramidChi2 (CSimpleFeatures< float64_t > *l, CSimpleFeatures< float64_t > *r, int32_t size, int32_t num_cells2, float64_t *weights_foreach_cell2, int32_t width_computation_type2, float64_t width2)
virtual bool init (CFeatures *l, CFeatures *r)
virtual ~CPyramidChi2 ()
virtual void cleanup ()
virtual EKernelType get_kernel_type ()
virtual const char * get_name () const
virtual void setparams_pychi2 (int32_t num_cells2, float64_t *weights_foreach_cell2, int32_t width_computation_type2, float64_t width2)
- Public Member Functions inherited from CDotKernel
 CDotKernel ()
 CDotKernel (int32_t cachesize)
 CDotKernel (CFeatures *l, CFeatures *r)
virtual EFeatureClass get_feature_class ()
virtual EFeatureType get_feature_type ()
- Public Member Functions inherited from CKernel
 CKernel ()
 CKernel (int32_t size)
 CKernel (CFeatures *l, CFeatures *r, int32_t size)
virtual ~CKernel ()
float64_t kernel (int32_t idx_a, int32_t idx_b)
SGMatrix< float64_tget_kernel_matrix ()
virtual SGVector< float64_tget_kernel_col (int32_t j)
virtual SGVector< float64_tget_kernel_row (int32_t i)
template<class T >
SGMatrix< T > get_kernel_matrix ()
virtual bool set_normalizer (CKernelNormalizer *normalizer)
virtual CKernelNormalizerget_normalizer ()
virtual bool init_normalizer ()
void load (CFile *loader)
void save (CFile *writer)
CFeaturesget_lhs ()
CFeaturesget_rhs ()
virtual int32_t get_num_vec_lhs ()
virtual int32_t get_num_vec_rhs ()
virtual bool has_features ()
bool get_lhs_equals_rhs ()
virtual void remove_lhs_and_rhs ()
virtual void remove_lhs ()
virtual void remove_rhs ()
 takes all necessary steps if the rhs is removed from kernel
void set_cache_size (int32_t size)
int32_t get_cache_size ()
void list_kernel ()
bool has_property (EKernelProperty p)
virtual void clear_normal ()
virtual void add_to_normal (int32_t vector_idx, float64_t weight)
EOptimizationType get_optimization_type ()
virtual void set_optimization_type (EOptimizationType t)
bool get_is_initialized ()
virtual bool init_optimization (int32_t count, int32_t *IDX, float64_t *weights)
virtual bool delete_optimization ()
bool init_optimization_svm (CSVM *svm)
virtual float64_t compute_optimized (int32_t vector_idx)
virtual void compute_batch (int32_t num_vec, int32_t *vec_idx, float64_t *target, int32_t num_suppvec, int32_t *IDX, float64_t *alphas, float64_t factor=1.0)
float64_t get_combined_kernel_weight ()
void set_combined_kernel_weight (float64_t nw)
virtual int32_t get_num_subkernels ()
virtual void compute_by_subkernel (int32_t vector_idx, float64_t *subkernel_contrib)
virtual const float64_tget_subkernel_weights (int32_t &num_weights)
virtual void set_subkernel_weights (SGVector< float64_t > weights)
- 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 Member Functions

virtual float64_t compute (int32_t idx_a, int32_t idx_b)

Protected Attributes

int32_t num_cells
float64_tweights
int32_t width_computation_type
float64_t width
int32_t num_randfeats_forwidthcomputation

Additional Inherited Members

- Public Attributes inherited from CSGObject
SGIOio
Parallelparallel
Versionversion
Parameterm_parameters
Parameterm_model_selection_parameters
- Static Protected Member Functions inherited from CKernel
template<class T >
static void * get_kernel_matrix_helper (void *p)

Constructor & Destructor Documentation

default constructor protected to avoid its usage

Definition at line 21 of file PyramidChi2.cpp.

CPyramidChi2 ( int32_t  size,
int32_t  num_cells2,
float64_t weights_foreach_cell2,
int32_t  width_computation_type2,
float64_t  width2 
)

constructor

Parameters
sizecache size in MB
num_cells2- the number of pyramid cells
weights_foreach_cell2the vector of weights for each cell with which the Chi2 distance gets weighted
width_computation_type2- 0 use the following parameter as fixed width, 1- use mean of inner distances in cases 1 and 2 the value of parameter width is still important, see parameter width2
width2- in case of width_computation_type ==0 it is the width, in case of width_computation_type > 0 its value determines the how many random features are used for determining the width in case of width_computation_type > 0 set width2 <=1 to use all LEFT HAND SIDE features for width estimation

Definition at line 31 of file PyramidChi2.cpp.

CPyramidChi2 ( CSimpleFeatures< float64_t > *  l,
CSimpleFeatures< float64_t > *  r,
int32_t  size,
int32_t  num_cells2,
float64_t weights_foreach_cell2,
int32_t  width_computation_type2,
float64_t  width2 
)

constructor

Parameters
lfeatures lhs convention: concatenated features along all cells, i.e. [feature for cell1, feature for cell2, ... feature for last cell] , the dimensionality of the base feature is equal to dividing the total feature length by the number ofcells
rfeatures rhs the same convention as for param l applies here
sizecache size
num_cells2- the number of pyramid cells
weights_foreach_cell2the vector of weights for each cell with which the Chi2 distance gets weighted
width_computation_type2- 0 use the following parameter as fixed width, 1- use mean of inner distances in case 1 the value of parameter width is important!!!
width2- in case of width_computation_type ==0 it is the width, in case of width_computation_type > 0 its value determines the how many random features are used for determining the width in case of width_computation_type > 0 set width2 <=1 to use all LEFT HAND SIDE features for width estimation

Definition at line 83 of file PyramidChi2.cpp.

~CPyramidChi2 ( )
virtual

Definition at line 115 of file PyramidChi2.cpp.

Member Function Documentation

void cleanup ( )
virtual

cleanup

Reimplemented from CKernel.

Definition at line 62 of file PyramidChi2.cpp.

float64_t compute ( int32_t  idx_a,
int32_t  idx_b 
)
protectedvirtual

compute kernel function for features a and b

Parameters
idx_aindex of feature vector a
idx_bindex of feature vector b
Returns
computed kernel function

Reimplemented from CDotKernel.

Definition at line 122 of file PyramidChi2.cpp.

virtual EKernelType get_kernel_type ( )
virtual

return what type of kernel we are Linear,Polynomial, Gaussian,...

Implements CDotKernel.

Definition at line 92 of file PyramidChi2.h.

virtual const char* get_name ( ) const
virtual

return the name of a kernel

Reimplemented from CDotKernel.

Definition at line 98 of file PyramidChi2.h.

bool init ( CFeatures l,
CFeatures r 
)
virtual

init

Parameters
lfeatures lhs
rreatures rhs

Reimplemented from CDotKernel.

Definition at line 77 of file PyramidChi2.cpp.

void setparams_pychi2 ( int32_t  num_cells2,
float64_t weights_foreach_cell2,
int32_t  width_computation_type2,
float64_t  width2 
)
virtual

sets parameters, see also constructor

Parameters
num_cells2- the number of pyramid cells
weights_foreach_cell2the vector of weights for each cell with which the Chi2 distance gets weighted
width_computation_type2- 0 use the following parameter as fixed width, 1- use mean of inner distances in cases 1 and 2 the value of parameter width is still important, see parameter width2
width2- in case of width_computation_type ==0 it is the width, in case of width_computation_type > 0 its value determines the how many random features are used for determining the width in case of width_computation_type > 0 set width2 <=1 to use all LEFT HAND SIDE features for width estimation

Definition at line 242 of file PyramidChi2.cpp.

Member Data Documentation

int32_t num_cells
protected

number of pyramidcells across all pyramidlevel

Definition at line 131 of file PyramidChi2.h.

int32_t num_randfeats_forwidthcomputation
protected

in case of adaptive width computation: how many features to use

Definition at line 141 of file PyramidChi2.h.

float64_t* weights
protected

vector of weights for each pyramid cell

Definition at line 134 of file PyramidChi2.h.

float64_t width
protected

width

Definition at line 139 of file PyramidChi2.h.

int32_t width_computation_type
protected

width_computation_type

Definition at line 137 of file PyramidChi2.h.


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

SHOGUN Machine Learning Toolbox - Documentation