class HammingWordDistance
在文件 HammingWordDistance.h 第 25 行定义.
|
| CHammingWordDistance () |
|
| CHammingWordDistance (bool use_sign) |
|
| CHammingWordDistance (CStringFeatures< uint16_t > *l, CStringFeatures< uint16_t > *r, bool use_sign) |
|
virtual | ~CHammingWordDistance () |
|
virtual bool | init (CFeatures *l, CFeatures *r) |
|
virtual void | cleanup () |
|
virtual EDistanceType | get_distance_type () |
|
virtual const char * | get_name () const |
|
virtual EFeatureClass | get_feature_class () |
|
virtual 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) |
|
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 更多...
|
|
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) |
|
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 void | update_parameter_hash () |
|
virtual bool | parameter_hash_changed () |
|
virtual bool | equals (CSGObject *other, float64_t accuracy=0.0, bool tolerant=false) |
|
virtual CSGObject * | clone () |
|
constructor
- 参数
-
l | features of left-hand side |
r | features of right-hand side |
use_sign | if sign shall be used |
在文件 HammingWordDistance.cpp 第 37 行定义.
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. |
在文件 SGObject.cpp 第 1174 行定义.
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.
- 返回
- an identical copy of the given object, which is disjoint in memory. NULL if the clone fails. Note that the returned object is SG_REF'ed
在文件 SGObject.cpp 第 1291 行定义.
float64_t compute |
( |
int32_t |
idx_a, |
|
|
int32_t |
idx_b |
|
) |
| |
|
protectedvirtual |
compute kernel function for features a and b idx_{a,b} denote the index of the feature vectors in the corresponding feature object
实现了 CDistance.
在文件 HammingWordDistance.cpp 第 64 行定义.
int32_t compute_row_start |
( |
int64_t |
offs, |
|
|
int32_t |
n, |
|
|
bool |
symmetric |
|
) |
| |
|
inherited |
compute row start offset for parallel kernel matrix computation
- 参数
-
offs | offset |
n | number of columns |
symmetric | whether matrix is symmetric |
在文件 Distance.h 第 143 行定义.
A deep copy. All the instance variables will also be copied.
在文件 SGObject.h 第 126 行定义.
float64_t distance |
( |
int32_t |
idx_a, |
|
|
int32_t |
idx_b |
|
) |
| |
|
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 |
- 返回
- distance value
在文件 Distance.cpp 第 189 行定义.
virtual float64_t distance_upper_bounded |
( |
int32_t |
idx_a, |
|
|
int32_t |
idx_b, |
|
|
float64_t |
upper_bound |
|
) |
| |
|
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 |
- 返回
- distance value or upper_bound
被 CEuclideanDistance 重载.
在文件 Distance.h 第 117 行定义.
void do_precompute_matrix |
( |
| ) |
|
|
protectedinherited |
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) |
tolerant | allows linient check on float equality (within accuracy) |
- 返回
- true if all parameters were equal, false if not
在文件 SGObject.cpp 第 1195 行定义.
get distance matrix
- 返回
- computed distance matrix (needs to be cleaned up)
在文件 Distance.h 第 126 行定义.
get distance matrix (templated)
- 返回
- the distance matrix
在文件 Distance.cpp 第 317 行定义.
template void * get_distance_matrix_helper< float32_t > |
( |
void * |
p | ) |
|
|
staticinherited |
helper for computing the kernel matrix in a parallel way
- 参数
-
在文件 Distance.cpp 第 266 行定义.
get feature type the distance can deal with
- 返回
- template-specific feature type
实现了 CDistance.
get left-hand side features used in distance matrix
- 返回
- left-hand side features
在文件 Distance.h 第 194 行定义.
- 返回
- vector of names of all parameters which are registered for model selection
在文件 SGObject.cpp 第 1066 行定义.
char * get_modsel_param_descr |
( |
const char * |
param_name | ) |
|
|
inherited |
Returns description of a given parameter string, if it exists. SG_ERROR otherwise
- 参数
-
param_name | name of the parameter |
- 返回
- description of the parameter
在文件 SGObject.cpp 第 1090 行定义.
index_t get_modsel_param_index |
( |
const char * |
param_name | ) |
|
|
inherited |
Returns index of model selection parameter with provided index
- 参数
-
param_name | name of model selection parameter |
- 返回
- index of model selection parameter with provided name, -1 if there is no such
在文件 SGObject.cpp 第 1103 行定义.
virtual const char* get_name |
( |
| ) |
const |
|
virtual |
virtual int32_t get_num_vec_lhs |
( |
| ) |
|
|
virtualinherited |
virtual int32_t get_num_vec_rhs |
( |
| ) |
|
|
virtualinherited |
bool get_precompute_matrix |
( |
| ) |
|
|
inherited |
FIXME: precompute matrix should be dropped, handling should be via customdistance
- 返回
- if precompute_matrix
在文件 Distance.h 第 260 行定义.
get right-hand side features used in distance matrix
- 返回
- right-hand side features
在文件 Distance.h 第 200 行定义.
virtual bool has_features |
( |
| ) |
|
|
virtualinherited |
bool is_generic |
( |
EPrimitiveType * |
generic | ) |
const |
|
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 |
- 返回
- TRUE if a class template.
在文件 SGObject.cpp 第 234 行定义.
test whether features on lhs and rhs are the same
- 返回
- true if features are the same
在文件 Distance.h 第 309 行定义.
void load |
( |
CFile * |
loader | ) |
|
|
inherited |
load the kernel matrix
- 参数
-
loader | File object via which to load data |
在文件 Distance.cpp 第 107 行定义.
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 |
- 返回
- (sorted) array of created TParameter instances with file data
在文件 SGObject.cpp 第 639 行定义.
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 |
- 返回
- new array with TParameter instances with the attached data
在文件 SGObject.cpp 第 480 行定义.
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) |
- 返回
- TRUE if done, otherwise FALSE
在文件 SGObject.cpp 第 311 行定义.
|
protectedvirtualinherited |
|
protectedvirtualinherited |
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 |
在文件 SGObject.cpp 第 677 行定义.
|
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 |
- 返回
- a new TParameter instance with migrated data from the base of the type which is specified by the target parameter
在文件 SGObject.cpp 第 884 行定义.
|
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 |
在文件 SGObject.cpp 第 824 行定义.
bool parameter_hash_changed |
( |
| ) |
|
|
virtualinherited |
- 返回
- whether parameter combination has changed since last update
在文件 SGObject.cpp 第 200 行定义.
void print_modsel_params |
( |
| ) |
|
|
inherited |
prints all parameter registered for model selection and their type
在文件 SGObject.cpp 第 1042 行定义.
void print_serializable |
( |
const char * |
prefix = "" | ) |
|
|
virtualinherited |
takes all necessary steps if the lhs is removed from distance matrix
在文件 Distance.cpp 第 130 行定义.
void remove_lhs_and_rhs |
( |
| ) |
|
|
virtualinherited |
takes all necessary steps if the rhs is removed from distance matrix
takes all necessary steps if the rhs is removed from distance
在文件 Distance.cpp 第 138 行定义.
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 |
- 返回
- replaced left-hand side features
在文件 Distance.cpp 第 167 行定义.
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 |
- 返回
- replaced right-hand side features
在文件 Distance.cpp 第 145 行定义.
static void* run_distance_thread |
( |
void * |
p | ) |
|
|
staticprotectedinherited |
void save |
( |
CFile * |
writer | ) |
|
|
inherited |
save kernel matrix
- 参数
-
writer | File object via which to save data |
在文件 Distance.cpp 第 113 行定义.
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) |
- 返回
- TRUE if done, otherwise FALSE
在文件 SGObject.cpp 第 252 行定义.
|
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.
- 异常
-
被 CKernel 重载.
在文件 SGObject.cpp 第 1005 行定义.
|
protectedvirtualinherited |
void set_global_io |
( |
SGIO * |
io | ) |
|
|
inherited |
void set_global_parallel |
( |
Parallel * |
parallel | ) |
|
|
inherited |
set the parallel object
- 参数
-
parallel | parallel object to use |
在文件 SGObject.cpp 第 180 行定义.
void set_global_version |
( |
Version * |
version | ) |
|
|
inherited |
set the version object
- 参数
-
version | version object to use |
在文件 SGObject.cpp 第 221 行定义.
virtual void set_precompute_matrix |
( |
bool |
flag | ) |
|
|
virtualinherited |
FIXME: precompute matrix should be dropped, handling should be via customdistance
- 参数
-
在文件 Distance.h 第 267 行定义.
unset generic type
this has to be called in classes specializing a template class
在文件 SGObject.cpp 第 241 行定义.
void update_parameter_hash |
( |
| ) |
|
|
virtualinherited |
Updates the hash of current parameter combination
在文件 SGObject.cpp 第 187 行定义.
feature vectors to occur on the left hand side
在文件 Distance.h 第 342 行定义.
parameters wrt which we can compute gradients
在文件 SGObject.h 第 488 行定义.
number of feature vectors on the left hand side
在文件 Distance.h 第 347 行定义.
number of feature vectors on the right hand side
在文件 Distance.h 第 349 行定义.
FIXME: precompute matrix should be dropped, handling should be via customdistance
在文件 Distance.h 第 339 行定义.
FIXME: precompute matrix should be dropped, handling should be via customdistance
在文件 Distance.h 第 334 行定义.
feature vectors to occur on the right hand side
在文件 Distance.h 第 344 行定义.
该类的文档由以下文件生成: