SHOGUN  v3.2.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes
CPolyFeatures Class Reference

Detailed Description

implement DotFeatures for the polynomial kernel

see DotFeatures for further discription

Definition at line 25 of file PolyFeatures.h.

Inheritance diagram for CPolyFeatures:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 CPolyFeatures ()
 CPolyFeatures (CDenseFeatures< float64_t > *feat, int32_t degree, bool normalize)
virtual ~CPolyFeatures ()
 CPolyFeatures (const CPolyFeatures &orig)
virtual int32_t get_dim_feature_space () const
virtual int32_t get_nnz_features_for_vector (int32_t num)
virtual EFeatureType get_feature_type () const
virtual EFeatureClass get_feature_class () const
virtual int32_t get_num_vectors () const
virtual float64_t dot (int32_t vec_idx1, CDotFeatures *df, int32_t vec_idx2)
CFeaturesduplicate () const
virtual const char * get_name () const
float64_t dense_dot (int32_t vec_idx1, float64_t *vec2, int32_t vec2_len)
void add_to_dense_vec (float64_t alpha, int32_t vec_idx1, float64_t *vec2, int32_t vec2_len, bool abs_val)
virtual void * get_feature_iterator (int32_t vector_index)
virtual bool get_next_feature (int32_t &index, float64_t &value, void *iterator)
virtual void free_feature_iterator (void *iterator)
virtual float64_t dense_dot_sgvec (int32_t vec_idx1, const SGVector< float64_t > vec2)
virtual void dense_dot_range (float64_t *output, int32_t start, int32_t stop, float64_t *alphas, float64_t *vec, int32_t dim, float64_t b)
virtual void dense_dot_range_subset (int32_t *sub_index, int32_t num, float64_t *output, float64_t *alphas, float64_t *vec, int32_t dim, float64_t b)
float64_t get_combined_feature_weight ()
void set_combined_feature_weight (float64_t nw)
SGMatrix< float64_tget_computed_dot_feature_matrix ()
SGVector< float64_tget_computed_dot_feature_vector (int32_t num)
void benchmark_add_to_dense_vector (int32_t repeats=5)
void benchmark_dense_dot_range (int32_t repeats=5)
virtual SGVector< float64_tget_mean ()
virtual SGMatrix< float64_tget_cov ()
virtual void add_preprocessor (CPreprocessor *p)
virtual void del_preprocessor (int32_t num)
CPreprocessorget_preprocessor (int32_t num) const
void set_preprocessed (int32_t num)
bool is_preprocessed (int32_t num) const
int32_t get_num_preprocessed () const
int32_t get_num_preprocessors () const
void clean_preprocessors ()
void list_preprocessors ()
int32_t get_cache_size () const
virtual bool reshape (int32_t num_features, int32_t num_vectors)
void list_feature_obj () const
virtual void load (CFile *loader)
virtual void save (CFile *writer)
bool check_feature_compatibility (CFeatures *f) const
bool has_property (EFeatureProperty p) const
void set_property (EFeatureProperty p)
void unset_property (EFeatureProperty p)
virtual CFeaturescreate_merged_copy (CList *others)
virtual CFeaturescreate_merged_copy (CFeatures *other)
virtual void add_subset (SGVector< index_t > subset)
virtual void remove_subset ()
virtual void remove_all_subsets ()
virtual CSubsetStackget_subset_stack ()
virtual void subset_changed_post ()
virtual CFeaturescopy_subset (SGVector< index_t > indices)
virtual CSGObjectshallow_copy () const
virtual CSGObjectdeep_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::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 bool update_parameter_hash ()
virtual bool equals (CSGObject *other, float64_t accuracy=0.0)
virtual CSGObjectclone ()

Static Public Member Functions

static void * dense_dot_range_helper (void *p)
static SGVector< float64_tget_mean (CDotFeatures *lhs, CDotFeatures *rhs)
static SGMatrix< float64_tcompute_cov (CDotFeatures *lhs, CDotFeatures *rhs)

Public Attributes

SGIOio
Parallelparallel
Versionversion
Parameterm_parameters
Parameterm_model_selection_parameters
Parameterm_gradient_parameters
ParameterMapm_parameter_map
uint32_t m_hash

Protected Member Functions

