Public Member Functions | Protected Attributes

CWDFeatures Class Reference


Detailed Description

Features that compute the Weighted Degreee Kernel feature space explicitly.

See also:
CWeightedDegreeStringKernel

Definition at line 28 of file WDFeatures.h.

Inheritance diagram for CWDFeatures:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 CWDFeatures (void)
 CWDFeatures (CStringFeatures< uint8_t > *str, int32_t order, int32_t from_order)
 CWDFeatures (const CWDFeatures &orig)
virtual ~CWDFeatures ()
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 * 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 CFeaturesduplicate () const
virtual EFeatureType get_feature_type ()
virtual EFeatureClass get_feature_class ()
virtual int32_t get_num_vectors () const
virtual int32_t get_size ()
void set_normalization_const (float64_t n=0)
float64_t get_normalization_const ()
virtual const char * get_name () const
void set_wd_weights (float64_t *weights, int32_t d)
void set_wd_weights ()

Protected Attributes

CStringFeatures< uint8_t > * strings
int32_t degree
int32_t from_degree
int32_t string_length
int32_t num_strings
int32_t alphabet_size
int32_t w_dim
float64_twd_weights
float64_t normalization_const

Constructor & Destructor Documentation

CWDFeatures ( void   ) 

defualt constructor

Definition at line 16 of file WDFeatures.cpp.

CWDFeatures ( CStringFeatures< uint8_t > *  str,
int32_t  order,
int32_t  from_order 
)

constructor

Parameters:
str stringfeatures (of bytes)
order of wd kernel
from_order use first order weights from higher order weighting

Definition at line 33 of file WDFeatures.cpp.

CWDFeatures ( const CWDFeatures orig  ) 

copy constructor

Definition at line 55 of file WDFeatures.cpp.

~CWDFeatures (  )  [virtual]

destructor

Definition at line 71 of file WDFeatures.cpp.


Member Function Documentation

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

add vector 1 multiplied with alpha to dense vector2

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.

Definition at line 146 of file WDFeatures.cpp.

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

compute dot product between vector1 and a dense vector

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

Implements CDotFeatures.

Definition at line 108 of file WDFeatures.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_idx1 index of first vector
df DotFeatures (of same kind) to compute dot product with
vec_idx2 index of second vector

Implements CDotFeatures.

Definition at line 77 of file WDFeatures.cpp.

CFeatures * duplicate (  )  const [virtual]

duplicate feature object

Returns:
feature object

Implements CFeatures.

Definition at line 292 of file WDFeatures.cpp.

void free_feature_iterator ( void *  iterator  )  [virtual]

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

Parameters:
iterator as returned by get_first_feature

Implements CDotFeatures.

Definition at line 283 of file WDFeatures.cpp.

virtual int32_t get_dim_feature_space (  )  const [virtual]

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.

Definition at line 55 of file WDFeatures.h.

virtual EFeatureClass get_feature_class (  )  [virtual]

get feature class

Returns:
feature class

Implements CFeatures.

Definition at line 179 of file WDFeatures.h.

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_index the 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 217 of file WDFeatures.cpp.

virtual EFeatureType get_feature_type (  )  [virtual]

get feature type

Returns:
templated feature type

Implements CFeatures.

Definition at line 170 of file WDFeatures.h.

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

Implements CSGObject.

Definition at line 205 of file WDFeatures.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:
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.

Definition at line 245 of file WDFeatures.cpp.

virtual int32_t get_nnz_features_for_vector ( int32_t  num  )  [virtual]

get number of non-zero features in vector

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

Implements CDotFeatures.

Definition at line 92 of file WDFeatures.h.

float64_t get_normalization_const (  ) 

get normalization constant

Definition at line 199 of file WDFeatures.h.

virtual int32_t get_num_vectors (  )  const [virtual]

get number of examples/vectors, possibly corresponding to the current subset

abstract base method

Returns:
number of examples/vectors (possibly of subset, if implemented)

Implements CFeatures.

Definition at line 184 of file WDFeatures.h.

virtual int32_t get_size (  )  [virtual]

get memory footprint of one feature

abstract base method

Returns:
memory footprint of one feature

Implements CFeatures.

Definition at line 189 of file WDFeatures.h.

void set_normalization_const ( float64_t  n = 0  ) 

set normalization constant

Parameters:
n n=0 means automagic

Definition at line 201 of file WDFeatures.cpp.

void set_wd_weights (  ) 

create wd kernel weighting heuristic

Definition at line 185 of file WDFeatures.cpp.

void set_wd_weights ( float64_t weights,
int32_t  d 
)

set wd weights

Parameters:
weights new weights
d degree
Returns:
if setting was successful

Definition at line 213 of file WDFeatures.h.


Member Data Documentation

int32_t alphabet_size [protected]

size of alphabet

Definition at line 237 of file WDFeatures.h.

int32_t degree [protected]

degree

Definition at line 229 of file WDFeatures.h.

int32_t from_degree [protected]

from degree

Definition at line 231 of file WDFeatures.h.

normalization const

Definition at line 244 of file WDFeatures.h.

int32_t num_strings [protected]

number of strings

Definition at line 235 of file WDFeatures.h.

int32_t string_length [protected]

length of string in vector

Definition at line 233 of file WDFeatures.h.

CStringFeatures<uint8_t>* strings [protected]

stringfeatures the wdfeatures are based on

Definition at line 226 of file WDFeatures.h.

int32_t w_dim [protected]

w dim

Definition at line 239 of file WDFeatures.h.

float64_t* wd_weights [protected]

wd weights

Definition at line 241 of file WDFeatures.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