Public Member Functions | Protected Member Functions | Protected Attributes

CLinearKernel Class Reference


Detailed Description

Computes the standard linear kernel on dense real valued features.

Formally, it computes

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

Definition at line 28 of file LinearKernel.h.

Inheritance diagram for CLinearKernel:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 CLinearKernel ()
 CLinearKernel (CSimpleFeatures< float64_t > *l, CSimpleFeatures< float64_t > *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 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_tget_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)

Protected Member Functions

virtual float64_t compute (int32_t idx_a, int32_t idx_b)

Protected Attributes

float64_tnormal
int32_t normal_length

Constructor & Destructor Documentation

CLinearKernel (  ) 

constructor

Definition at line 19 of file LinearKernel.cpp.

constructor

Parameters:
l features of left-hand side
r features of right-hand side

Definition at line 25 of file LinearKernel.cpp.

~CLinearKernel (  )  [virtual]

Definition at line 32 of file LinearKernel.cpp.


Member Function Documentation

void add_to_normal ( int32_t  idx,
float64_t  weight 
) [virtual]

add to normal vector

Parameters:
idx where to add
weight what to add

Reimplemented from CKernel.

Definition at line 65 of file LinearKernel.cpp.

void cleanup (  )  [virtual]

clean up kernel

Reimplemented from CKernel.

Definition at line 44 of file LinearKernel.cpp.

void clear_normal (  )  [virtual]

clear normal vector

Reimplemented from CKernel.

Definition at line 51 of file LinearKernel.cpp.

float64_t compute ( int32_t  idx_a,
int32_t  idx_b 
) [protected, virtual]

compute kernel function for features a and b idx_{a,b} denote the index of the feature vectors in the corresponding feature object

Parameters:
idx_a index a
idx_b index b
Returns:
computed kernel function at indices a,b

Implements CKernel.

Definition at line 72 of file LinearKernel.cpp.

float64_t compute_optimized ( int32_t  idx  )  [virtual]

compute optimized

Parameters:
idx index to compute
Returns:
optimized value at given index

Reimplemented from CKernel.

Definition at line 114 of file LinearKernel.cpp.

bool delete_optimization (  )  [virtual]

delete optimization

Returns:
if deleting was successful

Reimplemented from CKernel.

Definition at line 104 of file LinearKernel.cpp.

virtual EKernelType get_kernel_type (  )  [virtual]

return what type of kernel we are

Returns:
kernel type LINEAR

Implements CKernel.

Definition at line 59 of file LinearKernel.h.

virtual const char* get_name (  )  const [virtual]

return the kernel's name

Returns:
name Lineaer

Implements CSGObject.

Definition at line 65 of file LinearKernel.h.

const float64_t* get_normal ( int32_t &  len  ) 

get normal

Parameters:
len where length of normal vector will be stored
Returns:
normal vector

Definition at line 106 of file LinearKernel.h.

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

get normal vector (swig compatible)

Parameters:
dst_w store w in this argument
dst_dims dimension of w

Definition at line 125 of file LinearKernel.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 CSimpleKernel< float64_t >.

Definition at line 37 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_suppvec number of support vectors
sv_idx support vector index
alphas alphas
Returns:
if optimization was successful

Reimplemented from CKernel.

Definition at line 92 of file LinearKernel.cpp.

void set_w ( float64_t src_w,
int32_t  src_w_dim 
)

set normal vector (swig compatible)

Parameters:
src_w new w
src_w_dim dimension of new w - must fit dim of lhs

Definition at line 141 of file LinearKernel.h.


Member Data Documentation

float64_t* normal [protected]

normal vector (used in case of optimized kernel)

Definition at line 161 of file LinearKernel.h.

int32_t normal_length [protected]

length of normal vector

Definition at line 163 of file LinearKernel.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