Class NearestCentroid, an implementation of Nearest Shrunk Centroid classifier.
To define how close examples are NearestCentroid requires a CDistance object to work with (e.g., CEuclideanDistance ).
在文件 NearestCentroid.h 第 34 行定义.
Public 属性 | |
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 成员函数 | |
virtual bool | train_machine (CFeatures *data=NULL) |
virtual void | store_model_features () |
virtual bool | is_label_valid (CLabels *lab) const |
virtual bool | train_require_labels () const |
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) |
静态 Protected 成员函数 | |
static void * | run_distance_thread_lhs (void *p) |
static void * | run_distance_thread_rhs (void *p) |
Protected 属性 | |
int32_t | m_num_classes |
number of classes (i.e. number of values labels can take) 更多... | |
float64_t | m_shrinking |
Shrinking parameter. 更多... | |
CDenseFeatures< float64_t > * | m_centroids |
The centroids of the trained features. 更多... | |
bool | m_is_trained |
Tells if the classifier has been trained or not. 更多... | |
CDistance * | distance |
float64_t | m_max_train_time |
CLabels * | m_labels |
ESolverType | m_solver_type |
bool | m_store_model_features |
bool | m_data_locked |
CNearestCentroid | ( | ) |
Default constructor
在文件 NearestCentroid.cpp 第 19 行定义.
CNearestCentroid | ( | CDistance * | distance, |
CLabels * | trainlab | ||
) |
|
virtual |
Destructor
在文件 NearestCentroid.cpp 第 33 行定义.
apply machine to data if data is not specified apply to the current features
data | (test)data to be classified |
在文件 Machine.cpp 第 160 行定义.
|
virtualinherited |
apply machine to data in means of binary classification problem
被 CKernelMachine, COnlineLinearMachine, CWDSVMOcas, CNeuralNetwork, CLinearMachine, CDomainAdaptationSVMLinear, CPluginEstimate, CGaussianProcessBinaryClassification , 以及 CBaggingMachine 重载.
在文件 Machine.cpp 第 216 行定义.
|
virtualinherited |
apply machine to data in means of latent problem
被 CLinearLatentMachine 重载.
在文件 Machine.cpp 第 240 行定义.
Applies a locked machine on a set of indices. Error if machine is not locked
indices | index vector (of locked features) that is predicted |
在文件 Machine.cpp 第 195 行定义.
|
virtualinherited |
applies a locked machine on a set of indices for binary problems
被 CKernelMachine , 以及 CMultitaskLinearMachine 重载.
在文件 Machine.cpp 第 246 行定义.
|
virtualinherited |
applies a locked machine on a set of indices for latent problems
在文件 Machine.cpp 第 274 行定义.
|
virtualinherited |
applies a locked machine on a set of indices for multiclass problems
在文件 Machine.cpp 第 260 行定义.
|
virtualinherited |
applies a locked machine on a set of indices for regression problems
被 CKernelMachine 重载.
在文件 Machine.cpp 第 253 行定义.
|
virtualinherited |
applies a locked machine on a set of indices for structured problems
在文件 Machine.cpp 第 267 行定义.
|
virtualinherited |
Classify all provided features. Cluster index with smallest distance to to be classified element is returned
data | (test)data to be classified |
重载 CMachine .
被 CKNN 重载.
在文件 DistanceMachine.cpp 第 208 行定义.
|
virtualinherited |
Apply machine to one example. Cluster index with smallest distance to to be classified element is returned
num | which example to apply machine to |
重载 CMachine .
被 CKNN 重载.
在文件 DistanceMachine.cpp 第 234 行定义.
|
virtualinherited |
apply machine to data in means of regression problem
被 CKernelMachine, CWDSVMOcas, COnlineLinearMachine, CNeuralNetwork, CCHAIDTree, CStochasticGBMachine, CCARTree, CLinearMachine, CGaussianProcessRegression , 以及 CBaggingMachine 重载.
在文件 Machine.cpp 第 222 行定义.
|
virtualinherited |
apply machine to data in means of SO classification problem
被 CLinearStructuredOutputMachine 重载.
在文件 Machine.cpp 第 234 行定义.
|
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. |
在文件 SGObject.cpp 第 1185 行定义.
|
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.
在文件 SGObject.cpp 第 1302 行定义.
Locks the machine on given labels and data. After this call, only train_locked and apply_locked may be called
Only possible if supports_locking() returns true
labs | labels used for locking |
features | features used for locking |
被 CKernelMachine 重载.
在文件 Machine.cpp 第 120 行定义.
|
virtualinherited |
Unlocks a locked machine and restores previous state
被 CKernelMachine 重载.
在文件 Machine.cpp 第 151 行定义.
|
virtualinherited |
A deep copy. All the instance variables will also be copied.
在文件 SGObject.cpp 第 146 行定义.
|
inherited |
get distance functions for lhs feature vectors going from a1 to a2 and rhs feature vector b
result | array of distance values |
idx_a1 | first feature vector a1 at idx_a1 |
idx_a2 | last feature vector a2 at idx_a2 |
idx_b | feature vector b at idx_b |
在文件 DistanceMachine.cpp 第 52 行定义.
|
inherited |
get distance functions for rhs feature vectors going from b1 to b2 and lhs feature vector a
result | array of distance values |
idx_b1 | first feature vector a1 at idx_b1 |
idx_b2 | last feature vector a2 at idx_b2 |
idx_a | feature vector a at idx_a |
在文件 DistanceMachine.cpp 第 114 行定义.
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) |
在文件 SGObject.cpp 第 1206 行定义.
CDenseFeatures<float64_t>* get_centroids | ( | ) | const |
|
virtualinherited |
get classifier type
被 CLaRank, CDualLibQPBMSOSVM, CNeuralNetwork, CCCSOSVM, CLeastAngleRegression, CLDA, CKernelRidgeRegression, CLibLinearMTL, CBaggingMachine, CLibLinear, CLibSVR, CQDA, CKMeans, CGaussianNaiveBayes, CMCLDA, CLinearRidgeRegression, CGaussianProcessBinaryClassification, CKNN, CScatterSVM, CGaussianProcessRegression, CSGDQN, CSVMSGD, CSVMOcas, COnlineSVMSGD, CMKLMulticlass, CDomainAdaptationSVMLinear, CLeastSquaresRegression, CMKLRegression, CWDSVMOcas, CHierarchical, CMKLOneClass, CLibSVM, CStochasticSOSVM, CMKLClassification, CLPBoost, CPerceptron, CAveragedPerceptron, CLPM, CNewtonSVM, CGMNPSVM, CSVMLin, CMulticlassLibSVM, CLibSVMOneClass, CGPBTSVM, CMPDSVM, CGNPPSVM , 以及 CCPLEXSVM 重载.
在文件 Machine.cpp 第 100 行定义.
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
virtualinherited |
|
virtualinherited |
returns type of problem machine solves
被 CNeuralNetwork, CRandomForest, CCHAIDTree, CCARTree , 以及 CBaseMulticlassMachine 重载.
|
inherited |
|
inherited |
在文件 SGObject.cpp 第 1077 行定义.
|
inherited |
Returns description of a given parameter string, if it exists. SG_ERROR otherwise
param_name | name of the parameter |
在文件 SGObject.cpp 第 1101 行定义.
|
inherited |
Returns index of model selection parameter with provided index
param_name | name of model selection parameter |
在文件 SGObject.cpp 第 1114 行定义.
|
virtual |
Returns the name of the SGSerializable instance.
重载 CDistanceMachine .
在文件 NearestCentroid.h 第 85 行定义.
float64_t get_shrinking | ( | ) | const |
|
inherited |
|
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 |
在文件 SGObject.cpp 第 243 行定义.
|
protectedvirtualinherited |
check whether the labels is valid.
Subclasses can override this to implement their check of label types.
lab | the labels being checked, guaranteed to be non-NULL |
被 CNeuralNetwork, CCARTree, CCHAIDTree, CGaussianProcessBinaryClassification, CGaussianProcessRegression , 以及 CBaseMulticlassMachine 重载.
|
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 |
在文件 SGObject.cpp 第 648 行定义.
|
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 |
在文件 SGObject.cpp 第 489 行定义.
|
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) |
在文件 SGObject.cpp 第 320 行定义.
|
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. |
被 CKernel, CWeightedDegreePositionStringKernel, CList, CAlphabet, CLinearHMM, CGaussianKernel, CInverseMultiQuadricKernel, CCircularKernel , 以及 CExponentialKernel 重载.
在文件 SGObject.cpp 第 1004 行定义.
|
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. |
被 CDynamicArray< T >, CDynamicArray< float64_t >, CDynamicArray< float32_t >, CDynamicArray< int32_t >, CDynamicArray< char >, CDynamicArray< bool > , 以及 CDynamicObjectArray 重载.
在文件 SGObject.cpp 第 999 行定义.
MACHINE_PROBLEM_TYPE | ( | PT_MULTICLASS | ) |
problem type
|
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 |
在文件 SGObject.cpp 第 686 行定义.
|
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 |
在文件 SGObject.cpp 第 893 行定义.
|
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 第 833 行定义.
|
virtualinherited |
在文件 SGObject.cpp 第 209 行定义.
|
inherited |
prints all parameter registered for model selection and their type
在文件 SGObject.cpp 第 1053 行定义.
|
virtualinherited |
|
staticprotectedinherited |
thread function for computing distance values
p | thread parameter |
在文件 DistanceMachine.cpp 第 176 行定义.
|
staticprotectedinherited |
thread function for computing distance values
p | thread parameter |
在文件 DistanceMachine.cpp 第 192 行定义.
|
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) |
在文件 SGObject.cpp 第 261 行定义.
|
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. |
被 CKernel 重载.
在文件 SGObject.cpp 第 1014 行定义.
|
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. |
被 CKernel, CDynamicArray< T >, CDynamicArray< float64_t >, CDynamicArray< float32_t >, CDynamicArray< int32_t >, CDynamicArray< char >, CDynamicArray< bool > , 以及 CDynamicObjectArray 重载.
在文件 SGObject.cpp 第 1009 行定义.
|
inherited |
|
inherited |
在文件 SGObject.cpp 第 38 行定义.
|
inherited |
在文件 SGObject.cpp 第 43 行定义.
|
inherited |
在文件 SGObject.cpp 第 48 行定义.
|
inherited |
在文件 SGObject.cpp 第 53 行定义.
|
inherited |
在文件 SGObject.cpp 第 58 行定义.
|
inherited |
在文件 SGObject.cpp 第 63 行定义.
|
inherited |
在文件 SGObject.cpp 第 68 行定义.
|
inherited |
在文件 SGObject.cpp 第 73 行定义.
|
inherited |
在文件 SGObject.cpp 第 78 行定义.
|
inherited |
在文件 SGObject.cpp 第 83 行定义.
|
inherited |
在文件 SGObject.cpp 第 88 行定义.
|
inherited |
在文件 SGObject.cpp 第 93 行定义.
|
inherited |
在文件 SGObject.cpp 第 98 行定义.
|
inherited |
在文件 SGObject.cpp 第 103 行定义.
|
inherited |
在文件 SGObject.cpp 第 108 行定义.
|
inherited |
set generic type to T
|
inherited |
|
inherited |
|
inherited |
|
virtualinherited |
set labels
lab | labels |
被 CNeuralNetwork, CCARTree, CGaussianProcessMachine, CStructuredOutputMachine, CRelaxedTree , 以及 CMulticlassMachine 重载.
在文件 Machine.cpp 第 73 行定义.
|
inherited |
void set_shrinking | ( | float64_t | shrinking | ) |
|
inherited |
|
virtualinherited |
Setter for store-model-features-after-training flag
store_model | whether model should be stored after training |
在文件 Machine.cpp 第 115 行定义.
|
virtualinherited |
A shallow copy. All the SGObject instance variables will be simply assigned and SG_REF-ed.
被 CGaussianKernel 重载.
在文件 SGObject.cpp 第 140 行定义.
|
protectedvirtualinherited |
Ensures cluster centers are in lhs of underlying distance
NOT IMPLEMENTED! Base method. Is called automatically after train because flag is always true for distance machines. Since every distance machine has to make sure that cluster centers are in lhs of distance variable, it is unimplemented here and HAS to be implemented in subclasses.
重载 CMachine .
被 CKNN , 以及 CHierarchical 重载.
在文件 DistanceMachine.cpp 第 276 行定义.
|
virtualinherited |
被 CKernelMachine , 以及 CMultitaskLinearMachine 重载.
|
virtualinherited |
train machine
data | training data (parameter can be avoided if distance or kernel-based classifiers are used and distance/kernels are initialized with train data). If flag is set, model features will be stored after training. |
被 CRelaxedTree, CAutoencoder, CSGDQN , 以及 COnlineSVMSGD 重载.
在文件 Machine.cpp 第 47 行定义.
Trains a locked machine on a set of indices. Error if machine is not locked
NOT IMPLEMENTED
indices | index vector (of locked features) that is used for training |
被 CKernelMachine , 以及 CMultitaskLinearMachine 重载.
|
protectedvirtual |
train Nearest Centroid classifier
data | training data (parameter can be avoided if distance or kernel-based classifiers are used and distance/kernels are initialized with train data) |
重载 CMachine .
在文件 NearestCentroid.cpp 第 49 行定义.
|
protectedvirtualinherited |
returns whether machine require labels for training
被 COnlineLinearMachine, CHierarchical, CLinearLatentMachine, CVwConditionalProbabilityTree, CConditionalProbabilityTree , 以及 CLibSVMOneClass 重载.
|
inherited |
unset generic type
this has to be called in classes specializing a template class
在文件 SGObject.cpp 第 250 行定义.
|
virtualinherited |
Updates the hash of current parameter combination
在文件 SGObject.cpp 第 196 行定义.
|
protectedinherited |
the distance
在文件 DistanceMachine.h 第 131 行定义.
|
inherited |
io
在文件 SGObject.h 第 461 行定义.
|
protected |
The centroids of the trained features.
在文件 NearestCentroid.h 第 114 行定义.
|
inherited |
parameters wrt which we can compute gradients
在文件 SGObject.h 第 476 行定义.
|
inherited |
Hash of parameter values
在文件 SGObject.h 第 482 行定义.
|
protected |
Tells if the classifier has been trained or not.
在文件 NearestCentroid.h 第 117 行定义.
|
inherited |
model selection parameters
在文件 SGObject.h 第 473 行定义.
|
protected |
number of classes (i.e. number of values labels can take)
在文件 NearestCentroid.h 第 108 行定义.
|
inherited |
map for different parameter versions
在文件 SGObject.h 第 479 行定义.
|
inherited |
parameters
在文件 SGObject.h 第 470 行定义.
|
protected |
Shrinking parameter.
在文件 NearestCentroid.h 第 111 行定义.
|
protectedinherited |
|
protectedinherited |
|
inherited |
parallel
在文件 SGObject.h 第 464 行定义.
|
inherited |
version
在文件 SGObject.h 第 467 行定义.