void store_normalization_values ()
void store_multi_index ()
void enumerate_multi_index (const int32_t feat_idx, uint16_t **index, uint16_t *exponents, const int32_t degree)
void store_multinomial_coefficients ()
int32_t bico2 (int32_t n, int32_t k)
int32_t bico (int32_t n, int32_t k)
int32_t calc_feature_space_dimensions (int32_t N, int32_t D)
int32_t multinomialcoef (int32_t *exps, int32_t len)
float64_t gammln (float64_t xx)
float64_t factln (int32_t n)
void display_progress (int32_t start, int32_t stop, int32_t v)
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)
virtual void load_serializable_post () throw (ShogunException)
virtual void save_serializable_pre () throw (ShogunException)
virtual void save_serializable_post () throw (ShogunException)

Protected Attributes

CDenseFeatures< float64_t > * m_feat
int32_t m_degree
bool m_normalize
int32_t m_input_dimensions
int32_t m_output_dimensions
uint16_t * m_multi_index
float64_tm_multinomial_coefficients
float32_tm_normalization_values
float64_t combined_weight
 feature weighting in combined dot features
CSubsetStackm_subset_stack

Constructor & Destructor Documentation

default constructor

Definition at line 5 of file PolyFeatures.cpp.

CPolyFeatures ( CDenseFeatures< float64_t > *  feat,
int32_t  degree,
bool  normalize 
)

constructor

Parameters:
featreal features
degreedegree of the polynomial kernel
normalizenormalize kernel

Definition at line 19 of file PolyFeatures.cpp.

~CPolyFeatures ( ) [virtual]

Definition at line 41 of file PolyFeatures.cpp.

CPolyFeatures ( const CPolyFeatures orig)

copy constructor

not implemented!

Parameters:
origoriginal PolyFeature

Definition at line 49 of file PolyFeatures.cpp.


Member Function Documentation

void add_preprocessor ( CPreprocessor p) [virtual, inherited]

add preprocessor

Parameters:
ppreprocessor to set

Definition at line 82 of file Features.cpp.

void add_subset ( SGVector< index_t subset) [virtual, inherited]

adds a subset of indices on top of the current subsets (possibly subset o subset. Calls subset_changed_post() afterwards

Parameters:
subsetsubset of indices to add

Reimplemented in CCombinedFeatures.

Definition at line 307 of file Features.cpp.

void add_to_dense_vec ( float64_t  alpha,
int32_t  vec_idx1,
float64_t vec2,
int32_t  vec2_len,
bool  abs_val 
) [virtual]

compute alpha*x+vec2

Parameters:
alphaalpha
vec_idx1index of first vector x
vec2vec2
vec2_lenlength of vec2
abs_valif true add the absolute value

Implements CDotFeatures.

Definition at line 167 of file PolyFeatures.cpp.

void benchmark_add_to_dense_vector ( int32_t  repeats = 5) [inherited]

run benchmark for add_to_dense_vec

Definition at line 318 of file DotFeatures.cpp.

void benchmark_dense_dot_range ( int32_t  repeats = 5) [inherited]

run benchmark for dense_dot_range

Definition at line 341 of file DotFeatures.cpp.

int32_t bico ( int32_t  n,
int32_t  k 
) [protected]

efficient implementation for the binomial coefficient function for larger values of k

Definition at line 367 of file PolyFeatures.cpp.

int32_t bico2 ( int32_t  n,
int32_t  k 
) [protected]

simple recursive implementation of binomial coefficient which is very efficient if k is small, otherwise it calls a more sophisticated implementation

Definition at line 288 of file PolyFeatures.cpp.

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.

Parameters:
dictdictionary of parameters to be built.

Definition at line 1156 of file SGObject.cpp.

int32_t calc_feature_space_dimensions ( int32_t  N,
int32_t  D 
) [protected]

recursion to calculate the dimensions of the feature space: A(N, D)= sum_d=0^D A(N-1, d) A(1, D)==1 A(N, 0)==1 where N is the dimensionality of the input space and D is the degree

Definition at line 313 of file PolyFeatures.cpp.

bool check_feature_compatibility ( CFeatures f) const [inherited]

check feature compatibility

Parameters:
ffeatures to check for compatibility
Returns:
if features are compatible

Definition at line 280 of file Features.cpp.

void clean_preprocessors ( ) [inherited]

clears all preprocs

Definition at line 113 of file Features.cpp.

CSGObject * clone ( ) [virtual, inherited]

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.

Returns:
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

Definition at line 1273 of file SGObject.cpp.

SGMatrix< float64_t > compute_cov ( CDotFeatures lhs,
CDotFeatures rhs 
) [static, inherited]

compute the covariance of two CDotFeatures together

Returns:
covariance

Definition at line 469 of file DotFeatures.cpp.

CFeatures * copy_subset ( SGVector< index_t indices) [virtual, inherited]

Creates a new CFeatures instance containing copies of the elements which are specified by the provided indices.

This method is needed for a KernelMachine to store its model data. NOT IMPLEMENTED!

Parameters:
indicesindices of feature elements to copy
Returns:
new CFeatures instance with copies of feature data

Reimplemented in CStringFeatures< ST >, CStringFeatures< T >, CStringFeatures< uint8_t >, CStringFeatures< char >, CStringFeatures< uint16_t >, CSparseFeatures< ST >, CSparseFeatures< float64_t >, CSparseFeatures< T >, CDenseFeatures< ST >, CDenseFeatures< uint32_t >, CDenseFeatures< float64_t >, CDenseFeatures< T >, CDenseFeatures< uint16_t >, and CCombinedFeatures.

Definition at line 330 of file Features.cpp.

virtual CFeatures* create_merged_copy ( CList others) [virtual, inherited]

Takes a list of feature instances and returns a new instance being a concatenation of a copy of this instace's data and the given instancess data. Note that the feature types have to be equal.

NOT IMPLEMENTED!

Parameters:
otherslist of feature objects to append
Returns:
new feature object which contains copy of data of this instance and given ones

Reimplemented in CDenseFeatures< ST >, CDenseFeatures< uint32_t >, CDenseFeatures< float64_t >, CDenseFeatures< T >, and CDenseFeatures< uint16_t >.

Definition at line 229 of file Features.h.

virtual CFeatures* create_merged_copy ( CFeatures other) [virtual, inherited]

Convenience method for method with same name and list as parameter.

NOT IMPLEMENTED!

Parameters:
otherfeature object to append
Returns:
new feature object which contains copy of data of this instance and of given one

Reimplemented in CDenseFeatures< ST >, CDenseFeatures< uint32_t >, CDenseFeatures< float64_t >, CDenseFeatures< T >, CDenseFeatures< uint16_t >, and CCombinedFeatures.

Definition at line 243 of file Features.h.

virtual CSGObject* deep_copy ( ) const [virtual, inherited]

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

Definition at line 126 of file SGObject.h.

void del_preprocessor ( int32_t  num) [virtual, inherited]

delete preprocessor from list

Parameters:
numindex of preprocessor in list

Definition at line 119 of file Features.cpp.

float64_t dense_dot ( int32_t  vec_idx1,
float64_t vec2,
int32_t  vec2_len 
) [virtual]

compute dot product of vector with index arg1 with an given second vector

Parameters:
vec_idx1index of first vector
vec2second vector
vec2_lenlength of second vector

Implements CDotFeatures.

Definition at line 139 of file PolyFeatures.cpp.

void dense_dot_range ( float64_t output,
int32_t  start,
int32_t  stop,
float64_t alphas,
float64_t vec,
int32_t  dim,
float64_t  b 
) [virtual, inherited]

Compute the dot product for a range of vectors. This function makes use of dense_dot alphas[i] * sparse[i]^T * w + b

Parameters:
outputresult for the given vector range
startstart vector range from this idx
stopstop vector range at this idx
alphasscalars to multiply with, may be NULL
vecdense vector to compute dot product with
dimlength of the dense vector
bbias

note that the result will be written to output[0...(stop-start-1)]

Reimplemented in CCombinedDotFeatures, and CHashedWDFeaturesTransposed.

Definition at line 67 of file DotFeatures.cpp.

void * dense_dot_range_helper ( void *  p) [static, inherited]

Compute the dot product for a range of vectors. This function is called by the threads created in dense_dot_range

Reimplemented in CHashedWDFeaturesTransposed.

Definition at line 231 of file DotFeatures.cpp.

void dense_dot_range_subset ( int32_t *  sub_index,
int32_t  num,
float64_t output,
float64_t alphas,
float64_t vec,
int32_t  dim,
float64_t  b 
) [virtual, inherited]

Compute the dot product for a subset of vectors. This function makes use of dense_dot alphas[i] * sparse[i]^T * w + b

Parameters:
sub_indexindex for which to compute outputs
numlength of index
outputresult for the given vector range
alphasscalars to multiply with, may be NULL
vecdense vector to compute dot product with
dimlength of the dense vector
bbias

Reimplemented in CCombinedDotFeatures, and CHashedWDFeaturesTransposed.

Definition at line 153 of file DotFeatures.cpp.

float64_t dense_dot_sgvec ( int32_t  vec_idx1,
const SGVector< float64_t vec2 
) [virtual, inherited]

compute dot product between vector1 and a dense vector

Parameters:
vec_idx1index of first vector
vec2dense vector

Reimplemented in CHashedDocDotFeatures.

Definition at line 62 of file DotFeatures.cpp.

void display_progress ( int32_t  start,
int32_t  stop,
int32_t  v 
) [protected, inherited]

display progress output

Parameters:
startminimum value
stopmaximum value
vcurrent value

Definition at line 528 of file DotFeatures.cpp.

float64_t dot ( int32_t  vec_idx1,
CDotFeatures df,
int32_t  vec_idx2 
) [virtual]

compute dot product between vector1 and vector2, appointed by their indices

Parameters:
vec_idx1index of first vector
dfDotFeatures (of same kind) to compute dot product with
vec_idx2index of second vector

Implements CDotFeatures.

Definition at line 103 of file PolyFeatures.cpp.

CFeatures * duplicate ( ) const [virtual]

duplicate feature object

Returns:
feature object

Implements CFeatures.

Definition at line 372 of file PolyFeatures.cpp.

void enumerate_multi_index ( const int32_t  feat_idx,
uint16_t **  index,
uint16_t *  exponents,
const int32_t  degree 
) [protected]

recursive function enumerating all multi-indices that sum up to the degree of the polynomial kernel

Definition at line 232 of file PolyFeatures.cpp.

bool equals ( CSGObject other,
float64_t  accuracy = 0.0 
) [virtual, inherited]

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.

Parameters:
otherobject to compare with
accuracyaccuracy to use for comparison (optional)
Returns:
true if all parameters were equal, false if not

Definition at line 1177 of file SGObject.cpp.

float64_t factln ( int32_t  n) [protected]

implementation of the ln(x!) function

Definition at line 357 of file PolyFeatures.cpp.

void free_feature_iterator ( void *  iterator) [virtual]

clean up iterator call this function with the iterator returned by get_first_feature

Parameters:
iteratoras returned by get_first_feature

Implements CDotFeatures.

Definition at line 96 of file PolyFeatures.cpp.

float64_t gammln ( float64_t  xx) [protected]

efficient implementation of the ln(gamma(x)) function

Definition at line 341 of file PolyFeatures.cpp.

int32_t get_cache_size ( ) const [inherited]

get cache size

Returns:
cache size

Definition at line 157 of file Features.cpp.

get combined feature weight

Returns:
combined feature weight

Definition at line 151 of file DotFeatures.h.

compute the feature matrix in feature space

Returns:
computed feature matrix

Definition at line 284 of file DotFeatures.cpp.

SGVector< float64_t > get_computed_dot_feature_vector ( int32_t  num) [inherited]

compute the feature vector in feature space

Returns:
computed feature vector

Definition at line 305 of file DotFeatures.cpp.

SGMatrix< float64_t > get_cov ( ) [virtual, inherited]

get covariance

Returns:
covariance

Definition at line 427 of file DotFeatures.cpp.

int32_t get_dim_feature_space ( ) const [virtual]

get dimensions of feature space

Returns:
dimensions of feature space

Implements CDotFeatures.

Definition at line 55 of file PolyFeatures.cpp.

EFeatureClass get_feature_class ( ) const [virtual]

get feature class

Returns:
feature class

Implements CFeatures.

Definition at line 70 of file PolyFeatures.cpp.

void * get_feature_iterator ( int32_t  vector_index) [virtual]

iterate over the non-zero features

call get_feature_iterator first, followed by get_next_feature and free_feature_iterator to cleanup

Parameters:
vector_indexthe index of the vector over whose components to iterate over
Returns:
feature iterator (to be passed to get_next_feature)

Implements CDotFeatures.

Definition at line 84 of file PolyFeatures.cpp.

EFeatureType get_feature_type ( ) const [virtual]

get feature type

Returns:
feature type

Implements CFeatures.

Definition at line 65 of file PolyFeatures.cpp.

SGIO * get_global_io ( ) [inherited]

get the io object

Returns:
io object

Definition at line 174 of file SGObject.cpp.

Parallel * get_global_parallel ( ) [inherited]

get the parallel object

Returns:
parallel object

Definition at line 209 of file SGObject.cpp.

Version * get_global_version ( ) [inherited]

get the version object

Returns:
version object

Definition at line 222 of file SGObject.cpp.

SGVector< float64_t > get_mean ( ) [virtual, inherited]

get mean

Returns:
mean returned

Definition at line 384 of file DotFeatures.cpp.

SGVector< float64_t > get_mean ( CDotFeatures lhs,
CDotFeatures rhs 
) [static, inherited]

get mean of two CDotFeature objects

Returns:
mean returned

Definition at line 402 of file DotFeatures.cpp.

SGStringList< char > get_modelsel_names ( ) [inherited]
Returns:
vector of names of all parameters which are registered for model selection

Definition at line 1060 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

Parameters:
param_namename of the parameter
Returns:
description of the parameter

Definition at line 1084 of file SGObject.cpp.

index_t get_modsel_param_index ( const char *  param_name) [inherited]

Returns index of model selection parameter with provided index

Parameters:
param_namename of model selection parameter
Returns:
index of model selection parameter with provided name, -1 if there is no such

Definition at line 1097 of file SGObject.cpp.

virtual const char* get_name ( ) const [virtual]
Returns:
name of class

Implements CSGObject.

Definition at line 99 of file PolyFeatures.h.

bool get_next_feature ( int32_t &  index,
float64_t value,
void *  iterator 
) [virtual]

iterate over the non-zero features

call this function with the iterator returned by get_first_feature and call free_feature_iterator to cleanup

Parameters:
indexis returned by reference (-1 when not available)
valueis returned by reference
iteratoras returned by get_first_feature
Returns:
true if a new non-zero feature got returned

Implements CDotFeatures.

Definition at line 90 of file PolyFeatures.cpp.

int32_t get_nnz_features_for_vector ( int32_t  num) [virtual]

get number of non-zero features in vector

Parameters:
numindex of vector
Returns:
number of non-zero features in vector

Implements CDotFeatures.

Definition at line 60 of file PolyFeatures.cpp.

int32_t get_num_preprocessed ( ) const [inherited]

get the number of applied preprocs

Returns:
number of applied preprocessors

Definition at line 100 of file Features.cpp.

int32_t get_num_preprocessors ( ) const [inherited]

get number of preprocessors

Returns:
number of preprocessors

Definition at line 152 of file Features.cpp.

int32_t get_num_vectors ( ) const [virtual]

get number of vectors

Returns:
number of vectors

Implements CFeatures.

Definition at line 75 of file PolyFeatures.cpp.

CPreprocessor * get_preprocessor ( int32_t  num) const [inherited]

get specified preprocessor

Parameters:
numindex of preprocessor in list

Definition at line 90 of file Features.cpp.

CSubsetStack * get_subset_stack ( ) [virtual, inherited]

returns subset stack

Returns:
subset stack

Definition at line 325 of file Features.cpp.

bool has_property ( EFeatureProperty  p) const [inherited]

check if features have given property

Parameters:
pfeature property
Returns:
if features have given property

Definition at line 292 of file Features.cpp.

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.

Parameters:
genericset to the type of the generic if returning TRUE
Returns:
TRUE if a class template.

Definition at line 228 of file SGObject.cpp.

bool is_preprocessed ( int32_t  num) const [inherited]

get whether specified preprocessor was already applied

Parameters:
numindex of preprocessor in list

Definition at line 146 of file Features.cpp.

void list_feature_obj ( ) const [inherited]

list feature object

Definition at line 168 of file Features.cpp.

void list_preprocessors ( ) [inherited]

print preprocessors

Definition at line 128 of file Features.cpp.

void load ( CFile loader) [virtual, inherited]
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)

Parameters:
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
Returns:
(sorted) array of created TParameter instances with file data

Definition at line 633 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

Parameters:
param_infoinformation of parameter
file_versionparameter version of the file, must be <= provided parameter version
filefile to load from
prefixprefix for members
Returns:
new array with TParameter instances with the attached data

Definition at line 474 of file SGObject.cpp.

bool load_serializable ( CSerializableFile file,
const char *  prefix = "",
int32_t  param_version = Version::get_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!

Parameters:
filewhere to load from
prefixprefix for members
param_version(optional) a parameter version different to (this is mainly for testing, better do not use)
Returns:
TRUE if done, otherwise FALSE

Definition at line 305 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.

Exceptions:
ShogunExceptionWill be thrown if an error occurres.

Reimplemented in CKernel, CWeightedDegreePositionStringKernel, CList, CAlphabet, CLinearHMM, CGaussianKernel, CInverseMultiQuadricKernel, CCircularKernel, and CExponentialKernel.

Definition at line 989 of file SGObject.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.

Exceptions:
ShogunExceptionWill be thrown if an error occurres.

Reimplemented in CDynamicArray< T >, CDynamicArray< float64_t >, CDynamicArray< float32_t >, CDynamicArray< int32_t >, CDynamicArray< char >, CDynamicArray< bool >, and CDynamicObjectArray.

Definition at line 984 of file SGObject.cpp.

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

Parameters:
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

Definition at line 671 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

Parameters:
param_baseset of TParameter instances to use for migration
targetparameter info for the resulting TParameter
Returns:
a new TParameter instance with migrated data from the base of the type which is specified by the target parameter

Definition at line 878 of file SGObject.cpp.

int32_t multinomialcoef ( int32_t *  exps,
int32_t  len 
) [protected]

calculate the multinomial coefficient

Definition at line 327 of file PolyFeatures.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)

