CSimpleDistance< ST > Class Template Reference

---

Detailed Description

template<class ST>
class shogun::CSimpleDistance< ST >

template class SimpleDistance

Definition at line 21 of file SimpleDistance.h.

Inheritance diagram for CSimpleDistance< ST >:

List of all members.

Public Member Functions
	CSimpleDistance ()
virtual bool	init (CFeatures *l, CFeatures *r)
virtual EFeatureClass	get_feature_class ()
virtual EFeatureType	get_feature_type ()
virtual const char *	get_name (void) 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 ()

---

Constructor & Destructor Documentation

CSimpleDistance

(

)

default constructor

Definition at line 25 of file SimpleDistance.h.

---

Member Function Documentation

virtual void cleanup

(

)

[pure virtual]

cleanup distance

abstract base method

Implements CDistance.

Implemented in CBrayCurtisDistance, CCanberraMetric, CChebyshewMetric, CChiSquareDistance, CCosineDistance, CEuclidianDistance, CGeodesicMetric, CJensenMetric, CManhattanMetric, CMinkowskiMetric, CRealDistance, and CTanimotoDistance.

virtual EDistanceType get_distance_type

(

)

[pure virtual]

get distance type we are

abstrace base method

Returns:

distance type

Implements CDistance.

Implemented in CBrayCurtisDistance, CCanberraMetric, CChebyshewMetric, CChiSquareDistance, CCosineDistance, CEuclidianDistance, CGeodesicMetric, CJensenMetric, CManhattanMetric, CMinkowskiMetric, CRealDistance, and CTanimotoDistance.

virtual EFeatureClass get_feature_class

(

)

[virtual]

get feature class the distance can deal with

Returns:

feature class SIMPLE

Implements CDistance.

Definition at line 56 of file SimpleDistance.h.

EFeatureType get_feature_type

(

)

[virtual]

get feature type the SHORT distance can deal with

Returns:

feature type SHORT

Implements CDistance.

Definition at line 115 of file SimpleDistance.h.

EFeatureType get_feature_type

(

)

[virtual]

get feature type the BYTE distance can deal with

Returns:

feature type BYTE

Implements CDistance.

Definition at line 121 of file SimpleDistance.h.

EFeatureType get_feature_type

(

)

[virtual]

get feature type the ULONG distance can deal with

Returns:

feature type ULONG

Implements CDistance.

Definition at line 97 of file SimpleDistance.h.

EFeatureType get_feature_type

(

)

[virtual]

get feature type the INT distance can deal with

Returns:

feature type INT

Implements CDistance.

Definition at line 103 of file SimpleDistance.h.

EFeatureType get_feature_type

(

)

[virtual]

get feature type the DREAL distance can deal with

Returns:

feature type DREAL

Implements CDistance.

Definition at line 91 of file SimpleDistance.h.

virtual EFeatureType get_feature_type

(

)

[virtual]

get feature type the distance can deal with

Returns:

template-specific feature type

Implements CDistance.

Reimplemented in CEuclidianDistance, and CRealDistance.

EFeatureType get_feature_type

(

)

[virtual]

get feature type the WORD distance can deal with

Returns:

feature type WORD

Implements CDistance.

Definition at line 109 of file SimpleDistance.h.

EFeatureType get_feature_type

(

)

[virtual]

get feature type the CHAR distance can deal with

Returns:

feature type CHAR

Implements CDistance.

Definition at line 127 of file SimpleDistance.h.

virtual const char* get_name

(

void

)

const [virtual]

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

Returns:

name of the SGSerializable

Implements CSGObject.

Reimplemented in CBrayCurtisDistance, CCanberraMetric, CChebyshewMetric, CChiSquareDistance, CCosineDistance, CEuclidianDistance, CGeodesicMetric, CJensenMetric, CManhattanMetric, CMinkowskiMetric, CRealDistance, and CTanimotoDistance.

Definition at line 69 of file SimpleDistance.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 CDistance.

Reimplemented in CBrayCurtisDistance, CCanberraMetric, CChebyshewMetric, CChiSquareDistance, CCosineDistance, CEuclidianDistance, CGeodesicMetric, CJensenMetric, CManhattanMetric, CMinkowskiMetric, CRealDistance, and CTanimotoDistance.

Definition at line 33 of file SimpleDistance.h.

---

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

• SimpleDistance.h