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
CANOVAKernel Class Reference

Detailed Description

ANOVA (ANalysis Of VAriances) kernel.

Formally described as

\[ K_d(x,z) = \sum_{1\le i_1<i_2<\dots<i_d\le n} \prod_{j=1}^d x_{i_j} z_{i_j} \]

with d(cardinality)=1 by default this function is computed recusively

Definition at line 37 of file ANOVAKernel.h.

Inheritance diagram for CANOVAKernel:
Inheritance graph
[legend]

Public Member Functions

 CANOVAKernel ()
 
 CANOVAKernel (int32_t cache, int32_t d)
 
 CANOVAKernel (CSimpleFeatures< float64_t > *l, CSimpleFeatures< float64_t > *r, int32_t d, int32_t cache)
 
virtual ~CANOVAKernel ()
 
virtual bool init (CFeatures *l, CFeatures *r)
 
virtual EKernelType get_kernel_type ()
 
virtual EFeatureType get_feature_type ()
 
virtual EFeatureClass get_feature_class ()
 
virtual const char * get_name () const
 
int32_t get_cardinality ()
 
void set_cardinality (int32_t value)
 
float64_t compute_rec1 (int32_t idx_a, int32_t idx_b)
 
float64_t compute_rec2 (int32_t idx_a, int32_t idx_b)
 
- Public Member Functions inherited from CDotKernel
 CDotKernel ()
 
 CDotKernel (int32_t cachesize)
 
 CDotKernel (CFeatures *l, CFeatures *r)
 
- 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_t > get_kernel_matrix ()
 
virtual SGVector< float64_t > get_kernel_col (int32_t j)
 
virtual SGVector< float64_t > get_kernel_row (int32_t i)
 
template<class T >
SGMatrix< T > get_kernel_matrix ()
 
virtual bool set_normalizer (CKernelNormalizer *normalizer)
 
virtual CKernelNormalizer * get_normalizer ()
 
virtual bool init_normalizer ()
 
void load (CFile *loader)
 
void save (CFile *writer)
 
CFeatures * get_lhs ()
 
CFeatures * get_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 More...
 
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_t * get_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)
 
SGIO * get_global_io ()
 
void set_global_parallel (Parallel *parallel)
 
Parallel * get_global_parallel ()
 
void set_global_version (Version *version)
 
Version * get_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)
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 

Protected Member Functions

virtual float64_t compute (int32_t idx_a, int32_t idx_b)
 
void init ()
 
void allocate_arrays ()
 
virtual void cleanup ()
 
void register_params ()
 
virtual void load_serializable_post () throw (ShogunException)
 
- Protected Member Functions inherited from CKernel
void set_property (EKernelProperty p)
 
void unset_property (EKernelProperty p)
 
void set_is_initialized (bool p_init)
 
int32_t compute_row_start (int64_t offs, int32_t n, bool symmetric)
 
virtual void save_serializable_pre () throw (ShogunException)
 
virtual void save_serializable_post () throw (ShogunException)
 
- Protected Member Functions inherited from CSGObject
virtual void load_serializable_pre () throw (ShogunException)
 

Protected Attributes

int32_t cardinality
 degree parameter of kernel More...
 
float64_t * DP
 array for compute_recursive1 More...
 
int32_t DP_len
 length of DP More...
 
float64_t * KD
 arrays for compute_recursive2 More...
 
float64_t * KS
 KS. More...
 
float64_t * vec_pow
 vec pow More...
 
- Protected Attributes inherited from CKernel
int32_t cache_size
 cache_size in MB More...
 
KERNELCACHE_ELEM * kernel_matrix
 
CFeatures * lhs
 feature vectors to occur on left hand side More...
 
CFeatures * rhs
 feature vectors to occur on right hand side More...
 
bool lhs_equals_rhs
 lhs More...
 
int32_t num_lhs
 number of feature vectors on left hand side More...
 
int32_t num_rhs
 number of feature vectors on right hand side More...
 
float64_t combined_kernel_weight
 
bool optimization_initialized
 
EOptimizationType opt_type
 
uint64_t properties
 
CKernelNormalizer * normalizer
 

Additional Inherited Members

- Public Attributes inherited from CSGObject
SGIO * io
 
Parallel * parallel
 
Version * version
 
Parameter * m_parameters
 
Parameter * m_model_selection_parameters
 
- Static Protected Member Functions inherited from CKernel
template<class T >
static void * get_kernel_matrix_helper (void *p)
 

Constructor & Destructor Documentation

CANOVAKernel ( )

default constructor

