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

Detailed Description

Computes the standard linear kernel on CDotFeatures.

Formally, it computes

\[ k({\bf x},{\bf x'})= {\bf x}\cdot {\bf x'} \]

Definition at line 33 of file LinearKernel.h.

Inheritance diagram for CLinearKernel:
Inheritance graph
[legend]

Public Member Functions

 CLinearKernel ()
 
 CLinearKernel (CDotFeatures *l, CDotFeatures *r)
 
virtual ~CLinearKernel ()
 
virtual bool init (CFeatures *l, CFeatures *r)
 
virtual void cleanup ()
 
virtual EKernelType get_kernel_type ()
 
virtual const char * get_name () const
 
virtual bool init_optimization (int32_t num_suppvec, int32_t *sv_idx, float64_t *alphas)
 
virtual bool init_optimization (CKernelMachine *km)
 
virtual bool delete_optimization ()
 
virtual float64_t compute_optimized (int32_t idx)
 
virtual void clear_normal ()
 
virtual void add_to_normal (int32_t idx, float64_t weight)
 
const float64_t * get_normal (int32_t &len)
 
void get_w (float64_t **dst_w, int32_t *dst_dims)
 
void set_w (float64_t *src_w, int32_t src_w_dim)
 
- 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_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)
 
EOptimizationType get_optimization_type ()
 
virtual void set_optimization_type (EOptimizationType t)
 
bool get_is_initialized ()
 
bool init_optimization_svm (CSVM *svm)
 
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 Attributes

float64_t * normal
 
int32_t normal_length
 
- 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
 
- Protected Member Functions inherited from CDotKernel
virtual float64_t compute (int32_t idx_a, int32_t idx_b)
 
- 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 load_serializable_post () throw (ShogunException)
 
virtual void save_serializable_pre () throw (ShogunException)
 
virtual void save_serializable_post () throw (ShogunException)
 
virtual void register_params ()
 
- Protected Member Functions inherited from CSGObject
virtual void load_serializable_pre () throw (ShogunException)
 
- Static Protected Member Functions inherited from CKernel
template<class T >
static void * get_kernel_matrix_helper (void *p)
 

Constructor & Destructor Documentation

CLinearKernel ( )

constructor

Definition at line 20 of file LinearKernel.cpp.

CLinearKernel ( CDotFeatures *  l,
CDotFeatures *  r 
)

constructor

Parameters
lfeatures of left-hand side
rfeatures of right-hand side

Definition at line 26 of file LinearKernel.cpp.

~CLinearKernel ( )
virtual

Definition at line 33 of file LinearKernel.cpp.

Member Function Documentation

void add_to_normal ( int32_t  idx,
float64_t  weight 
)
virtual

add to normal vector

Parameters
idxwhere to add
weightwhat to add

Reimplemented from CKernel.

Definition at line 66 of file LinearKernel.cpp.

void cleanup ( )
virtual

clean up kernel

Reimplemented from CKernel.

Definition at line 45 of file LinearKernel.cpp.

void clear_normal ( )
virtual

clear normal vector

Reimplemented from CKernel.

Definition at line 52 of file LinearKernel.cpp.

float64_t compute_optimized ( int32_t  idx)
virtual

compute optimized

Parameters
idxindex to compute
Returns
optimized value at given index

Reimplemented from CKernel.

Definition at line 108 of file LinearKernel.cpp.

bool delete_optimization ( )
virtual

delete optimization

Returns
if deleting was successful

Reimplemented from CKernel.

Definition at line 98 of file LinearKernel.cpp.

virtual EKernelType get_kernel_type ( )
virtual

return what type of kernel we are

Returns
kernel type LINEAR

Implements CDotKernel.

Definition at line 64 of file LinearKernel.h.

virtual const char* get_name ( ) const
virtual

return the kernel's name

Returns
name Lineaer

Reimplemented from CDotKernel.

Definition at line 70 of file LinearKernel.h.

const float64_t* get_normal ( int32_t &  len)

get normal

Parameters
lenwhere length of normal vector will be stored
Returns
normal vector

Definition at line 116 of file LinearKernel.h.

void get_w ( float64_t **  dst_w,
int32_t *  dst_dims 
)

get normal vector (swig compatible)

Parameters
dst_wstore w in this argument
dst_dimsdimension of w

Definition at line 135 of file LinearKernel.h.

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

initialize kernel

Parameters
lfeatures of left-hand side
rfeatures of right-hand side
Returns
if initializing was successful

Reimplemented from CDotKernel.

Definition at line 38 of file LinearKernel.cpp.

bool init_optimization ( int32_t  num_suppvec,
int32_t *  sv_idx,
float64_t *  alphas 
)
virtual

optimizable kernel, i.e. precompute normal vector and as phi(x) = x do scalar product in input space

Parameters
num_suppvecnumber of support vectors
sv_idxsupport vector index
alphasalphas
Returns
if optimization was successful

Reimplemented from CKernel.

Definition at line 73 of file LinearKernel.cpp.

bool init_optimization ( CKernelMachine *  km)
virtual

init optimization

Parameters
km

Definition at line 85 of file LinearKernel.cpp.

void set_w ( float64_t *  src_w,
int32_t  src_w_dim 
)

set normal vector (swig compatible)

Parameters
src_wnew w
src_w_dimdimension of new w - must fit dim of lhs

Definition at line 151 of file LinearKernel.h.

Member Data Documentation

float64_t* normal
protected

normal vector (used in case of optimized kernel)

Definition at line 160 of file LinearKernel.h.

int32_t normal_length
protected

length of normal vector

Definition at line 162 of file LinearKernel.h.

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