SHOGUN  4.0.0
所有成员列表 | Public 成员函数 | 静态 Public 成员函数 | Public 属性 | Protected 成员函数 | 静态 Protected 成员函数 | Protected 属性
CDotKernel类 参考abstract

详细描述

Template class DotKernel is the base class for kernels working on DotFeatures.

CDotFeatures are features supporting operations like dot product, dot product with a dense vector and addition to a dense vector. Therefore several dot product based kernels derive from this class (cf., e.g., CLinearKernel)

参见
CDotFeatures

在文件 DotKernel.h31 行定义.

类 CDotKernel 继承关系图:
Inheritance graph
[图例]

Public 成员函数

 CDotKernel ()
 
 CDotKernel (int32_t cachesize)
 
 CDotKernel (CFeatures *l, CFeatures *r)
 
virtual bool init (CFeatures *l, CFeatures *r)
 
virtual EFeatureClass get_feature_class ()
 
virtual EFeatureType get_feature_type ()
 
virtual const char * get_name () const
 
virtual EKernelType get_kernel_type ()=0
 
float64_t kernel (int32_t idx_a, int32_t idx_b)
 
SGMatrix< float64_tget_kernel_matrix ()
 
template<class T >
SGMatrix< T > get_kernel_matrix ()
 
SGVector< float64_tget_kernel_diagonal (SGVector< float64_t > preallocated=SGVector< float64_t >())
 
virtual SGVector< float64_tget_kernel_col (int32_t j)
 
virtual SGVector< float64_tget_kernel_row (int32_t i)
 
virtual float64_t sum_symmetric_block (index_t block_begin, index_t block_size, bool no_diag=true)
 
virtual float64_t sum_block (index_t block_begin_row, index_t block_begin_col, index_t block_size_row, index_t block_size_col, bool no_diag=false)
 
virtual SGVector< float64_trow_wise_sum_symmetric_block (index_t block_begin, index_t block_size, bool no_diag=true)
 
virtual SGMatrix< float64_trow_wise_sum_squared_sum_symmetric_block (index_t block_begin, index_t block_size, bool no_diag=true)
 
virtual SGVector< float64_trow_col_wise_sum_block (index_t block_begin_row, index_t block_begin_col, index_t block_size_row, index_t block_size_col, bool no_diag=false)
 
virtual bool set_normalizer (CKernelNormalizer *normalizer)
 
virtual CKernelNormalizerget_normalizer ()
 
virtual bool init_normalizer ()
 
virtual void cleanup ()
 
void load (CFile *loader)
 
void save (CFile *writer)
 
CFeaturesget_lhs ()
 
CFeaturesget_rhs ()
 
virtual int32_t get_num_vec_lhs ()
 
virtual int32_t get_num_vec_rhs ()
 
virtual bool has_features ()
 
bool get_lhs_equals_rhs ()
 
virtual void remove_lhs_and_rhs ()
 
virtual void remove_lhs ()
 
virtual void remove_rhs ()
 takes all necessary steps if the rhs is removed from kernel 更多...
 
void set_cache_size (int32_t size)
 
int32_t get_cache_size ()
 
void list_kernel ()
 
bool has_property (EKernelProperty p)
 
virtual void clear_normal ()
 
virtual void add_to_normal (int32_t vector_idx, float64_t weight)
 
EOptimizationType get_optimization_type ()
 
virtual void set_optimization_type (EOptimizationType t)
 
bool get_is_initialized ()
 
virtual bool init_optimization (int32_t count, int32_t *IDX, float64_t *weights)
 
virtual bool delete_optimization ()
 
bool init_optimization_svm (CSVM *svm)
 
virtual float64_t compute_optimized (int32_t vector_idx)
 
virtual void compute_batch (int32_t num_vec, int32_t *vec_idx, float64_t *target, int32_t num_suppvec, int32_t *IDX, float64_t *alphas, float64_t factor=1.0)
 
float64_t get_combined_kernel_weight ()
 
void set_combined_kernel_weight (float64_t nw)
 
virtual int32_t get_num_subkernels ()
 
virtual void compute_by_subkernel (int32_t vector_idx, float64_t *subkernel_contrib)
 
virtual const float64_tget_subkernel_weights (int32_t &num_weights)
 
virtual SGVector< float64_tget_subkernel_weights ()
 
virtual void set_subkernel_weights (SGVector< float64_t > weights)
 
virtual SGMatrix< float64_tget_parameter_gradient (const TParameter *param, index_t index=-1)
 
virtual CSGObjectshallow_copy () const
 
virtual CSGObjectdeep_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)
 
SGIOget_global_io ()
 
void set_global_parallel (Parallel *parallel)
 
Parallelget_global_parallel ()
 
void set_global_version (Version *version)
 
