SHOGUN  4.1.0
 全部 类 命名空间 文件 函数 变量 类型定义 枚举 枚举值 友元 宏定义 组 页
所有成员列表 | Public 成员函数 | Public 属性 | Protected 成员函数 | Protected 属性
CStreamingStringFeatures< T > 模板类 参考

详细描述

template<class T>
class shogun::CStreamingStringFeatures< T >

This class implements streaming features as strings.

在文件 StreamingStringFeatures.h 第 30 行定义.

类 CStreamingStringFeatures< T > 继承关系图:
Inheritance graph
[图例]

Public 成员函数

 CStreamingStringFeatures ()
 
 CStreamingStringFeatures (CStreamingFile *file, bool is_labelled, int32_t size)
 
virtual ~CStreamingStringFeatures ()
 
virtual void set_vector_reader ()
 
virtual void set_vector_and_label_reader ()
 
void use_alphabet (EAlphabet alpha)
 
void use_alphabet (CAlphabet *alpha)
 
void set_remap (CAlphabet *ascii_alphabet, CAlphabet *binary_alphabet)
 
void set_remap (EAlphabet ascii_alphabet=DNA, EAlphabet binary_alphabet=RAWDNA)
 
CAlphabet * get_alphabet ()
 
floatmax_t get_num_symbols ()
 
virtual void start_parser ()
 
virtual void end_parser ()
 
virtual bool get_next_example ()
 
SGString< T > get_vector ()
 
virtual float64_t get_label ()
 
virtual void release_example ()
 
virtual int32_t get_vector_length ()
 
virtual EFeatureType get_feature_type () const
 
virtual EFeatureClass get_feature_class () const
 
virtual CFeatures * duplicate () const
 
virtual const char * get_name () const
 
virtual int32_t get_num_vectors () const
 
virtual int32_t get_num_features ()
 
void set_read_functions ()
 
virtual bool get_has_labels ()
 
virtual bool is_seekable ()
 
virtual void reset_stream ()
 
virtual CFeatures * get_streamed_features (index_t num_elements)
 
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
 
virtual bool reshape (int32_t num_features, int32_t num_vectors)
 
void list_feature_obj () const
 
virtual void load (CFile *loader)
 
virtual void save (CFile *writer)
 
bool check_feature_compatibility (CFeatures *f) const
 
bool has_property (EFeatureProperty p) const
 
void set_property (EFeatureProperty p)
 
void unset_property (EFeatureProperty p)
 
virtual CFeatures * create_merged_copy (CList *others)
 
virtual CFeatures * create_merged_copy (CFeatures *other)
 
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 CFeatures * copy_subset (SGVector< index_t > indices)
 
virtual CFeatures * copy_dimension_subset (SGVector< index_t > dims)
 
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 属性

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

Protected 成员函数

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 属性

CInputParser< T > parser
 The parser object, which reads from input and returns parsed example objects. 更多...
 
CAlphabet * alphabet
 Alphabet to use. 更多...
 
CAlphabet * alpha_ascii
 If remapping is enabled, this is the source alphabet. 更多...
 
CAlphabet * alpha_bin
 If remapping is enabled, this is the target alphabet. 更多...
 
CStreamingFile * working_file
 The StreamingFile object to read from. 更多...
 
SGString< T > current_sgstring
 The current example's string as an SGString<T> 更多...
 
T * current_string
 The current example's string as a T*. 更多...
 
int32_t current_length
 The length of the current string. 更多...
 
float64_t current_label
 The label of the current example, if applicable. 更多...
 
bool has_labels
 Whether examples are labelled or not. 更多...
 
bool remap_to_bin
 Whether remapping must be done. 更多...
 
int32_t num_symbols
 Number of symbols. 更多...
 
bool seekable
 Whether the stream is seekable. 更多...
 
CSubsetStack * m_subset_stack
 

构造及析构函数说明

CStreamingStringFeatures ( )

Default constructor.

Sets the reading functions to be CStreamingFile::get_*_vector and get_*_vector_and_label depending on the type T.

在文件 StreamingStringFeatures.cpp 第 8 行定义.

CStreamingStringFeatures ( CStreamingFile *  file,
bool  is_labelled,
int32_t  size 
)

Constructor taking args. Initializes the parser with the given args.

参数
fileStreamingFile object, input file.
is_labelledWhether examples are labelled or not.
sizeNumber of example objects to be stored in the parser at a time.

在文件 StreamingStringFeatures.cpp 第 16 行定义.

~CStreamingStringFeatures ( )
virtual

Destructor.

Ends the parsing thread. (Waits for pthread_join to complete)

在文件 StreamingStringFeatures.cpp 第 27 行定义.

成员函数说明

void add_preprocessor ( CPreprocessor *  p)
virtualinherited

