Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes

CFKFeatures Class Reference


Detailed Description

The class FKFeatures implements Fischer kernel features obtained from two Hidden Markov models.

It was used in

K. Tsuda, M. Kawanabe, G. Raetsch, S. Sonnenburg, and K.R. Mueller. A new discriminative kernel from probabilistic models. Neural Computation, 14:2397-2414, 2002.

which also has the details.

Note that FK-features are computed on the fly, so to be effective feature caching should be enabled.

It inherits its functionality from CDenseFeatures, which should be consulted for further reference.

Definition at line 41 of file FKFeatures.h.

Inheritance diagram for CFKFeatures:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 CFKFeatures ()
 CFKFeatures (int32_t size, CHMM *p, CHMM *n)
 CFKFeatures (const CFKFeatures &orig)
virtual ~CFKFeatures ()
void set_models (CHMM *p, CHMM *n)
void set_a (float64_t a)
float64_t get_a ()
virtual float64_tset_feature_matrix ()
float64_t set_opt_a (float64_t a=-1)
float64_t get_weight_a ()
virtual const char * get_name () const
virtual CFeaturesduplicate () const
void free_feature_matrix ()
void free_features ()
float64_tget_feature_vector (int32_t num, int32_t &len, bool &dofree)
SGVector< float64_tget_feature_vector (int32_t num)
void set_feature_vector (SGVector< float64_t > vector, int32_t num)
void free_feature_vector (float64_t *feat_vec, int32_t num, bool dofree)
void free_feature_vector (SGVector< float64_t > vec, int32_t num)
void vector_subset (int32_t *idx, int32_t idx_len)
void feature_subset (int32_t *idx, int32_t idx_len)
SGMatrix< float64_tget_feature_matrix ()
float64_tget_feature_matrix (int32_t &num_feat, int32_t &num_vec)
SGMatrix< float64_tsteal_feature_matrix ()
void set_feature_matrix (SGMatrix< float64_t > matrix)
CDenseFeatures< float64_t > * get_transposed ()
float64_tget_transposed (int32_t &num_feat, int32_t &num_vec)
virtual void copy_feature_matrix (SGMatrix< float64_t > src)
void obtain_from_dot (CDotFeatures *df)
virtual bool apply_preprocessor (bool force_preprocessing=false)
virtual int32_t get_size () const
virtual int32_t get_num_vectors () const
int32_t get_num_features ()
void set_num_features (int32_t num)
void set_num_vectors (int32_t num)
void initialize_cache ()
virtual EFeatureClass get_feature_class () const
virtual EFeatureType get_feature_type () const
virtual bool reshape (int32_t p_num_features, int32_t p_num_vectors)
virtual int32_t get_dim_feature_space () const
virtual float64_t dot (int32_t vec_idx1, CDotFeatures *df, int32_t vec_idx2)
virtual float64_t dense_dot (int32_t vec_idx1, const float64_t *vec2, int32_t vec2_len)
virtual void add_to_dense_vec (float64_t alpha, int32_t vec_idx1, float64_t *vec2, int32_t vec2_len, bool abs_val=false)
virtual int32_t get_nnz_features_for_vector (int32_t num)
virtual void load (CFile *loader)
virtual void save (CFile *saver)
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 CFeaturescopy_subset (SGVector< index_t > indices)
virtual bool is_equal (CDenseFeatures *rhs)
CFeaturescreate_merged_copy (CFeatures *other)
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 int32_t add_preprocessor (CPreprocessor *p)
 set preprocessor
virtual CPreprocessordel_preprocessor (int32_t num)
 del current preprocessor
CPreprocessorget_preprocessor (int32_t num) const
 get current preprocessor
void set_preprocessed (int32_t num)
bool is_preprocessed (int32_t num) const
int32_t get_num_preprocessed () const
 get whether specified preprocessor (or all if num=1) was/were already applied
