Detailed Description

class Bray-Curtis distance

The Bray-Curtis distance (Sorensen distance) is similar to the Manhattan distance with normalization.

$\displaystyle d(\bf{x},\bf{x}') = \frac{\sum_{i=1}^{n}|x_{i}-x'_{i}|}{\sum_{i=1}^{n}|x_{i} +x'_{i}|} \quad x,x' \in R^{n}$

Definition at line 31 of file BrayCurtisDistance.h.

Inheritance diagram for CBrayCurtisDistance:

[legend]

Public Member Functions
	CBrayCurtisDistance ()

	CBrayCurtisDistance (CSimpleFeatures< float64_t > l, CSimpleFeatures< float64_t > r)

virtual	~CBrayCurtisDistance ()

virtual bool	init (CFeatures l, CFeatures r)

virtual void	cleanup ()

virtual EDistanceType	get_distance_type ()

virtual const char *	get_name () const

Public Member Functions inherited from CSimpleDistance< float64_t >
	CSimpleDistance ()

virtual EFeatureClass	get_feature_class ()

virtual EFeatureType	get_feature_type ()

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

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)

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

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

Protected Member Functions inherited from CDistance
void	do_precompute_matrix ()
	matrix precomputation More...

Protected Member Functions inherited from CSGObject
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)

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 More...

Protected Attributes inherited from CDistance
float32_t *	precomputed_matrix

bool	precompute_matrix

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

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

Constructor & Destructor Documentation

CBrayCurtisDistance ( )

default constructor

Definition at line 20 of file BrayCurtisDistance.cpp.

CBrayCurtisDistance	(	CSimpleFeatures< float64_t > *	l,
		CSimpleFeatures< float64_t > *	r
	)

constructor

Parameters

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

Definition at line 25 of file BrayCurtisDistance.cpp.

~CBrayCurtisDistance ( )

virtual

Definition at line 31 of file BrayCurtisDistance.cpp.

Member Function Documentation

void cleanup ( )

virtual

cleanup distance

Implements CSimpleDistance< float64_t >.

Definition at line 43 of file BrayCurtisDistance.cpp.

float64_t compute	(	int32_t	idx_a,
		int32_t	idx_b
	)

protectedvirtual

compute distance 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 47 of file BrayCurtisDistance.cpp.

virtual EDistanceType get_distance_type ( )

virtual

get distance type we are

Returns: distance type BRAYCURTIS

Implements CSimpleDistance< float64_t >.

Definition at line 60 of file BrayCurtisDistance.h.

virtual const char* get_name ( ) const

virtual

get name of the distance

Returns: name Bray-Curtis distance

Reimplemented from CSimpleDistance< float64_t >.

Definition at line 66 of file BrayCurtisDistance.h.

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

Definition at line 36 of file BrayCurtisDistance.cpp.

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

Detailed Description

Public Member Functions

Protected Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation