SHOGUN  4.1.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
List of all members | Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes
CStreamingStringFeatures< T > Class Template Reference

Detailed Description

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

This class implements streaming features as strings.

Definition at line 30 of file StreamingStringFeatures.h.

Inheritance diagram for CStreamingStringFeatures< T >:
Inheritance graph
[legend]

Public Member Functions

 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 Attributes

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

Protected Member Functions

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 Attributes

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

Constructor & Destructor Documentation

CStreamingStringFeatures ( )

Default constructor.

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

Definition at line 8 of file StreamingStringFeatures.cpp.

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

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

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

Definition at line 16 of file StreamingStringFeatures.cpp.

~CStreamingStringFeatures ( )
virtual

Destructor.

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

Definition at line 27 of file StreamingStringFeatures.cpp.

Member Function Documentation

void add_preprocessor ( CPreprocessor *  p)
virtualinherited

add preprocessor

Parameters
ppreprocessor to set

Definition at line 85 of file Features.cpp.

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

Parameters
subsetsubset of indices to add

Reimplemented in CCombinedFeatures.

Definition at line 310 of file Features.cpp.

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

Parameters
subsetsubset of indices to replace the latest one with.

Definition at line 316 of file Features.cpp.

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.

Parameters
dictdictionary of parameters to be built.

Definition at line 597 of file SGObject.cpp.

bool check_feature_compatibility ( CFeatures *  f) const
inherited

check feature compatibility

Parameters
ffeatures to check for compatibility
Returns
if features are compatible

Definition at line 283 of file Features.cpp.

void clean_preprocessors ( )
inherited

clears all preprocs

Definition at line 116 of file Features.cpp.

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.

Returns
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

Definition at line 714 of file SGObject.cpp.

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!

Parameters
dimsindices of feature dimensions to copy
Returns
new CFeatures instance with copies of specified features

Reimplemented in CDenseFeatures< ST >, CDenseFeatures< uint32_t >, CDenseFeatures< float64_t >, CDenseFeatures< T >, and CDenseFeatures< uint16_t >.

Definition at line 348 of file Features.cpp.

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!

Parameters
indicesindices of feature elements to copy
Returns
new CFeatures instance with copies of feature data

Reimplemented in 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 >, and CCombinedFeatures.

Definition at line 340 of file Features.cpp.

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!

Parameters
otherslist of feature objects to append
Returns
new feature object which contains copy of data of this instance and given ones

Reimplemented in CDenseFeatures< ST >, CDenseFeatures< uint32_t >, CDenseFeatures< float64_t >, CDenseFeatures< T >, and CDenseFeatures< uint16_t >.

Definition at line 235 of file Features.h.

virtual CFeatures* create_merged_copy ( CFeatures *  other)
virtualinherited

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

NOT IMPLEMENTED!

Parameters
otherfeature object to append
Returns
new feature object which contains copy of data of this instance and of given one

Reimplemented in CDenseFeatures< ST >, CDenseFeatures< uint32_t >, CDenseFeatures< float64_t >, CDenseFeatures< T >, CDenseFeatures< uint16_t >, and CCombinedFeatures.

Definition at line 249 of file Features.h.

CSGObject * deep_copy ( ) const
virtualinherited

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

Definition at line 198 of file SGObject.cpp.

void del_preprocessor ( int32_t  num)
virtualinherited

delete preprocessor from list

Parameters
numindex of preprocessor in list

Definition at line 122 of file Features.cpp.

CFeatures * duplicate ( ) const
virtual

Duplicate the object.

Returns
a duplicate object as CFeatures*

Implements CFeatures.

Definition at line 84 of file StreamingStringFeatures.cpp.

void end_parser ( )
virtual

Ends the parsing thread.

Waits for the thread to join.

Implements CStreamingFeatures.

Definition at line 174 of file StreamingStringFeatures.cpp.

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.

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

Definition at line 618 of file SGObject.cpp.

CAlphabet * get_alphabet ( )

Return the alphabet being used as a CAlphabet*

Returns

Definition at line 71 of file StreamingStringFeatures.cpp.

int32_t get_cache_size ( ) const
inherited

get cache size

Returns
cache size

Definition at line 160 of file Features.cpp.

EFeatureClass get_feature_class ( ) const
virtual

Return the feature class

Returns
C_STREAMING_STRING

Implements CFeatures.

Definition at line 255 of file StreamingStringFeatures.cpp.

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

Parameters
rhsthe class in right hand side
Returns
whether this class supports compatible computation

Reimplemented in CDenseSubSamplesFeatures< ST >.

Definition at line 355 of file Features.cpp.

virtual EFeatureType get_feature_type ( ) const
virtual

Return the feature type, depending on T.

Returns
Feature type as EFeatureType

Implements CFeatures.

SGIO * get_global_io ( )
inherited

get the io object

Returns
io object

Definition at line 235 of file SGObject.cpp.

Parallel * get_global_parallel ( )
inherited

get the parallel object

Returns
parallel object

Definition at line 277 of file SGObject.cpp.

Version * get_global_version ( )
inherited

get the version object

Returns
version object

Definition at line 290 of file SGObject.cpp.

bool get_has_labels ( )
virtualinherited

Return whether the examples are labelled or not.

Returns
true if labelled, else false

Definition at line 35 of file StreamingFeatures.cpp.

float64_t get_label ( )
virtual

Return the label of the current example as a float.

Examples must be labelled, otherwise an error occurs.

Returns
The label as a float64_t.

Implements CStreamingFeatures.

Definition at line 235 of file StreamingStringFeatures.cpp.

SGStringList< char > get_modelsel_names ( )
inherited
Returns
vector of names of all parameters which are registered for model selection

Definition at line 498 of file SGObject.cpp.

char * get_modsel_param_descr ( const char *  param_name)
inherited

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

Parameters
param_namename of the parameter
Returns
description of the parameter

Definition at line 522 of file SGObject.cpp.

index_t get_modsel_param_index ( const char *  param_name)
inherited

Returns index of model selection parameter with provided index

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

Definition at line 535 of file SGObject.cpp.

virtual const char* get_name ( ) const
virtual

Return the name.

Returns
StreamingSparseFeatures

Implements CSGObject.

Definition at line 213 of file StreamingStringFeatures.h.

bool get_next_example ( )
virtual

Instructs the parser to return the next example.

This example is stored as the current_example in this object.

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

Implements CStreamingFeatures.

Definition at line 180 of file StreamingStringFeatures.cpp.

int32_t get_num_features ( )
virtual

Return the number of features in the current vector.

Returns
length of the vector

Implements CStreamingFeatures.

Definition at line 98 of file StreamingStringFeatures.cpp.

int32_t get_num_preprocessed ( ) const
inherited

get the number of applied preprocs

Returns
number of applied preprocessors

Definition at line 103 of file Features.cpp.

int32_t get_num_preprocessors ( ) const
inherited

get number of preprocessors

Returns
number of preprocessors

Definition at line 155 of file Features.cpp.

floatmax_t get_num_symbols ( )

get number of symbols

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

Returns
number of symbols

Definition at line 78 of file StreamingStringFeatures.cpp.

int32_t get_num_vectors ( ) const
virtual

Return the number of vectors stored in this object.

Returns
1 if current_vector exists, else 0.

Implements CFeatures.

Definition at line 90 of file StreamingStringFeatures.cpp.

CPreprocessor * get_preprocessor ( int32_t  num) const
inherited

get specified preprocessor

Parameters
numindex of preprocessor in list

Definition at line 93 of file Features.cpp.

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

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

NOT IMPLEMENTED!

Reimplemented in CStreamingDenseFeatures< T >, CStreamingDenseFeatures< float64_t >, and CStreamingDenseFeatures< float32_t >.

Definition at line 191 of file StreamingFeatures.h.

CSubsetStack * get_subset_stack ( )
virtualinherited

returns subset stack

Returns
subset stack

Definition at line 334 of file Features.cpp.

SGString< T > get_vector ( )

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

Returns
The vector as SGString<T>

Definition at line 226 of file StreamingStringFeatures.cpp.

int32_t get_vector_length ( )
virtual

Return the length of the current vector.

Returns
current vector length as int32_t

Definition at line 249 of file StreamingStringFeatures.cpp.

bool has_property ( EFeatureProperty  p) const
inherited

check if features have given property

Parameters
pfeature property
Returns
if features have given property

Definition at line 295 of file Features.cpp.

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.

Parameters
genericset to the type of the generic if returning TRUE
Returns
TRUE if a class template.

Definition at line 296 of file SGObject.cpp.

bool is_preprocessed ( int32_t  num) const
inherited

get whether specified preprocessor was already applied

Parameters
numindex of preprocessor in list

Definition at line 149 of file Features.cpp.

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.

Returns
true if seekable, else false.

Definition at line 40 of file StreamingFeatures.cpp.

void list_feature_obj ( ) const
inherited

list feature object

Definition at line 171 of file Features.cpp.

void list_preprocessors ( )
inherited

print preprocessors

Definition at line 131 of file Features.cpp.

void load ( CFile *  loader)
virtualinherited

load features from file

Parameters
loaderFile object via which data shall be loaded

Reimplemented in 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 >, and CStringFeatures< uint16_t >.

Definition at line 269 of file Features.cpp.

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!

Parameters
filewhere to load from
prefixprefix for members
Returns
TRUE if done, otherwise FALSE

Definition at line 369 of file SGObject.cpp.

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.

Exceptions
ShogunExceptionwill be thrown if an error occurs.

Reimplemented in CKernel, CWeightedDegreePositionStringKernel, CList, CAlphabet, CLinearHMM, CGaussianKernel, CInverseMultiQuadricKernel, CCircularKernel, and CExponentialKernel.

Definition at line 426 of file SGObject.cpp.

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.

Exceptions
ShogunExceptionwill be thrown if an error occurs.

Reimplemented in CDynamicArray< T >, CDynamicArray< float64_t >, CDynamicArray< float32_t >, CDynamicArray< int32_t >, CDynamicArray< char >, CDynamicArray< bool >, and CDynamicObjectArray.

Definition at line 421 of file SGObject.cpp.

bool parameter_hash_changed ( )
virtualinherited
Returns
whether parameter combination has changed since last update

Definition at line 262 of file SGObject.cpp.

void print_modsel_params ( )
inherited

prints all parameter registered for model selection and their type

Definition at line 474 of file SGObject.cpp.

void print_serializable ( const char *  prefix = "")
virtualinherited

prints registered parameters out

Parameters
prefixprefix for members

Definition at line 308 of file SGObject.cpp.

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.

Implements CStreamingFeatures.

Definition at line 243 of file StreamingStringFeatures.cpp.

void remove_all_subsets ( )
virtualinherited

removes all subsets Calls subset_changed_post() afterwards

Reimplemented in CCombinedFeatures.

Definition at line 328 of file Features.cpp.

void remove_subset ( )
virtualinherited

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

Reimplemented in CCombinedFeatures.

Definition at line 322 of file Features.cpp.

void reset_stream ( )
virtualinherited

Function to reset the stream (if possible).

Reimplemented in CStreamingSparseFeatures< T >, CStreamingVwFeatures, CStreamingDenseFeatures< T >, CStreamingDenseFeatures< float64_t >, and CStreamingDenseFeatures< float32_t >.

Definition at line 45 of file StreamingFeatures.cpp.

bool reshape ( int32_t  num_features,
int32_t  num_vectors 
)
virtualinherited

in case there is a feature matrix allow for reshaping

NOT IMPLEMENTED!

Parameters
num_featuresnew number of features
num_vectorsnew number of vectors
Returns
if reshaping was successful

Reimplemented in CDenseFeatures< ST >, CDenseFeatures< uint32_t >, CDenseFeatures< float64_t >, CDenseFeatures< T >, and CDenseFeatures< uint16_t >.

Definition at line 165 of file Features.cpp.

void save ( CFile *  writer)
virtualinherited

save features to file

Parameters
writerFile object via which data shall be saved

Reimplemented in 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 >, and CSparseFeatures< T >.

Definition at line 276 of file Features.cpp.

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

Save this object to file.

Parameters
filewhere to save the object; will be closed during returning if PREFIX is an empty string.
prefixprefix for members
Returns
TRUE if done, otherwise FALSE

Definition at line 314 of file SGObject.cpp.

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.

Exceptions
ShogunExceptionwill be thrown if an error occurs.

Reimplemented in CKernel.

Definition at line 436 of file SGObject.cpp.

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.

Exceptions
ShogunExceptionwill be thrown if an error occurs.

Reimplemented in CKernel, CDynamicArray< T >, CDynamicArray< float64_t >, CDynamicArray< float32_t >, CDynamicArray< int32_t >, CDynamicArray< char >, CDynamicArray< bool >, and CDynamicObjectArray.

Definition at line 431 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 41 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 46 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 51 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 56 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 61 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 66 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 71 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 76 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 81 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 86 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 91 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 96 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 101 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 106 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 111 of file SGObject.cpp.

void set_generic ( )
inherited

set generic type to T

void set_global_io ( SGIO *  io)
inherited

set the io object

Parameters
ioio object to use

Definition at line 228 of file SGObject.cpp.

void set_global_parallel ( Parallel *  parallel)
inherited

set the parallel object

Parameters
parallelparallel object to use

Definition at line 241 of file SGObject.cpp.

void set_global_version ( Version *  version)
inherited

set the version object

Parameters
versionversion object to use

Definition at line 283 of file SGObject.cpp.

void set_preprocessed ( int32_t  num)
inherited

set applied flag for preprocessor

Parameters
numindex of preprocessor in list

Definition at line 143 of file Features.cpp.

void set_property ( EFeatureProperty  p)
inherited

set property

Parameters
pkernel property to set

Definition at line 300 of file Features.cpp.

void set_read_functions ( )
inherited

Set the vector reading functions.

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

Definition at line 29 of file StreamingFeatures.cpp.

void set_remap ( CAlphabet *  ascii_alphabet,
CAlphabet *  binary_alphabet 
)

Set whether remapping to another alphabet is required.

Call before parsing.

Parameters
ascii_alphabetthe alphabet to convert from, CAlphabet*
binary_alphabetthe alphabet to convert to, CAlphabet*

