详细描述

Class Distance, a base class for all the distances used in the Shogun toolbox.

The distance (or metric) is a function \( d: X \times X \to R \) satisfying (for all \( x,y,z \in X\)) conditions below:

\( d(x,y) \geq 0 \)
\( d(x,y) = 0\) if and only if \( x=y\)
\( d(x,y) = d(y,x) \)
\( d(x,y) \leq d(x,z) + d(z,y) \)

Currently distance inherited from the CDistance class should be symmetric.

The simplest example of a distance function is the Euclidean distance:

参见: CEuclideanDistance

In the means of Shogun toolbox the distance function is defined on the 'space' of CFeatures.

在文件 Distance.h 第 81 行定义.

类 CDistance 继承关系图:

[图例]

Public 成员函数
	CDistance ()

	CDistance (CFeatures lhs, CFeatures rhs)

virtual	~CDistance ()

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)

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)

virtual bool	init (CFeatures lhs, CFeatures rhs)

virtual void	cleanup ()=0

void	load (CFile *loader)

void	save (CFile *writer)

CFeatures *	get_lhs ()

CFeatures *	get_rhs ()

CFeatures *	replace_rhs (CFeatures *rhs)

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 更多...

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

virtual EDistanceType	get_distance_type ()=0

virtual EFeatureType	get_feature_type ()=0

virtual EFeatureClass	get_feature_class ()=0

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 const char *	get_name () const =0

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)

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

静态 Public 成员函数
template<class T >
static void *	get_distance_matrix_helper (void *p)

Public 属性
SGIO *	io

Parallel *	parallel

Version *	version

Parameter *	m_parameters

Parameter *	m_model_selection_parameters

Parameter *	m_gradient_parameters

uint32_t	m_hash

Protected 成员函数
virtual float64_t	compute (int32_t idx_a, int32_t idx_b)=0

void	do_precompute_matrix ()
	matrix precomputation 更多...

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)

静态 Protected 成员函数
static void *	run_distance_thread (void *p)
	run distance thread 更多...

Protected 属性
float32_t *	precomputed_matrix

bool	precompute_matrix

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

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

int32_t	num_lhs

int32_t	num_rhs

构造及析构函数说明

CDistance ( )

default constructor

在文件 Distance.cpp 第 58 行定义.

CDistance	(	CFeatures *	lhs,
		CFeatures *	rhs
	)

init distance

参数

lhs	features of left-hand side
rhs	features of right-hand side

返回: if init was successful

在文件 Distance.cpp 第 64 行定义.

~CDistance ( )

virtual

在文件 Distance.cpp 第 70 行定义.

成员函数说明

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.

参数

dict	dictionary of parameters to be built.

在文件 SGObject.cpp 第 597 行定义.

virtual void cleanup ( )

pure virtual

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.

返回: 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

在文件 SGObject.cpp 第 714 行定义.

virtual float64_t compute	(	int32_t	idx_a,
		int32_t	idx_b
	)

protectedpure virtual

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

在 CCustomDistance, CMahalanobisDistance, CEuclideanDistance, CKernelDistance, CAttenuatedEuclideanDistance, CMinkowskiMetric, CCanberraMetric, CCosineDistance, CManhattanMetric, CGeodesicMetric, CJensenMetric, CTanimotoDistance, CChiSquareDistance, CHammingWordDistance, CRealDistance, CBrayCurtisDistance, CChebyshewMetric, CSparseEuclideanDistance, CCustomMahalanobisDistance, CCanberraWordDistance , 以及 CManhattanWordDistance 内被实现.

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

compute row start offset for parallel kernel matrix computation

参数

offs	offset
n	number of columns
symmetric	whether matrix is symmetric

在文件 Distance.h 第 144 行定义.

CSGObject * deep_copy ( ) const

virtualinherited

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

在文件 SGObject.cpp 第 198 行定义.

float64_t distance	(	int32_t	idx_a,
		int32_t	idx_b
	)

virtual

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

参数

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

返回: distance value

在文件 Distance.cpp 第 189 行定义.

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

virtual

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

参数

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

返回: distance value or upper_bound

被 CEuclideanDistance 重载.

在文件 Distance.h 第 118 行定义.

void do_precompute_matrix ( )

protected

matrix precomputation

在文件 Distance.cpp 第 227 行定义.

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.

参数

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

返回: true if all parameters were equal, false if not

在文件 SGObject.cpp 第 618 行定义.

template SGMatrix< float32_t > get_distance_matrix< float32_t > ( )

get distance matrix

返回: computed distance matrix (needs to be cleaned up)

在文件 Distance.h 第 127 行定义.

SGMatrix< T > get_distance_matrix ( )

get distance matrix (templated)

返回: the distance matrix

在文件 Distance.cpp 第 317 行定义.

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

static

helper for computing the kernel matrix in a parallel way

参数

p	thread parameters

在文件 Distance.cpp 第 266 行定义.

virtual EDistanceType get_distance_type ( )

pure virtual

get distance type we are

abstrace base method

返回: distance type

在 CCustomDistance, CSparseDistance< ST >, CSparseDistance< float64_t >, CMahalanobisDistance, CStringDistance< ST >, CStringDistance< uint16_t >, CMinkowskiMetric, CEuclideanDistance, CKernelDistance, CAttenuatedEuclideanDistance, CRealDistance, CCanberraMetric, CCosineDistance, CManhattanMetric, CGeodesicMetric, CJensenMetric, CTanimotoDistance, CDenseDistance< ST >, CDenseDistance< float64_t >, CChiSquareDistance, CHammingWordDistance, CBrayCurtisDistance, CChebyshewMetric, CCustomMahalanobisDistance, CCanberraWordDistance, CManhattanWordDistance , 以及 CSparseEuclideanDistance 内被实现.

virtual EFeatureClass get_feature_class ( )

pure virtual

get feature class the distance can deal with

abstract base method

返回: feature class

在 CCustomDistance, CKernelDistance, CSparseDistance< ST >, CSparseDistance< float64_t >, CStringDistance< ST >, CStringDistance< uint16_t >, CDenseDistance< ST > , 以及 CDenseDistance< float64_t > 内被实现.

virtual EFeatureType get_feature_type ( )

pure virtual

get feature type the distance can deal with

abstrace base method

返回: feature type

在 CSparseDistance< ST >, CStringDistance< ST >, CSparseDistance< ST >, CStringDistance< ST >, CSparseDistance< ST >, CStringDistance< ST >, CCustomDistance, CSparseDistance< ST >, CStringDistance< ST >, CSparseDistance< ST >, CStringDistance< ST >, CSparseDistance< ST >, CStringDistance< ST >, CSparseDistance< ST >, CMahalanobisDistance, CStringDistance< ST >, CEuclideanDistance, CKernelDistance, CAttenuatedEuclideanDistance, CDenseDistance< ST >, CSparseDistance< ST >, CSparseDistance< float64_t >, CSparseEuclideanDistance, CStringDistance< ST >, CStringDistance< uint16_t >, CDenseDistance< ST >, CDenseDistance< ST >, CDenseDistance< ST >, CRealDistance, CDenseDistance< float64_t >, CDenseDistance< ST >, CDenseDistance< ST >, CDenseDistance< ST > , 以及 CDenseDistance< ST > 内被实现.

SGIO * get_global_io ( )

inherited

get the io object

返回: io object

在文件 SGObject.cpp 第 235 行定义.

Parallel * get_global_parallel ( )

inherited

get the parallel object

返回: parallel object

在文件 SGObject.cpp 第 277 行定义.

Version * get_global_version ( )

inherited

get the version object

返回: version object

在文件 SGObject.cpp 第 290 行定义.

CFeatures* get_lhs ( )

get left-hand side features used in distance matrix

返回: left-hand side features

在文件 Distance.h 第 195 行定义.

SGStringList< char > get_modelsel_names ( )

inherited

返回: vector of names of all parameters which are registered for model selection

在文件 SGObject.cpp 第 498 行定义.

char * get_modsel_param_descr ( const char * param_name )

inherited

