SHOGUN  v1.1.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
List of all members | Public Member Functions | Protected Member Functions | Protected Attributes
CMinkowskiMetric Class Reference

Detailed Description

class MinkowskiMetric

The Minkowski metric is one general class of metrics for a $\displaystyle R^{n}$ feature space also referred as the $\displaystyle L_{k} $ norm.

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

special cases:

  1. $\displaystyle L_{1} $ norm: Manhattan distance
    See Also
    CManhattanMetric
  2. $\displaystyle L_{2} $ norm: Euclidean distance
    See Also
    CEuclidianDistance
    Note that the Minkowski distance tends to the Chebyshew distance for increasing $k$.
See Also
Wikipedia: Distance

Definition at line 40 of file MinkowskiMetric.h.

Inheritance diagram for CMinkowskiMetric:
Inheritance graph
[legend]

Public Member Functions

 CMinkowskiMetric ()
 CMinkowskiMetric (float64_t k)
 CMinkowskiMetric (CSimpleFeatures< float64_t > *l, CSimpleFeatures< float64_t > *r, float64_t k)
virtual ~CMinkowskiMetric ()
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_tget_distance_matrix ()
virtual float64_tget_distance_matrix_real (int32_t &m, int32_t &n, float64_t *target)
virtual float32_tget_distance_matrix_shortreal (int32_t &m, int32_t &n, float32_t *target)
void load (CFile *loader)
void save (CFile *writer)
CFeaturesget_lhs ()
CFeaturesget_rhs ()
CFeaturesreplace_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)
SGIOget_global_io ()
void set_global_parallel (Parallel *parallel)
Parallelget_global_parallel ()
void set_global_version (Version *version)
Versionget_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 idx_a, int32_t idx_b)

Protected Attributes

float64_t k

Additional Inherited Members

- Public Attributes inherited from CSGObject
SGIOio
Parallelparallel
Versionversion
Parameterm_parameters
Parameterm_model_selection_parameters
- Static Protected Member Functions inherited from CDistance
static void * run_distance_thread (void *p)
 run distance thread

Constructor & Destructor Documentation

default constructor

Definition at line 23 of file MinkowskiMetric.cpp.

constructor

Parameters
kparameter k

Definition at line 28 of file MinkowskiMetric.cpp.

constructor

Parameters
lfeatures of left-hand side
rfeatures of right-hand side
kparameter k

Definition at line 35 of file MinkowskiMetric.cpp.

~CMinkowskiMetric ( )
virtual

Definition at line 44 of file MinkowskiMetric.cpp.

Member Function Documentation

void cleanup ( )
virtual

cleanup distance

Implements CSimpleDistance< float64_t >.

Definition at line 54 of file MinkowskiMetric.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 58 of file MinkowskiMetric.cpp.

virtual EDistanceType get_distance_type ( )
virtual

get distance type we are

Returns
distance type MINKOWSKI

Implements CSimpleDistance< float64_t >.

Definition at line 75 of file MinkowskiMetric.h.

virtual const char* get_name ( ) const
virtual

get name of the distance

Returns
name Minkowski-Metric

Reimplemented from CSimpleDistance< float64_t >.

Definition at line 81 of file MinkowskiMetric.h.

bool init ( CFeatures l,
CFeatures r 
)
virtual

constructor

Parameters
lfeatures of left-hand side
rfeatures of right-hand side

Reimplemented from CSimpleDistance< float64_t >.

Definition at line 49 of file MinkowskiMetric.cpp.

Member Data Documentation

float64_t k
protected

parameter k

Definition at line 94 of file MinkowskiMetric.h.


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

SHOGUN Machine Learning Toolbox - Documentation