add preprocessor

参数
ppreprocessor 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

参数
subsetsubset 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

参数
subsetsubset of indices to replace the latest one with.

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

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.

参数
dictdictionary of parameters to be built.

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

bool check_feature_compatibility ( CFeatures *  f) const
inherited

check feature compatibility

参数
ffeatures 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 行定义.

CFeatures * copy_dimension_subset ( SGVector< index_t >  dims)
virtualinherited

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 NOT IMPLEMENTED!

参数
dimsindices of feature dimensions to copy
返回
new CFeatures instance with copies of specified features

被 CDenseFeatures< ST >, CDenseFeatures< uint32_t >, CDenseFeatures< float64_t >, CDenseFeatures< T > , 以及 CDenseFeatures< uint16_t > 重载.

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

CFeatures * copy_subset ( SGVector< index_t >  indices)
virtualinherited

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

This method is needed for a KernelMachine to store its model data. NOT IMPLEMENTED!

参数
indicesindices of feature elements to copy
返回
new CFeatures instance with copies of feature data

被 CStringFeatures< ST >, CStringFeatures< T >, CStringFeatures< uint8_t >, CStringFeatures< char >, CStringFeatures< uint16_t >, CSparseFeatures< ST >, CSparseFeatures< float64_t >, CSparseFeatures< T >, CDenseFeatures< ST >, CDenseFeatures< uint32_t >, CDenseFeatures< float64_t >, CDenseFeatures< T >, CDenseFeatures< uint16_t > , 以及 CCombinedFeatures 重载.

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

virtual CFeatures* create_merged_copy ( CList *  others)
virtualinherited

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

NOT IMPLEMENTED!

参数
otherslist of feature objects to append
返回
new feature object which contains copy of data of this instance and given ones

被 CDenseFeatures< ST >, CDenseFeatures< uint32_t >, CDenseFeatures< float64_t >, CDenseFeatures< T > , 以及 CDenseFeatures< uint16_t > 重载.

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

virtual CFeatures* create_merged_copy ( CFeatures *  other)
virtualinherited

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

NOT IMPLEMENTED!

参数
otherfeature object to append
返回
new feature object which contains copy of data of this instance and of given one

被 CDenseFeatures< ST >, CDenseFeatures< uint32_t >, CDenseFeatures< float64_t >, CDenseFeatures< T >, CDenseFeatures< uint16_t > , 以及 CCombinedFeatures 重载.

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

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

参数
numindex of preprocessor in list

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

CFeatures * duplicate ( ) const
virtual

Duplicate the object.

返回
a duplicate object as CFeatures*

实现了 CFeatures.

在文件 StreamingStringFeatures.cpp 第 84 行定义.

void end_parser ( )
virtual

Ends the parsing thread.

Waits for the thread to join.

实现了 CStreamingFeatures.

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

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.

参数
otherobject to compare with
accuracyaccuracy to use for comparison (optional)
tolerantallows linient check on float equality (within accuracy)
返回
true if all parameters were equal, false if not

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

CAlphabet * get_alphabet ( )

Return the alphabet being used as a CAlphabet*

返回

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

int32_t get_cache_size ( ) const
inherited

get cache size

返回
cache size

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

EFeatureClass get_feature_class ( ) const
virtual

Return the feature class

返回
C_STREAMING_STRING

实现了 CFeatures.

在文件 StreamingStringFeatures.cpp 第 255 行定义.

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

参数
rhsthe class in right hand side
返回
whether this class supports compatible computation

被 CDenseSubSamplesFeatures< ST > 重载.

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

virtual EFeatureType get_feature_type ( ) const
virtual

Return the feature type, depending on T.

返回
Feature type as EFeatureType

实现了 CFeatures.

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 行定义.

bool get_has_labels ( )
virtualinherited

Return whether the examples are labelled or not.

返回
true if labelled, else false

在文件 StreamingFeatures.cpp 第 35 行定义.

float64_t get_label ( )
virtual

Return the label of the current example as a float.

Examples must be labelled, otherwise an error occurs.

返回
The label as a float64_t.

实现了 CStreamingFeatures.

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

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_namename 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_namename 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

Return the name.

返回
StreamingSparseFeatures

实现了 CSGObject.

在文件 StreamingStringFeatures.h 第 213 行定义.

bool get_next_example ( )
virtual

Instructs the parser to return the next example.

This example is stored as the current_example in this object.

返回
True on success, false if there are no more examples, or an error occurred.

实现了 CStreamingFeatures.

在文件 StreamingStringFeatures.cpp 第 180 行定义.

int32_t get_num_features ( )
virtual

Return the number of features in the current vector.

返回
length of the vector

实现了 CStreamingFeatures.

在文件 StreamingStringFeatures.cpp 第 98 行定义.

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 行定义.

