CEuclidianDistance Class Reference

Inheritance diagram for CEuclidianDistance:

Detailed Description

class EuclidianDistance

Definition at line 19 of file EuclidianDistance.h.


Public Member Functions
	CEuclidianDistance ()
	CEuclidianDistance (CRealFeatures l, CRealFeatures r)
virtual	~CEuclidianDistance ()
virtual bool	init (CFeatures l, CFeatures r)
virtual void	cleanup ()
virtual bool	load_init (FILE *src)
virtual bool	save_init (FILE *dest)
virtual EDistanceType	get_distance_type ()
virtual EFeatureType	get_feature_type ()
virtual const CHAR *	get_name ()
virtual bool	get_disable_sqrt ()
virtual void	set_disable_sqrt (bool state)
virtual EFeatureClass	get_feature_class ()
DREAL	distance (INT idx_a, INT idx_b)
void	get_distance_matrix (DREAL *dst, INT m, INT *n)
virtual DREAL *	get_distance_matrix_real (int &m, int &n, DREAL *target)
virtual SHORTREAL *	get_distance_matrix_shortreal (int &m, int &n, SHORTREAL *target)
bool	load (CHAR *fname)
bool	save (CHAR *fname)
CFeatures *	get_lhs ()
CFeatures *	get_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
bool	get_precompute_matrix ()
virtual void	set_precompute_matrix (bool flag)
Static Public Attributes
static CParallel	parallel
static CIO	io
static CVersion	version
Protected Member Functions
virtual DREAL	compute (INT idx_a, INT idx_b)
void	do_precompute_matrix ()
	matrix precomputation
Protected Attributes
double	scale
bool	disable_sqrt
SHORTREAL *	precomputed_matrix
bool	precompute_matrix
CFeatures *	lhs
	feature vectors to occur on left hand side
CFeatures *	rhs
	feature vectors to occur on right hand side

Constructor & Destructor Documentation

CEuclidianDistance::CEuclidianDistance ( )

default constructor

Definition at line 17 of file EuclidianDistance.cpp.

CEuclidianDistance::CEuclidianDistance	(	CRealFeatures *	l,
		CRealFeatures *	r
	)

constructor

Parameters:

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

Definition at line 23 of file EuclidianDistance.cpp.

CEuclidianDistance::~CEuclidianDistance ( ) [virtual]

Definition at line 30 of file EuclidianDistance.cpp.

Member Function Documentation

bool CEuclidianDistance::init	(	CFeatures *	l,
		CFeatures *	r
	)			`[virtual]`

init distance

Parameters:

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

Returns:: if init was successful

Reimplemented from CRealDistance.

Definition at line 35 of file EuclidianDistance.cpp.

void CEuclidianDistance::cleanup ( ) [virtual]

cleanup distance

Implements CDistance.

Definition at line 42 of file EuclidianDistance.cpp.

bool CEuclidianDistance::load_init ( FILE * src ) [virtual]

load init data from file

Parameters:

src

file to load from

Returns:: if loading was successful

Implements CDistance.

Definition at line 46 of file EuclidianDistance.cpp.

bool CEuclidianDistance::save_init ( FILE * dest ) [virtual]

save init data to file

Parameters:

dest

file to save to

Returns:: if saving was successful

Implements CDistance.

Definition at line 51 of file EuclidianDistance.cpp.

virtual EDistanceType CEuclidianDistance::get_distance_type ( ) [virtual]

get distance type we are

Returns:: distance type EUCLIDIAN

Implements CDistance.

Definition at line 62 of file EuclidianDistance.h.

virtual EFeatureType CEuclidianDistance::get_feature_type ( ) [virtual]

get feature type the distance can deal with

Returns:: feature type DREAL

Reimplemented from CRealDistance.

Definition at line 68 of file EuclidianDistance.h.

virtual const CHAR* CEuclidianDistance::get_name ( ) [virtual]

get name of the distance

Returns:: name Euclidian

Implements CDistance.

Definition at line 74 of file EuclidianDistance.h.

virtual bool CEuclidianDistance::get_disable_sqrt ( ) [virtual]

disable application of sqrt on matrix computation the matrix can then also be named norm squared

Returns:: if application of sqrt is disabled

Definition at line 81 of file EuclidianDistance.h.

virtual void CEuclidianDistance::set_disable_sqrt ( bool state ) [virtual]