Returns description of a given parameter string, if it exists. SG_ERROR otherwise

参数

param_name name of the parameter

返回: description of the parameter

在文件 SGObject.cpp 第 522 行定义.

index_t get_modsel_param_index ( const char * param_name )

inherited

Returns index of model selection parameter with provided index

参数

param_name name of model selection parameter

返回: index of model selection parameter with provided name, -1 if there is no such

在文件 SGObject.cpp 第 535 行定义.

virtual const char* get_name ( ) const

pure virtualinherited

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

返回: name of the SGSerializable

virtual int32_t get_num_vec_lhs ( )

virtual

get number of vectors of lhs features

返回: number of vectors of left-hand side

被 CCustomDistance 重载.

在文件 Distance.h 第 283 行定义.

virtual int32_t get_num_vec_rhs ( )

virtual

get number of vectors of rhs features

返回: number of vectors of right-hand side

被 CCustomDistance 重载.

在文件 Distance.h 第 292 行定义.

bool get_precompute_matrix ( )

FIXME: precompute matrix should be dropped, handling should be via customdistance

返回: if precompute_matrix

在文件 Distance.h 第 261 行定义.

CFeatures* get_rhs ( )

get right-hand side features used in distance matrix

返回: right-hand side features

在文件 Distance.h 第 201 行定义.

virtual bool has_features ( )

virtual

test whether features have been assigned to lhs and rhs

返回: true if features are assigned

被 CCustomDistance 重载.

在文件 Distance.h 第 301 行定义.

bool init	(	CFeatures *	lhs,
		CFeatures *	rhs
	)

virtual

init distance

make sure to check that your distance can deal with the supplied features (!)

参数

lhs	features of left-hand side
rhs	features of right-hand side

返回: if init was successful

被 CCustomDistance, CMahalanobisDistance, CKernelDistance, CMinkowskiMetric, CEuclideanDistance, CAttenuatedEuclideanDistance, CCanberraMetric, CCosineDistance, CManhattanMetric, CGeodesicMetric, CJensenMetric, CTanimotoDistance, CChiSquareDistance, CHammingWordDistance, CBrayCurtisDistance, CChebyshewMetric, CCanberraWordDistance, CManhattanWordDistance, CSparseEuclideanDistance, CStringDistance< ST >, CStringDistance< uint16_t >, CDenseDistance< ST >, CDenseDistance< float64_t >, CRealDistance, CSparseDistance< ST > , 以及 CSparseDistance< float64_t > 重载.

在文件 Distance.cpp 第 78 行定义.

bool is_generic ( EPrimitiveType * generic ) const

virtualinherited

If the SGSerializable is a class template then TRUE will be returned and GENERIC is set to the type of the generic.

参数

generic set to the type of the generic if returning TRUE

返回: TRUE if a class template.

在文件 SGObject.cpp 第 296 行定义.

bool lhs_equals_rhs ( )

test whether features on lhs and rhs are the same

返回: true if features are the same

在文件 Distance.h 第 310 行定义.

void load ( CFile * loader )

load the kernel matrix

参数

loader File object via which to load data

在文件 Distance.cpp 第 107 行定义.

bool load_serializable	(	CSerializableFile *	file,
		const char *	prefix = `""`
	)

virtualinherited

Load this object from file. If it will fail (returning FALSE) then this object will contain inconsistent data and should not be used!

参数

file	where to load from
prefix	prefix for members

返回: TRUE if done, otherwise FALSE

在文件 SGObject.cpp 第 369 行定义.

void load_serializable_post	(		)
throw	(	ShogunException
	)

protectedvirtualinherited

Can (optionally) be overridden to post-initialize some member variables which are not PARAMETER::ADD'ed. Make sure that at first the overridden method BASE_CLASS::LOAD_SERIALIZABLE_POST is called.

异常

ShogunException will be thrown if an error occurs.

被 CKernel, CWeightedDegreePositionStringKernel, CList, CAlphabet, CLinearHMM, CGaussianKernel, CInverseMultiQuadricKernel, CCircularKernel , 以及 CExponentialKernel 重载.

在文件 SGObject.cpp 第 426 行定义.

