Detailed Description

Spherical kernel.

Formally described as

$k(x, y) = 1 - \frac{3}{2} \frac{|x-y|}{\sigma} + \frac{1}{2} \left( \frac{|x-y|}{\sigma} \right)^3 \mbox{if}~ |x-y| \leq \sigma \mbox{, zero otherwise}$

Definition at line 38 of file SphericalKernel.h.

Inheritance diagram for CSphericalKernel:

[legend]

Public Member Functions
	CSphericalKernel ()

	CSphericalKernel (int32_t size, float64_t sigma, CDistance *dist)

	CSphericalKernel (CFeatures l, CFeatures r, float64_t sigma, CDistance *dist)

virtual bool	init (CFeatures l, CFeatures r)

void	init ()

virtual EKernelType	get_kernel_type ()

virtual EFeatureType	get_feature_type ()

virtual EFeatureClass	get_feature_class ()

virtual const char *	get_name () const

virtual void	set_sigma (float64_t s)

virtual float64_t	get_sigma () const

virtual	~CSphericalKernel ()

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 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)

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)

Protected Attributes
CDistance *	distance

float64_t	sigma

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

CSphericalKernel ( )

default constructor

Definition at line 17 of file SphericalKernel.cpp.

CSphericalKernel	(	int32_t	size,
		float64_t	sigma,
		CDistance *	dist
	)

constructor

Parameters

size	cache size
sigma	kernel parameter sigma
dist	distance

Definition at line 23 of file SphericalKernel.cpp.

CSphericalKernel	(	CFeatures *	l,
		CFeatures *	r,
		float64_t	sigma,
		CDistance *	dist
	)

constructor

Parameters

l	features of left-side
r	features of right-side
sigma	kernel parameter sigma
dist	distance

Definition at line 32 of file SphericalKernel.cpp.

~CSphericalKernel ( )

virtual

Definition at line 43 of file SphericalKernel.cpp.

Member Function Documentation

float64_t compute	(	int32_t	idx_a,
		int32_t	idx_b
	)

protectedvirtual

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 63 of file SphericalKernel.cpp.

virtual EFeatureClass get_feature_class ( )

virtual

Returns: class of features

Implements CKernel.

Definition at line 84 of file SphericalKernel.h.

virtual EFeatureType get_feature_type ( )

virtual

Returns: type of features

Implements CKernel.

Definition at line 79 of file SphericalKernel.h.

virtual EKernelType get_kernel_type ( )

virtual

Returns: kernel type

Implements CKernel.

Definition at line 74 of file SphericalKernel.h.

virtual const char* get_name ( ) const

virtual

Returns: name of kernel

Implements CSGObject.

Definition at line 89 of file SphericalKernel.h.

virtual float64_t get_sigma ( ) const

virtual

return the kernel's sigma

Returns: kernel sigma

Definition at line 104 of file SphericalKernel.h.

bool init	(	CFeatures *	l,
		CFeatures *	r
	)

virtual

initialize kernel with features

Parameters

l	features of left-side
r	features of right-side

Returns: true if successful

Reimplemented from CKernel.

Definition at line 49 of file SphericalKernel.cpp.

void init ( )

Definition at line 57 of file SphericalKernel.cpp.

virtual void set_sigma ( float64_t s )

virtual

set the kernel's sigma

Parameters

s	kernel sigma

Definition at line 95 of file SphericalKernel.h.

Member Data Documentation

CDistance* distance

protected

distance

Definition at line 113 of file SphericalKernel.h.

float64_t sigma

protected

width

Definition at line 116 of file SphericalKernel.h.

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

Detailed Description

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation