The Combined kernel is used to combine a number of kernels into a single CombinedKernel object by linear combination.
It keeps pointers to the added sub-kernels 
and for each sub-kernel - a kernel specific weight 
.
It is especially useful to combine kernels working on different domains and to combine kernels looking at independent features and requires CCombinedFeatures to be used.
It is defined as:
![\[ k_{combined}({\bf x}, {\bf x'}) = \sum_{m=1}^M \beta_m k_m({\bf x}, {\bf x'}) \]](form_114.png)
Definition at line 46 of file CombinedKernel.h.
Public Member Functions | |
| CCombinedKernel (int32_t size=10, bool append_subkernel_weights=false) | |
| virtual | ~CCombinedKernel () |
| virtual bool | init (CFeatures *lhs, CFeatures *rhs) |
| virtual void | cleanup () |
| virtual EKernelType | get_kernel_type () |
| virtual EFeatureType | get_feature_type () |
| virtual EFeatureClass | get_feature_class () |
| virtual const char * | get_name () const |
| void | list_kernels () |
| CKernel * | get_first_kernel () |
| CKernel * | get_first_kernel (CListElement *¤t) |
| CKernel * | get_kernel (int32_t idx) |
| CKernel * | get_last_kernel () |
| CKernel * | get_next_kernel () |
| CKernel * | get_next_kernel (CListElement *¤t) |
| bool | insert_kernel (CKernel *k) |
| bool | append_kernel (CKernel *k) |
| bool | delete_kernel () |
| bool | get_append_subkernel_weights () |
| int32_t | get_num_subkernels () |
| virtual bool | has_features () |
| virtual void | remove_lhs () |
| virtual void | remove_rhs () |
| virtual void | remove_lhs_and_rhs () |
| virtual bool | init_optimization (int32_t count, int32_t *IDX, float64_t *weights) |
| virtual bool | delete_optimization () |
| virtual float64_t | compute_optimized (int32_t 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) |
| void | emulate_compute_batch (CKernel *k, int32_t num_vec, int32_t *vec_idx, float64_t *target, int32_t num_suppvec, int32_t *IDX, float64_t *weights) |
| virtual void | add_to_normal (int32_t idx, float64_t weight) |
| virtual void | clear_normal () |
| virtual void | compute_by_subkernel (int32_t idx, float64_t *subkernel_contrib) |
| virtual const float64_t * | get_subkernel_weights (int32_t &num_weights) |
| virtual SGVector< float64_t > | get_subkernel_weights () |
| virtual void | set_subkernel_weights (SGVector< float64_t > weights) |
| virtual void | set_optimization_type (EOptimizationType t) |
| bool | precompute_subkernels () |
| CCombinedKernel * | KernelToCombinedKernel (shogun::CKernel *n) |
| SGMatrix< float64_t > | get_parameter_gradient (TParameter *param, CSGObject *obj, index_t index) |
| CList * | get_list () |
| float64_t | kernel (int32_t idx_a, int32_t idx_b) |
| SGMatrix< float64_t > | get_kernel_matrix () |
| template<class T > | |
| SGMatrix< T > | get_kernel_matrix () |
| SGVector< float64_t > | get_kernel_diagonal () |
| virtual SGVector< float64_t > | get_kernel_col (int32_t j) |
| virtual SGVector< float64_t > | get_kernel_row (int32_t i) |
| void | get_kernel_row (int32_t docnum, int32_t *active2dnum, float64_t *buffer, bool full_line=false) |
| virtual bool | set_normalizer (CKernelNormalizer *normalizer) |
| virtual CKernelNormalizer * | get_normalizer () |
| virtual bool | init_normalizer () |
| void | load (CFile *loader) |
| void | save (CFile *writer) |
| CFeatures * | get_lhs () |
| CFeatures * | get_rhs () |
| virtual int32_t | get_num_vec_lhs () |
| virtual int32_t | get_num_vec_rhs () |
| bool | get_lhs_equals_rhs () |
| void | set_cache_size (int32_t size) |
| int32_t | get_cache_size () |
| void | cache_reset () |
| int32_t | get_max_elems_cache () |
| int32_t | get_activenum_cache () |
| void | cache_kernel_row (int32_t x) |
| void | cache_multiple_kernel_rows (int32_t *key, int32_t varnum) |
| void | kernel_cache_reset_lru () |
| void | kernel_cache_shrink (int32_t totdoc, int32_t num_shrink, int32_t *after) |
| void | resize_kernel_cache (KERNELCACHE_IDX size, bool regression_hack=false) |
| void | set_time (int32_t t) |
| int32_t | kernel_cache_touch (int32_t cacheidx) |
| int32_t | kernel_cache_check (int32_t cacheidx) |
| int32_t | kernel_cache_space_available () |
| void | kernel_cache_init (int32_t size, bool regression_hack=false) |
| void | kernel_cache_cleanup () |
| void | list_kernel () |
| bool | has_property (EKernelProperty p) |
| EOptimizationType | get_optimization_type () |
| bool | get_is_initialized () |
| bool | init_optimization_svm (CSVM *svm) |
| float64_t | get_combined_kernel_weight () |
| void | set_combined_kernel_weight (float64_t nw) |
| virtual CSGObject * | shallow_copy () const |
| virtual CSGObject * | deep_copy () const |
| virtual bool | is_generic (EPrimitiveType *generic) const |
| template<class T > | |
| 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_PARAMETER) |
| virtual bool | load_serializable (CSerializableFile *file, const char *prefix="", int32_t param_version=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_parameter_dictionary (CMap< TParameter *, CSGObject * > &dict) |
Static Public Member Functions | |
| static void * | compute_optimized_kernel_helper (void *p) |
| static void * | compute_kernel_helper (void *p) |
Public Attributes | |
| SGIO * | io |
| Parallel * | parallel |
| Version * | version |
| Parameter * | m_parameters |
| Parameter * | m_model_selection_parameters |
| ParameterMap * | m_parameter_map |
| uint32_t | m_hash |
Protected Member Functions | |
| virtual float64_t | compute (int32_t x, int32_t y) |
| void | adjust_num_lhs_rhs_initialized (CKernel *k) |
| 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 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 bool | update_parameter_hash () |
Static Protected Member Functions | |
| template<class T > | |
| static void * | get_kernel_matrix_helper (void *p) |
Protected Attributes | |
| CList * | kernel_list |
| int32_t | sv_count |
| int32_t * | sv_idx |
| float64_t * | sv_weight |
| float64_t * | subkernel_weights_buffer |
| bool | append_subkernel_weights |
| bool | initialized |
| int32_t | cache_size |
| cache_size in MB | |
| KERNEL_CACHE | kernel_cache |
| kernel cache | |
| KERNELCACHE_ELEM * | kernel_matrix |
| CFeatures * | lhs |
| feature vectors to occur on left hand side | |
| CFeatures * | rhs |
| 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 |
| CKernelNormalizer * | normalizer |
| CCombinedKernel | ( | int32_t | size = 10, |
|
| bool | append_subkernel_weights = false | |||
| ) |
constructor
| size | cache size | |
| append_subkernel_weights | if subkernel weights shall be appended |
Definition at line 44 of file CombinedKernel.cpp.
| ~CCombinedKernel | ( | ) | [virtual] |
Definition at line 55 of file CombinedKernel.cpp.
| void add_to_normal | ( | int32_t | idx, | |
| float64_t | weight | |||
| ) | [virtual] |
add to normal vector
| idx | where to add | |
| weight | what to add |
Reimplemented from CKernel.
Definition at line 578 of file CombinedKernel.cpp.
| void adjust_num_lhs_rhs_initialized | ( | CKernel * | k | ) | [protected] |
adjust the variables num_lhs, num_rhs and initialized based on the kernel to be appended/inserted
| k | kernel |
Definition at line 416 of file CombinedKernel.h.
| bool append_kernel | ( | CKernel * | k | ) |
append kernel
| k | kernel |
Definition at line 190 of file CombinedKernel.h.
| void build_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.
| dict | dictionary of parameters to be built. |
Definition at line 1201 of file SGObject.cpp.
| void cache_kernel_row | ( | int32_t | x | ) | [inherited] |
| void cache_multiple_kernel_rows | ( | int32_t * | key, | |
| int32_t | varnum | |||
| ) | [inherited] |
| void cleanup | ( | ) | [virtual] |
| void clear_normal | ( | ) | [virtual] |
| float64_t compute | ( | int32_t | x, | |
| int32_t | y | |||
| ) | [protected, virtual] |
compute kernel function
| x | x | |
| y | y |
Implements CKernel.
Definition at line 242 of file CombinedKernel.cpp.
| 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 | |||
| ) | [virtual] |
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
Reimplemented from CKernel.
Definition at line 335 of file CombinedKernel.cpp.
| void compute_by_subkernel | ( | int32_t | idx, | |
| float64_t * | subkernel_contrib | |||
| ) | [virtual] |
compute by subkernel
| idx | index | |
| subkernel_contrib | subkernel contribution |
Reimplemented from CKernel.
Definition at line 606 of file CombinedKernel.cpp.
| void * compute_kernel_helper | ( | void * | p | ) | [static] |
helper for compute kernel
| p | thread parameter |
Definition at line 382 of file CombinedKernel.cpp.
| float64_t compute_optimized | ( | int32_t | idx | ) | [virtual] |
compute optimized
| idx | index to compute |
Reimplemented from CKernel.
Definition at line 533 of file CombinedKernel.cpp.
| void * compute_optimized_kernel_helper | ( | void * | p | ) | [static] |
helper for compute optimized kernel
| p | thread parameter |
Definition at line 369 of file CombinedKernel.cpp.
| int32_t compute_row_start | ( | int64_t | offs, | |
| int32_t | n, | |||
| bool | symmetric | |||
| ) | [protected, inherited] |
| virtual CSGObject* deep_copy | ( | ) | const [virtual, inherited] |
A deep copy. All the instance variables will also be copied.
Definition at line 131 of file SGObject.h.
| bool delete_kernel | ( | ) |
| bool delete_optimization | ( | ) | [virtual] |
delete optimization
Reimplemented from CKernel.
Definition at line 309 of file CombinedKernel.cpp.
| void emulate_compute_batch | ( | CKernel * | k, | |
| int32_t | num_vec, | |||
| int32_t * | vec_idx, | |||
| float64_t * | target, | |||
| int32_t | num_suppvec, | |||
| int32_t * | IDX, | |||
| float64_t * | weights | |||
| ) |
emulates batch computation, via linadd optimization w^t x or even down to sum_i alpha_i K(x_i,x)
| k | kernel | |
| num_vec | number of vectors | |
| vec_idx | vector index | |
| target | target | |
| num_suppvec | number of support vectors | |
| IDX | IDX | |
| weights | weights |
Definition at line 404 of file CombinedKernel.cpp.
| int32_t get_activenum_cache | ( | ) | [inherited] |
| bool get_append_subkernel_weights | ( | ) |
check if subkernel weights are appended
Definition at line 224 of file CombinedKernel.h.
| int32_t get_cache_size | ( | ) | [inherited] |
| float64_t get_combined_kernel_weight | ( | ) | [inherited] |
| virtual EFeatureClass get_feature_class | ( | ) | [virtual] |
return feature class the kernel can deal with
Implements CKernel.
Definition at line 92 of file CombinedKernel.h.
| virtual EFeatureType get_feature_type | ( | ) | [virtual] |
return feature type the kernel can deal with
Implements CKernel.
Definition at line 83 of file CombinedKernel.h.
| CKernel* get_first_kernel | ( | ) |
| CKernel* get_first_kernel | ( | CListElement *& | current | ) |
get first kernel
| current |
Definition at line 120 of file CombinedKernel.h.
| SGIO * get_global_io | ( | ) | [inherited] |
| Parallel * get_global_parallel | ( | ) | [inherited] |
| Version * get_global_version | ( | ) | [inherited] |
| bool get_is_initialized | ( | ) | [inherited] |
| CKernel* get_kernel | ( | int32_t | idx | ) |
get kernel
| idx | index of kernel |
Definition at line 130 of file CombinedKernel.h.
| SGMatrix<T> get_kernel_matrix | ( | ) | [inherited] |
| static void* get_kernel_matrix_helper | ( | void * | p | ) | [static, protected, inherited] |
| void get_kernel_row | ( | int32_t | docnum, | |
| int32_t * | active2dnum, | |||
| float64_t * | buffer, | |||
| bool | full_line = false | |||
| ) | [inherited] |
get kernel row
| docnum | docnum | |
| active2dnum | active2dnum | |
| buffer | buffer | |
| full_line | full line |
Definition at line 229 of file Kernel.cpp.
| virtual EKernelType get_kernel_type | ( | ) | [virtual] |
return what type of kernel we are
Implements CKernel.
Definition at line 74 of file CombinedKernel.h.
| CKernel* get_last_kernel | ( | ) |
| CFeatures* get_lhs | ( | ) | [inherited] |
| bool get_lhs_equals_rhs | ( | ) | [inherited] |
| CList* get_list | ( | ) |
| int32_t get_max_elems_cache | ( | ) | [inherited] |
| SGStringList< char > get_modelsel_names | ( | ) | [inherited] |
Definition at line 1108 of file SGObject.cpp.
| 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 |
Definition at line 1132 of file SGObject.cpp.
| 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 |
Definition at line 1145 of file SGObject.cpp.
| virtual const char* get_name | ( | ) | const [virtual] |
return the kernel's name
Implements CSGObject.
Definition at line 101 of file CombinedKernel.h.
| CKernel* get_next_kernel | ( | ) |
| CKernel* get_next_kernel | ( | CListElement *& | current | ) |
get next kernel multi-thread safe
| current |
Definition at line 164 of file CombinedKernel.h.
| CKernelNormalizer * get_normalizer | ( | ) | [virtual, inherited] |
obtain the current kernel normalizer
Definition at line 153 of file Kernel.cpp.
| int32_t get_num_subkernels | ( | ) | [virtual] |
get number of subkernels
Reimplemented from CKernel.
Definition at line 233 of file CombinedKernel.h.
| virtual int32_t get_num_vec_lhs | ( | ) | [virtual, inherited] |
get number of vectors of lhs features
Reimplemented in CCustomKernel.
| virtual int32_t get_num_vec_rhs | ( | ) | [virtual, inherited] |
get number of vectors of rhs features
Reimplemented in CCustomKernel.
| EOptimizationType get_optimization_type | ( | ) | [inherited] |
| SGMatrix< float64_t > get_parameter_gradient | ( | TParameter * | param, | |
| CSGObject * | obj, | |||
| index_t | index | |||
| ) | [virtual] |
return derivative with respect to specified parameter
| param | the parameter | |
| obj | the object that owns the parameter | |
| index | the index of the element if parameter is a vector |
Reimplemented from CKernel.
Definition at line 803 of file CombinedKernel.cpp.
| CFeatures* get_rhs | ( | ) | [inherited] |
| const float64_t * get_subkernel_weights | ( | int32_t & | num_weights | ) | [virtual] |
get subkernel weights
| num_weights | where number of weights is stored |
Reimplemented from CKernel.
Definition at line 645 of file CombinedKernel.cpp.
get subkernel weights (swig compatible)
Definition at line 693 of file CombinedKernel.cpp.
| virtual bool has_features | ( | ) | [virtual] |
test whether features have been assigned to lhs and rhs
Reimplemented from CKernel.
Definition at line 257 of file CombinedKernel.h.
| bool has_property | ( | EKernelProperty | p | ) | [inherited] |
initialize kernel
| lhs | features of left-hand side | |
| rhs | features of right-hand side |
Reimplemented from CKernel.
Definition at line 66 of file CombinedKernel.cpp.
| bool init_normalizer | ( | ) | [virtual, inherited] |
initialize the current kernel normalizer
Definition at line 159 of file Kernel.cpp.
| bool init_optimization | ( | int32_t | count, | |
| int32_t * | IDX, | |||
| float64_t * | weights | |||
| ) | [virtual] |
initialize optimization
| count | count | |
| IDX | index | |
| weights | weights |
Reimplemented from CKernel.
Definition at line 258 of file CombinedKernel.cpp.
| bool init_optimization_svm | ( | CSVM * | svm | ) | [inherited] |
initialize optimization
| svm | svm model |
Definition at line 871 of file Kernel.cpp.
| bool insert_kernel | ( | CKernel * | k | ) |
insert kernel
| k | kernel |
Definition at line 174 of file CombinedKernel.h.
| bool is_generic | ( | EPrimitiveType * | generic | ) | const [virtual, inherited] |
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 278 of file SGObject.cpp.
| float64_t kernel | ( | int32_t | idx_a, | |
| int32_t | idx_b | |||
| ) | [inherited] |
| int32_t kernel_cache_check | ( | int32_t | cacheidx | ) | [inherited] |
| void kernel_cache_cleanup | ( | ) | [inherited] |
cleanup kernel cache
Definition at line 555 of file Kernel.cpp.
| void kernel_cache_init | ( | int32_t | size, | |
| bool | regression_hack = false | |||
| ) | [inherited] |
initialize kernel cache
| size | size to initialize to | |
| regression_hack | if hack for regression shall be applied |
Definition at line 172 of file Kernel.cpp.
| void kernel_cache_reset_lru | ( | ) | [inherited] |
kernel cache reset lru
Definition at line 542 of file Kernel.cpp.
| void kernel_cache_shrink | ( | int32_t | totdoc, | |
| int32_t | num_shrink, | |||
| int32_t * | after | |||
| ) | [inherited] |
kernel cache shrink
| totdoc | totdoc | |
| num_shrink | number of shrink | |
| after | after |
Definition at line 486 of file Kernel.cpp.
| int32_t kernel_cache_space_available | ( | ) | [inherited] |
| int32_t kernel_cache_touch | ( | int32_t | cacheidx | ) | [inherited] |
| CCombinedKernel* KernelToCombinedKernel | ( | shogun::CKernel * | n | ) |
casts kernel to combined kernel
| n | kernel to cast |
Definition at line 380 of file CombinedKernel.h.
| void list_kernel | ( | ) | [inherited] |
list kernel
Definition at line 696 of file Kernel.cpp.
| void list_kernels | ( | ) |
list kernels
Definition at line 224 of file CombinedKernel.cpp.
| void load | ( | CFile * | loader | ) | [inherited] |
load the kernel matrix
| loader | File object via which to load data |
Definition at line 634 of file Kernel.cpp.
| 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_version | parameter version of the file | |
| current_version | version from which mapping begins (you want to use VERSION_PARAMETER for this in most cases) | |
| file | file to load from | |
| prefix | prefix for members |
Definition at line 679 of file SGObject.cpp.
| 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_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 523 of file SGObject.cpp.
| bool load_serializable | ( | CSerializableFile * | file, | |
| const char * | prefix = "", |
|||
| int32_t | param_version = VERSION_PARAMETER | |||
| ) | [virtual, inherited] |
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) |
Reimplemented in CModelSelectionParameters.
Definition at line 354 of file SGObject.cpp.
| void load_serializable_post | ( | ) | throw (ShogunException) [protected, virtual, inherited] |
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 from CSGObject.
Reimplemented in CANOVAKernel, CCircularKernel, CExponentialKernel, CGaussianKernel, CInverseMultiQuadricKernel, and CWeightedDegreePositionStringKernel.
Definition at line 889 of file Kernel.cpp.
| void load_serializable_pre | ( | ) | throw (ShogunException) [protected, virtual, inherited] |
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. |
Definition at line 1028 of file SGObject.cpp.
| 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_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 717 of file SGObject.cpp.
| TParameter * migrate | ( | DynArray< TParameter * > * | param_base, | |
| const SGParamInfo * | target | |||
| ) | [protected, virtual, inherited] |
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 923 of file SGObject.cpp.
| void one_to_one_migration_prepare | ( | DynArray< TParameter * > * | param_base, | |
| const SGParamInfo * | target, | |||
| TParameter *& | replacement, | |||
| TParameter *& | to_migrate, | |||
| char * | old_name = NULL | |||
| ) | [protected, virtual, inherited] |
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 864 of file SGObject.cpp.
| bool precompute_subkernels | ( | ) |
precompute all sub-kernels
Definition at line 755 of file CombinedKernel.cpp.
| void print_modsel_params | ( | ) | [inherited] |
prints all parameter registered for model selection and their type
Definition at line 1084 of file SGObject.cpp.
| void print_serializable | ( | const char * | prefix = "" |
) | [virtual, inherited] |
prints registered parameters out
| prefix | prefix for members |
Definition at line 290 of file SGObject.cpp.
| void register_params | ( | ) | [protected, virtual, inherited] |
Separate the function of parameter registration This can be the first stage of a *general* framework for cross-validation or other parameter-based operations
Reimplemented in CANOVAKernel, CDistanceKernel, CGaussianShortRealKernel, CHistogramIntersectionKernel, CGaussianMatchStringKernel, CRegulatoryModulesStringKernel, CSNPStringKernel, CSpectrumMismatchRBFKernel, and CTensorProductPairKernel.
Definition at line 912 of file Kernel.cpp.
| void remove_lhs | ( | ) | [virtual] |
remove lhs from kernel
Reimplemented from CKernel.
Definition at line 146 of file CombinedKernel.cpp.
| void remove_lhs_and_rhs | ( | ) | [virtual] |
remove lhs and rhs from kernel
Reimplemented from CKernel.
Definition at line 183 of file CombinedKernel.cpp.
| void remove_rhs | ( | ) | [virtual] |
remove rhs from kernel
Reimplemented from CKernel.
Definition at line 166 of file CombinedKernel.cpp.
| void resize_kernel_cache | ( | KERNELCACHE_IDX | size, | |
| bool | regression_hack = false | |||
| ) | [inherited] |
resize kernel cache
| size | new size | |
| regression_hack | hack for regression |
Definition at line 85 of file Kernel.cpp.
| void save | ( | CFile * | writer | ) | [inherited] |
save kernel matrix
| writer | File object via which to save data |
Definition at line 640 of file Kernel.cpp.
| bool save_serializable | ( | CSerializableFile * | file, | |
| const char * | prefix = "", |
|||
| int32_t | param_version = VERSION_PARAMETER | |||
| ) | [virtual, inherited] |
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) |
Reimplemented in CModelSelectionParameters.
Definition at line 296 of file SGObject.cpp.
| void save_serializable_post | ( | ) | throw (ShogunException) [protected, virtual, inherited] |
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 from CSGObject.
Definition at line 904 of file Kernel.cpp.
| void save_serializable_pre | ( | ) | throw (ShogunException) [protected, virtual, inherited] |
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 from CSGObject.
Definition at line 896 of file Kernel.cpp.
| void set_cache_size | ( | int32_t | size | ) | [inherited] |
| void set_combined_kernel_weight | ( | float64_t | nw | ) | [inherited] |
| void set_generic< floatmax_t > | ( | ) | [inherited] |
set generic type to T
| void set_global_io | ( | SGIO * | io | ) | [inherited] |
| void set_global_parallel | ( | Parallel * | parallel | ) | [inherited] |
set the parallel object
| parallel | parallel object to use |
Definition at line 230 of file SGObject.cpp.
| void set_global_version | ( | Version * | version | ) | [inherited] |
set the version object
| version | version object to use |
Definition at line 265 of file SGObject.cpp.
| void set_is_initialized | ( | bool | p_init | ) | [protected, inherited] |
| bool set_normalizer | ( | CKernelNormalizer * | normalizer | ) | [virtual, inherited] |
set the current kernel normalizer
Reimplemented in CWeightedDegreeStringKernel.
Definition at line 141 of file Kernel.cpp.
| void set_optimization_type | ( | EOptimizationType | t | ) | [virtual] |
set optimization type
| t | optimization type |
Reimplemented from CKernel.
Definition at line 740 of file CombinedKernel.cpp.
| void set_property | ( | EKernelProperty | p | ) | [protected, inherited] |
set subkernel weights
| weights | new subkernel weights |
Reimplemented from CKernel.
Definition at line 705 of file CombinedKernel.cpp.
| void set_time | ( | int32_t | t | ) | [inherited] |
| virtual CSGObject* shallow_copy | ( | ) | const [virtual, inherited] |
A shallow copy. All the SGObject instance variables will be simply assigned and SG_REF-ed.
Reimplemented in CGaussianKernel.
Definition at line 122 of file SGObject.h.
| void unset_generic | ( | ) | [inherited] |
unset generic type
this has to be called in classes specializing a template class
Definition at line 285 of file SGObject.cpp.
| void unset_property | ( | EKernelProperty | p | ) | [protected, inherited] |
| bool update_parameter_hash | ( | ) | [protected, virtual, inherited] |
Updates the hash of current parameter combination.
Definition at line 237 of file SGObject.cpp.
bool append_subkernel_weights [protected] |
if subkernel weights are appended
Definition at line 470 of file CombinedKernel.h.
int32_t cache_size [protected, inherited] |
float64_t combined_kernel_weight [protected, inherited] |
bool initialized [protected] |
whether kernel is ready to be used
Definition at line 472 of file CombinedKernel.h.
io
Definition at line 462 of file SGObject.h.
KERNEL_CACHE kernel_cache [protected, inherited] |
CList* kernel_list [protected] |
list of kernels
Definition at line 460 of file CombinedKernel.h.
KERNELCACHE_ELEM* kernel_matrix [protected, inherited] |
this *COULD* store the whole kernel matrix usually not applicable / necessary to compute the whole matrix
Reimplemented in CSpectrumMismatchRBFKernel, and CSpectrumRBFKernel.
bool lhs_equals_rhs [protected, inherited] |
uint32_t m_hash [inherited] |
Hash of parameter values
Definition at line 480 of file SGObject.h.
Parameter* m_model_selection_parameters [inherited] |
model selection parameters
Definition at line 474 of file SGObject.h.
ParameterMap* m_parameter_map [inherited] |
map for different parameter versions
Definition at line 477 of file SGObject.h.
Parameter* m_parameters [inherited] |
parameters
Definition at line 471 of file SGObject.h.
CKernelNormalizer* normalizer [protected, inherited] |
int32_t num_lhs [protected, inherited] |
int32_t num_rhs [protected, inherited] |
EOptimizationType opt_type [protected, inherited] |
bool optimization_initialized [protected, inherited] |
parallel
Definition at line 465 of file SGObject.h.
uint64_t properties [protected, inherited] |
float64_t* subkernel_weights_buffer [protected] |
subkernel weights buffers
Definition at line 468 of file CombinedKernel.h.
int32_t sv_count [protected] |
support vector count
Definition at line 462 of file CombinedKernel.h.
int32_t* sv_idx [protected] |
support vector index
Definition at line 464 of file CombinedKernel.h.
support vector weights
Definition at line 466 of file CombinedKernel.h.
version
Definition at line 468 of file SGObject.h.