int32_t get_num_preprocessors () const
void clean_preprocessors ()
int32_t get_cache_size () const
void list_feature_obj () const
bool check_feature_compatibility (CFeatures *f) const
bool has_property (EFeatureProperty p) const
void set_property (EFeatureProperty p)
void unset_property (EFeatureProperty p)
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 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_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)
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_parameter_dictionary (CMap< TParameter *, CSGObject * > &dict)

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
ParameterMapm_parameter_map
uint32_t m_hash

Protected Member Functions

virtual float64_tcompute_feature_vector (int32_t num, int32_t &len, float64_t *target=NULL)
void compute_feature_vector (float64_t *addr, int32_t num, int32_t &len)
float64_t deriv_a (float64_t a, int32_t dimension=-1)
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)
virtual bool update_parameter_hash ()

Protected Attributes

CHMMpos
CHMMneg
float64_tpos_prob
float64_tneg_prob
float64_t weight_a
int32_t num_vectors
 number of vectors in cache
int32_t num_features
 number of features in cache
SGMatrix< float64_tfeature_matrix
CCache< float64_t > * feature_cache
float64_t combined_weight
 feature weighting in combined dot features
CSubsetStackm_subset_stack

Constructor & Destructor Documentation

CFKFeatures (  ) 

default constructor

Definition at line 19 of file FKFeatures.cpp.

CFKFeatures ( int32_t  size,
CHMM p,
CHMM n 
)

constructor

Parameters:
size cache size
p positive HMM
n negative HMM

Definition at line 24 of file FKFeatures.cpp.

CFKFeatures ( const CFKFeatures orig  ) 

copy constructor

Definition at line 32 of file FKFeatures.cpp.

~CFKFeatures (  )  [virtual]

Definition at line 37 of file FKFeatures.cpp.


Member Function Documentation

int32_t add_preprocessor ( CPreprocessor p  )  [virtual, inherited]

set preprocessor

add preprocessor

Parameters:
p preprocessor to set
Returns:
something inty

Definition at line 81 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:
subset subset of indices to add

Reimplemented in CCombinedFeatures.

Definition at line 351 of file Features.cpp.

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

add vector 1 multiplied with alpha to dense vector2

possible with subset

Parameters:
alpha scalar alpha
vec_idx1 index of first vector
vec2 pointer to real valued vector
vec2_len length of real valued vector
abs_val if true add the absolute value

Implements CDotFeatures.

virtual bool apply_preprocessor ( bool  force_preprocessing = false  )  [virtual, inherited]

apply preprocessor

applies preprocessors to ALL features (subset removed before and restored afterwards)

not possible with subset

Parameters:
force_preprocessing if preprocssing shall be forced
Returns:
if applying was successful
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.

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.

Parameters:
dict dictionary of parameters to be built.

Definition at line 1201 of file SGObject.cpp.

bool check_feature_compatibility ( CFeatures f  )  const [inherited]

check feature compatibility

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

Definition at line 326 of file Features.cpp.

void clean_preprocessors (  )  [inherited]

clears all preprocs

Definition at line 137 of file Features.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.

void compute_feature_vector ( float64_t addr,
int32_t  num,
int32_t &  len 
) [protected]

computes the feature vector to the address addr

Parameters:
addr address
num num
len len

Definition at line 168 of file FKFeatures.cpp.

float64_t * compute_feature_vector ( int32_t  num,
int32_t &  len,
float64_t target = NULL 
) [protected, virtual]

compute feature vector

Parameters:
num num
len len
target 
Returns:
something floaty

Reimplemented from CDenseFeatures< float64_t >.

Definition at line 148 of file FKFeatures.cpp.

virtual void copy_feature_matrix ( SGMatrix< float64_t src  )  [virtual, inherited]

copy feature matrix store copy of feature_matrix, where num_features is the column offset, and columns are linear in memory see below for definition of feature_matrix

not possible with subset

Parameters:
src feature matrix to copy
virtual 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.

possible with subset

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

Reimplemented from CFeatures.

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

Takes another feature instance and returns a new instance which is a concatenation of a copy if this instace's data and the given instance's data. Note that the feature types have to be equal.

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

Reimplemented from CFeatures.

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.

CPreprocessor * del_preprocessor ( int32_t  num  )  [virtual, inherited]

del current preprocessor

delete preprocessor from list caller has to clean up returned preproc

Parameters:
num index of preprocessor in list

Definition at line 143 of file Features.cpp.

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

compute dot product between vector1 and a dense vector

possible with subset

Parameters:
vec_idx1 index of first vector
vec2 pointer to real valued vector
vec2_len length of real valued vector

Implements CDotFeatures.

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:
output result for the given vector range
start start vector range from this idx
stop stop vector range at this idx
alphas scalars to multiply with, may be NULL
vec dense vector to compute dot product with
dim length of the dense vector
b bias

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_index index for which to compute outputs
num length of index
output result for the given vector range
alphas scalars to multiply with, may be NULL
vec dense vector to compute dot product with
dim length of the dense vector
b bias

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_idx1 index of first vector
vec2 dense vector

Definition at line 62 of file DotFeatures.cpp.

float64_t deriv_a ( float64_t  a,
int32_t  dimension = -1 
) [protected]

deriv a

Parameters:
a a
dimension dimension

Definition at line 43 of file FKFeatures.cpp.

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

display progress output

Parameters:
start minimum value
stop maximum value
v current value

Definition at line 528 of file DotFeatures.cpp.

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

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

possible with subset

Parameters:
vec_idx1 index of first vector
df DotFeatures (of same kind) to compute dot product with
vec_idx2 index of second vector

Implements CDotFeatures.

virtual CFeatures* duplicate (  )  const [virtual, inherited]

duplicate feature object

Returns:
feature object

Implements CFeatures.

void feature_subset ( int32_t *  idx,
int32_t  idx_len 
) [inherited]

Extracts the features mentioned in idx and replaces them in feature matrix in place.

It does not resize the allocated memory block.

Not possible with subset.

Parameters:
idx index with features that shall remain in the feature matrix
idx_len length of the index

Note: assumes idx is sorted

virtual void free_feature_iterator ( void *  iterator  )  [virtual, inherited]

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

Parameters:
iterator as returned by get_first_feature

Implements CDotFeatures.

void free_feature_matrix (  )  [inherited]

free feature matrix

Any subset is removed

void free_feature_vector ( float64_t feat_vec,
int32_t  num,
bool  dofree 
) [inherited]

free feature vector

possible with subset

Parameters:
feat_vec feature vector to free
num index in feature cache
dofree if vector should be really deleted
void free_feature_vector ( SGVector< float64_t vec,
int32_t  num 
) [inherited]

free feature vector

possible with subset

Parameters:
vec feature vector to free
num index in feature cache
void free_features (  )  [inherited]

free feature matrix and cache

Any subset is removed

float64_t get_a (  ) 

get weight a

Returns:
weight a

Definition at line 80 of file FKFeatures.h.

int32_t get_cache_size (  )  const [inherited]

get cache size

Returns:
cache size

Definition at line 203 of file Features.cpp.

float64_t get_combined_feature_weight (  )  [inherited]

get combined feature weight

Returns:
combined feature weight

Definition at line 151 of file DotFeatures.h.

SGMatrix< float64_t > get_computed_dot_feature_matrix (  )  [inherited]

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.

virtual int32_t get_dim_feature_space (  )  const [virtual, inherited]

obtain the dimensionality of the feature space

(not mix this up with the dimensionality of the input space, usually obtained via get_num_features())

Returns:
dimensionality

Implements CDotFeatures.

virtual EFeatureClass get_feature_class (  )  const [virtual, inherited]

get feature class

Returns:
feature class DENSE

Implements CFeatures.

virtual void* get_feature_iterator ( int32_t  vector_index  )  [virtual, inherited]

iterate over the non-zero features

call get_feature_iterator first, followed by get_next_feature and free_feature_iterator to cleanup

possible with subset

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

Implements CDotFeatures.

