SHOGUN v0.9.0
公有成员 | 保护属性
CSNPFeatures类参考

详细描述

Features that compute the Weighted Degreee Kernel feature space explicitly.

参见:
CWeightedDegreeStringKernel

在文件SNPFeatures.h27行定义。

继承图,类CSNPFeatures
Inheritance graph
[图例]

所有成员的列表。

公有成员

 CSNPFeatures (void)
 CSNPFeatures (CStringFeatures< uint8_t > *str)
 CSNPFeatures (const CSNPFeatures &orig)
virtual ~CSNPFeatures ()
virtual int32_t get_dim_feature_space ()
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 ()
virtual int32_t get_size ()
void set_normalization_const (float64_t n=0)
float64_t get_normalization_const ()
void set_minor_base_string (const char *str)
void set_major_base_string (const char *str)
char * get_minor_base_string ()
char * get_major_base_string ()
void obtain_base_strings ()
virtual const char * get_name () const

保护属性

CStringFeatures< uint8_t > * strings
int32_t string_length
int32_t num_strings
int32_t w_dim
float64_t normalization_const
uint8_t * m_str_min
uint8_t * m_str_maj

构造及析构函数文档

CSNPFeatures ( void  )

default constructor

在文件SNPFeatures.cpp17行定义。

CSNPFeatures ( CStringFeatures< uint8_t > *  str)

constructor

参数:
strstringfeatures (of bytes)

在文件SNPFeatures.cpp33行定义。

CSNPFeatures ( const CSNPFeatures orig)

copy constructor

在文件SNPFeatures.cpp54行定义。

~CSNPFeatures ( ) [virtual]

destructor

在文件SNPFeatures.cpp70行定义。


成员函数文档

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

参数:
alphascalar alpha
vec_idx1index of first vector
vec2pointer to real valued vector
vec2_lenlength of real valued vector
abs_valif true add the absolute value

实现了CDotFeatures

在文件SNPFeatures.cpp172行定义。

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_idx1index of first vector
vec2pointer to real valued vector
vec2_lenlength of real valued vector

实现了CDotFeatures

在文件SNPFeatures.cpp133行定义。

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

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

实现了CDotFeatures

在文件SNPFeatures.cpp75行定义。

CFeatures * duplicate ( ) const [virtual]

duplicate feature object

返回:
feature object

实现了CFeatures

在文件SNPFeatures.cpp284行定义。

void free_feature_iterator ( void *  iterator) [virtual]

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

参数:
iteratoras returned by get_first_feature

实现了CDotFeatures

在文件SNPFeatures.cpp280行定义。

virtual int32_t get_dim_feature_space ( ) [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

在文件SNPFeatures.h52行定义。

virtual EFeatureClass get_feature_class ( ) [virtual]

get feature class

返回:
feature class

实现了CFeatures

在文件SNPFeatures.h143行定义。

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

参数:
vector_indexthe index of the vector over whose components to iterate over
返回:
feature iterator (to be passed to get_next_feature)

实现了CDotFeatures

在文件SNPFeatures.cpp270行定义。

virtual EFeatureType get_feature_type ( ) [virtual]

get feature type

返回:
templated feature type

实现了CFeatures

在文件SNPFeatures.h134行定义。

char* get_major_base_string ( )

return the major base string

返回:
major base string

在文件SNPFeatures.h210行定义。

char* get_minor_base_string ( )

get the minor base string

返回:
the minor base string

在文件SNPFeatures.h200行定义。

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

实现了CSGObject

在文件SNPFeatures.h220行定义。

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

参数:
indexis returned by reference (-1 when not available)
valueis returned by reference
iteratoras returned by get_first_feature
返回:
true if a new non-zero feature got returned

实现了CDotFeatures

在文件SNPFeatures.cpp275行定义。

virtual int32_t get_nnz_features_for_vector ( int32_t  num) [virtual]

get number of non-zero features in vector

参数:
numwhich vector
返回:
number of non-zero features in vector

实现了CDotFeatures

在文件SNPFeatures.h89行定义。

float64_t get_normalization_const ( )

get normalization constant

在文件SNPFeatures.h171行定义。

virtual int32_t get_num_vectors ( ) [virtual]

get number of vectors

返回:
number of vectors

实现了CFeatures

在文件SNPFeatures.h152行定义。

virtual int32_t get_size ( ) [virtual]

get memory footprint of one feature

返回:
memory footprint of one feature

实现了CFeatures

在文件SNPFeatures.h161行定义。

void obtain_base_strings ( )

compute the basee strings from current strings

在文件SNPFeatures.cpp211行定义。

void set_major_base_string ( const char *  str)

set the major base string

参数:
strbase string

在文件SNPFeatures.h190行定义。

void set_minor_base_string ( const char *  str)

set the minor base string

参数:
strbase string

在文件SNPFeatures.h180行定义。

void set_normalization_const ( float64_t  n = 0)

set normalization constant

参数:
nn=0 means automagic

在文件SNPFeatures.cpp257行定义。


成员数据文档

uint8_t* m_str_maj [protected]

allele B

在文件SNPFeatures.h239行定义。

uint8_t* m_str_min [protected]

allele A

在文件SNPFeatures.h237行定义。

normalization const

在文件SNPFeatures.h234行定义。

int32_t num_strings [protected]

number of strings

在文件SNPFeatures.h229行定义。

int32_t string_length [protected]

length of string in vector

在文件SNPFeatures.h227行定义。

CStringFeatures<uint8_t>* strings [protected]

stringfeatures the wdfeatures are based on

在文件SNPFeatures.h224行定义。

int32_t w_dim [protected]

dim of feature space

在文件SNPFeatures.h231行定义。


该类的文档由以下文件生成:

SHOGUN Machine Learning Toolbox - Documentation