CDenseFeatures< ST > Singleton Reference

详细描述

template<class ST>
singleton shogun::CDenseFeatures< ST >

The class DenseFeatures implements dense feature matrices.

The feature matrices are stored en-block in memory in fortran order, i.e. column-by-column, where a column denotes a feature vector.

There are get_num_vectors() many feature vectors, of dimension get_num_features(). To access a feature vector call get_feature_vector() and when you are done treating it call free_feature_vector(). While free_feature_vector() is a NOP in most cases feature vectors might have been generated on the fly (due to a number preprocessors being attached to them).

From this template class a number the following dense feature matrix types are used and supported:

• bool matrix - CDenseFeatures<bool>
• 8bit char matrix - CDenseFeatures<char>
• 8bit Byte matrix - CDenseFeatures<uint8_t>
• 16bit Integer matrix - CDenseFeatures<int16_t>
• 16bit Word matrix - CDenseFeatures<uint16_t>
• 32bit Integer matrix - CDenseFeatures<int32_t>
• 32bit Unsigned Integer matrix - CDenseFeatures<uint32_t>
• 32bit Float matrix - CDenseFeatures<float32_t>
• 64bit Float matrix - CDenseFeatures<float64_t>
• 64bit Float matrix in a file - CRealFileFeatures
• 64bit Tangent of posterior log-odds (TOP) features from HMM - CTOPFeatures
• 64bit Fisher Kernel (FK) features from HMM - CTOPFeatures
• 96bit Float matrix - CDenseFeatures<floatmax_t>

Partly) subset access is supported for this feature type. Dense use the (inherited) add_subset(), remove_subset() functions. If done, all calls that work with features are translated to the subset. See comments to find out whether it is supported for that method. See also CFeatures class documentation

在文件 LDA.h 第 41 行定义.

类 CDenseFeatures< ST > 继承关系图:

Public 成员函数
	CDenseFeatures (int32_t size=0)
	CDenseFeatures (const CDenseFeatures &orig)
	CDenseFeatures (SGMatrix< ST > matrix)
	CDenseFeatures (ST *src, int32_t num_feat, int32_t num_vec)
	CDenseFeatures (CFile *loader)
virtual CFeatures *	duplicate () const
virtual	~CDenseFeatures ()
void	free_feature_matrix ()
void	free_features ()
ST *	get_feature_vector (int32_t num, int32_t &len, bool &dofree)
void	set_feature_vector (SGVector< ST > vector, int32_t num)
SGVector< ST >	get_feature_vector (int32_t num)
void	free_feature_vector (ST *feat_vec, int32_t num, bool dofree)
void	free_feature_vector (SGVector< ST > 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< ST >	get_feature_matrix ()
SGMatrix< ST >	steal_feature_matrix ()
void	set_feature_matrix (SGMatrix< ST > matrix)
ST *	get_feature_matrix (int32_t &num_feat, int32_t &num_vec)
CDenseFeatures< ST > *	get_transposed ()
ST *	get_transposed (int32_t &num_feat, int32_t &num_vec)
virtual void	copy_feature_matrix (SGMatrix< ST > src)
void	obtain_from_dot (CDotFeatures *df)
virtual bool	apply_preprocessor (bool force_preprocessing=false)
virtual int32_t	get_num_vectors () const
int32_t	get_num_features () const
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 CFeatures *	copy_subset (SGVector< index_t > indices)
virtual CFeatures *	copy_dimension_subset (SGVector< index_t > dims)
virtual bool	is_equal (CDenseFeatures *rhs)
CFeatures *	create_merged_copy (CList *other)
CFeatures *	create_merged_copy (CFeatures *other)
virtual const char *	get_name () const
template<>
void	add_to_dense_vec (float64_t alpha, int32_t vec_idx1, float64_t *vec2, int32_t vec2_len, bool abs_val)
template<>
float64_t	dense_dot (int32_t vec_idx1, const float64_t *vec2, int32_t vec2_len)
template<>
float64_t	dense_dot (int32_t vec_idx1, const float64_t *vec2, int32_t vec2_len)
template<>
float64_t	dense_dot (int32_t vec_idx1, const float64_t *vec2, int32_t vec2_len)
template<>
float64_t	dense_dot (int32_t vec_idx1, const float64_t *vec2, int32_t vec2_len)
template<>
float64_t	dense_dot (int32_t vec_idx1, const float64_t *vec2, int32_t vec2_len)
template<>
float64_t	dense_dot (int32_t vec_idx1, const float64_t *vec2, int32_t vec2_len)
template<>
float64_t	dense_dot (int32_t vec_idx1, const float64_t *vec2, int32_t vec2_len)
template<>
float64_t	dense_dot (int32_t vec_idx1, const float64_t *vec2, int32_t vec2_len)
template<>
float64_t	dense_dot (int32_t vec_idx1, const float64_t *vec2, int32_t vec2_len)
template<>
float64_t	dense_dot (int32_t vec_idx1, const float64_t *vec2, int32_t vec2_len)
template<>
float64_t	dense_dot (int32_t vec_idx1, const float64_t *vec2, int32_t vec2_len)
template<>
float64_t	dense_dot (int32_t vec_idx1, const float64_t *vec2, int32_t vec2_len)
template<>
float64_t	dense_dot (int32_t vec_idx1, const float64_t *vec2, int32_t vec2_len)
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_t >	get_computed_dot_feature_matrix ()
SGVector< float64_t >	get_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_t >	get_mean ()
virtual SGMatrix< float64_t >	get_cov ()
virtual void	add_preprocessor (CPreprocessor *p)
virtual void	del_preprocessor (int32_t num)
CPreprocessor *	get_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
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	add_subset_in_place (SGVector< index_t > subset)
virtual void	remove_subset ()
virtual void	remove_all_subsets ()
virtual CSubsetStack *	get_subset_stack ()
virtual void	subset_changed_post ()
virtual bool	support_compatible_class () const
virtual bool	get_feature_class_compatibility (EFeatureClass rhs) const
virtual CSGObject *	shallow_copy () const
virtual CSGObject *	deep_copy () const
virtual bool	is_generic (EPrimitiveType *generic) const
template<class T >
void	set_generic ()
template<>
void	set_generic ()
template<>
void	set_generic ()
template<>
void	set_generic ()
template<>
void	set_generic ()
template<>
void	set_generic ()
template<>
void	set_generic ()
template<>
void	set_generic ()
template<>
void	set_generic ()
template<>
void	set_generic ()
template<>
void	set_generic ()
template<>
void	set_generic ()
template<>
void	set_generic ()
template<>
void	set_generic ()
template<>
void	set_generic ()
template<>
void	set_generic ()
void	unset_generic ()
virtual void	print_serializable (const char *prefix="")
virtual bool	save_serializable (CSerializableFile *file, const char *prefix="")
virtual bool	load_serializable (CSerializableFile *file, const char *prefix="")
void	set_global_io (SGIO *io)
SGIO *	get_global_io ()
void	set_global_parallel (Parallel *parallel)
Parallel *	get_global_parallel ()
void	set_global_version (Version *version)
Version *	get_global_version ()
SGStringList< char >	get_modelsel_names ()
void	print_modsel_params ()
char *	get_modsel_param_descr (const char *param_name)
index_t	get_modsel_param_index (const char *param_name)
void	build_gradient_parameter_dictionary (CMap< TParameter *, CSGObject * > *dict)
virtual void	update_parameter_hash ()
virtual bool	parameter_hash_changed ()
virtual bool	equals (CSGObject *other, float64_t accuracy=0.0, bool tolerant=false)
virtual CSGObject *	clone ()

静态 Public 成员函数
static CDenseFeatures *	obtain_from_generic (CFeatures *const base_features)
static void *	dense_dot_range_helper (void *p)
static SGVector< float64_t >	get_mean (CDotFeatures *lhs, CDotFeatures *rhs)
static SGMatrix< float64_t >	compute_cov (CDotFeatures *lhs, CDotFeatures *rhs)

Public 属性
SGIO *	io
Parallel *	parallel
Version *	version
Parameter *	m_parameters
Parameter *	m_model_selection_parameters
Parameter *	m_gradient_parameters
uint32_t	m_hash

Protected 成员函数
virtual ST *	compute_feature_vector (int32_t num, int32_t &len, ST *target=NULL)
void	display_progress (int32_t start, int32_t stop, int32_t v)
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 属性
int32_t	num_vectors
	number of vectors in cache 更多...
int32_t	num_features
	number of features in cache 更多...
SGMatrix< ST >	feature_matrix
CCache< ST > *	feature_cache
float64_t	combined_weight
	feature weighting in combined dot features 更多...
CSubsetStack *	m_subset_stack

构造及析构函数说明

CDenseFeatures

(

int32_t

size = 0

)

constructor

参数

size	cache size

在文件 DenseFeatures.cpp 第 24 行定义.

CDenseFeatures

(

const CDenseFeatures< ST > &

orig

)

copy constructor

在文件 DenseFeatures.cpp 第 29 行定义.

CDenseFeatures

(

SGMatrix< ST >

matrix

)

constructor

参数

matrix

feature matrix

在文件 DenseFeatures.cpp 第 44 行定义.

CDenseFeatures	(	ST *	src,
		int32_t	num_feat,
		int32_t	num_vec
	)

constructor

参数

src	feature matrix
num_feat	number of features in matrix
num_vec	number of vectors in matrix

在文件 DenseFeatures.cpp 第 51 行定义.

CDenseFeatures

(

CFile *

loader

)

constructor loading features from file

参数

loader

File object via which to load data

在文件 DenseFeatures.cpp 第 57 行定义.

~CDenseFeatures ( )

virtual

在文件 DenseFeatures.cpp 第 69 行定义.

成员函数说明

void add_preprocessor ( CPreprocessor *  p )

virtualinherited

add preprocessor

参数

p	preprocessor to set

在文件 Features.cpp 第 85 行定义.

void add_subset ( SGVector< index_t >  subset )

virtualinherited

Adds a subset of indices on top of the current subsets (possibly subset of subset). Every call causes a new active index vector to be stored. Added subsets can be removed one-by-one. If this is not needed, add_subset_in_place() should be used (does not store intermediate index vectors)

Calls subset_changed_post() afterwards

参数

subset

subset of indices to add

被 CCombinedFeatures 重载.

在文件 Features.cpp 第 310 行定义.

void add_subset_in_place ( SGVector< index_t >  subset )

virtualinherited

Sets/changes latest added subset. This allows to add multiple subsets with in-place memory requirements. They cannot be removed one-by-one afterwards, only the latest active can. If this is needed, use add_subset(). If no subset is active, this just adds.

Calls subset_changed_post() afterwards

参数

subset

subset of indices to replace the latest one with.

在文件 Features.cpp 第 316 行定义.

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

possible with subset

参数

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

实现了 CDotFeatures.

在文件 DenseFeatures.cpp 第 498 行定义.

void add_to_dense_vec ( float64_t  alpha, int32_t  vec_idx1, float64_t *  vec2, int32_t  vec2_len, bool  abs_val  )

virtual

add vector 1 multiplied with alpha to dense vector2

参数

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

实现了 CDotFeatures.

在文件 DenseFeatures.cpp 第 524 行定义.

bool apply_preprocessor ( bool  force_preprocessing = false )

virtual

apply preprocessor

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

not possible with subset

参数

force_preprocessing

if preprocssing shall be forced

返回

if applying was successful

在文件 DenseFeatures.cpp 第 379 行定义.

void benchmark_add_to_dense_vector ( int32_t  repeats = 5 )

inherited

run benchmark for add_to_dense_vec

在文件 DotFeatures.cpp 第 318 行定义.

void benchmark_dense_dot_range ( int32_t  repeats = 5 )

inherited

run benchmark for dense_dot_range

在文件 DotFeatures.cpp 第 341 行定义.

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.

参数

dict	dictionary of parameters to be built.

在文件 SGObject.cpp 第 597 行定义.

bool check_feature_compatibility ( CFeatures *  f ) const

inherited

check feature compatibility

参数

f	features to check for compatibility

返回

if features are compatible

在文件 Features.cpp 第 283 行定义.

void clean_preprocessors ( )

inherited

clears all preprocs

在文件 Features.cpp 第 116 行定义.

CSGObject * clone ( )

virtualinherited

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.

返回

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

在文件 SGObject.cpp 第 714 行定义.

SGMatrix< float64_t > compute_cov ( CDotFeatures *  lhs, CDotFeatures *  rhs  )

staticinherited

compute the covariance of two CDotFeatures together

返回

covariance

在文件 DotFeatures.cpp 第 469 行定义.

ST * compute_feature_vector ( int32_t  num, int32_t &  len, ST *  target = NULL  )

protectedvirtual

compute feature vector for sample num if target is set the vector is written to target len is returned by reference

NOT IMPLEMENTED!

参数

num	num
len	len
target

返回

feature vector

被 CTOPFeatures, CFKFeatures , 以及 CRealFileFeatures 重载.

在文件 DenseFeatures.cpp 第 639 行定义.

CFeatures * copy_dimension_subset ( SGVector< index_t >  dims )

virtual

Creates a new CFeatures instance containing only the dimensions of the feature vector which are specified by the provided indices.

This method is needed for feature selection tasks

possible with subset

参数

dims	indices of feature dimensions to copy

返回

new CFeatures instance with copies of specified features

重载 CFeatures .

在文件 DenseFeatures.cpp 第 610 行定义.

void copy_feature_matrix ( SGMatrix< ST >  src )

virtual

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

参数

src	feature matrix to copy

在文件 DenseFeatures.cpp 第 343 行定义.

CFeatures * copy_subset ( SGVector< index_t >  indices )

virtual

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

possible with subset

参数

indices

indices of feature elements to copy

返回

new CFeatures instance with copies of feature data

重载 CFeatures .

在文件 DenseFeatures.cpp 第 592 行定义.

CFeatures * create_merged_copy ( CList *  other )

virtual

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

参数

other

feature object to append

返回

new feature object which contains copy of data of this instance and of given one

重载 CFeatures .

在文件 DenseFeatures.cpp 第 976 行定义.

CFeatures * create_merged_copy ( CFeatures *  other )

virtual

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

参数

other

feature object to append

返回

new feature object which contains copy of data of this instance and of given one

重载 CFeatures .

在文件 DenseFeatures.cpp 第 1058 行定义.

CSGObject * deep_copy ( ) const

virtualinherited

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

在文件 SGObject.cpp 第 198 行定义.

void del_preprocessor ( int32_t  num )

virtualinherited

delete preprocessor from list

参数

num	index of preprocessor in list

在文件 Features.cpp 第 122 行定义.

virtual 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

possible with subset

参数

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

实现了 CDotFeatures.

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

参数

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

实现了 CDotFeatures.

在文件 DenseFeatures.cpp 第 685 行定义.

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

参数

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

实现了 CDotFeatures.

在文件 DenseFeatures.cpp 第 705 行定义.

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

参数

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

实现了 CDotFeatures.

在文件 DenseFeatures.cpp 第 725 行定义.

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

参数

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

实现了 CDotFeatures.

在文件 DenseFeatures.cpp 第 745 行定义.

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

参数

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

实现了 CDotFeatures.

在文件 DenseFeatures.cpp 第 765 行定义.

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

参数

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

实现了 CDotFeatures.

在文件 DenseFeatures.cpp 第 785 行定义.

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

参数

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

实现了 CDotFeatures.

在文件 DenseFeatures.cpp 第 805 行定义.

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

参数

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

实现了 CDotFeatures.

在文件 DenseFeatures.cpp 第 825 行定义.

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

参数

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

实现了 CDotFeatures.

在文件 DenseFeatures.cpp 第 845 行定义.

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

参数

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

实现了 CDotFeatures.

在文件 DenseFeatures.cpp 第 865 行定义.

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

参数

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

实现了 CDotFeatures.

在文件 DenseFeatures.cpp 第 885 行定义.

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

参数

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

实现了 CDotFeatures.

在文件 DenseFeatures.cpp 第 905 行定义.

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

参数

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

实现了 CDotFeatures.

在文件 DenseFeatures.cpp 第 922 行定义.

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  )