SGMatrix<float64_t > get_feature_matrix (  )  [inherited]

Getter the feature matrix

in-place without subset a copy with subset

Returns:
matrix feature matrix
float64_t * get_feature_matrix ( int32_t &  num_feat,
int32_t &  num_vec 
) [inherited]

get the pointer to the feature matrix num_feat,num_vectors are returned by reference

subset is ignored

Parameters:
num_feat number of features in matrix
num_vec number of vectors in matrix
Returns:
feature matrix
virtual EFeatureType get_feature_type (  )  const [virtual, inherited]

get feature type

Returns:
templated feature type

Implements CFeatures.

float64_t * get_feature_vector ( int32_t  num,
int32_t &  len,
bool &  dofree 
) [inherited]

get feature vector for sample num from the matrix as it is if matrix is initialized, else return preprocessed compute_feature_vector (not implemented)

Parameters:
num index of feature vector
len length is returned by reference
dofree whether returned vector must be freed by caller via free_feature_vector
Returns:
feature vector
SGVector<float64_t > get_feature_vector ( int32_t  num  )  [inherited]

get feature vector num

possible with subset

Parameters:
num index of vector
Returns:
feature vector
SGIO * get_global_io (  )  [inherited]

get the io object

Returns:
io object

Definition at line 224 of file SGObject.cpp.

Parallel * get_global_parallel (  )  [inherited]

get the parallel object

Returns:
parallel object

Definition at line 259 of file SGObject.cpp.

Version * get_global_version (  )  [inherited]

get the version object

Returns:
version object

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

Parameters:
param_name name of the parameter
Returns:
description 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

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

Definition at line 1145 of file SGObject.cpp.

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

Reimplemented from CDenseFeatures< float64_t >.

Definition at line 105 of file FKFeatures.h.

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

iterate over the non-zero features

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

possible with subset

Parameters:
index is returned by reference (-1 when not available)
value is returned by reference
iterator as returned by get_first_feature
Returns:
true if a new non-zero feature got returned

Implements CDotFeatures.

virtual int32_t get_nnz_features_for_vector ( int32_t  num  )  [virtual, inherited]

get number of non-zero features in vector

Parameters:
num which vector
Returns:
number of non-zero features in vector

Implements CDotFeatures.

int32_t get_num_features (  )  [inherited]

get number of features (of possible subset)

Returns:
number of features
int32_t get_num_preprocessed (  )  const [inherited]

get whether specified preprocessor (or all if num=1) was/were already applied

get the number of applied preprocs

Returns:
number of applied preprocessors

Definition at line 123 of file Features.cpp.

int32_t get_num_preprocessors (  )  const [inherited]

get number of preprocessors

Returns:
number of preprocessors

Definition at line 198 of file Features.cpp.

virtual int32_t get_num_vectors (  )  const [virtual, inherited]

get number of feature vectors

Returns:
number of feature vectors

Implements CFeatures.

CPreprocessor * get_preprocessor ( int32_t  num  )  const [inherited]

get current preprocessor

get specified preprocessor

Parameters:
num index of preprocessor in list

Definition at line 111 of file Features.cpp.

virtual int32_t get_size (  )  const [virtual, inherited]

get memory footprint of one feature

Returns:
memory footprint of one feature

Implements CFeatures.

CSubsetStack * get_subset_stack (  )  [virtual, inherited]

returns subset stack

Returns:
subset stack

Definition at line 369 of file Features.cpp.

CDenseFeatures<float64_t >* get_transposed (  )  [inherited]

get a transposed copy of the features

possible with subset

Returns:
transposed copy
float64_t * get_transposed ( int32_t &  num_feat,
int32_t &  num_vec 
) [inherited]

compute and return the transpose of the feature matrix which will be prepocessed. num_feat, num_vectors are returned by reference caller has to clean up

possible with subset

Parameters:
num_feat number of features in matrix
num_vec number of vectors in matrix
Returns:
transposed sparse feature matrix
float64_t get_weight_a (  ) 

get weight_a

Returns:
weight_a

