Detailed Description

template<class ST>
class shogun::CSparseDistance< ST >

template class SparseDistance

Definition at line 22 of file SparseDistance.h.

Inheritance diagram for CSparseDistance< ST >:

Public Member Functions
	CSparseDistance ()

virtual bool	init (CFeatures l, CFeatures r)

virtual EFeatureClass	get_feature_class ()

virtual EFeatureType	get_feature_type ()

virtual const char *	get_name () const

virtual void	cleanup ()=0

virtual EDistanceType	get_distance_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 ()

virtual float64_t	distance (int32_t idx_a, int32_t idx_b)

virtual float64_t	distance_upper_bounded (int32_t idx_a, int32_t idx_b, float64_t upper_bound)

virtual void	precompute_rhs ()

virtual void	precompute_lhs ()

virtual void	reset_precompute ()

SGMatrix< float64_t >	get_distance_matrix ()

template<class T >
SGMatrix< T >	get_distance_matrix ()

int32_t	compute_row_start (int64_t offs, int32_t n, bool symmetric)

void	load (CFile *loader)

void	save (CFile *writer)

CFeatures *	get_lhs ()

CFeatures *	get_rhs ()

virtual CFeatures *	replace_rhs (CFeatures *rhs)

virtual CFeatures *	replace_lhs (CFeatures *lhs)

virtual void	remove_lhs_and_rhs ()

virtual void	remove_lhs ()
	takes all necessary steps if the lhs is removed from distance matrix More...

virtual void	remove_rhs ()
	takes all necessary steps if the rhs is removed from distance matrix More...

bool	get_precompute_matrix ()

virtual void	set_precompute_matrix (bool flag)

virtual int32_t	get_num_vec_lhs ()

virtual int32_t	get_num_vec_rhs ()

virtual bool	has_features ()

bool	lhs_equals_rhs ()

virtual CSGObject *	shallow_copy () const

virtual CSGObject *	deep_copy () const

virtual bool	is_generic (EPrimitiveType *generic) const

template<class T >
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 ()

template<>
void	set_generic ()

template<>
void	set_generic ()

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

SGStringList< char >	get_modelsel_names ()

void	print_modsel_params ()

char *	get_modsel_param_descr (const char *param_name)

index_t	get_modsel_param_index (const char *param_name)

void	build_gradient_parameter_dictionary (CMap< TParameter , CSGObject > *dict)

bool	has (const std::string &name) const

template<typename T >
bool	has (const Tag< T > &tag) const

template<typename T , typename U = void>
bool	has (const std::string &name) const

template<typename T >
void	set (const Tag< T > &_tag, const T &value)

template<typename T , typename U = void>
void	set (const std::string &name, const T &value)

template<typename T >
T	get (const Tag< T > &_tag) const

template<typename T , typename U = void>
T	get (const std::string &name) const

virtual void	update_parameter_hash ()

virtual bool	parameter_hash_changed ()

virtual bool	equals (CSGObject *other, float64_t accuracy=0.0, bool tolerant=false)

virtual CSGObject *	clone ()

Static Public Member Functions
template<class T >
static void *	get_distance_matrix_helper (void *p)

Public Attributes
SGIO *	io

Parallel *	parallel

Version *	version

Parameter *	m_parameters

Parameter *	m_model_selection_parameters

Parameter *	m_gradient_parameters

uint32_t	m_hash

Protected Member Functions
virtual float64_t	compute (int32_t idx_a, int32_t idx_b)=0

void	do_precompute_matrix ()
	matrix precomputation More...

virtual bool	check_compatibility (CFeatures l, CFeatures r)

virtual void	load_serializable_pre () throw (ShogunException)

virtual void	load_serializable_post () throw (ShogunException)

virtual void	save_serializable_pre () throw (ShogunException)

virtual void	save_serializable_post () throw (ShogunException)

template<typename T >
void	register_param (Tag< T > &_tag, const T &value)

template<typename T >
void	register_param (const std::string &name, const T &value)

Static Protected Member Functions
static void *	run_distance_thread (void *p)
	run distance thread More...

Protected Attributes
float32_t *	precomputed_matrix

bool	precompute_matrix

CFeatures *	lhs
	feature vectors to occur on the left hand side More...

CFeatures *	rhs
	feature vectors to occur on the right hand side More...

int32_t	num_lhs

int32_t	num_rhs

Constructor & Destructor Documentation

CSparseDistance ( )

default constructor

Definition at line 26 of file SparseDistance.h.

Member Function Documentation

void build_gradient_parameter_dictionary ( CMap< TParameter *, CSGObject * > * dict )

inherited

Builds a dictionary of all parameters in SGObject as well of those of SGObjects that are parameters of this object. Dictionary maps parameters to the objects that own them.

Parameters

dict	dictionary of parameters to be built.

Definition at line 630 of file SGObject.cpp.

bool check_compatibility	(	CFeatures *	l,
		CFeatures *	r
	)

protectedvirtualinherited

Checks the compatibility between two supplied features

Parameters

l	left hand side features
r	right hand side features

Returns: true if the features are compatible