virtualinherited

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

参数

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)]

被 CCombinedDotFeatures , 以及 CHashedWDFeaturesTransposed 重载.

在文件 DotFeatures.cpp 第 67 行定义.

void * dense_dot_range_helper ( void *  p )

staticinherited

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

在文件 DotFeatures.cpp 第 231 行定义.

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  )

virtualinherited

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

参数

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

被 CCombinedDotFeatures , 以及 CHashedWDFeaturesTransposed 重载.

在文件 DotFeatures.cpp 第 153 行定义.

float64_t dense_dot_sgvec ( int32_t  vec_idx1, const SGVector< float64_t >  vec2  )

virtualinherited

compute dot product between vector1 and a dense vector

参数

vec_idx1	index of first vector
vec2	dense vector

被 CHashedDocDotFeatures 重载.

在文件 DotFeatures.cpp 第 62 行定义.

void display_progress ( int32_t  start, int32_t  stop, int32_t  v  )

protectedinherited

display progress output

参数

start	minimum value
stop	maximum value
v	current value

在文件 DotFeatures.cpp 第 528 行定义.

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

possible with subset

参数

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

实现了 CDotFeatures.

在文件 DenseFeatures.cpp 第 476 行定义.

CFeatures * duplicate ( ) const

virtual

duplicate feature object

返回

feature object

实现了 CFeatures.

在文件 DenseFeatures.cpp 第 64 行定义.

bool equals ( CSGObject *  other, float64_t  accuracy = 0.0, bool  tolerant = false  )

virtualinherited

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.

参数

other	object to compare with
accuracy	accuracy to use for comparison (optional)
tolerant	allows linient check on float equality (within accuracy)

返回

true if all parameters were equal, false if not

在文件 SGObject.cpp 第 618 行定义.

void feature_subset	(	int32_t *	idx,
		int32_t	idx_len
	)

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.

参数

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

Note: assumes idx is sorted

在文件 DenseFeatures.cpp 第 237 行定义.

void free_feature_iterator ( void *  iterator )

virtual

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

参数

iterator

as returned by get_first_feature

实现了 CDotFeatures.

在文件 DenseFeatures.cpp 第 582 行定义.

void free_feature_matrix

(

)

free feature matrix

Any subset is removed

在文件 DenseFeatures.cpp 第 81 行定义.

void free_feature_vector	(	ST *	feat_vec,
		int32_t	num,
		bool	dofree
	)

free feature vector

possible with subset

参数

feat_vec	feature vector to free
num	index in feature cache
dofree	if vector should be really deleted

在文件 DenseFeatures.cpp 第 191 行定义.

void free_feature_vector	(	SGVector< ST >	vec,
		int32_t	num
	)

free feature vector

possible with subset

参数

vec	feature vector to free
num	index in feature cache

在文件 DenseFeatures.cpp 第 200 行定义.

void free_features

(

)

free feature matrix and cache

Any subset is removed

在文件 DenseFeatures.cpp 第 74 行定义.

int32_t get_cache_size ( ) const

inherited

get cache size

返回

cache size

在文件 Features.cpp 第 160 行定义.

float64_t get_combined_feature_weight ( )

inherited

get combined feature weight

返回

combined feature weight

在文件 DotFeatures.h 第 154 行定义.

SGMatrix< float64_t > get_computed_dot_feature_matrix ( )

inherited

compute the feature matrix in feature space

返回

computed feature matrix

在文件 DotFeatures.cpp 第 284 行定义.

SGVector< float64_t > get_computed_dot_feature_vector ( int32_t  num )

inherited

compute the feature vector in feature space

返回

computed feature vector

在文件 DotFeatures.cpp 第 305 行定义.

SGMatrix< float64_t > get_cov ( )

virtualinherited

get covariance

返回

covariance

在文件 DotFeatures.cpp 第 427 行定义.

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())

返回

dimensionality

实现了 CDotFeatures.

在文件 DenseFeatures.cpp 第 474 行定义.

EFeatureClass get_feature_class ( ) const

virtual

get feature class

返回

feature class DENSE

实现了 CFeatures.

在文件 DenseFeatures.cpp 第 457 行定义.

bool get_feature_class_compatibility ( EFeatureClass  rhs ) const

virtualinherited

Given a class in right hand side, does this class support compatible computation?

for example, is this->dot(rhs_prt) valid, where rhs_prt is the class in right hand side

参数

rhs	the class in right hand side

返回

whether this class supports compatible computation

被 CDenseSubSamplesFeatures< ST > 重载.

在文件 Features.cpp 第 355 行定义.

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

possible with subset

参数

vector_index

the index of the vector over whose components to iterate over

返回

feature iterator (to be passed to get_next_feature)

实现了 CDotFeatures.

在文件 DenseFeatures.cpp 第 553 行定义.

SGMatrix< ST > get_feature_matrix

(

)

Getter the feature matrix

in-place without subset a copy with subset

返回

matrix feature matrix

在文件 DenseFeatures.cpp 第 267 行定义.

ST * get_feature_matrix	(	int32_t &	num_feat,
		int32_t &	num_vec
	)

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

subset is ignored

参数

num_feat	number of features in matrix
num_vec	number of vectors in matrix

返回

feature matrix

在文件 DenseFeatures.cpp 第 305 行定义.

virtual EFeatureType get_feature_type ( ) const

virtual

get feature type

返回

templated feature type

实现了 CFeatures.

ST * get_feature_vector	(	int32_t	num,
		int32_t &	len,
		bool &	dofree
	)

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

参数

num	index of feature vector
len	length is returned by reference
dofree	whether returned vector must be freed by caller via free_feature_vector

返回

feature vector

在文件 DenseFeatures.cpp 第 89 行定义.

SGVector< ST > get_feature_vector

(

int32_t

num

)

get feature vector num

possible with subset

参数

num	index of vector

返回

feature vector

在文件 DenseFeatures.cpp 第 174 行定义.

SGIO * get_global_io ( )

inherited

get the io object

返回

io object

在文件 SGObject.cpp 第 235 行定义.

Parallel * get_global_parallel ( )

inherited

get the parallel object

返回

parallel object

在文件 SGObject.cpp 第 277 行定义.

Version * get_global_version ( )

inherited

get the version object

返回

version object

在文件 SGObject.cpp 第 290 行定义.

SGVector< float64_t > get_mean ( )

virtualinherited

get mean

返回

mean returned

在文件 DotFeatures.cpp 第 384 行定义.

SGVector< float64_t > get_mean ( CDotFeatures *  lhs, CDotFeatures *  rhs  )

staticinherited

get mean of two CDotFeature objects

返回

mean returned

在文件 DotFeatures.cpp 第 402 行定义.

SGStringList< char > get_modelsel_names ( )

inherited

返回

vector of names of all parameters which are registered for model selection

在文件 SGObject.cpp 第 498 行定义.

char * get_modsel_param_descr ( const char *  param_name )

inherited

Returns description of a given parameter string, if it exists. SG_ERROR otherwise

参数

param_name

name of the parameter

返回

description of the parameter

在文件 SGObject.cpp 第 522 行定义.

index_t get_modsel_param_index ( const char *  param_name )

inherited

Returns index of model selection parameter with provided index

参数

param_name

name of model selection parameter

返回

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

在文件 SGObject.cpp 第 535 行定义.

virtual const char* get_name ( ) const

virtual

返回

object name

实现了 CSGObject.

被 CTOPFeatures, CFKFeatures , 以及 CRealFileFeatures 重载.

在文件 DenseFeatures.h 第 519 行定义.

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

possible with subset

参数

index	is returned by reference (-1 when not available)
value	is returned by reference
iterator	as returned by get_first_feature

返回

true if a new non-zero feature got returned

实现了 CDotFeatures.

在文件 DenseFeatures.cpp 第 569 行定义.

int32_t get_nnz_features_for_vector ( int32_t  num )

virtual

get number of non-zero features in vector

参数

num	which vector

返回

number of non-zero features in vector

实现了 CDotFeatures.

在文件 DenseFeatures.cpp 第 548 行定义.

int32_t get_num_features

(

)

const

get number of features (of possible subset)

返回

number of features

在文件 DenseFeatures.cpp 第 426 行定义.

int32_t get_num_preprocessed ( ) const

inherited

get the number of applied preprocs

返回

number of applied preprocessors

在文件 Features.cpp 第 103 行定义.

int32_t get_num_preprocessors ( ) const

inherited

get number of preprocessors

返回

number of preprocessors

在文件 Features.cpp 第 155 行定义.

int32_t get_num_vectors ( ) const

virtual

get number of feature vectors

返回

number of feature vectors

实现了 CFeatures.

在文件 DenseFeatures.cpp 第 421 行定义.

CPreprocessor * get_preprocessor ( int32_t  num ) const

inherited

get specified preprocessor

参数

num	index of preprocessor in list

在文件 Features.cpp 第 93 行定义.

CSubsetStack * get_subset_stack ( )

virtualinherited

returns subset stack

返回

subset stack

在文件 Features.cpp 第 334 行定义.

CDenseFeatures< ST > * get_transposed

(

)

get a transposed copy of the features

possible with subset

返回

transposed copy

在文件 DenseFeatures.cpp 第 312 行定义.

ST * get_transposed	(	int32_t &	num_feat,
		int32_t &	num_vec
	)

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

参数

num_feat	number of features in matrix
num_vec	number of vectors in matrix

返回

transposed sparse feature matrix

在文件 DenseFeatures.cpp 第 321 行定义.

bool has_property ( EFeatureProperty  p ) const

inherited

check if features have given property

参数

p	feature property

返回

if features have given property

在文件 Features.cpp 第 295 行定义.

void initialize_cache

(

)

Initialize cache

not possible with subset

在文件 DenseFeatures.cpp 第 443 行定义.

bool is_equal ( CDenseFeatures< ST > *  rhs )

virtual

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

参数

rhs	other CDenseFeatures object to compare to this one

返回

whether they represent the same information

在文件 DenseFeatures.cpp 第 942 行定义.

bool is_generic ( EPrimitiveType *  generic ) const

virtualinherited

If the SGSerializable is a class template then TRUE will be returned and GENERIC is set to the type of the generic.

参数

generic

set to the type of the generic if returning TRUE

返回

TRUE if a class template.

在文件 SGObject.cpp 第 296 行定义.

bool is_preprocessed ( int32_t  num ) const

inherited

get whether specified preprocessor was already applied

参数

num	index of preprocessor in list

在文件 Features.cpp 第 149 行定义.

void list_feature_obj ( ) const

inherited

list feature object

在文件 Features.cpp 第 171 行定义.

void list_preprocessors ( )

inherited

print preprocessors

在文件 Features.cpp 第 131 行定义.

void load ( CFile *  loader )

virtual

load features from file

参数

loader

File object via which to load data

重载 CFeatures .

在文件 DenseFeatures.cpp 第 1074 行定义.

bool load_serializable ( CSerializableFile *  file, const char *  prefix = ""  )

virtualinherited

Load this object from file. If it will fail (returning FALSE) then this object will contain inconsistent data and should not be used!

参数

file	where to load from
prefix	prefix for members

返回

TRUE if done, otherwise FALSE

在文件 SGObject.cpp 第 369 行定义.

void load_serializable_post ( ) throw ( ShogunException )

protectedvirtualinherited

Can (optionally) be overridden to post-initialize some member variables which are not PARAMETER::ADD'ed. Make sure that at first the overridden method BASE_CLASS::LOAD_SERIALIZABLE_POST is called.

异常

ShogunException

will be thrown if an error occurs.

被 CKernel, CWeightedDegreePositionStringKernel, CList, CAlphabet, CLinearHMM, CGaussianKernel, CInverseMultiQuadricKernel, CCircularKernel , 以及 CExponentialKernel 重载.

在文件 SGObject.cpp 第 426 行定义.

void load_serializable_pre ( ) throw ( ShogunException )

protectedvirtualinherited

Can (optionally) be overridden to pre-initialize some member variables which are not PARAMETER::ADD'ed. Make sure that at first the overridden method BASE_CLASS::LOAD_SERIALIZABLE_PRE is called.

异常

ShogunException

will be thrown if an error occurs.

被 CDynamicArray< T >, CDynamicArray< float64_t >, CDynamicArray< float32_t >, CDynamicArray< int32_t >, CDynamicArray< char >, CDynamicArray< bool > , 以及 CDynamicObjectArray 重载.

在文件 SGObject.cpp 第 421 行定义.

void obtain_from_dot

(

CDotFeatures *

df

)

obtain dense features from other dotfeatures

removes any subset before

参数

df	dotfeatures to obtain features from

在文件 DenseFeatures.cpp 第 355 行定义.

CDenseFeatures< ST > * obtain_from_generic ( CFeatures *const  base_features )

static

helper method used to specialize a base class instance

在文件 DenseFeatures.cpp 第 1087 行定义.

bool parameter_hash_changed ( )

virtualinherited

返回

whether parameter combination has changed since last update

在文件 SGObject.cpp 第 262 行定义.

void print_modsel_params ( )

inherited

prints all parameter registered for model selection and their type

在文件 SGObject.cpp 第 474 行定义.

void print_serializable ( const char *  prefix = "" )

virtualinherited

prints registered parameters out

参数

prefix

prefix for members

在文件 SGObject.cpp 第 308 行定义.

void remove_all_subsets ( )

virtualinherited

removes all subsets Calls subset_changed_post() afterwards

被 CCombinedFeatures 重载.

在文件 Features.cpp 第 328 行定义.

void remove_subset ( )

virtualinherited

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

被 CCombinedFeatures 重载.

在文件 Features.cpp 第 322 行定义.

bool reshape ( int32_t  p_num_features, int32_t  p_num_vectors  )

virtual

reshape

not possible with subset

参数

p_num_features	new number of features
p_num_vectors	new number of vectors

返回

if reshaping was successful

重载 CFeatures .

在文件 DenseFeatures.cpp 第 459 行定义.

void save ( CFile *  saver )

virtual

save features to file

参数

saver

File object via which to save data

重载 CFeatures .

在文件 DenseFeatures.cpp 第 1082 行定义.

bool save_serializable ( CSerializableFile *  file, const char *  prefix = ""  )

virtualinherited

Save this object to file.

参数

file	where to save the object; will be closed during returning if PREFIX is an empty string.
prefix	prefix for members

返回

TRUE if done, otherwise FALSE

在文件 SGObject.cpp 第 314 行定义.

void save_serializable_post ( ) throw ( ShogunException )

protectedvirtualinherited

Can (optionally) be overridden to post-initialize some member variables which are not PARAMETER::ADD'ed. Make sure that at first the overridden method BASE_CLASS::SAVE_SERIALIZABLE_POST is called.

异常

ShogunException

will be thrown if an error occurs.

被 CKernel 重载.

在文件 SGObject.cpp 第 436 行定义.

void save_serializable_pre ( ) throw ( ShogunException )

protectedvirtualinherited

Can (optionally) be overridden to pre-initialize some member variables which are not PARAMETER::ADD'ed. Make sure that at first the overridden method BASE_CLASS::SAVE_SERIALIZABLE_PRE is called.

异常

ShogunException

will be thrown if an error occurs.

被 CKernel, CDynamicArray< T >, CDynamicArray< float64_t >, CDynamicArray< float32_t >, CDynamicArray< int32_t >, CDynamicArray< char >, CDynamicArray< bool > , 以及 CDynamicObjectArray 重载.

在文件 SGObject.cpp 第 431 行定义.

void set_combined_feature_weight ( float64_t  nw )

inherited

set combined kernel weight

参数

nw	new combined feature weight

在文件 DotFeatures.h 第 160 行定义.

void set_feature_matrix

(

SGMatrix< ST >

matrix

)

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

参数

matrix

feature matrix to set

在文件 DenseFeatures.cpp 第 296 行定义.

void set_feature_vector	(	SGVector< ST >	vector,
		int32_t	num
	)

set feature vector num

possible with subset

参数

vector	vector
num	index if vector to set

在文件 DenseFeatures.cpp 第 152 行定义.

void set_generic ( )

inherited

在文件 SGObject.cpp 第 41 行定义.

void set_generic ( )

inherited

在文件 SGObject.cpp 第 46 行定义.

void set_generic ( )

inherited

在文件 SGObject.cpp 第 51 行定义.

void set_generic ( )

inherited

在文件 SGObject.cpp 第 56 行定义.

void set_generic ( )

inherited

在文件 SGObject.cpp 第 61 行定义.

void set_generic ( )

inherited

在文件 SGObject.cpp 第 66 行定义.

void set_generic ( )

inherited

在文件 SGObject.cpp 第 71 行定义.

void set_generic ( )

inherited

在文件 SGObject.cpp 第 76 行定义.

void set_generic ( )

inherited

在文件 SGObject.cpp 第 81 行定义.

void set_generic ( )

inherited