void load_serializable_pre	(		)
throw	(	ShogunException
	)

protectedvirtualinherited

Can (optionally) be overridden to pre-initialize some member variables which are not PARAMETER::ADD'ed. Make sure that at first the overridden method BASE_CLASS::LOAD_SERIALIZABLE_PRE is called.

异常

ShogunException will be thrown if an error occurs.

被 CDynamicArray< T >, CDynamicArray< float64_t >, CDynamicArray< float32_t >, CDynamicArray< int32_t >, CDynamicArray< char >, CDynamicArray< bool > , 以及 CDynamicObjectArray 重载.

在文件 SGObject.cpp 第 421 行定义.

bool parameter_hash_changed ( )

virtualinherited

返回: whether parameter combination has changed since last update

在文件 SGObject.cpp 第 262 行定义.

void print_modsel_params ( )

inherited

prints all parameter registered for model selection and their type

在文件 SGObject.cpp 第 474 行定义.

void print_serializable ( const char * prefix = "" )

virtualinherited

prints registered parameters out

参数

prefix prefix for members

在文件 SGObject.cpp 第 308 行定义.

void remove_lhs ( )

virtual

takes all necessary steps if the lhs is removed from distance matrix

在文件 Distance.cpp 第 130 行定义.

void remove_lhs_and_rhs ( )

virtual

remove lhs and rhs from distance

在文件 Distance.cpp 第 119 行定义.

void remove_rhs ( )

virtual

takes all necessary steps if the rhs is removed from distance matrix

takes all necessary steps if the rhs is removed from distance

在文件 Distance.cpp 第 138 行定义.

CFeatures * replace_lhs ( CFeatures * lhs )

replace left-hand side features used in distance matrix

make sure to check that your distance can deal with the supplied features (!)

参数

lhs	features of right-hand side

返回: replaced left-hand side features

在文件 Distance.cpp 第 167 行定义.

CFeatures * replace_rhs ( CFeatures * rhs )

replace right-hand side features used in distance matrix

make sure to check that your distance can deal with the supplied features (!)

参数

rhs	features of right-hand side

返回: replaced right-hand side features

在文件 Distance.cpp 第 145 行定义.

static void* run_distance_thread ( void * p )

staticprotected

run distance thread

void save ( CFile * writer )

save kernel matrix

参数

writer File object via which to save data

在文件 Distance.cpp 第 113 行定义.

bool save_serializable	(	CSerializableFile *	file,
		const char *	prefix = `""`
	)

virtualinherited

Save this object to file.

参数

file	where to save the object; will be closed during returning if PREFIX is an empty string.
prefix	prefix for members

返回: TRUE if done, otherwise FALSE

在文件 SGObject.cpp 第 314 行定义.

void save_serializable_post	(		)
throw	(	ShogunException
	)

protectedvirtualinherited

Can (optionally) be overridden to post-initialize some member variables which are not PARAMETER::ADD'ed. Make sure that at first the overridden method BASE_CLASS::SAVE_SERIALIZABLE_POST is called.

异常

ShogunException will be thrown if an error occurs.

被 CKernel 重载.

在文件 SGObject.cpp 第 436 行定义.

void save_serializable_pre	(		)
throw	(	ShogunException
	)

protectedvirtualinherited

Can (optionally) be overridden to pre-initialize some member variables which are not PARAMETER::ADD'ed. Make sure that at first the overridden method BASE_CLASS::SAVE_SERIALIZABLE_PRE is called.

异常

ShogunException will be thrown if an error occurs.

被 CKernel, CDynamicArray< T >, CDynamicArray< float64_t >, CDynamicArray< float32_t >, CDynamicArray< int32_t >, CDynamicArray< char >, CDynamicArray< bool > , 以及 CDynamicObjectArray 重载.

在文件 SGObject.cpp 第 431 行定义.

void set_generic ( )

inherited

在文件 SGObject.cpp 第 41 行定义.

void set_generic ( )

inherited

在文件 SGObject.cpp 第 46 行定义.

void set_generic ( )

inherited