Parameters:
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

Definition at line 818 of file SGObject.cpp.

void print_modsel_params ( ) [inherited]

prints all parameter registered for model selection and their type

Definition at line 1036 of file SGObject.cpp.

void print_serializable ( const char *  prefix = "") [virtual, inherited]

prints registered parameters out

Parameters:
prefixprefix for members

Definition at line 240 of file SGObject.cpp.

void remove_all_subsets ( ) [virtual, inherited]

removes all subsets Calls subset_changed_post() afterwards

Reimplemented in CCombinedFeatures.

Definition at line 319 of file Features.cpp.

void remove_subset ( ) [virtual, inherited]

removes that last added subset from subset stack, if existing Calls subset_changed_post() afterwards

Reimplemented in CCombinedFeatures.

Definition at line 313 of file Features.cpp.

bool reshape ( int32_t  num_features,
int32_t  num_vectors 
) [virtual, inherited]

in case there is a feature matrix allow for reshaping

NOT IMPLEMENTED!

Parameters:
num_featuresnew number of features
num_vectorsnew number of vectors
Returns:
if reshaping was successful

Reimplemented in CDenseFeatures< ST >, CDenseFeatures< uint32_t >, CDenseFeatures< float64_t >, CDenseFeatures< T >, and CDenseFeatures< uint16_t >.