Definition at line 102 of file FKFeatures.h.

bool has_property ( EFeatureProperty  p  )  const [inherited]

check if features have given property

Parameters:
p feature property
Returns:
if features have given property

Definition at line 336 of file Features.cpp.

void initialize_cache (  )  [inherited]

Initialize cache

not possible with subset

virtual bool is_equal ( CDenseFeatures< float64_t > *  rhs  )  [virtual, inherited]

checks if the contents of this CDenseFeatures object are the same to the contents of rhs

Parameters:
rhs other CDenseFeatures object to compare to this one
Returns:
whether they represent the same information
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:
generic set to the type of the generic if returning TRUE
Returns:
TRUE if a class template.

Definition at line 278 of file SGObject.cpp.

bool is_preprocessed ( int32_t  num  )  const [inherited]

get whether specified preprocessor was already applied

Parameters:
num index of preprocessor in list

Definition at line 193 of file Features.cpp.

void list_feature_obj (  )  const [inherited]

list feature object

Definition at line 214 of file Features.cpp.

virtual void load ( CFile loader  )  [virtual, inherited]

load features from file

Parameters:
loader File object via which to load data

Reimplemented from CFeatures.

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

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

Parameters:
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
Returns:
new array with TParameter instances with the attached data

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!

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

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.

Exceptions:
ShogunException Will be thrown if an error occurres.

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

Definition at line 1033 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:
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

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

Parameters:
param_base set of TParameter instances to use for migration
target parameter 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 923 of file SGObject.cpp.

void obtain_from_dot ( CDotFeatures df  )  [inherited]

obtain dense features from other dotfeatures

removes any subset before

Parameters:
df dotfeatures to obtain features from
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_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.

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

Parameters:
prefix prefix for members

Definition at line 290 of file SGObject.cpp.

void remove_all_subsets (  )  [virtual, inherited]

removes all subsets Calls subset_changed_post() afterwards

Reimplemented in CCombinedFeatures.

Definition at line 363 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 357 of file Features.cpp.

virtual bool reshape ( int32_t  p_num_features,
int32_t  p_num_vectors 
) [virtual, inherited]

reshape

not possible with subset

Parameters:
p_num_features new number of features
p_num_vectors new number of vectors
Returns:
if reshaping was successful

Reimplemented from CFeatures.

virtual void save ( CFile saver  )  [virtual, inherited]

save features to file

Parameters:
saver File object via which to save data

Reimplemented from CFeatures.

bool save_serializable ( CSerializableFile file,
const char *  prefix = "",
int32_t  param_version = VERSION_PARAMETER 
) [virtual, inherited]

Save this object to file.

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

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.

Exceptions:
ShogunException Will be thrown if an error occurres.

Reimplemented in CKernel.

Definition at line 1043 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:
ShogunException Will be thrown if an error occurres.

Reimplemented in CKernel.

Definition at line 1038 of file SGObject.cpp.

void set_a ( float64_t  a  ) 

set weight a

Parameters:
a weight a

Definition at line 71 of file FKFeatures.h.

void set_combined_feature_weight ( float64_t  nw  )  [inherited]

set combined kernel weight

Parameters:
nw new combined feature weight

Definition at line 157 of file DotFeatures.h.

float64_t * set_feature_matrix (  )  [virtual]

set feature matrix

Returns:
something floaty

Definition at line 214 of file FKFeatures.cpp.

void set_feature_matrix ( SGMatrix< float64_t matrix  )  [inherited]

Setter for feature matrix

any subset is removed

num_cols is number of feature vectors num_rows is number of dims of vectors see below for definition of feature_matrix

Parameters:
matrix feature matrix to set
void set_feature_vector ( SGVector< float64_t vector,
int32_t  num 
) [inherited]

set feature vector num

possible with subset

Parameters:
vector vector
num index if vector to set
void set_generic< floatmax_t > (  )  [inherited]

set generic type to T

void set_global_io ( SGIO io  )  [inherited]

set the io object

Parameters:
io io object to use