Definition at line 55 of file StreamingStringFeatures.cpp.

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

Set whether remapping to another alphabet is required.

Call before parsing.

Parameters
ascii_alphabetthe alphabet to convert from, EAlphabet
binary_alphabetthe alphabet to convert to, EAlphabet

Definition at line 63 of file StreamingStringFeatures.cpp.

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.

Implements CStreamingFeatures.

Definition at line 108 of file StreamingStringFeatures.cpp.

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.

Implements CStreamingFeatures.

Definition at line 103 of file StreamingStringFeatures.cpp.

CSGObject * shallow_copy ( ) const
virtualinherited

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

Reimplemented in CGaussianKernel.

Definition at line 192 of file SGObject.cpp.

void start_parser ( )
virtual

Starts the parsing thread.

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

Implements CStreamingFeatures.

Definition at line 164 of file StreamingStringFeatures.cpp.

virtual void subset_changed_post ( )
virtualinherited

method may be overwritten to update things that depend on subset

Reimplemented in CStringFeatures< ST >, CStringFeatures< T >, CStringFeatures< uint8_t >, CStringFeatures< char >, and CStringFeatures< uint16_t >.

Definition at line 293 of file Features.h.

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?

Returns
whether this class supports compatible computation

Reimplemented in CDenseSubSamplesFeatures< ST >.

Definition at line 323 of file Features.h.

void unset_generic ( )
inherited

unset generic type

this has to be called in classes specializing a template class

Definition at line 303 of file SGObject.cpp.

void unset_property ( EFeatureProperty  p)
inherited

unset property

Parameters
pkernel property to unset

Definition at line 305 of file Features.cpp.

void update_parameter_hash ( )
virtualinherited

Updates the hash of current parameter combination

Definition at line 248 of file SGObject.cpp.

void use_alphabet ( EAlphabet  alpha)

Set the alphabet to be used. Call before parsing.

Parameters
alphaalphabet as an EAlphabet enum.

Definition at line 35 of file StreamingStringFeatures.cpp.

void use_alphabet ( CAlphabet *  alpha)

Set the alphabet to be used. Call before parsing.

Parameters
alphaalphabet as a pointer to a CAlphabet object.

Definition at line 45 of file StreamingStringFeatures.cpp.

Member Data Documentation

CAlphabet* alpha_ascii
protected

If remapping is enabled, this is the source alphabet.

Definition at line 255 of file StreamingStringFeatures.h.

CAlphabet* alpha_bin
protected

If remapping is enabled, this is the target alphabet.

Definition at line 258 of file StreamingStringFeatures.h.

CAlphabet* alphabet
protected

Alphabet to use.

Definition at line 252 of file StreamingStringFeatures.h.

float64_t current_label
protected

The label of the current example, if applicable.

Definition at line 273 of file StreamingStringFeatures.h.

int32_t current_length
protected

The length of the current string.

Definition at line 270 of file StreamingStringFeatures.h.

SGString<T> current_sgstring
protected

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

Definition at line 264 of file StreamingStringFeatures.h.

T* current_string
protected

The current example's string as a T*.

Definition at line 267 of file StreamingStringFeatures.h.

bool has_labels
protected

Whether examples are labelled or not.

Definition at line 276 of file StreamingStringFeatures.h.

SGIO* io
inherited

io

Definition at line 369 of file SGObject.h.

Parameter* m_gradient_parameters
inherited

parameters wrt which we can compute gradients

Definition at line 384 of file SGObject.h.

uint32_t m_hash
inherited

Hash of parameter values

Definition at line 387 of file SGObject.h.

Parameter* m_model_selection_parameters
inherited

model selection parameters

Definition at line 381 of file SGObject.h.

Parameter* m_parameters
inherited

parameters

Definition at line 378 of file SGObject.h.

CSubsetStack* m_subset_stack
protectedinherited

subset used for index transformations

Definition at line 352 of file Features.h.

int32_t num_symbols
protected

Number of symbols.

Definition at line 282 of file StreamingStringFeatures.h.

Parallel* parallel
inherited

parallel

Definition at line 372 of file SGObject.h.

CInputParser<T> parser
protected

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

Definition at line 249 of file StreamingStringFeatures.h.

bool remap_to_bin
protected

Whether remapping must be done.

Definition at line 279 of file StreamingStringFeatures.h.

bool seekable
protectedinherited

Whether the stream is seekable.

Definition at line 207 of file StreamingFeatures.h.

Version* version
inherited

version

Definition at line 375 of file SGObject.h.

CStreamingFile* working_file
protected

The StreamingFile object to read from.

Definition at line 261 of file StreamingStringFeatures.h.

The documentation for this class was generated from the following files:
SHOGUN Machine Learning Toolbox - Documentation