Versionget_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 CSGObjectclone ()
 

静态 Public 成员函数

static CKernelobtain_from_generic (CSGObject *kernel)
 

Public 属性

SGIOio
 
Parallelparallel
 
Versionversion
 
Parameterm_parameters
 
Parameterm_model_selection_parameters
 
Parameterm_gradient_parameters
 
ParameterMapm_parameter_map
 
uint32_t m_hash
 

Protected 成员函数

virtual float64_t compute (int32_t idx_a, int32_t idx_b)
 
void set_property (EKernelProperty p)
 
void unset_property (EKernelProperty p)
 
void set_is_initialized (bool p_init)
 
int32_t compute_row_start (int64_t offs, int32_t n, bool symmetric)
 
virtual void load_serializable_post () throw (ShogunException)
 
virtual void save_serializable_pre () throw (ShogunException)
 
virtual void save_serializable_post () throw (ShogunException)
 
virtual void register_params ()
 
virtual TParametermigrate (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)
 

静态 Protected 成员函数

template<class T >
static void * get_kernel_matrix_helper (void *p)
 

Protected 属性

int32_t cache_size
 cache_size in MB 更多...
 
KERNELCACHE_ELEMkernel_matrix
 
CFeatureslhs
 feature vectors to occur on left hand side 更多...
 
CFeaturesrhs
 feature vectors to occur on right hand side 更多...
 
bool lhs_equals_rhs
 lhs 更多...
 
int32_t num_lhs
 number of feature vectors on left hand side 更多...
 
int32_t num_rhs
 number of feature vectors on right hand side 更多...
 
float64_t combined_kernel_weight
 
bool optimization_initialized
 
EOptimizationType opt_type
 
uint64_t properties
 
CKernelNormalizernormalizer
 

构造及析构函数说明

default constructor

在文件 DotKernel.h37 行定义.

CDotKernel ( int32_t  cachesize)

constructor

参数
cachesizecache size

在文件 DotKernel.h43 行定义.

CDotKernel ( CFeatures l,
CFeatures r 
)

constructor

参数
lfeatures of left-hand side
rfeatures of right-hand side

在文件 DotKernel.h50 行定义.

成员函数说明

void add_to_normal ( int32_t  vector_idx,
float64_t  weight 
)
virtualinherited

add vector*factor to 'virtual' normal vector

参数
vector_idxindex
weightweight

CCombinedKernel, CWeightedDegreeStringKernel, CWeightedDegreePositionStringKernel, CCommUlongStringKernel, CCommWordStringKernel, CLinearKernel, CLinearStringKernel , 以及 CWeightedCommWordStringKernel 重载.

在文件 Kernel.cpp352 行定义.

void build_gradient_parameter_dictionary ( CMap< TParameter *, CSGObject * > *  dict)
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.

参数
dictdictionary of parameters to be built.

在文件 SGObject.cpp1243 行定义.

void cleanup ( )
virtualinherited
void clear_normal ( )
virtualinherited

for optimizable kernels, i.e. kernels where the weight vector can be computed explicitly (if it fits into memory)

CCombinedKernel, CWeightedDegreeStringKernel, CWeightedDegreePositionStringKernel, CCommUlongStringKernel, CCommWordStringKernel, CLinearKernel , 以及 CLinearStringKernel 重载.

在文件 Kernel.cpp357 行定义.

CSGObject * clone ( )
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.

返回
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.cpp1360 行定义.

virtual 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

参数
idx_aindex a
idx_bindex b
返回
computed kernel function at indices a,b

实现了 CKernel.

CGaussianKernel, CPyramidChi2, CANOVAKernel, CLinearARDKernel, CChi2Kernel, CTensorProductPairKernel, CGaussianShiftKernel, CHistogramIntersectionKernel, CAUCKernel, CExponentialKernel, CWeightedDegreeRBFKernel, CPolyKernel, CGaussianARDKernel, CWaveletKernel, CGaussianShortRealKernel, CSigmoidKernel, CJensenShannonKernel , 以及 CSplineKernel 重载.

在文件 DotKernel.h123 行定义.

void compute_batch ( int32_t  num_vec,
int32_t *  vec_idx,
float64_t target,
int32_t  num_suppvec,
int32_t *  IDX,
float64_t alphas,
float64_t  factor = 1.0 
)
virtualinherited

