CRealDistance Class Reference

Detailed Description

class RealDistance

Definition at line 20 of file RealDistance.h.

Inheritance diagram for CRealDistance:

Public Member Functions
	CRealDistance ()
virtual bool	init (CFeatures *l, CFeatures *r)
virtual EFeatureType	get_feature_type ()
virtual const char *	get_name () const
virtual void	cleanup ()=0
virtual EDistanceType	get_distance_type ()=0
Public Member Functions inherited from CSimpleDistance< float64_t >
	CSimpleDistance ()
virtual EFeatureClass	get_feature_class ()
Public Member Functions inherited from CDistance
	CDistance ()
	CDistance (CFeatures *lhs, CFeatures *rhs)
virtual	~CDistance ()
float64_t	distance (int32_t idx_a, int32_t idx_b)
SGMatrix< float64_t >	get_distance_matrix ()
virtual float64_t *	get_distance_matrix_real (int32_t &m, int32_t &n, float64_t *target)
virtual float32_t *	get_distance_matrix_shortreal (int32_t &m, int32_t &n, float32_t *target)
void	load (CFile *loader)
void	save (CFile *writer)
CFeatures *	get_lhs ()
CFeatures *	get_rhs ()
CFeatures *	replace_rhs (CFeatures *rhs)
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
bool	get_precompute_matrix ()
virtual void	set_precompute_matrix (bool flag)
int32_t	get_num_vec_lhs ()
int32_t	get_num_vec_rhs ()
bool	has_features ()
bool	lhs_equals_rhs ()
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)

Protected Member Functions
virtual float64_t	compute (int32_t x, int32_t y)=0

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 CDistance
static void *	run_distance_thread (void *p)
	run distance thread
Protected Attributes inherited from CDistance
float32_t *	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

CRealDistance

(

)

default constructor

Definition at line 24 of file RealDistance.h.

Member Function Documentation

virtual void cleanup ( )

pure virtual

cleanup distance

abstract base method

Implements CSimpleDistance< float64_t >.

Implemented in CEuclidianDistance, and CAttenuatedEuclidianDistance.

virtual float64_t compute ( int32_t  x, int32_t  y  )

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

Implements CDistance.

Implemented in CEuclidianDistance, and CAttenuatedEuclidianDistance.

virtual EDistanceType get_distance_type ( )

pure virtual

get distance type we are

abstrace base method

Returns

distance type

Implements CSimpleDistance< float64_t >.

Implemented in CEuclidianDistance, and CAttenuatedEuclidianDistance.

virtual EFeatureType get_feature_type ( )

virtual

get feature type the distance can deal with

Returns

feature type DREAL

Reimplemented from CSimpleDistance< float64_t >.

Reimplemented in CEuclidianDistance, and CAttenuatedEuclidianDistance.

Definition at line 46 of file RealDistance.h.

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

Reimplemented from CSimpleDistance< float64_t >.

Reimplemented in CEuclidianDistance, and CAttenuatedEuclidianDistance.

Definition at line 53 of file RealDistance.h.

virtual bool 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 CSimpleDistance< float64_t >.

Reimplemented in CEuclidianDistance, and CAttenuatedEuclidianDistance.

Definition at line 32 of file RealDistance.h.

---

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

• RealDistance.h