class Distance
All distance classes are derived from this base class.
Definition at line 56 of file Distance.h.
Public Member Functions | |
CDistance () | |
CDistance (CFeatures *lhs, CFeatures *rhs) | |
virtual | ~CDistance () |
float64_t | distance (int32_t idx_a, int32_t idx_b) |
void | get_distance_matrix (float64_t **dst, int32_t *m, int32_t *n) |
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) |
virtual bool | init (CFeatures *lhs, CFeatures *rhs) |
virtual void | cleanup ()=0 |
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 | |
virtual EDistanceType | get_distance_type ()=0 |
virtual EFeatureType | get_feature_type ()=0 |
virtual EFeatureClass | get_feature_class ()=0 |
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 () |
Protected Member Functions | |
virtual float64_t | compute (int32_t x, int32_t y)=0 |
void | do_precompute_matrix () |
matrix precomputation | |
Protected Attributes | |
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 |
CDistance | ( | ) |
default constructor
Definition at line 32 of file Distance.cpp.
init distance
lhs | features of left-hand side | |
rhs | features of right-hand side |
Definition at line 38 of file Distance.cpp.
~CDistance | ( | ) | [virtual] |
Definition at line 44 of file Distance.cpp.
virtual void cleanup | ( | ) | [pure virtual] |
cleanup distance
abstract base method
Implemented in CBrayCurtisDistance, CCanberraMetric, CCanberraWordDistance, CChebyshewMetric, CChiSquareDistance, CCosineDistance, CCustomDistance, CEuclidianDistance, CGeodesicMetric, CHammingWordDistance, CJensenMetric, CKernelDistance, CManhattanMetric, CManhattanWordDistance, CMinkowskiMetric, CRealDistance, CSimpleDistance< ST >, CSparseDistance< ST >, CSparseEuclidianDistance, CStringDistance< ST >, CTanimotoDistance, CSimpleDistance< float64_t >, CSparseDistance< float64_t >, and CStringDistance< uint16_t >.
virtual float64_t compute | ( | int32_t | x, | |
int32_t | y | |||
) | [protected, pure virtual] |
compute distance function for features a and b idx_{a,b} denote the index of the feature vectors in the corresponding feature object
Implemented in CBrayCurtisDistance, CCanberraMetric, CCanberraWordDistance, CChebyshewMetric, CChiSquareDistance, CCosineDistance, CCustomDistance, CEuclidianDistance, CGeodesicMetric, CHammingWordDistance, CJensenMetric, CKernelDistance, CManhattanMetric, CManhattanWordDistance, CMinkowskiMetric, CRealDistance, CSparseEuclidianDistance, and CTanimotoDistance.
float64_t distance | ( | int32_t | idx_a, | |
int32_t | idx_b | |||
) |
get distance function for lhs feature vector a and rhs feature vector b
idx_a | feature vector a at idx_a | |
idx_b | feature vector b at idx_b |
Definition at line 78 of file Distance.h.
void do_precompute_matrix | ( | ) | [protected] |
matrix precomputation
Definition at line 133 of file Distance.cpp.
void get_distance_matrix | ( | float64_t ** | dst, | |
int32_t * | m, | |||
int32_t * | n | |||
) |
get distance matrix
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 157 of file Distance.cpp.
get distance matrix real
m | dimension m | |
n | dimension n | |
target | target matrix |
Definition at line 293 of file Distance.cpp.
float32_t * get_distance_matrix_shortreal | ( | int32_t & | m, | |
int32_t & | n, | |||
float32_t * | target | |||
) | [virtual] |
get distance matrix short real
m | dimension m | |
n | dimension n | |
target | target matrix |
Definition at line 224 of file Distance.cpp.
virtual EDistanceType get_distance_type | ( | ) | [pure virtual] |
get distance type we are
abstrace base method
Implemented in CBrayCurtisDistance, CCanberraMetric, CCanberraWordDistance, CChebyshewMetric, CChiSquareDistance, CCosineDistance, CCustomDistance, CEuclidianDistance, CGeodesicMetric, CHammingWordDistance, CJensenMetric, CKernelDistance, CManhattanMetric, CManhattanWordDistance, CMinkowskiMetric, CRealDistance, CSimpleDistance< ST >, CSparseDistance< ST >, CSparseEuclidianDistance, CStringDistance< ST >, CTanimotoDistance, CSimpleDistance< float64_t >, CSparseDistance< float64_t >, and CStringDistance< uint16_t >.
virtual EFeatureClass get_feature_class | ( | ) | [pure virtual] |
get feature class the distance can deal with
abstract base method
Implemented in CCustomDistance, CKernelDistance, CSimpleDistance< ST >, CSparseDistance< ST >, CStringDistance< ST >, CSimpleDistance< float64_t >, CSparseDistance< float64_t >, and CStringDistance< uint16_t >.
virtual EFeatureType get_feature_type | ( | ) | [pure virtual] |
get feature type the distance can deal with
abstrace base method
Implemented in CCustomDistance, CEuclidianDistance, CKernelDistance, CRealDistance, CSimpleDistance< ST >, CSparseDistance< ST >, CSparseEuclidianDistance, CStringDistance< ST >, CSimpleDistance< float64_t >, CSparseDistance< float64_t >, CStringDistance< uint16_t >, CSimpleDistance< ST >, CSimpleDistance< ST >, CSimpleDistance< ST >, CSimpleDistance< ST >, CSimpleDistance< ST >, CSimpleDistance< ST >, CSimpleDistance< ST >, CSparseDistance< ST >, CSparseDistance< ST >, CSparseDistance< ST >, CSparseDistance< ST >, CSparseDistance< ST >, CSparseDistance< ST >, CSparseDistance< ST >, CStringDistance< ST >, CStringDistance< ST >, CStringDistance< ST >, CStringDistance< ST >, CStringDistance< ST >, CStringDistance< ST >, and CStringDistance< ST >.
CFeatures* get_lhs | ( | ) |
get left-hand side features used in distance matrix
Definition at line 172 of file Distance.h.
int32_t get_num_vec_lhs | ( | ) |
get number of vectors of lhs features
Reimplemented in CCustomDistance.
Definition at line 250 of file Distance.h.
int32_t get_num_vec_rhs | ( | ) |
get number of vectors of rhs features
Reimplemented in CCustomDistance.
Definition at line 262 of file Distance.h.
bool get_precompute_matrix | ( | ) |
FIXME: precompute matrix should be dropped, handling should be via customdistance
Definition at line 228 of file Distance.h.
CFeatures* get_rhs | ( | ) |
get right-hand side features used in distance matrix
Definition at line 178 of file Distance.h.
bool has_features | ( | ) |
test whether features have been assigned to lhs and rhs
Reimplemented in CCustomDistance.
Definition at line 274 of file Distance.h.
init distance
make sure to check that your distance can deal with the supplied features (!)
lhs | features of left-hand side | |
rhs | features of right-hand side |
Reimplemented in CBrayCurtisDistance, CCanberraMetric, CCanberraWordDistance, CChebyshewMetric, CChiSquareDistance, CCosineDistance, CCustomDistance, CEuclidianDistance, CGeodesicMetric, CHammingWordDistance, CJensenMetric, CKernelDistance, CManhattanMetric, CManhattanWordDistance, CMinkowskiMetric, CRealDistance, CSimpleDistance< ST >, CSparseDistance< ST >, CSparseEuclidianDistance, CStringDistance< ST >, CTanimotoDistance, CSimpleDistance< float64_t >, CSparseDistance< float64_t >, and CStringDistance< uint16_t >.
Definition at line 52 of file Distance.cpp.
bool lhs_equals_rhs | ( | ) |
test whether features on lhs and rhs are the same
Definition at line 283 of file Distance.h.
void load | ( | CFile * | loader | ) |
load the kernel matrix
loader | File object via which to load data |
Definition at line 78 of file Distance.cpp.
void remove_lhs | ( | ) | [virtual] |
takes all necessary steps if the lhs is removed from distance matrix
Definition at line 99 of file Distance.cpp.
void remove_lhs_and_rhs | ( | ) | [virtual] |
remove lhs and rhs from distance
Definition at line 90 of file Distance.cpp.
void remove_rhs | ( | ) | [virtual] |
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 106 of file Distance.cpp.
replace right-hand side features used in distance matrix
make sure to check that your distance can deal with the supplied features (!)
rhs | features of right-hand side |
Definition at line 112 of file Distance.cpp.
void save | ( | CFile * | writer | ) |
save kernel matrix
writer | File object via which to save data |
Definition at line 84 of file Distance.cpp.
virtual void set_precompute_matrix | ( | bool | flag | ) | [virtual] |
FIXME: precompute matrix should be dropped, handling should be via customdistance
flag | if precompute_matrix |
Definition at line 235 of file Distance.h.
feature vectors to occur on left hand side
Definition at line 312 of file Distance.h.
bool precompute_matrix [protected] |
FIXME: precompute matrix should be dropped, handling should be via customdistance
Definition at line 309 of file Distance.h.
float32_t* precomputed_matrix [protected] |
FIXME: precompute matrix should be dropped, handling should be via customdistance
Definition at line 304 of file Distance.h.
feature vectors to occur on right hand side
Definition at line 314 of file Distance.h.