floatmax_t get_num_symbols ( )

get number of symbols

Note: floatmax_t sounds weird, but LONG is not long enough

返回
number of symbols

在文件 StreamingStringFeatures.cpp 第 78 行定义.

int32_t get_num_vectors ( ) const
virtual

Return the number of vectors stored in this object.

返回
1 if current_vector exists, else 0.

实现了 CFeatures.

在文件 StreamingStringFeatures.cpp 第 90 行定义.

CPreprocessor * get_preprocessor ( int32_t  num) const
inherited

get specified preprocessor

参数
numindex of preprocessor in list

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

virtual CFeatures* get_streamed_features ( index_t  num_elements)
virtualinherited

Returns a new CFeatures instance which contains num_elements elements from the underlying stream. Not SG_REF'ed

参数
num_elementsnum elements to save from stream
返回
CFeatures object of underlying type, might be smaller than requested if the stream stopped. A warning is issued in this case.

NOT IMPLEMENTED!

被 CStreamingDenseFeatures< T >, CStreamingDenseFeatures< float64_t > , 以及 CStreamingDenseFeatures< float32_t > 重载.

在文件 StreamingFeatures.h 第 191 行定义.

CSubsetStack * get_subset_stack ( )
virtualinherited

returns subset stack

返回
subset stack

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

SGString< T > get_vector ( )

Return the current feature vector as an SGString<T>.

返回
The vector as SGString<T>

在文件 StreamingStringFeatures.cpp 第 226 行定义.

int32_t get_vector_length ( )
virtual

Return the length of the current vector.

返回
current vector length as int32_t

在文件 StreamingStringFeatures.cpp 第 249 行定义.

bool has_property ( EFeatureProperty  p) const
inherited

check if features have given property

参数
pfeature property
返回
if features have given property

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

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.

参数
genericset 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

参数
numindex of preprocessor in list

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

bool is_seekable ( )
virtualinherited

Whether the stream is seekable (to check if multiple epochs are possible), i.e., whether we can process examples in a batch fashion.

A stream can usually seekable when it comes from a file or when it comes from another conventional CFeatures object.

返回
true if seekable, else false.

在文件 StreamingFeatures.cpp 第 40 行定义.

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

load features from file

参数
loaderFile object via which data shall be loaded

被 CDenseFeatures< ST >, CDenseFeatures< uint32_t >, CDenseFeatures< float64_t >, CDenseFeatures< T >, CDenseFeatures< uint16_t >, CSparseFeatures< ST >, CSparseFeatures< float64_t >, CSparseFeatures< T >, CStringFeatures< ST >, CStringFeatures< T >, CStringFeatures< uint8_t >, CStringFeatures< char > , 以及 CStringFeatures< uint16_t > 重载.

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

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!

参数
filewhere to load from
prefixprefix 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.

异常
ShogunExceptionwill 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.

异常
ShogunExceptionwill 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 行定义.

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

参数
prefixprefix for members

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

void release_example ( )
virtual

Release the current example, indicating to the parser that it has been processed by the learning algorithm.

The parser is then free to throw away that example.

实现了 CStreamingFeatures.

在文件 StreamingStringFeatures.cpp 第 243 行定义.

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 行定义.

void reset_stream ( )
virtualinherited

Function to reset the stream (if possible).

被 CStreamingSparseFeatures< T >, CStreamingVwFeatures, CStreamingDenseFeatures< T >, CStreamingDenseFeatures< float64_t > , 以及 CStreamingDenseFeatures< float32_t > 重载.

在文件 StreamingFeatures.cpp 第 45 行定义.

bool reshape ( int32_t  num_features,
int32_t  num_vectors 
)
virtualinherited

in case there is a feature matrix allow for reshaping

NOT IMPLEMENTED!

参数
num_featuresnew number of features
num_vectorsnew number of vectors
返回
if reshaping was successful

被 CDenseFeatures< ST >, CDenseFeatures< uint32_t >, CDenseFeatures< float64_t >, CDenseFeatures< T > , 以及 CDenseFeatures< uint16_t > 重载.

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

void save ( CFile *  writer)
virtualinherited

save features to file

参数
writerFile object via which data shall be saved

被 CStringFeatures< ST >, CStringFeatures< T >, CStringFeatures< uint8_t >, CStringFeatures< char >, CStringFeatures< uint16_t >, CDenseFeatures< ST >, CDenseFeatures< uint32_t >, CDenseFeatures< float64_t >, CDenseFeatures< T >, CDenseFeatures< uint16_t >, CSparseFeatures< ST >, CSparseFeatures< float64_t > , 以及 CSparseFeatures< T > 重载.

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

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

Save this object to file.

参数
filewhere to save the object; will be closed during returning if PREFIX is an empty string.
prefixprefix 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.