Definition at line 17 of file ANOVAKernel.cpp.

CANOVAKernel ( int32_t  cache,
int32_t  d 
)

constructor

Parameters
cachesize of cache
dkernel parameter cardinality

Definition at line 23 of file ANOVAKernel.cpp.

CANOVAKernel ( CSimpleFeatures< float64_t > *  l,
CSimpleFeatures< float64_t > *  r,
int32_t  d,
int32_t  cache 
)

constructor

Parameters
lfeatures left-side
rfeatures right-side
dkernel parameter cardinality
cachecache size

Definition at line 30 of file ANOVAKernel.cpp.

~CANOVAKernel ( )
virtual

Definition at line 39 of file ANOVAKernel.cpp.

Member Function Documentation

void allocate_arrays ( )
protected

allocate arrays

Definition at line 109 of file ANOVAKernel.cpp.

void cleanup ( )
protectedvirtual

clean up kernel

Reimplemented from CKernel.

Definition at line 127 of file ANOVAKernel.cpp.

float64_t compute ( int32_t  idx_a,
int32_t  idx_b 
)
protectedvirtual

compute kernel for specific feature vectors corresponding to [idx_a] of left-side and [idx_b] of right-side

Parameters
idx_aleft-side index
idx_bright-side index
Returns
kernel value

Reimplemented from CDotKernel.

Definition at line 55 of file ANOVAKernel.cpp.

float64_t compute_rec1 ( int32_t  idx_a,
int32_t  idx_b 
)

compute rec 1

Parameters
idx_a
idx_b
Returns
rec1

Definition at line 60 of file ANOVAKernel.cpp.

float64_t compute_rec2 ( int32_t  idx_a,
int32_t  idx_b 
)

computer rec 2

Parameters
idx_a
idx_b
Returns
rec2

Definition at line 79 of file ANOVAKernel.cpp.

int32_t get_cardinality ( )

getter for degree parameter

Returns
kernel parameter cardinality

Definition at line 90 of file ANOVAKernel.h.

virtual EFeatureClass get_feature_class ( )
virtual
Returns
class of features

Reimplemented from CDotKernel.

Definition at line 80 of file ANOVAKernel.h.

virtual EFeatureType get_feature_type ( )
virtual
Returns
type of features

Reimplemented from CDotKernel.

Definition at line 75 of file ANOVAKernel.h.

virtual EKernelType get_kernel_type ( )
virtual
Returns
kernel type

Implements CDotKernel.

Definition at line 70 of file ANOVAKernel.h.

virtual const char* get_name ( ) const
virtual
Returns
name of kernel

Reimplemented from CDotKernel.

Definition at line 85 of file ANOVAKernel.h.

bool init ( CFeatures *  l,
CFeatures *  r 
)
virtual

initialize kernel with features

Parameters
lfeatures left-side
rfeatures right-side
Returns
true if successful

Reimplemented from CDotKernel.

Definition at line 44 of file ANOVAKernel.cpp.

void init ( )
protected

init

array for compute_recursive1

arrays for compute_recursive2

Definition at line 98 of file ANOVAKernel.cpp.

void load_serializable_post ( )
throw (ShogunException
)
protectedvirtual

Can (optionally) be overridden to post-initialize some member variables which are not PARAMETER::ADD'ed. Make sure that at first the overridden method BASE_CLASS::LOAD_SERIALIZABLE_POST is called.

Exceptions
ShogunExceptionWill be thrown if an error occurres.

Reimplemented from CKernel.

Definition at line 143 of file ANOVAKernel.cpp.

void register_params ( )
protectedvirtual

register params

Reimplemented from CKernel.

Definition at line 149 of file ANOVAKernel.cpp.

void set_cardinality ( int32_t  value)

setter for degree parameter

Parameters
valuekernel parameter cardinality

Definition at line 95 of file ANOVAKernel.h.

Member Data Documentation

int32_t cardinality
protected

degree parameter of kernel

Definition at line 148 of file ANOVAKernel.h.

float64_t* DP
protected

array for compute_recursive1

Definition at line 151 of file ANOVAKernel.h.

int32_t DP_len
protected

length of DP

Definition at line 153 of file ANOVAKernel.h.

float64_t* KD
protected

arrays for compute_recursive2

Definition at line 156 of file ANOVAKernel.h.

float64_t* KS
protected

KS.

Definition at line 158 of file ANOVAKernel.h.

float64_t* vec_pow
protected

vec pow

Definition at line 160 of file ANOVAKernel.h.

The documentation for this class was generated from the following files:
SHOGUN Machine Learning Toolbox - Documentation