Definition at line 162 of file Features.cpp.

void save ( CFile writer) [virtual, inherited]
bool save_serializable ( CSerializableFile file,
const char *  prefix = "",
int32_t  param_version = Version::get_version_parameter() 
) [virtual, inherited]

Save this object to file.

Parameters:
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)
Returns:
TRUE if done, otherwise FALSE

Definition at line 246 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.

Exceptions:
ShogunExceptionWill be thrown if an error occurres.

Reimplemented in CKernel.

Definition at line 999 of file SGObject.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.

Exceptions:
ShogunExceptionWill be thrown if an error occurres.

Reimplemented in CKernel, CDynamicArray< T >, CDynamicArray< float64_t >, CDynamicArray< float32_t >, CDynamicArray< int32_t >, CDynamicArray< char >, CDynamicArray< bool >, and CDynamicObjectArray.

Definition at line 994 of file SGObject.cpp.

void set_combined_feature_weight ( float64_t  nw) [inherited]

set combined kernel weight

Parameters:
nwnew combined feature weight

Definition at line 157 of file DotFeatures.h.

void set_generic< complex128_t > ( ) [inherited]

set generic type to T

Definition at line 41 of file SGObject.cpp.

void set_global_io ( SGIO io) [inherited]

set the io object

Parameters:
ioio object to use

