Public Member Functions | Protected Member Functions | Protected Attributes

CCustomKernel Class Reference


Detailed Description

The Custom Kernel allows for custom user provided kernel matrices.

For squared training matrices it allows to store only the upper triangle of the kernel to save memory: Full symmetric kernel matrices can be stored as is or can be internally converted into (or directly given in) upper triangle representation. Also note that values are stored as 32bit floats.

Definition at line 29 of file CustomKernel.h.

Inheritance diagram for CCustomKernel:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 CCustomKernel ()
 CCustomKernel (CKernel *k)
 CCustomKernel (SGMatrix< float64_t > km)
virtual ~CCustomKernel ()
virtual bool dummy_init (int32_t rows, int32_t cols)
virtual bool init (CFeatures *l, CFeatures *r)
virtual void cleanup ()
virtual EKernelType get_kernel_type ()
virtual EFeatureType get_feature_type ()
virtual EFeatureClass get_feature_class ()
virtual const char * get_name () const
bool set_triangle_kernel_matrix_from_triangle (SGVector< float64_t > tri_kernel_matrix)
template<class T >
bool set_triangle_kernel_matrix_from_triangle_generic (SGVector< T > tri_kernel_matrix)
bool set_triangle_kernel_matrix_from_full (SGMatrix< float64_t > full_kernel_matrix)
template<class T >
bool set_triangle_kernel_matrix_from_full_generic (SGMatrix< T > full_kernel_matrix)
bool set_full_kernel_matrix_from_full (SGMatrix< float32_t > full_kernel_matrix)
bool set_full_kernel_matrix_from_full (SGMatrix< float64_t > full_kernel_matrix)
virtual int32_t get_num_vec_lhs ()
virtual int32_t get_num_vec_rhs ()
virtual bool has_features ()

Protected Member Functions

virtual float64_t compute (int32_t row, int32_t col)

Protected Attributes

SGMatrix< float32_tkmatrix
bool upper_diagonal

Constructor & Destructor Documentation

CCustomKernel (  ) 

default constructor

Definition at line 26 of file CustomKernel.cpp.

CCustomKernel ( CKernel k  ) 

constructor

compute custom kernel from given kernel matrix

Parameters:
k kernel matrix

Definition at line 32 of file CustomKernel.cpp.

CCustomKernel ( SGMatrix< float64_t km  ) 

constructor

sets full kernel matrix from full kernel matrix (from double precision floats)

Parameters:
km kernel matrix

Definition at line 38 of file CustomKernel.cpp.

~CCustomKernel (  )  [virtual]

Definition at line 45 of file CustomKernel.cpp.


Member Function Documentation

void cleanup (  )  [virtual]

clean up kernel

Reimplemented from CKernel.

Definition at line 76 of file CustomKernel.cpp.

virtual float64_t compute ( int32_t  row,
int32_t  col 
) [protected, virtual]

compute kernel function

Parameters:
row row
col col
Returns:
computed kernel function

Implements CKernel.

Definition at line 288 of file CustomKernel.h.

bool dummy_init ( int32_t  rows,
int32_t  cols 
) [virtual]

initialize kernel with dummy features

Kernels always need feature objects assigned. As the custom kernel does not really require this it creates some magic dummy features that only know about the number of vectors

Parameters:
rows features of left-hand side
cols features of right-hand side
Returns:
if initializing was successful

Definition at line 50 of file CustomKernel.cpp.

virtual EFeatureClass get_feature_class (  )  [virtual]

return feature class the kernel can deal with

Returns:
feature class ANY

Implements CKernel.

Definition at line 97 of file CustomKernel.h.

virtual EFeatureType get_feature_type (  )  [virtual]

return feature type the kernel can deal with

Returns:
feature type ANY

Implements CKernel.

Definition at line 91 of file CustomKernel.h.

virtual EKernelType get_kernel_type (  )  [virtual]

return what type of kernel we are

Returns:
kernel type CUSTOM

Implements CKernel.

Definition at line 85 of file CustomKernel.h.

virtual const char* get_name ( void   )  const [virtual]

return the kernel's name

Returns:
name Custom

Implements CSGObject.

Definition at line 103 of file CustomKernel.h.

virtual int32_t get_num_vec_lhs (  )  [virtual]

get number of vectors of lhs features

Returns:
number of vectors of left-hand side

Reimplemented from CKernel.

Definition at line 257 of file CustomKernel.h.

virtual int32_t get_num_vec_rhs (  )  [virtual]

get number of vectors of rhs features

Returns:
number of vectors of right-hand side

Reimplemented from CKernel.

Definition at line 266 of file CustomKernel.h.

virtual bool has_features (  )  [virtual]

test whether features have been assigned to lhs and rhs

Returns:
true if features are assigned

Reimplemented from CKernel.

Definition at line 275 of file CustomKernel.h.

bool init ( CFeatures l,
CFeatures r 
) [virtual]

initialize kernel

Parameters:
l features of left-hand side
r features of right-hand side
Returns:
if initializing was successful

Reimplemented from CKernel.

Definition at line 55 of file CustomKernel.cpp.

bool set_full_kernel_matrix_from_full ( SGMatrix< float64_t full_kernel_matrix  ) 

set full kernel matrix from full kernel matrix

for float64

Returns:
if setting was successful

Definition at line 229 of file CustomKernel.h.

bool set_full_kernel_matrix_from_full ( SGMatrix< float32_t full_kernel_matrix  ) 

set full kernel matrix from full kernel matrix

for float32

Returns:
if setting was successful

Definition at line 212 of file CustomKernel.h.

bool set_triangle_kernel_matrix_from_full ( SGMatrix< float64_t full_kernel_matrix  ) 

set kernel matrix (only elements from upper triangle) from squared matrix

for float64's

Returns:
if setting was successful

Definition at line 166 of file CustomKernel.h.

bool set_triangle_kernel_matrix_from_full_generic ( SGMatrix< T >  full_kernel_matrix  ) 

set kernel matrix (only elements from upper triangle) from squared matrix

Returns:
if setting was successful

Definition at line 178 of file CustomKernel.h.

bool set_triangle_kernel_matrix_from_triangle ( SGVector< float64_t tri_kernel_matrix  ) 

set kernel matrix (only elements from upper triangle) from elements of upper triangle (concat'd), including the main diagonal

small variant for floats64's, triangle needs to have less than 2**32 elements

Parameters:
tri_kernel_matrix tri kernel matrix
Returns:
if setting was successful

Definition at line 114 of file CustomKernel.h.

bool set_triangle_kernel_matrix_from_triangle_generic ( SGVector< T >  tri_kernel_matrix  ) 

set kernel matrix (only elements from upper triangle) from elements of upper triangle (concat'd), including the main diagonal

big variant, allowing the triangle to have more than 2**31-1 elements

Parameters:
tri_kernel_matrix tri kernel matrix
Returns:
if setting was successful

Definition at line 130 of file CustomKernel.h.


Member Data Documentation

SGMatrix<float32_t> kmatrix [protected]

kernel matrix

Definition at line 320 of file CustomKernel.h.

bool upper_diagonal [protected]

upper diagonal

Definition at line 323 of file CustomKernel.h.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

SHOGUN Machine Learning Toolbox - Documentation