CSparseKernel< ST > Class Template Reference

Detailed Description

template<class ST>
class shogun::CSparseKernel< ST >

Template class SparseKernel, is the base class of kernels working on sparse features.

See e.g. the CSparseGaussianKernel for an example.

Definition at line 24 of file SparseKernel.h.

Inheritance diagram for CSparseKernel< ST >:

Public Member Functions
	CSparseKernel (int32_t cachesize)
	CSparseKernel (CFeatures *l, CFeatures *r)
virtual bool	init (CFeatures *l, CFeatures *r)
virtual EFeatureClass	get_feature_class ()
virtual EFeatureType	get_feature_type ()
virtual const char *	get_name () const
virtual EKernelType	get_kernel_type ()=0
template<>
EFeatureType	get_feature_type ()
template<>
EFeatureType	get_feature_type ()
template<>
EFeatureType	get_feature_type ()
template<>
EFeatureType	get_feature_type ()
template<>
EFeatureType	get_feature_type ()
template<>
EFeatureType	get_feature_type ()
template<>
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 ()
virtual void	cleanup ()
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
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)

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 CKernel
void	set_property (EKernelProperty p)
void	unset_property (EKernelProperty p)
void	set_is_initialized (bool p_init)
virtual float64_t	compute (int32_t x, int32_t y)=0
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 ()
Static Protected Member Functions inherited from CKernel
template<class T >
static void *	get_kernel_matrix_helper (void *p)
Protected Attributes inherited from CKernel
int32_t	cache_size
	cache_size in MB
KERNELCACHE_ELEM *	kernel_matrix
CFeatures *	lhs
	feature vectors to occur on left hand side
CFeatures *	rhs
	feature vectors to occur on right hand side
bool	lhs_equals_rhs
	lhs
int32_t	num_lhs
	number of feature vectors on left hand side
int32_t	num_rhs
	number of feature vectors on right hand side
float64_t	combined_kernel_weight
bool	optimization_initialized
EOptimizationType	opt_type
uint64_t	properties
CKernelNormalizer *	normalizer

Constructor & Destructor Documentation

CSparseKernel

(

int32_t

cachesize

)

constructor

Parameters

cachesize

cache size

Definition at line 31 of file SparseKernel.h.

CSparseKernel	(	CFeatures *	l,
		CFeatures *	r
	)

constructor

Parameters

l	features for left-hand side
r	features for right-hand side

Definition at line 38 of file SparseKernel.h.

Member Function Documentation

virtual EFeatureClass get_feature_class ( )

virtual

return feature class the kernel can deal with

Returns

feature class SPARSE

Implements CKernel.

Definition at line 70 of file SparseKernel.h.

virtual EFeatureType get_feature_type ( )

virtual

return feature type the kernel can deal with

Returns

templated feature type

Implements CKernel.

EFeatureType get_feature_type ( )

virtual

return feature type the kernel can deal with

abstract base method

Returns

feature type

Implements CKernel.

Definition at line 96 of file SparseKernel.h.

EFeatureType get_feature_type ( )

virtual

return feature type the kernel can deal with

abstract base method

Returns

feature type

Implements CKernel.

Definition at line 98 of file SparseKernel.h.

EFeatureType get_feature_type ( )

virtual

return feature type the kernel can deal with

abstract base method

Returns

feature type

Implements CKernel.

Definition at line 100 of file SparseKernel.h.

EFeatureType get_feature_type ( )

virtual

return feature type the kernel can deal with

abstract base method

Returns

feature type

Implements CKernel.

Definition at line 102 of file SparseKernel.h.

EFeatureType get_feature_type ( )

virtual

return feature type the kernel can deal with

abstract base method

Returns

feature type

Implements CKernel.

Definition at line 104 of file SparseKernel.h.

EFeatureType get_feature_type ( )

virtual

return feature type the kernel can deal with

abstract base method

Returns

feature type

Implements CKernel.

Definition at line 106 of file SparseKernel.h.

EFeatureType get_feature_type ( )

virtual

return feature type the kernel can deal with

abstract base method

Returns

feature type

Implements CKernel.

Definition at line 108 of file SparseKernel.h.

virtual EKernelType get_kernel_type ( )

pure virtual

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

abstract base method

Returns

kernel type

Implements CKernel.

virtual const char* get_name ( ) const

virtual

Returns the name of the SGSerializable instance. It MUST BE the CLASS NAME without the prefixed `C'.

Returns

name of the SGSerializable

Implements CSGObject.

Definition at line 83 of file SparseKernel.h.

virtual 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 49 of file SparseKernel.h.

---

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

• SparseKernel.h