Definition at line 167 of file SGObject.cpp.

void set_global_parallel ( Parallel parallel) [inherited]

set the parallel object

Parameters:
parallelparallel object to use

Definition at line 180 of file SGObject.cpp.

void set_global_version ( Version version) [inherited]

set the version object

Parameters:
versionversion object to use

Definition at line 215 of file SGObject.cpp.

void set_preprocessed ( int32_t  num) [inherited]

set applied flag for preprocessor

Parameters:
numindex of preprocessor in list

Definition at line 140 of file Features.cpp.

void set_property ( EFeatureProperty  p) [inherited]

set property

Parameters:
pkernel property to set

Definition at line 297 of file Features.cpp.

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 117 of file SGObject.h.

void store_multi_index ( ) [protected]

caller function for the recursive function enumerate_multi_index

Definition at line 216 of file PolyFeatures.cpp.

void store_multinomial_coefficients ( ) [protected]

function calculating the multinomial coefficients for all multi indices

Definition at line 260 of file PolyFeatures.cpp.

void store_normalization_values ( ) [protected]

store the norm of each training example

Definition at line 197 of file PolyFeatures.cpp.

virtual void subset_changed_post ( ) [virtual, inherited]

method may be overwritten to update things that depend on subset

Reimplemented in CStringFeatures< ST >, CStringFeatures< T >, CStringFeatures< uint8_t >, CStringFeatures< char >, and CStringFeatures< uint16_t >.

Definition at line 271 of file Features.h.

void unset_generic ( ) [inherited]

unset generic type

this has to be called in classes specializing a template class

Definition at line 235 of file SGObject.cpp.

void unset_property ( EFeatureProperty  p) [inherited]

unset property

Parameters:
pkernel property to unset

Definition at line 302 of file Features.cpp.

bool update_parameter_hash ( ) [virtual, inherited]

Updates the hash of current parameter combination.

Returns:
bool if parameter combination has changed since last update.

Definition at line 187 of file SGObject.cpp.


Member Data Documentation

float64_t combined_weight [protected, inherited]

feature weighting in combined dot features

Definition at line 246 of file DotFeatures.h.

SGIO* io [inherited]

io

Definition at line 473 of file SGObject.h.

int32_t m_degree [protected]

degree of the polynomial kernel

Definition at line 217 of file PolyFeatures.h.

features in original space

Definition at line 215 of file PolyFeatures.h.

parameters wrt which we can compute gradients

Definition at line 488 of file SGObject.h.

uint32_t m_hash [inherited]

Hash of parameter values

Definition at line 494 of file SGObject.h.

int32_t m_input_dimensions [protected]

dimensions of the input space

Definition at line 221 of file PolyFeatures.h.

model selection parameters

Definition at line 485 of file SGObject.h.

uint16_t* m_multi_index [protected]

flattened matrix of all multi indices that sum do the degree of the polynomial kernel

Definition at line 226 of file PolyFeatures.h.

multinomial coefficients for all multi-indices

Definition at line 228 of file PolyFeatures.h.

store norm of each training example

Definition at line 230 of file PolyFeatures.h.

bool m_normalize [protected]

normalize

Definition at line 219 of file PolyFeatures.h.

int32_t m_output_dimensions [protected]

dimensions of the feature space of the polynomial kernel

Definition at line 223 of file PolyFeatures.h.

map for different parameter versions

Definition at line 491 of file SGObject.h.

Parameter* m_parameters [inherited]

parameters

Definition at line 482 of file SGObject.h.

CSubsetStack* m_subset_stack [protected, inherited]

subset used for index transformations

Definition at line 302 of file Features.h.

Parallel* parallel [inherited]

parallel

Definition at line 476 of file SGObject.h.

Version* version [inherited]

version

Definition at line 479 of file SGObject.h.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

SHOGUN Machine Learning Toolbox - Documentation