computes output for a batch of examples in an optimized fashion (favorable if kernel supports it, i.e. has KP_BATCHEVALUATION. to the outputvector target (of length num_vec elements) the output for the examples enumerated in vec_idx are added. therefore make sure that it is initialized with ZERO. the following num_suppvec, IDX, alphas arguments are the number of support vectors, their indices and weights

CCombinedKernel, CWeightedDegreeStringKernel , 以及 CWeightedDegreePositionStringKernel 重载.

在文件 Kernel.cpp345 行定义.

void compute_by_subkernel ( int32_t  vector_idx,
float64_t subkernel_contrib 
)
virtualinherited

compute by subkernel

参数
vector_idxindex
subkernel_contribsubkernel contribution

CCombinedKernel, CWeightedDegreeStringKernel , 以及 CWeightedDegreePositionStringKernel 重载.

在文件 Kernel.cpp367 行定义.

float64_t compute_optimized ( int32_t  vector_idx)
virtualinherited

compute optimized

参数
vector_idxindex to compute
返回
optimized value at given index

CCombinedKernel, CWeightedDegreeStringKernel, CWeightedDegreePositionStringKernel, CCommWordStringKernel, CCommUlongStringKernel, CLinearKernel, CLinearStringKernel , 以及 CWeightedCommWordStringKernel 重载.

在文件 Kernel.cpp339 行定义.

int32_t compute_row_start ( int64_t  offs,
int32_t  n,
bool  symmetric 
)
protectedinherited

compute row start offset for parallel kernel matrix computation

参数
offsoffset
nnumber of columns
symmetricwhether matrix is symmetric

在文件 Kernel.h788 行定义.

CSGObject * deep_copy ( ) const
virtualinherited

A deep copy. All the instance variables will also be copied.

在文件 SGObject.cpp200 行定义.

bool delete_optimization ( )
virtualinherited

delete optimization

返回
if deleting was successful

CCombinedKernel, CWeightedDegreeStringKernel, CWeightedDegreePositionStringKernel, CCommWordStringKernel, CCommUlongStringKernel, CLinearKernel , 以及 CLinearStringKernel 重载.

在文件 Kernel.cpp333 行定义.

bool equals ( CSGObject other,
float64_t  accuracy = 0.0,
bool  tolerant = false 
)
virtualinherited

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.

参数
otherobject to compare with
accuracyaccuracy to use for comparison (optional)
tolerantallows linient check on float equality (within accuracy)
返回
true if all parameters were equal, false if not

在文件 SGObject.cpp1264 行定义.

int32_t get_cache_size ( )
inherited

return the size of the kernel cache

返回
size of kernel cache

在文件 Kernel.h593 行定义.

float64_t get_combined_kernel_weight ( )
inherited

get combined kernel weight

返回
combined kernel weight

在文件 Kernel.h684 行定义.

virtual EFeatureClass get_feature_class ( )
virtual

return feature class the kernel can deal with

dot kernel returns unknown since features can be based on anything

返回
feature class ANY

实现了 CKernel.

CTensorProductPairKernel, CChi2Kernel, CAUCKernel, CANOVAKernel, CLinearARDKernel , 以及 CWeightedDegreeRBFKernel 重载.

在文件 DotKernel.h88 行定义.

virtual EFeatureType get_feature_type ( )
virtual

return feature type the kernel can deal with

dot kernel returns unknown since features can be based on anything

返回
ANY feature type

实现了 CKernel.

CTensorProductPairKernel, CChi2Kernel, CAUCKernel, CLinearARDKernel, CWeightedDegreeRBFKernel , 以及 CANOVAKernel 重载.

在文件 DotKernel.h96 行定义.

SGIO * get_global_io ( )
inherited

get the io object

返回
io object

在文件 SGObject.cpp237 行定义.

Parallel * get_global_parallel ( )
inherited

get the parallel object

返回
parallel object

在文件 SGObject.cpp278 行定义.

Version * get_global_version ( )
inherited

get the version object

返回
version object

在文件 SGObject.cpp291 行定义.

bool get_is_initialized ( )
inherited

check if optimization is initialized

返回
if optimization is initialized

在文件 Kernel.h635 行定义.

virtual SGVector<float64_t> get_kernel_col ( int32_t  j)
virtualinherited

get column j

返回
the jth column of the kernel matrix

在文件 Kernel.h259 行定义.

SGVector<float64_t> get_kernel_diagonal ( SGVector< float64_t preallocated = SGVector<float64_t>())
inherited
返回
Vector with diagonal elements of the kernel matrix. Note that left- and right-handside features must be set and of equal size
参数
preallocatedvector with space for results

在文件 Kernel.h225 行定义.

template SGMatrix< float32_t > get_kernel_matrix< float32_t > ( )
inherited

get kernel matrix

返回
computed kernel matrix (needs to be cleaned up)

在文件 Kernel.h214 行定义.

SGMatrix< T > get_kernel_matrix ( )
inherited

get kernel matrix (templated)

返回
the kernel matrix

在文件 Kernel.cpp840 行定义.

template void * get_kernel_matrix_helper< float32_t > ( void *  p)
staticprotectedinherited

helper for computing the kernel matrix in a parallel way

参数
pthread parameters

在文件 Kernel.cpp789 行定义.

virtual SGVector<float64_t> get_kernel_row ( int32_t  i)
virtualinherited

get row i

返回
the ith row of the kernel matrix

在文件 Kernel.h276 行定义.

virtual EKernelType get_kernel_type ( )
pure virtual
CFeatures* get_lhs ( )
inherited

get left-hand side of features used in kernel

返回
features of left-hand side

在文件 Kernel.h501 行定义.

bool get_lhs_equals_rhs ( )
inherited

test whether features on lhs and rhs are the same

返回
true if features are the same

在文件 Kernel.h540 行定义.

SGStringList< char > get_modelsel_names ( )
inherited
返回
vector of names of all parameters which are registered for model selection

在文件 SGObject.cpp1135 行定义.

char * get_modsel_param_descr ( const char *  param_name)
inherited

Returns description of a given parameter string, if it exists. SG_ERROR otherwise

参数
param_namename of the parameter
返回
description of the parameter

在文件 SGObject.cpp1159 行定义.

index_t get_modsel_param_index ( const char *  param_name)
inherited

Returns index of model selection parameter with provided index

参数
param_namename of model selection parameter
返回
index of model selection parameter with provided name, -1 if there is no such

在文件 SGObject.cpp1172 行定义.

virtual const char* get_name ( ) const
virtual

Returns the name of the SGSerializable instance. It MUST BE the CLASS NAME without the prefixed `C'.

返回
name of the SGSerializable

实现了 CSGObject.

CGaussianKernel, CChi2Kernel, CPyramidChi2, CGaussianShiftKernel, CPolyKernel, CANOVAKernel, CTensorProductPairKernel, CWaveletKernel, CExponentialKernel, CAUCKernel, CHistogramIntersectionKernel, CSigmoidKernel, CGaussianARDKernel, CGaussianShortRealKernel, CSplineKernel, CJensenShannonKernel, CLinearKernel, CLinearARDKernel , 以及 CWeightedDegreeRBFKernel 重载.

在文件 DotKernel.h103 行定义.

CKernelNormalizer * get_normalizer ( )
virtualinherited

obtain the current kernel normalizer

返回
the kernel normalizer

在文件 Kernel.cpp136 行定义.

int32_t get_num_subkernels ( )
virtualinherited

get number of subkernels

返回
number of subkernels

CWeightedDegreeStringKernel, CWeightedDegreePositionStringKernel, CCombinedKernel , 以及 CProductKernel 重载.

在文件 Kernel.cpp362 行定义.

virtual int32_t get_num_vec_lhs ( )
virtualinherited

get number of vectors of lhs features

返回
number of vectors of left-hand side

CCustomKernel 重载.

在文件 Kernel.h513 行定义.

virtual int32_t get_num_vec_rhs ( )
virtualinherited

get number of vectors of rhs features

返回
number of vectors of right-hand side

CCustomKernel 重载.

在文件 Kernel.h522 行定义.

EOptimizationType get_optimization_type ( )
inherited

get optimization type

返回
optimization type

在文件 Kernel.h623 行定义.

virtual SGMatrix<float64_t> get_parameter_gradient ( const TParameter param,
index_t  index = -1 
)
virtualinherited

return derivative with respect to specified parameter

参数
paramthe parameter
indexthe index of the element if parameter is a vector
返回
gradient with respect to parameter

CCombinedKernel, CProductKernel, CGaussianKernel, CLinearARDKernel , 以及 CGaussianARDKernel 重载.

在文件 Kernel.h732 行定义.

CFeatures* get_rhs ( )
inherited

get right-hand side of features used in kernel

返回
features of right-hand side

在文件 Kernel.h507 行定义.

const float64_t * get_subkernel_weights ( int32_t &  num_weights)
virtualinherited

get subkernel weights

参数
num_weightsnumber of weights will be stored here
返回
subkernel weights

CCombinedKernel, CWeightedDegreeStringKernel , 以及 CWeightedDegreePositionStringKernel 重载.

在文件 Kernel.cpp373 行定义.

SGVector< float64_t > get_subkernel_weights ( )
virtualinherited

get subkernel weights (swig compatible)

返回
subkernel weights

CCombinedKernel 重载.

在文件 Kernel.cpp379 行定义.

virtual bool has_features ( )
virtualinherited

test whether features have been assigned to lhs and rhs

返回
true if features are assigned

CCustomKernel, CCombinedKernel , 以及 CProductKernel 重载.

在文件 Kernel.h531 行定义.

bool has_property ( EKernelProperty  p)
inherited

check if kernel has given property

参数
pkernel property
返回
if kernel has given property

在文件 Kernel.h605 行定义.

virtual bool init ( CFeatures l,
CFeatures r 
)
virtual

initialize kernel e.g. setup lhs/rhs of kernel, precompute normalization constants etc. make sure to check that your kernel can deal with the supplied features (!)

参数
lfeatures for left-hand side
rfeatures for right-hand side
返回
if init was successful

重载 CKernel .

CGaussianKernel, CPyramidChi2, CGaussianShiftKernel, CPolyKernel, CWaveletKernel, CTensorProductPairKernel, CAUCKernel, CChi2Kernel, CExponentialKernel, CANOVAKernel, CGaussianARDKernel, CGaussianShortRealKernel, CHistogramIntersectionKernel, CSigmoidKernel, CJensenShannonKernel, CSplineKernel, CLinearKernel, CLinearARDKernel , 以及 CWeightedDegreeRBFKernel 重载.

在文件 DotKernel.h65 行定义.

bool init_normalizer ( )
virtualinherited

initialize the current kernel normalizer

返回
if init was successful

在文件 Kernel.cpp142 行定义.

bool init_optimization ( int32_t  count,
int32_t *  IDX,
float64_t weights 
)
virtualinherited

initialize optimization

参数
countcount
IDXindex
weightsweights
返回
if initializing was successful

CCombinedKernel, CWeightedDegreeStringKernel, CWeightedDegreePositionStringKernel, CCommWordStringKernel, CCommUlongStringKernel, CLinearKernel , 以及 CLinearStringKernel 重载.

在文件 Kernel.cpp326 行定义.

bool init_optimization_svm ( CSVM svm)
inherited

initialize optimization

参数
svmsvm model
返回
if initializing was successful

在文件 Kernel.cpp409 行定义.

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.

参数
genericset to the type of the generic if returning TRUE
返回
TRUE if a class template.

在文件 SGObject.cpp297 行定义.

float64_t kernel ( int32_t  idx_a,
int32_t  idx_b 
)
inherited

get kernel function for lhs feature vector a and rhs feature vector b

参数
idx_aindex of feature vector a
idx_bindex of feature vector b
返回
computed kernel function

在文件 Kernel.h201 行定义.

void list_kernel ( )
inherited

list kernel

在文件 Kernel.cpp210 行定义.

void load ( CFile loader)
inherited

load the kernel matrix

参数
loaderFile object via which to load data

在文件 Kernel.cpp154 行定义.

DynArray< TParameter * > * load_all_file_parameters ( int32_t  file_version,
int32_t  current_version,
CSerializableFile file,
const char *  prefix = "" 
)
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_versionparameter version of the file
current_versionversion from which mapping begins (you want to use Version::get_version_parameter() for this in most cases)
filefile to load from
prefixprefix for members
返回
(sorted) array of created TParameter instances with file data

在文件 SGObject.cpp704 行定义.

DynArray< TParameter * > * load_file_parameters ( const SGParamInfo param_info,
int32_t  file_version,
CSerializableFile file,
const char *  prefix = "" 
)
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_infoinformation of parameter
file_versionparameter version of the file, must be <= provided parameter version
filefile to load from
prefixprefix for members
返回
new array with TParameter instances with the attached data

在文件 SGObject.cpp545 行定义.

bool load_serializable ( CSerializableFile file,
const char *  prefix = "",
int32_t  param_version = Version::get_version_parameter() 
)
virtualinherited

Load this object from file. If it will fail (returning FALSE) then this object will contain inconsistent data and should not be used!

参数
filewhere to load from
prefixprefix 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.cpp374 行定义.

void load_serializable_post ( )
throw (ShogunException
)
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.

异常
ShogunExceptionWill be thrown if an error occurres.

重载 CSGObject .

CWeightedDegreePositionStringKernel, CGaussianKernel, CInverseMultiQuadricKernel, CCircularKernel , 以及 CExponentialKernel 重载.

在文件 Kernel.cpp427 行定义.

void load_serializable_pre ( )
throw (ShogunException
)
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.

异常
ShogunExceptionwill be thrown if an error occurs.

CDynamicArray< T >, CDynamicArray< float64_t >, CDynamicArray< float32_t >, CDynamicArray< int32_t >, CDynamicArray< char >, CDynamicArray< bool > , 以及 CDynamicObjectArray 重载.

在文件 SGObject.cpp1057 行定义.

void map_parameters ( DynArray< TParameter * > *  param_base,
int32_t &  base_version,
DynArray< const SGParamInfo * > *  target_param_infos 
)
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_baseset of TParameter instances that are mapped to the provided target parameter infos
base_versionversion of the parameter base
target_param_infosset of SGParamInfo instances that specify the target parameter base

在文件 SGObject.cpp742 行定义.

TParameter * migrate ( DynArray< TParameter * > *  param_base,
const SGParamInfo target 
)
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_baseset of TParameter instances to use for migration
targetparameter 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.cpp949 行定义.

CKernel * obtain_from_generic ( CSGObject kernel)
staticinherited

Obtains a kernel from a generic SGObject with error checking. Note that if passing NULL, result will be NULL

参数
kernelObject to cast to CKernel, is not SG_REFed
返回
object casted to CKernel, NULL if not possible

在文件 Kernel.cpp395 行定义.

void one_to_one_migration_prepare ( DynArray< TParameter * > *  param_base,
const SGParamInfo target,
TParameter *&  replacement,
TParameter *&  to_migrate,
char *  old_name = NULL 
)
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_baseset of TParameter instances to use for migration
targetparameter info for the resulting TParameter
replacement(used as output) here the TParameter instance which is returned by migration is created into
to_migratethe only source that is used for migration
old_namewith this parameter, a name change may be specified

在文件 SGObject.cpp889 行定义.

bool parameter_hash_changed ( )
virtualinherited
返回
whether parameter combination has changed since last update

在文件 SGObject.cpp263 行定义.

void print_modsel_params ( )
inherited

prints all parameter registered for model selection and their type

在文件 SGObject.cpp1111 行定义.

void print_serializable ( const char *  prefix = "")
virtualinherited

prints registered parameters out

参数
prefixprefix for members

在文件 SGObject.cpp309 行定义.

void register_params ( )
protectedvirtualinherited

Separate the function of parameter registration This can be the first stage of a general framework for cross-validation or other parameter-based operations

CSpectrumMismatchRBFKernel, CSNPStringKernel, CANOVAKernel, CSubsequenceStringKernel, CGaussianMatchStringKernel, CGaussianShortRealKernel, CTensorProductPairKernel, CDistanceKernel , 以及 CHistogramIntersectionKernel 重载.

在文件 Kernel.cpp450 行定义.

void remove_lhs ( )
virtualinherited
void remove_lhs_and_rhs ( )
virtualinherited

remove lhs and rhs from kernel

CCombinedKernel , 以及 CProductKernel 重载.

在文件 Kernel.cpp168 行定义.

void remove_rhs ( )
virtualinherited

takes all necessary steps if the rhs is removed from kernel

remove rhs from kernel

CCombinedKernel, CCommUlongStringKernel , 以及 CProductKernel 重载.

在文件 Kernel.cpp197 行定义.

SGVector< float64_t > row_col_wise_sum_block ( index_t  block_begin_row,
index_t  block_begin_col,
index_t  block_size_row,
index_t  block_size_col,
bool  no_diag = false 
)
virtualinherited

Computes row-wise/col-wise sum of kernel values. This method is useful while computing statistical estimation of mean/variance over kernel values but the kernel matrix is too huge to be fit inside memory.

参数
block_begin_rowthe row index at which the block starts
block_begin_colthe col index at which the block starts
block_size_rowthe number of rows in the block
block_size_colthe number of cols in the block

For Example, block_begin_row 0, block_begin_col 4 and block_size_row 5, block_size_col 6 represents the block that starts at index (0,4) in the kernel matrix and goes upto (0+5-1,4+6-1) i.e. (4,9) both inclusive

参数
no_diagif true (default is false), the diagonal elements are excluded from the row/col-wise sum, provided that block_size_row and block_size_col are same (i.e. the block is square). Otherwise, these are always added
返回
a vector whose first block_size_row entries contain row-wise sum of kernel values computed as

\[ v[i]=\sum_{j}k(i+\text{block-begin-row}, j+\text{block-begin-col}) \]

and rest block_size_col entries col-wise sum of kernel values computed as

\[ v[\text{block-size-row}+j]=\sum_{i}k(i+\text{block-begin-row}, j+\text{block-begin-col}) \]

where \(i\in[0,\text{block-size-row}-1]\) and \(j\in[0,\text{block-size-col}-1]\)

在文件 Kernel.cpp735 行定义.

SGMatrix< float64_t > row_wise_sum_squared_sum_symmetric_block ( index_t  block_begin,
index_t  block_size,
bool  no_diag = true 
)
virtualinherited

Computes row-wise/col-wise sum and squared sum of kernel values from a symmetric part of the kernel matrix that always is supposed to contain the main upper diagonal. This method is useful while computing statistical estimation of mean/variance over kernel values but the kernel matrix is too huge to be fit inside memory.

参数
block_beginthe row and col index at which the block starts
block_sizethe number of rows and cols in the block

For Example, block_begin 4 and block_size 5 represents the block that starts at index (4,4) in the kernel matrix and goes upto (4+5-1,4+5-1) i.e. (8,8) both inclusive

参数
no_diagif true (default), the diagonal elements are excluded from the row/col-wise sum
返回
a matrix whose first column contains the row-wise sum of kernel values computed as

\[ v_0[i]=\sum_{j}k(i+\text{block-begin}, j+\text{block-begin}) \]

and second column contains the row-wise sum of squared kernel values

\[ v_1[i]=\sum_{j}^k^2(i+\text{block-begin}, j+\text{block-begin}) \]

where \(i,j\in[0,\text{block-size}-1]\)

在文件 Kernel.cpp676 行定义.

SGVector< float64_t > row_wise_sum_symmetric_block ( index_t  block_begin,
index_t  block_size,
bool  no_diag = true 
)
virtualinherited

Computes row-wise/col-wise sum from a symmetric part of the kernel matrix that always is supposed to contain the main upper diagonal. This method is useful while computing statistical estimation of mean/variance over kernel values but the kernel matrix is too huge to be fit inside memory.

参数
block_beginthe row and col index at which the block starts
block_sizethe number of rows and cols in the block

For Example, block_begin 4 and block_size 5 represents the block that starts at index (4,4) in the kernel matrix and goes upto (4+5-1,4+5-1) i.e. (8,8) both inclusive

参数
no_diagif true (default), the diagonal elements are excluded from the row/col-wise sum
返回
vector containing row-wise sum computed as

\[ v[i]=\sum_{j}k(i+\text{block-begin}, j+\text{block-begin}) \]

where \(i,j\in[0,\text{block-size}-1]\)

在文件 Kernel.cpp622 行定义.

void save ( CFile writer)
inherited

save kernel matrix

参数
writerFile object via which to save data

在文件 Kernel.cpp160 行定义.

bool save_serializable ( CSerializableFile file,
const char *  prefix = "",
int32_t  param_version = Version::get_version_parameter() 
)
virtualinherited

Save this object to file.

参数
filewhere to save the object; will be closed during returning if PREFIX is an empty string.
prefixprefix 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.cpp315 行定义.

void save_serializable_post ( )
throw (ShogunException
)
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.

异常
ShogunExceptionWill be thrown if an error occurres.

重载 CSGObject .

在文件 Kernel.cpp442 行定义.

void save_serializable_pre ( )
throw (ShogunException
)
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.

异常
ShogunExceptionWill be thrown if an error occurres.

重载 CSGObject .

在文件 Kernel.cpp434 行定义.

void set_cache_size ( int32_t  size)
inherited

set the size of the kernel cache

参数
sizeof kernel cache

在文件 Kernel.h583 行定义.

void set_combined_kernel_weight ( float64_t  nw)
inherited

set combined kernel weight

参数
nwnew combined kernel weight

在文件 Kernel.h690 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp42 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp47 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp52 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp57 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp62 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp67 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp72 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp77 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp82 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp87 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp92 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp97 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp102 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp107 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp112 行定义.

void set_generic ( )
inherited

set generic type to T

void set_global_io ( SGIO io)
inherited

set the io object

参数
ioio object to use

在文件 SGObject.cpp230 行定义.

void set_global_parallel ( Parallel parallel)
inherited

set the parallel object

参数
parallelparallel object to use

在文件 SGObject.cpp243 行定义.

void set_global_version ( Version version)
inherited

set the version object

参数
versionversion object to use

在文件 SGObject.cpp284 行定义.

void set_is_initialized ( bool  p_init)
protectedinherited

set is initialized

参数
p_initif optimization shall be set to initialized

在文件 Kernel.h768 行定义.

bool set_normalizer ( CKernelNormalizer normalizer)
virtualinherited

set the current kernel normalizer

返回
if successful

CWeightedDegreeStringKernel 重载.

在文件 Kernel.cpp124 行定义.

virtual void set_optimization_type ( EOptimizationType  t)
virtualinherited

set optimization type

参数
toptimization type to set

CCombinedKernel 重载.

在文件 Kernel.h629 行定义.

void set_property ( EKernelProperty  p)
protectedinherited

set property

参数
pkernel property to set

在文件 Kernel.h750 行定义.

void set_subkernel_weights ( SGVector< float64_t weights)
virtualinherited

set subkernel weights

参数
weightsnew subkernel weights

CCombinedKernel, CWeightedDegreeStringKernel , 以及 CWeightedDegreePositionStringKernel 重载.

在文件 Kernel.cpp386 行定义.

CSGObject * shallow_copy ( ) const
virtualinherited

A shallow copy. All the SGObject instance variables will be simply assigned and SG_REF-ed.

CGaussianKernel 重载.

在文件 SGObject.cpp194 行定义.

float64_t sum_block ( index_t  block_begin_row,
index_t  block_begin_col,
index_t  block_size_row,
index_t  block_size_col,
bool  no_diag = false 
)
virtualinherited

Computes sum of kernel values from a specified block. This method is useful while computing statistical estimation of mean/variance over kernel values but the kernel matrix is too huge to be fit inside memory.

参数
block_begin_rowthe row index at which the block starts
block_begin_colthe col index at which the block starts
block_size_rowthe number of rows in the block
block_size_colthe number of cols in the block

For example, block_begin_row 0, block_begin_col 4 and block_size_row 5, block_size_col 6 represents the block that starts at index (0,4) in the kernel matrix and goes upto (0+5-1,4+6-1) i.e. (4,9) both inclusive

参数
no_diagif true (default is false), the diagonal elements are excluded from the sum, provided that block_size_row and block_size_col are same (i.e. the block is square). Otherwise, these are always added
返回
sum of kernel values within the block computed as

\[ \sum_{i}\sum_{j}k(i+\text{block-begin-row}, j+\text{block-begin-col}) \]

where \(i\in[0,\text{block-size-row}-1]\) and \(j\in[0,\text{block-size-col}-1]\)

在文件 Kernel.cpp576 行定义.

float64_t sum_symmetric_block ( index_t  block_begin,
index_t  block_size,
bool  no_diag = true 
)
virtualinherited

Computes sum from a symmetric part of the kernel matrix that always is supposed to contain the main upper diagonal. This method is useful while computing statistical estimation of mean/variance over kernel values but the kernel matrix is too huge to be fit inside memory.

参数
block_beginthe row and col index at which the block starts
block_sizethe number of rows and cols in the block

For example, block_begin 4 and block_size 5 represents the block that starts at index (4,4) in the kernel matrix and goes upto (4+5-1,4+5-1) i.e. (8,8) both inclusive

参数
no_diagif true (default), the diagonal elements are excluded from the sum
返回
sum of kernel values within the block computed as

\[ \sum_{i}\sum_{j}k(i+\text{block-begin}, j+\text{block-begin}) \]

where \(i,j\in[0,\text{block-size}-1]\)

在文件 Kernel.cpp523 行定义.

void unset_generic ( )
inherited

unset generic type

this has to be called in classes specializing a template class

在文件 SGObject.cpp304 行定义.

void unset_property ( EKernelProperty  p)
protectedinherited

unset property

参数
pkernel property to unset

在文件 Kernel.h759 行定义.

void update_parameter_hash ( )
virtualinherited

Updates the hash of current parameter combination

在文件 SGObject.cpp250 行定义.

类成员变量说明

int32_t cache_size
protectedinherited

cache_size in MB

在文件 Kernel.h853 行定义.

float64_t combined_kernel_weight
protectedinherited

combined kernel weight

在文件 Kernel.h875 行定义.

SGIO* io
inherited

io

在文件 SGObject.h496 行定义.

KERNELCACHE_ELEM* kernel_matrix
protectedinherited

this COULD store the whole kernel matrix usually not applicable / necessary to compute the whole matrix

在文件 Kernel.h859 行定义.

CFeatures* lhs
protectedinherited

feature vectors to occur on left hand side

在文件 Kernel.h862 行定义.

bool lhs_equals_rhs
protectedinherited

lhs

在文件 Kernel.h867 行定义.

Parameter* m_gradient_parameters
inherited

parameters wrt which we can compute gradients

在文件 SGObject.h511 行定义.

uint32_t m_hash
inherited

Hash of parameter values

在文件 SGObject.h517 行定义.

Parameter* m_model_selection_parameters
inherited

model selection parameters

在文件 SGObject.h508 行定义.

ParameterMap* m_parameter_map
inherited

map for different parameter versions

在文件 SGObject.h514 行定义.

Parameter* m_parameters
inherited

parameters

在文件 SGObject.h505 行定义.

CKernelNormalizer* normalizer
protectedinherited

normalize the kernel(i,j) function based on this normalization function

在文件 Kernel.h889 行定义.

int32_t num_lhs
protectedinherited

number of feature vectors on left hand side

在文件 Kernel.h870 行定义.

int32_t num_rhs
protectedinherited

number of feature vectors on right hand side

在文件 Kernel.h872 行定义.

EOptimizationType opt_type
protectedinherited

optimization type (currently FASTBUTMEMHUNGRY and SLOWBUTMEMEFFICIENT)

在文件 Kernel.h882 行定义.

bool optimization_initialized
protectedinherited

if optimization is initialized

在文件 Kernel.h878 行定义.

Parallel* parallel
inherited

parallel

在文件 SGObject.h499 行定义.

uint64_t properties
protectedinherited

kernel properties

在文件 Kernel.h885 行定义.

CFeatures* rhs
protectedinherited

feature vectors to occur on right hand side

在文件 Kernel.h864 行定义.

Version* version
inherited

version

在文件 SGObject.h502 行定义.


该类的文档由以下文件生成:

SHOGUN 机器学习工具包 - 项目文档