CCombinedDotFeatures Class Reference

Detailed Description

Features that allow stacking of a number of DotFeatures.

They transparently provide all the operations of DotFeatures, i.e.

a way to obtain the dimensionality of the feature space, i.e. $\mbox{dim}({\cal X})$

dot product between feature vectors:

$r = {\bf x} \cdot {\bf x'}$

dot product between feature vector and a dense vector ${\bf z}$ :

$r = {\bf x} \cdot {\bf z}$

multiplication with a scalar $\alpha$ and addition on to a dense vector ${\bf z}$ :

${\bf z'} = \alpha {\bf x} + {\bf z}$

Definition at line 43 of file CombinedDotFeatures.h.

Inheritance diagram for CCombinedDotFeatures:

[legend]

List of all members.

Public Member Functions
	CCombinedDotFeatures ()
	CCombinedDotFeatures (const CCombinedDotFeatures &orig)
virtual	~CCombinedDotFeatures ()
virtual int32_t	get_num_vectors ()
virtual int32_t	get_dim_feature_space ()
virtual float64_t	dot (int32_t vec_idx1, 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 EFeatureType	get_feature_type ()
virtual EFeatureClass	get_feature_class ()
virtual int32_t	get_size ()
virtual CFeatures *	duplicate () const
void	list_feature_objs ()
CDotFeatures *	get_first_feature_obj ()
CDotFeatures *	get_first_feature_obj (CListElement< CDotFeatures * > *&current)
CDotFeatures *	get_next_feature_obj ()
CDotFeatures *	get_next_feature_obj (CListElement< CDotFeatures * > *&current)
CDotFeatures *	get_last_feature_obj ()
bool	insert_feature_obj (CDotFeatures *obj)
bool	append_feature_obj (CDotFeatures *obj)
bool	delete_feature_obj ()
int32_t	get_num_feature_obj ()
virtual void	get_subfeature_weights (float64_t *weights, int32_t num_weights)
virtual void	set_subfeature_weights (float64_t *weights, int32_t num_weights)
virtual const char *	get_name () const
Protected Member Functions
void	update_dim_feature_space_and_num_vec ()
Protected Attributes
CList< CDotFeatures * > *	feature_list
int32_t	num_vectors
	total number of vectors
int32_t	num_dimensions
	total number of dimensions

Constructor & Destructor Documentation

CCombinedDotFeatures ( )

constructor

Definition at line 17 of file CombinedDotFeatures.cpp.

CCombinedDotFeatures ( const CCombinedDotFeatures & orig )

copy constructor

Definition at line 23 of file CombinedDotFeatures.cpp.

~CCombinedDotFeatures ( ) [virtual]

destructor

Definition at line 34 of file CombinedDotFeatures.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 119 of file CombinedDotFeatures.cpp.

bool append_feature_obj ( CDotFeatures * obj )

append feature object

Parameters:

obj

feature object to append

Returns:: if appending was successful

Definition at line 210 of file CombinedDotFeatures.h.

bool delete_feature_obj ( )

delete feature object

Returns:: if deleting was successful

Definition at line 223 of file CombinedDotFeatures.h.

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 100 of file CombinedDotFeatures.cpp.

float64_t dot	(	int32_t	vec_idx1,
		int32_t	vec_idx2
	)			`[virtual]`

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

Parameters:

	vec_idx1	index of first vector
	vec_idx2	index of second vector

Implements CDotFeatures.

Definition at line 84 of file CombinedDotFeatures.cpp.

CFeatures * duplicate ( ) const [virtual]

duplicate feature object

Returns:: feature object

Implements CFeatures.

Definition at line 29 of file CombinedDotFeatures.cpp.

virtual int32_t get_dim_feature_space ( ) [virtual]

obtain the dimensionality of the feature space

Returns:: dimensionality

Implements CDotFeatures.

Definition at line 64 of file CombinedDotFeatures.h.

virtual EFeatureClass get_feature_class ( ) [virtual]

get feature class

Returns:: feature class

Implements CFeatures.

Definition at line 115 of file CombinedDotFeatures.h.

virtual EFeatureType get_feature_type ( ) [virtual]

get feature type

Returns:: templated feature type

Implements CFeatures.

Definition at line 106 of file CombinedDotFeatures.h.

CDotFeatures* get_first_feature_obj ( CListElement< CDotFeatures * > *& current )

get first feature object

Parameters:

current

list of features

Returns:: first feature object

Definition at line 150 of file CombinedDotFeatures.h.

CDotFeatures* get_first_feature_obj ( )

get first feature object

Returns:: first feature object

Definition at line 138 of file CombinedDotFeatures.h.

CDotFeatures* get_last_feature_obj ( )

get last feature object

Returns:: last feature object

Definition at line 184 of file CombinedDotFeatures.h.

virtual const char* get_name ( ) const [virtual]

Returns:: object name

Implements CSGObject.

Definition at line 261 of file CombinedDotFeatures.h.

CDotFeatures* get_next_feature_obj ( CListElement< CDotFeatures * > *& current )

get next feature object

Parameters:

current

list of features

Returns:: next feature object

Definition at line 173 of file CombinedDotFeatures.h.

CDotFeatures* get_next_feature_obj ( )

get next feature object

Returns:: next feature object

Definition at line 161 of file CombinedDotFeatures.h.

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 135 of file CombinedDotFeatures.cpp.

int32_t get_num_feature_obj ( )

get number of feature objects

Returns:: number of feature objects

Definition at line 240 of file CombinedDotFeatures.h.

virtual int32_t get_num_vectors ( ) [virtual]

get number of examples/vectors

abstract base method

Returns:: number of examples/vectors

Implements CFeatures.

Definition at line 55 of file CombinedDotFeatures.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 120 of file CombinedDotFeatures.h.

void get_subfeature_weights	(	float64_t **	weights,
		int32_t *	num_weights
	)			`[virtual]`

get subfeature weights

Parameters:

	weights	subfeature weights
	num_weights	where number of weights is stored

Definition at line 150 of file CombinedDotFeatures.cpp.

bool insert_feature_obj ( CDotFeatures * obj )

insert feature object

Parameters:

obj

feature object to insert

Returns:: if inserting was successful

Definition at line 196 of file CombinedDotFeatures.h.

void list_feature_objs ( )

list feature objects

Definition at line 39 of file CombinedDotFeatures.cpp.

void set_subfeature_weights	(	float64_t *	weights,
		int32_t	num_weights
	)			`[virtual]`

set subfeature weights

Parameters:

	weights	new subfeature weights
	num_weights	number of subfeature weights

Definition at line 168 of file CombinedDotFeatures.cpp.

void update_dim_feature_space_and_num_vec ( ) [protected]

update total number of dimensions and vectors

Definition at line 57 of file CombinedDotFeatures.cpp.

Member Data Documentation

CList<CDotFeatures*>* feature_list [protected]

feature list

Definition at line 269 of file CombinedDotFeatures.h.

int32_t num_dimensions [protected]

total number of dimensions

Definition at line 274 of file CombinedDotFeatures.h.

int32_t num_vectors [protected]

total number of vectors

Definition at line 272 of file CombinedDotFeatures.h.

The documentation for this class was generated from the following files:

CCombinedDotFeatures Class Reference

Detailed Description

Public Member Functions

Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation