SHOGUN
v3.1.1
|
template class DenseDistance
Definition at line 22 of file DenseDistance.h.
Public Member Functions | |
CDenseDistance () | |
virtual bool | init (CFeatures *l, CFeatures *r) |
virtual EFeatureClass | get_feature_class () |
virtual EFeatureType | get_feature_type () |
virtual const char * | get_name () const |
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 () |
virtual float64_t | distance (int32_t idx_a, int32_t idx_b) |
virtual float64_t | distance_upper_bounded (int32_t idx_a, int32_t idx_b, float64_t upper_bound) |
SGMatrix< float64_t > | get_distance_matrix () |
template<class T > | |
SGMatrix< T > | get_distance_matrix () |
int32_t | compute_row_start (int64_t offs, int32_t n, bool symmetric) |
virtual void | cleanup ()=0 |
void | load (CFile *loader) |
void | save (CFile *writer) |
CFeatures * | get_lhs () |
CFeatures * | get_rhs () |
CFeatures * | replace_rhs (CFeatures *rhs) |
CFeatures * | replace_lhs (CFeatures *lhs) |
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) |
virtual int32_t | get_num_vec_lhs () |
virtual int32_t | get_num_vec_rhs () |
virtual bool | has_features () |
bool | lhs_equals_rhs () |
virtual CSGObject * | shallow_copy () const |
virtual CSGObject * | deep_copy () const |
virtual bool | is_generic (EPrimitiveType *generic) const |
template<class T > | |
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 () |
template<> | |
void | set_generic () |
template<> | |
void | set_generic () |
template<> | |
void | set_generic () |
void | unset_generic () |
virtual void | print_serializable (const char *prefix="") |
virtual bool | save_serializable (CSerializableFile *file, const char *prefix="", int32_t param_version=Version::get_version_parameter()) |
virtual bool | load_serializable (CSerializableFile *file, const char *prefix="", int32_t param_version=Version::get_version_parameter()) |
DynArray< TParameter * > * | load_file_parameters (const SGParamInfo *param_info, int32_t file_version, CSerializableFile *file, const char *prefix="") |
DynArray< TParameter * > * | load_all_file_parameters (int32_t file_version, int32_t current_version, CSerializableFile *file, const char *prefix="") |
void | map_parameters (DynArray< TParameter * > *param_base, int32_t &base_version, DynArray< const SGParamInfo * > *target_param_infos) |
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 () |
SGStringList< char > | get_modelsel_names () |
void | print_modsel_params () |
char * | get_modsel_param_descr (const char *param_name) |
index_t | get_modsel_param_index (const char *param_name) |
void | build_gradient_parameter_dictionary (CMap< TParameter *, CSGObject * > *dict) |
virtual bool | update_parameter_hash () |
virtual bool | equals (CSGObject *other, float64_t accuracy=0.0) |
virtual CSGObject * | clone () |
Static Public Member Functions | |
template<class T > | |
static void * | get_distance_matrix_helper (void *p) |
Public Attributes | |
SGIO * | io |
Parallel * | parallel |
Version * | version |
Parameter * | m_parameters |
Parameter * | m_model_selection_parameters |
Parameter * | m_gradient_parameters |
ParameterMap * | m_parameter_map |
uint32_t | m_hash |
Protected Member Functions | |
virtual float64_t | compute (int32_t idx_a, int32_t idx_b)=0 |
void | do_precompute_matrix () |
matrix precomputation More... | |
virtual TParameter * | migrate (DynArray< TParameter * > *param_base, const SGParamInfo *target) |
virtual void | one_to_one_migration_prepare (DynArray< TParameter * > *param_base, const SGParamInfo *target, TParameter *&replacement, TParameter *&to_migrate, char *old_name=NULL) |
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) |
Static Protected Member Functions | |
static void * | run_distance_thread (void *p) |
run distance thread More... | |
Protected Attributes | |
float32_t * | precomputed_matrix |
bool | precompute_matrix |
CFeatures * | lhs |
feature vectors to occur on the left hand side More... | |
CFeatures * | rhs |
feature vectors to occur on the right hand side More... | |
int32_t | num_lhs |
int32_t | num_rhs |
CDenseDistance | ( | ) |
default constructor
Definition at line 26 of file DenseDistance.h.
|
inherited |
Builds a dictionary of all parameters in SGObject as well of those of SGObjects that are parameters of this object. Dictionary maps parameters to the objects that own them.
dict | dictionary of parameters to be built. |
Definition at line 1156 of file SGObject.cpp.
|
pure virtualinherited |
cleanup distance
abstract base method
Implemented in CCustomDistance, CKernelDistance, CMahalanobisDistance, CSparseDistance< ST >, CSparseDistance< float64_t >, CStringDistance< ST >, CStringDistance< uint16_t >, CMinkowskiMetric, CEuclideanDistance, CAttenuatedEuclideanDistance, CRealDistance, CCanberraMetric, CCosineDistance, CManhattanMetric, CGeodesicMetric, CJensenMetric, CTanimotoDistance, CChiSquareDistance, CHammingWordDistance, CBrayCurtisDistance, CChebyshewMetric, CCustomMahalanobisDistance, CCanberraWordDistance, CManhattanWordDistance, and CSparseEuclideanDistance.
|
virtualinherited |
Creates a clone of the current object. This is done via recursively traversing all parameters, which corresponds to a deep copy. Calling equals on the cloned object always returns true although none of the memory of both objects overlaps.
Definition at line 1273 of file SGObject.cpp.
|
protectedpure virtualinherited |
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 CCustomDistance, CMahalanobisDistance, CEuclideanDistance, CKernelDistance, CAttenuatedEuclideanDistance, CMinkowskiMetric, CCanberraMetric, CCosineDistance, CManhattanMetric, CGeodesicMetric, CJensenMetric, CTanimotoDistance, CChiSquareDistance, CHammingWordDistance, CRealDistance, CBrayCurtisDistance, CChebyshewMetric, CSparseEuclideanDistance, CCustomMahalanobisDistance, CCanberraWordDistance, and CManhattanWordDistance.
|
inherited |
compute row start offset for parallel kernel matrix computation
offs | offset |
n | number of columns |
symmetric | whether matrix is symmetric |
Definition at line 143 of file Distance.h.
|
virtualinherited |
A deep copy. All the instance variables will also be copied.
Definition at line 126 of file SGObject.h.
|
virtualinherited |
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 189 of file Distance.cpp.
|
virtualinherited |
get distance function for lhs feature vector a and rhs feature vector b. The computation of the distance stops if the intermediate result is larger than upper_bound. This is useful to use with John Langford's Cover Tree and it is ONLY implemented for Euclidean distance
idx_a | feature vector a at idx_a |
idx_b | feature vector b at idx_b |
upper_bound | value above which the computation halts |
Reimplemented in CEuclideanDistance.
Definition at line 117 of file Distance.h.
|
protectedinherited |
matrix precomputation
Definition at line 227 of file Distance.cpp.
Recursively compares the current SGObject to another one. Compares all registered numerical parameters, recursion upon complex (SGObject) parameters. Does not compare pointers!
May be overwritten but please do with care! Should not be necessary in most cases.
other | object to compare with |
accuracy | accuracy to use for comparison (optional) |
Definition at line 1177 of file SGObject.cpp.
get distance matrix
Definition at line 126 of file Distance.h.
|
inherited |
get distance matrix (templated)
|
staticinherited |
helper for computing the kernel matrix in a parallel way
p | thread parameters |
Definition at line 266 of file Distance.cpp.
|
pure virtual |
get distance type we are
abstrace base method
Implements CDistance.
Implemented in CMahalanobisDistance, CMinkowskiMetric, CEuclideanDistance, CAttenuatedEuclideanDistance, CRealDistance, CCanberraMetric, CCosineDistance, CManhattanMetric, CGeodesicMetric, CJensenMetric, CTanimotoDistance, CChiSquareDistance, CBrayCurtisDistance, CChebyshewMetric, and CCustomMahalanobisDistance.
|
virtual |
get feature class the distance can deal with
Implements CDistance.
Definition at line 40 of file DenseDistance.h.
|
virtual |
get feature type the DREAL distance can deal with
Implements CDistance.
Definition at line 28 of file DenseDistance.cpp.
|
virtual |
get feature type the ULONG distance can deal with
Implements CDistance.
Definition at line 34 of file DenseDistance.cpp.
|
virtual |
get feature type the INT distance can deal with
Implements CDistance.
Definition at line 40 of file DenseDistance.cpp.
|
virtual |
get feature type the WORD distance can deal with
Implements CDistance.
Definition at line 46 of file DenseDistance.cpp.
|
virtual |
get feature type the distance can deal with
Implements CDistance.
Reimplemented in CMahalanobisDistance, CEuclideanDistance, CAttenuatedEuclideanDistance, and CRealDistance.
|
virtual |
get feature type the SHORT distance can deal with
Implements CDistance.
Definition at line 52 of file DenseDistance.cpp.
|
virtual |
get feature type the BYTE distance can deal with
Implements CDistance.
Definition at line 58 of file DenseDistance.cpp.
|
virtual |
get feature type the CHAR distance can deal with
Implements CDistance.
Definition at line 64 of file DenseDistance.cpp.
|
inherited |
|
inherited |
|
inherited |
|
inherited |
get left-hand side features used in distance matrix
Definition at line 194 of file Distance.h.
|
inherited |
Definition at line 1060 of file SGObject.cpp.
|
inherited |
Returns description of a given parameter string, if it exists. SG_ERROR otherwise
param_name | name of the parameter |
Definition at line 1084 of file SGObject.cpp.
|
inherited |
Returns index of model selection parameter with provided index
param_name | name of model selection parameter |
Definition at line 1097 of file SGObject.cpp.
|
virtual |
Returns the name of the SGSerializable instance. It MUST BE the CLASS NAME without the prefixed `C'.
Implements CSGObject.
Reimplemented in CMahalanobisDistance, CEuclideanDistance, CMinkowskiMetric, CAttenuatedEuclideanDistance, CCanberraMetric, CCosineDistance, CManhattanMetric, CGeodesicMetric, CJensenMetric, CTanimotoDistance, CChiSquareDistance, CBrayCurtisDistance, CChebyshewMetric, CRealDistance, and CCustomMahalanobisDistance.
Definition at line 53 of file DenseDistance.h.
|
virtualinherited |
get number of vectors of lhs features
Reimplemented in CCustomDistance.
Definition at line 282 of file Distance.h.
|
virtualinherited |
get number of vectors of rhs features
Reimplemented in CCustomDistance.
Definition at line 291 of file Distance.h.
|
inherited |
FIXME: precompute matrix should be dropped, handling should be via customdistance
Definition at line 260 of file Distance.h.
|
inherited |
get right-hand side features used in distance matrix
Definition at line 200 of file Distance.h.
|
virtualinherited |
test whether features have been assigned to lhs and rhs
Reimplemented in CCustomDistance.
Definition at line 300 of file Distance.h.
init distance
l | features of left-hand side |
r | features of right-hand side |
Reimplemented from CDistance.
Reimplemented in CMahalanobisDistance, CMinkowskiMetric, CEuclideanDistance, CAttenuatedEuclideanDistance, CCanberraMetric, CCosineDistance, CManhattanMetric, CGeodesicMetric, CJensenMetric, CTanimotoDistance, CChiSquareDistance, CBrayCurtisDistance, CChebyshewMetric, and CRealDistance.
Definition at line 5 of file DenseDistance.cpp.
|
virtualinherited |
If the SGSerializable is a class template then TRUE will be returned and GENERIC is set to the type of the generic.
generic | set to the type of the generic if returning TRUE |
Definition at line 228 of file SGObject.cpp.
|
inherited |
test whether features on lhs and rhs are the same
Definition at line 309 of file Distance.h.
|
inherited |
load the kernel matrix
loader | File object via which to load data |
Definition at line 107 of file Distance.cpp.
|
inherited |
maps all parameters of this instance to the provided file version and loads all parameter data from the file into an array, which is sorted (basically calls load_file_parameter(...) for all parameters and puts all results into a sorted array)
file_version | parameter version of the file |
current_version | version from which mapping begins (you want to use Version::get_version_parameter() for this in most cases) |
file | file to load from |
prefix | prefix for members |
Definition at line 633 of file SGObject.cpp.
|
inherited |
loads some specified parameters from a file with a specified version The provided parameter info has a version which is recursively mapped until the file parameter version is reached. Note that there may be possibly multiple parameters in the mapping, therefore, a set of TParameter instances is returned
param_info | information of parameter |
file_version | parameter version of the file, must be <= provided parameter version |
file | file to load from |
prefix | prefix for members |
Definition at line 474 of file SGObject.cpp.
|
virtualinherited |
Load this object from file. If it will fail (returning FALSE) then this object will contain inconsistent data and should not be used!
file | where to load from |
prefix | prefix for members |
param_version | (optional) a parameter version different to (this is mainly for testing, better do not use) |
Definition at line 305 of file SGObject.cpp.
|
protectedvirtualinherited |
Can (optionally) be overridden to post-initialize some member variables which are not PARAMETER::ADD'ed. Make sure that at first the overridden method BASE_CLASS::LOAD_SERIALIZABLE_POST is called.
ShogunException | Will be thrown if an error occurres. |
Reimplemented in CWeightedDegreePositionStringKernel, CKernel, CList, CAlphabet, CLinearHMM, CGaussianKernel, CInverseMultiQuadricKernel, CCircularKernel, and CExponentialKernel.
Definition at line 989 of file SGObject.cpp.
|
protectedvirtualinherited |
Can (optionally) be overridden to pre-initialize some member variables which are not PARAMETER::ADD'ed. Make sure that at first the overridden method BASE_CLASS::LOAD_SERIALIZABLE_PRE is called.
ShogunException | Will be thrown if an error occurres. |
Reimplemented in CDynamicArray< T >, CDynamicArray< float64_t >, CDynamicArray< float32_t >, CDynamicArray< int32_t >, CDynamicArray< char >, CDynamicArray< bool >, and CDynamicObjectArray.
Definition at line 984 of file SGObject.cpp.
|
inherited |
Takes a set of TParameter instances (base) with a certain version and a set of target parameter infos and recursively maps the base level wise to the current version using CSGObject::migrate(...). The base is replaced. After this call, the base version containing parameters should be of same version/type as the initial target parameter infos. Note for this to work, the migrate methods and all the internal parameter mappings have to match
param_base | set of TParameter instances that are mapped to the provided target parameter infos |
base_version | version of the parameter base |
target_param_infos | set of SGParamInfo instances that specify the target parameter base |
Definition at line 671 of file SGObject.cpp.
|
protectedvirtualinherited |
creates a new TParameter instance, which contains migrated data from the version that is provided. The provided parameter data base is used for migration, this base is a collection of all parameter data of the previous version. Migration is done FROM the data in param_base TO the provided param info Migration is always one version step. Method has to be implemented in subclasses, if no match is found, base method has to be called.
If there is an element in the param_base which equals the target, a copy of the element is returned. This represents the case when nothing has changed and therefore, the migrate method is not overloaded in a subclass
param_base | set of TParameter instances to use for migration |
target | parameter info for the resulting TParameter |
Definition at line 878 of file SGObject.cpp.
|
protectedvirtualinherited |
This method prepares everything for a one-to-one parameter migration. One to one here means that only ONE element of the parameter base is needed for the migration (the one with the same name as the target). Data is allocated for the target (in the type as provided in the target SGParamInfo), and a corresponding new TParameter instance is written to replacement. The to_migrate pointer points to the single needed TParameter instance needed for migration. If a name change happened, the old name may be specified by old_name. In addition, the m_delete_data flag of to_migrate is set to true. So if you want to migrate data, the only thing to do after this call is converting the data in the m_parameter fields. If unsure how to use - have a look into an example for this. (base_migration_type_conversion.cpp for example)
param_base | set of TParameter instances to use for migration |
target | parameter info for the resulting TParameter |
replacement | (used as output) here the TParameter instance which is returned by migration is created into |
to_migrate | the only source that is used for migration |
old_name | with this parameter, a name change may be specified |
Definition at line 818 of file SGObject.cpp.
|
inherited |
prints all parameter registered for model selection and their type
Definition at line 1036 of file SGObject.cpp.
|
virtualinherited |
prints registered parameters out
prefix | prefix for members |
Definition at line 240 of file SGObject.cpp.
|
virtualinherited |
takes all necessary steps if the lhs is removed from distance matrix
Definition at line 130 of file Distance.cpp.
|
virtualinherited |
remove lhs and rhs from distance
Definition at line 119 of file Distance.cpp.
|
virtualinherited |
takes all necessary steps if the rhs is removed from distance matrix
takes all necessary steps if the rhs is removed from distance
Definition at line 138 of file Distance.cpp.
replace left-hand side features used in distance matrix
make sure to check that your distance can deal with the supplied features (!)
lhs | features of right-hand side |
Definition at line 167 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 145 of file Distance.cpp.
|
staticprotectedinherited |
run distance thread
|
inherited |
save kernel matrix
writer | File object via which to save data |
Definition at line 113 of file Distance.cpp.
|
virtualinherited |
Save this object to file.
file | where to save the object; will be closed during returning if PREFIX is an empty string. |
prefix | prefix for members |
param_version | (optional) a parameter version different to (this is mainly for testing, better do not use) |
Definition at line 246 of file SGObject.cpp.
|
protectedvirtualinherited |
Can (optionally) be overridden to post-initialize some member variables which are not PARAMETER::ADD'ed. Make sure that at first the overridden method BASE_CLASS::SAVE_SERIALIZABLE_POST is called.
ShogunException | Will be thrown if an error occurres. |
Reimplemented in CKernel.
Definition at line 999 of file SGObject.cpp.
|
protectedvirtualinherited |
Can (optionally) be overridden to pre-initialize some member variables which are not PARAMETER::ADD'ed. Make sure that at first the overridden method BASE_CLASS::SAVE_SERIALIZABLE_PRE is called.
ShogunException | Will be thrown if an error occurres. |
Reimplemented in CKernel, CDynamicArray< T >, CDynamicArray< float64_t >, CDynamicArray< float32_t >, CDynamicArray< int32_t >, CDynamicArray< char >, CDynamicArray< bool >, and CDynamicObjectArray.
Definition at line 994 of file SGObject.cpp.
|
inherited |
Definition at line 41 of file SGObject.cpp.
|
inherited |
Definition at line 46 of file SGObject.cpp.
|
inherited |
Definition at line 51 of file SGObject.cpp.
|
inherited |
Definition at line 56 of file SGObject.cpp.
|
inherited |
Definition at line 61 of file SGObject.cpp.
|
inherited |
Definition at line 66 of file SGObject.cpp.
|
inherited |
Definition at line 71 of file SGObject.cpp.
|
inherited |
Definition at line 76 of file SGObject.cpp.
|
inherited |
Definition at line 81 of file SGObject.cpp.
|
inherited |
Definition at line 86 of file SGObject.cpp.
|
inherited |
Definition at line 91 of file SGObject.cpp.
|
inherited |
Definition at line 96 of file SGObject.cpp.
|
inherited |
Definition at line 101 of file SGObject.cpp.
|
inherited |
Definition at line 106 of file SGObject.cpp.
|
inherited |
Definition at line 111 of file SGObject.cpp.
|
inherited |
set generic type to T
|
inherited |
|
inherited |
set the parallel object
parallel | parallel object to use |
Definition at line 180 of file SGObject.cpp.
|
inherited |
set the version object
version | version object to use |
Definition at line 215 of file SGObject.cpp.
|
virtualinherited |
FIXME: precompute matrix should be dropped, handling should be via customdistance
flag | if precompute_matrix |
Definition at line 267 of file Distance.h.
|
virtualinherited |
A shallow copy. All the SGObject instance variables will be simply assigned and SG_REF-ed.
Reimplemented in CGaussianKernel.
Definition at line 117 of file SGObject.h.
|
inherited |
unset generic type
this has to be called in classes specializing a template class
Definition at line 235 of file SGObject.cpp.
|
virtualinherited |
Updates the hash of current parameter combination.
Definition at line 187 of file SGObject.cpp.
|
inherited |
io
Definition at line 473 of file SGObject.h.
|
protectedinherited |
feature vectors to occur on the left hand side
Definition at line 342 of file Distance.h.
|
inherited |
parameters wrt which we can compute gradients
Definition at line 488 of file SGObject.h.
|
inherited |
Hash of parameter values
Definition at line 494 of file SGObject.h.
|
inherited |
model selection parameters
Definition at line 485 of file SGObject.h.
|
inherited |
map for different parameter versions
Definition at line 491 of file SGObject.h.
|
inherited |
parameters
Definition at line 482 of file SGObject.h.
|
protectedinherited |
number of feature vectors on the left hand side
Definition at line 347 of file Distance.h.
|
protectedinherited |
number of feature vectors on the right hand side
Definition at line 349 of file Distance.h.
|
inherited |
parallel
Definition at line 476 of file SGObject.h.
|
protectedinherited |
FIXME: precompute matrix should be dropped, handling should be via customdistance
Definition at line 339 of file Distance.h.
|
protectedinherited |
FIXME: precompute matrix should be dropped, handling should be via customdistance
Definition at line 334 of file Distance.h.
|
protectedinherited |
feature vectors to occur on the right hand side
Definition at line 344 of file Distance.h.
|
inherited |
version
Definition at line 479 of file SGObject.h.