异常
ShogunExceptionwill 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.

异常
ShogunExceptionwill 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_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

参数
ioio object to use

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

void set_global_parallel ( Parallel *  parallel)
inherited

set the parallel object

参数
parallelparallel object to use

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

void set_global_version ( Version *  version)
inherited

set the version object

参数
versionversion object to use

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

void set_preprocessed ( int32_t  num)
inherited

set applied flag for preprocessor

参数
numindex of preprocessor in list

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

void set_property ( EFeatureProperty  p)
inherited

set property

参数
pkernel property to set

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

void set_read_functions ( )
inherited

Set the vector reading functions.

The functions are implemented specific to the type in the derived class.

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

void set_remap ( CAlphabet *  ascii_alphabet,
CAlphabet *  binary_alphabet 
)

Set whether remapping to another alphabet is required.

Call before parsing.

参数
ascii_alphabetthe alphabet to convert from, CAlphabet*
binary_alphabetthe alphabet to convert to, CAlphabet*

在文件 StreamingStringFeatures.cpp 第 55 行定义.

void set_remap ( EAlphabet  ascii_alphabet = DNA,
EAlphabet  binary_alphabet = RAWDNA 
)

Set whether remapping to another alphabet is required.

Call before parsing.

参数
ascii_alphabetthe alphabet to convert from, EAlphabet
binary_alphabetthe alphabet to convert to, EAlphabet

在文件 StreamingStringFeatures.cpp 第 63 行定义.

void set_vector_and_label_reader ( )
virtual

Sets the read function (in case the examples are labelled) to get_*_vector_and_label from CStreamingFile.

The exact function depends on type T.

The parser uses the function set by this while reading labelled examples.

实现了 CStreamingFeatures.

在文件 StreamingStringFeatures.cpp 第 108 行定义.

void set_vector_reader ( )
virtual

Sets the read function (in case the examples are unlabelled) to get_*_vector() from CStreamingFile.

The exact function depends on type T.

The parser uses the function set by this while reading unlabelled examples.

实现了 CStreamingFeatures.

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

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 行定义.

void start_parser ( )
virtual

Starts the parsing thread.

To be called before trying to use any feature vectors from this object.

实现了 CStreamingFeatures.

在文件 StreamingStringFeatures.cpp 第 164 行定义.

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

参数
pkernel property to unset

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

void update_parameter_hash ( )
virtualinherited

Updates the hash of current parameter combination

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

void use_alphabet ( EAlphabet  alpha)

Set the alphabet to be used. Call before parsing.

参数
alphaalphabet as an EAlphabet enum.

在文件 StreamingStringFeatures.cpp 第 35 行定义.

void use_alphabet ( CAlphabet *  alpha)

Set the alphabet to be used. Call before parsing.

参数
alphaalphabet as a pointer to a CAlphabet object.

在文件 StreamingStringFeatures.cpp 第 45 行定义.

类成员变量说明

CAlphabet* alpha_ascii
protected

If remapping is enabled, this is the source alphabet.

在文件 StreamingStringFeatures.h 第 255 行定义.

CAlphabet* alpha_bin
protected

If remapping is enabled, this is the target alphabet.

在文件 StreamingStringFeatures.h 第 258 行定义.

CAlphabet* alphabet
protected

Alphabet to use.

在文件 StreamingStringFeatures.h 第 252 行定义.

float64_t current_label
protected

The label of the current example, if applicable.

在文件 StreamingStringFeatures.h 第 273 行定义.

int32_t current_length
protected

The length of the current string.

在文件 StreamingStringFeatures.h 第 270 行定义.

SGString<T> current_sgstring
protected

The current example's string as an SGString<T>

在文件 StreamingStringFeatures.h 第 264 行定义.

T* current_string
protected

The current example's string as a T*.

在文件 StreamingStringFeatures.h 第 267 行定义.

bool has_labels
protected

Whether examples are labelled or not.

在文件 StreamingStringFeatures.h 第 276 行定义.

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_symbols
protected

Number of symbols.

在文件 StreamingStringFeatures.h 第 282 行定义.

Parallel* parallel
inherited

parallel

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

CInputParser<T> parser
protected

The parser object, which reads from input and returns parsed example objects.

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

bool remap_to_bin
protected

Whether remapping must be done.

在文件 StreamingStringFeatures.h 第 279 行定义.

bool seekable
protectedinherited

Whether the stream is seekable.

在文件 StreamingFeatures.h 第 207 行定义.

Version* version
inherited

version

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

CStreamingFile* working_file
protected

The StreamingFile object to read from.

在文件 StreamingStringFeatures.h 第 261 行定义.

该类的文档由以下文件生成:
SHOGUN 机器学习工具包 - 项目文档