Definition at line 217 of file SGObject.cpp.

void set_global_parallel ( Parallel parallel  )  [inherited]

set the parallel object

Parameters:
parallel parallel object to use

Definition at line 230 of file SGObject.cpp.

void set_global_version ( Version version  )  [inherited]

set the version object

Parameters:
version version object to use

Definition at line 265 of file SGObject.cpp.

void set_models ( CHMM p,
CHMM n 
)

set HMMs

Parameters:
p positive HMM
n negative HMM

Definition at line 128 of file FKFeatures.cpp.

void set_num_features ( int32_t  num  )  [inherited]

set number of features

Parameters:
num number to set
void set_num_vectors ( int32_t  num  )  [inherited]

set number of vectors

not possible with subset

Parameters:
num number to set
float64_t set_opt_a ( float64_t  a = -1  ) 

set opt a

Parameters:
a a
Returns:
something floaty

Definition at line 91 of file FKFeatures.cpp.

void set_preprocessed ( int32_t  num  )  [inherited]

set applied flag for preprocessor

Parameters:
num index of preprocessor in list

Definition at line 188 of file Features.cpp.

void set_property ( EFeatureProperty  p  )  [inherited]

set property

Parameters:
p kernel property to set

Definition at line 341 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 122 of file SGObject.h.

SGMatrix<float64_t > steal_feature_matrix (  )  [inherited]

steals feature matrix, i.e. returns matrix and forget about it subset is ignored

Returns:
matrix feature matrix
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 262 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 285 of file SGObject.cpp.

void unset_property ( EFeatureProperty  p  )  [inherited]

unset property

Parameters:
p kernel property to unset

Definition at line 346 of file Features.cpp.

bool update_parameter_hash (  )  [protected, virtual, inherited]

Updates the hash of current parameter combination.

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

Definition at line 237 of file SGObject.cpp.

void vector_subset ( int32_t *  idx,
int32_t  idx_len 
) [inherited]

Extracts the feature vectors mentioned in idx and replaces them in feature matrix in place.

It does not resize the allocated memory block.

not possible with subset

Parameters:
idx index with examples that shall remain in the feature matrix
idx_len length of the index

Note: assumes idx is sorted


Member Data Documentation

float64_t combined_weight [protected, inherited]

feature weighting in combined dot features

Definition at line 246 of file DotFeatures.h.

CCache<float64_t >* feature_cache [protected, inherited]

feature cache

Definition at line 530 of file DenseFeatures.h.

SGMatrix<float64_t > feature_matrix [protected, inherited]

Feature matrix and its associated number of vectors and features. Note that num_vectors / num_features above match matrix sizes if feature_matrix.matrix != NULL

Definition at line 527 of file DenseFeatures.h.

SGIO* io [inherited]

io

Definition at line 462 of file SGObject.h.

uint32_t m_hash [inherited]

Hash of parameter values

Definition at line 480 of file SGObject.h.

model selection parameters

Definition at line 474 of file SGObject.h.

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.

CSubsetStack* m_subset_stack [protected, inherited]

subset used for index transformations

Definition at line 296 of file Features.h.

CHMM* neg [protected]

negative HMM

Definition at line 140 of file FKFeatures.h.

float64_t* neg_prob [protected]

negative prob

Definition at line 144 of file FKFeatures.h.

int32_t num_features [protected, inherited]

number of features in cache

Definition at line 521 of file DenseFeatures.h.

int32_t num_vectors [protected, inherited]

number of vectors in cache

Definition at line 518 of file DenseFeatures.h.

Parallel* parallel [inherited]

parallel

Definition at line 465 of file SGObject.h.

CHMM* pos [protected]

positive HMM

Definition at line 138 of file FKFeatures.h.

float64_t* pos_prob [protected]

positive prob

Definition at line 142 of file FKFeatures.h.

Version* version [inherited]

version

Definition at line 468 of file SGObject.h.

float64_t weight_a [protected]

weight a

Definition at line 146 of file FKFeatures.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