Definition at line 101 of file Distance.cpp.

virtual void cleanup ( )

pure virtual

cleanup distance

abstract base method

Implements CDistance.

Implemented in CSparseEuclideanDistance.

CSGObject * clone ( )

virtualinherited

Creates a clone of the current object. This is done via recursively traversing all parameters, which corresponds to a deep copy. Calling equals on the cloned object always returns true although none of the memory of both objects overlaps.

Returns: an identical copy of the given object, which is disjoint in memory. NULL if the clone fails. Note that the returned object is SG_REF'ed

Definition at line 747 of file SGObject.cpp.

virtual float64_t compute	(	int32_t	idx_a,
		int32_t	idx_b
	)

protectedpure virtualinherited

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

Implemented in CCustomDistance, CEuclideanDistance, CMahalanobisDistance, CKernelDistance, CAttenuatedEuclideanDistance, CMinkowskiMetric, CCanberraMetric, CCosineDistance, CManhattanMetric, CGeodesicMetric, CJensenMetric, CTanimotoDistance, CChiSquareDistance, CHammingWordDistance, CRealDistance, CBrayCurtisDistance, CChebyshewMetric, CSparseEuclideanDistance, CCustomMahalanobisDistance, CCanberraWordDistance, and CManhattanWordDistance.

int32_t compute_row_start	(	int64_t	offs,
		int32_t	n,
		bool	symmetric
	)

inherited

compute row start offset for parallel kernel matrix computation

Parameters

offs	offset
n	number of columns
symmetric	whether matrix is symmetric

Definition at line 173 of file Distance.h.

CSGObject * deep_copy ( ) const

virtualinherited

A deep copy. All the instance variables will also be copied.

Definition at line 231 of file SGObject.cpp.

float64_t distance	(	int32_t	idx_a,
		int32_t	idx_b
	)

virtualinherited

get distance function for lhs feature vector a and rhs feature vector b

Parameters

idx_a	feature vector a at idx_a
idx_b	feature vector b at idx_b

Returns: distance value

Definition at line 206 of file Distance.cpp.

virtual float64_t distance_upper_bounded	(	int32_t	idx_a,
		int32_t	idx_b,
		float64_t	upper_bound
	)

virtualinherited

get distance function for lhs feature vector a and rhs feature vector b. The computation of the distance stops if the intermediate result is larger than upper_bound. This is useful to use with John Langford's Cover Tree and it is ONLY implemented for Euclidean distance

Parameters

idx_a	feature vector a at idx_a
idx_b	feature vector b at idx_b
upper_bound	value above which the computation halts

Returns: distance value or upper_bound

Reimplemented in CEuclideanDistance.

Definition at line 124 of file Distance.h.

void do_precompute_matrix ( )

protectedinherited

matrix precomputation

Definition at line 244 of file Distance.cpp.

bool equals	(	CSGObject *	other,
		float64_t	accuracy = `0.0`,
		bool	tolerant = `false`
	)

virtualinherited

Recursively compares the current SGObject to another one. Compares all registered numerical parameters, recursion upon complex (SGObject) parameters. Does not compare pointers!

May be overwritten but please do with care! Should not be necessary in most cases.

Parameters

other	object to compare with
accuracy	accuracy to use for comparison (optional)
tolerant	allows linient check on float equality (within accuracy)

Returns: true if all parameters were equal, false if not

Definition at line 651 of file SGObject.cpp.

T get ( const Tag< T > & _tag ) const

inherited

Getter for a class parameter, identified by a Tag. Throws an exception if the class does not have such a parameter.

Parameters

_tag	name and type information of parameter

Returns: value of the parameter identified by the input tag

Definition at line 367 of file SGObject.h.

T get ( const std::string & name ) const

inherited

Getter for a class parameter, identified by a name. Throws an exception if the class does not have such a parameter.

Parameters

name	name of the parameter

Returns: value of the parameter corresponding to the input name and type

Definition at line 388 of file SGObject.h.

template SGMatrix< float32_t > get_distance_matrix< float32_t > ( )

inherited

get distance matrix

Returns: computed distance matrix (needs to be cleaned up)

Definition at line 156 of file Distance.h.

SGMatrix< T > get_distance_matrix ( )

inherited

get distance matrix (templated)

Returns: the distance matrix

Definition at line 334 of file Distance.cpp.

template void * get_distance_matrix_helper< float32_t > ( void * p )

staticinherited

helper for computing the kernel matrix in a parallel way

Parameters

p	thread parameters

Definition at line 283 of file Distance.cpp.

virtual EDistanceType get_distance_type ( )

pure virtual

get distance type we are

abstrace base method

Returns: distance type

Implements CDistance.

Implemented in CSparseEuclideanDistance.

virtual EFeatureClass get_feature_class ( )

virtual

get feature class the distance can deal with

Returns: feature class SPARSE

Implements CDistance.

Definition at line 55 of file SparseDistance.h.

virtual EFeatureType get_feature_type ( )

virtual

get feature type the distance can deal with

Returns: template-specific feature type

Implements CDistance.

Reimplemented in CSparseEuclideanDistance.