在文件 SGObject.cpp 第 86 行定义.

void set_generic ( )

inherited

在文件 SGObject.cpp 第 91 行定义.

void set_generic ( )

inherited

在文件 SGObject.cpp 第 96 行定义.

void set_generic ( )

inherited

在文件 SGObject.cpp 第 101 行定义.

void set_generic ( )

inherited

在文件 SGObject.cpp 第 106 行定义.

void set_generic ( )

inherited

在文件 SGObject.cpp 第 111 行定义.

void set_generic ( )

inherited

set generic type to T

void set_global_io ( SGIO *  io )

inherited

set the io object

参数

io	io object to use

在文件 SGObject.cpp 第 228 行定义.

void set_global_parallel ( Parallel *  parallel )

inherited

set the parallel object

参数

parallel

parallel object to use

在文件 SGObject.cpp 第 241 行定义.

void set_global_version ( Version *  version )

inherited

set the version object

参数

version

version object to use

在文件 SGObject.cpp 第 283 行定义.

void set_num_features

(

int32_t

num

)

set number of features

参数

num	number to set

在文件 DenseFeatures.cpp 第 428 行定义.

void set_num_vectors

(

int32_t

num

)

set number of vectors

not possible with subset

参数

num	number to set

在文件 DenseFeatures.cpp 第 434 行定义.

void set_preprocessed ( int32_t  num )

inherited

set applied flag for preprocessor

参数

num	index of preprocessor in list

在文件 Features.cpp 第 143 行定义.

void set_property ( EFeatureProperty  p )

inherited

set property

参数

p	kernel property to set

在文件 Features.cpp 第 300 行定义.

CSGObject * shallow_copy ( ) const

virtualinherited

A shallow copy. All the SGObject instance variables will be simply assigned and SG_REF-ed.

被 CGaussianKernel 重载.

在文件 SGObject.cpp 第 192 行定义.

SGMatrix< ST > steal_feature_matrix

(

)

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

返回

matrix feature matrix

在文件 DenseFeatures.cpp 第 286 行定义.

virtual void subset_changed_post ( )

virtualinherited

method may be overwritten to update things that depend on subset

被 CStringFeatures< ST >, CStringFeatures< T >, CStringFeatures< uint8_t >, CStringFeatures< char > , 以及 CStringFeatures< uint16_t > 重载.

在文件 Features.h 第 293 行定义.

virtual bool support_compatible_class ( ) const

virtualinherited

does this class support compatible computation bewteen difference classes? for example, this->dot(rhs_prt), can rhs_prt be an instance of a difference class?

返回

whether this class supports compatible computation

被 CDenseSubSamplesFeatures< ST > 重载.

在文件 Features.h 第 323 行定义.

void unset_generic ( )

inherited

unset generic type

this has to be called in classes specializing a template class

在文件 SGObject.cpp 第 303 行定义.

void unset_property ( EFeatureProperty  p )

inherited

unset property

参数

p	kernel property to unset

在文件 Features.cpp 第 305 行定义.

void update_parameter_hash ( )

virtualinherited

Updates the hash of current parameter combination

在文件 SGObject.cpp 第 248 行定义.

void vector_subset	(	int32_t *	idx,
		int32_t	idx_len
	)

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

参数

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

Note: assumes idx is sorted

在文件 DenseFeatures.cpp 第 206 行定义.

类成员变量说明

float64_t combined_weight

protectedinherited

feature weighting in combined dot features

在文件 DotFeatures.h 第 249 行定义.

CCache<ST>* feature_cache

protected

feature cache

在文件 DenseFeatures.h 第 553 行定义.

SGMatrix<ST> feature_matrix

protected

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

在文件 DenseFeatures.h 第 550 行定义.

SGIO* io

inherited

io

在文件 SGObject.h 第 369 行定义.

Parameter* m_gradient_parameters

inherited

parameters wrt which we can compute gradients

在文件 SGObject.h 第 384 行定义.

uint32_t m_hash

inherited

Hash of parameter values

在文件 SGObject.h 第 387 行定义.

Parameter* m_model_selection_parameters

inherited

model selection parameters

在文件 SGObject.h 第 381 行定义.

Parameter* m_parameters

inherited

parameters

在文件 SGObject.h 第 378 行定义.

CSubsetStack* m_subset_stack

protectedinherited

subset used for index transformations

在文件 Features.h 第 352 行定义.

int32_t num_features

protected

number of features in cache

在文件 DenseFeatures.h 第 544 行定义.

int32_t num_vectors

protected

number of vectors in cache

在文件 DenseFeatures.h 第 541 行定义.

Parallel* parallel

inherited

parallel

在文件 SGObject.h 第 372 行定义.

Version* version

inherited

version

在文件 SGObject.h 第 375 行定义.

---

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

• LDA.h
• DenseFeatures.h
• DenseFeatures.cpp