在文件 SGObject.cpp 第 51 行定义.

void set_generic ( )

inherited

在文件 SGObject.cpp 第 56 行定义.

void set_generic ( )

inherited

在文件 SGObject.cpp 第 61 行定义.

void set_generic ( )

inherited

在文件 SGObject.cpp 第 66 行定义.

void set_generic ( )

inherited

在文件 SGObject.cpp 第 71 行定义.

void set_generic ( )

inherited

在文件 SGObject.cpp 第 76 行定义.

void set_generic ( )

inherited

在文件 SGObject.cpp 第 81 行定义.

void set_generic ( )

inherited

在文件 SGObject.cpp 第 86 行定义.

void set_generic ( )

inherited

在文件 SGObject.cpp 第 91 行定义.

void set_generic ( )

inherited

在文件 SGObject.cpp 第 96 行定义.

void set_generic ( )

inherited

在文件 SGObject.cpp 第 101 行定义.

void set_generic ( )

inherited

在文件 SGObject.cpp 第 106 行定义.

void set_generic ( )

inherited

在文件 SGObject.cpp 第 111 行定义.

void set_generic ( )

inherited

set generic type to T

void set_global_io ( SGIO * io )

inherited

set the io object

参数

io	io object to use

在文件 SGObject.cpp 第 228 行定义.

void set_global_parallel ( Parallel * parallel )

inherited

set the parallel object

参数

parallel parallel object to use

在文件 SGObject.cpp 第 241 行定义.

void set_global_version ( Version * version )

inherited

set the version object

参数

version version object to use

在文件 SGObject.cpp 第 283 行定义.

virtual void set_precompute_matrix ( bool flag )

virtual

FIXME: precompute matrix should be dropped, handling should be via customdistance

参数

flag	if precompute_matrix

在文件 Distance.h 第 268 行定义.

CSGObject * shallow_copy ( ) const

virtualinherited

A shallow copy. All the SGObject instance variables will be simply assigned and SG_REF-ed.

被 CGaussianKernel 重载.

在文件 SGObject.cpp 第 192 行定义.

void unset_generic ( )

inherited

unset generic type

this has to be called in classes specializing a template class

在文件 SGObject.cpp 第 303 行定义.

void update_parameter_hash ( )

virtualinherited

Updates the hash of current parameter combination

在文件 SGObject.cpp 第 248 行定义.

类成员变量说明

SGIO* io

inherited

io

在文件 SGObject.h 第 369 行定义.

CFeatures* lhs

protected

feature vectors to occur on the left hand side

在文件 Distance.h 第 343 行定义.

Parameter* m_gradient_parameters

inherited

parameters wrt which we can compute gradients

在文件 SGObject.h 第 384 行定义.

uint32_t m_hash

inherited

Hash of parameter values

在文件 SGObject.h 第 387 行定义.

Parameter* m_model_selection_parameters

inherited

model selection parameters

在文件 SGObject.h 第 381 行定义.

Parameter* m_parameters

inherited

parameters

在文件 SGObject.h 第 378 行定义.

int32_t num_lhs

protected

number of feature vectors on the left hand side

在文件 Distance.h 第 348 行定义.

int32_t num_rhs

protected

number of feature vectors on the right hand side

在文件 Distance.h 第 350 行定义.

Parallel* parallel

inherited

parallel

在文件 SGObject.h 第 372 行定义.

bool precompute_matrix

protected

FIXME: precompute matrix should be dropped, handling should be via customdistance

在文件 Distance.h 第 340 行定义.

float32_t* precomputed_matrix

protected

FIXME: precompute matrix should be dropped, handling should be via customdistance

在文件 Distance.h 第 335 行定义.

CFeatures* rhs

protected

feature vectors to occur on the right hand side

在文件 Distance.h 第 345 行定义.

Version* version

inherited

version

在文件 SGObject.h 第 375 行定义.

该类的文档由以下文件生成:

详细描述

Public 成员函数

静态 Public 成员函数

Public 属性

Protected 成员函数

静态 Protected 成员函数

Protected 属性

构造及析构函数说明

成员函数说明

类成员变量说明