disable application of sqrt on matrix computation the matrix can then also be named norm squared

Parameters:

state

new disable_sqrt

Definition at line 88 of file EuclidianDistance.h.

DREAL CEuclidianDistance::compute	(	INT	idx_a,
		INT	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

Implements CDistance.

Definition at line 56 of file EuclidianDistance.cpp.

template<class ST>

virtual EFeatureClass CSimpleDistance< ST >::get_feature_class ( ) [virtual, inherited]

get feature class the distance can deal with

Returns:: feature class SIMPLE

Implements CDistance.

Definition at line 54 of file SimpleDistance.h.

DREAL CDistance::distance	(	INT	idx_a,
		INT	idx_b
	)			`[inherited]`

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 45 of file Distance.h.

void CDistance::get_distance_matrix	(	DREAL **	dst,
		INT *	m,
		INT *	n
	)			`[inherited]`

get distance matrix

Parameters:

	dst	distance matrix is stored in here
	m	dimension m of matrix is stored in here
	n	dimension n of matrix is stored in here

Definition at line 143 of file Distance.cpp.

DREAL * CDistance::get_distance_matrix_real	(	int &	m,
		int &	n,
		DREAL *	target
	)			`[virtual, inherited]`

get distance matrix real

Parameters:

	m	dimension m
	n	dimension n
	target	target matrix

Returns:: target matrix

Definition at line 278 of file Distance.cpp.

SHORTREAL * CDistance::get_distance_matrix_shortreal	(	int &	m,
		int &	n,
		SHORTREAL *	target
	)			`[virtual, inherited]`

get distance matrix short real

Parameters:

	m	dimension m
	n	dimension n
	target	target matrix

Returns:: target matrix

Definition at line 210 of file Distance.cpp.

bool CDistance::load ( CHAR * fname ) [inherited]

load distance matrix from file

Parameters:

fname

filename to load from

Returns:: if loading was successful

Definition at line 69 of file Distance.cpp.

bool CDistance::save ( CHAR * fname ) [inherited]

save distance matrix to file

Parameters:

fname

filename to save to

Returns:: if saving was successful

Definition at line 74 of file Distance.cpp.

CFeatures* CDistance::get_lhs ( ) [inherited]

get left-hand side features used in distance matrix

Returns:: left-hand side features

Definition at line 157 of file Distance.h.

CFeatures* CDistance::get_rhs ( ) [inherited]

get right-hand side features used in distance matrix

Returns:: right-hand side features

Definition at line 163 of file Distance.h.

void CDistance::remove_lhs ( ) [virtual, inherited]

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

Definition at line 105 of file Distance.cpp.

void CDistance::remove_rhs ( ) [virtual, inherited]

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

takes all necessary steps if the rhs is removed from kernel

Definition at line 112 of file Distance.cpp.

bool CDistance::get_precompute_matrix ( ) [inherited]

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

Returns:: if precompute_matrix

Definition at line 209 of file Distance.h.

virtual void CDistance::set_precompute_matrix ( bool flag ) [virtual, inherited]

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

Parameters:

flag

if precompute_matrix

Definition at line 216 of file Distance.h.

void CDistance::do_precompute_matrix ( ) [protected, inherited]

matrix precomputation

Definition at line 119 of file Distance.cpp.

Member Data Documentation

double CEuclidianDistance::scale [protected]

applied scaling factor

Definition at line 99 of file EuclidianDistance.h.

bool CEuclidianDistance::disable_sqrt [protected]

if application of sqrt on matrix computation is disabled

Definition at line 101 of file EuclidianDistance.h.

SHORTREAL* CDistance::precomputed_matrix [protected, inherited]

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

Definition at line 240 of file Distance.h.

bool CDistance::precompute_matrix [protected, inherited]

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

Definition at line 245 of file Distance.h.

CFeatures* CDistance::lhs [protected, inherited]

feature vectors to occur on left hand side

Definition at line 248 of file Distance.h.

CFeatures* CDistance::rhs [protected, inherited]

feature vectors to occur on right hand side

Definition at line 250 of file Distance.h.

CParallel CSGObject::parallel [static, inherited]

Definition at line 105 of file SGObject.h.

CIO CSGObject::io [static, inherited]

Definition at line 106 of file SGObject.h.

CVersion CSGObject::version [static, inherited]

Definition at line 107 of file SGObject.h.

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

CEuclidianDistance Class Reference

Detailed Description

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation