SHOGUN  v2.0.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups 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 27 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)
CAlphabetget_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 CFeaturesduplicate () const
virtual const char * get_name () const
virtual int32_t get_num_vectors () const
virtual int32_t get_size () 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 int32_t add_preprocessor (CPreprocessor *p)
 set preprocessor
virtual CPreprocessordel_preprocessor (int32_t num)
 del current preprocessor
CPreprocessorget_preprocessor (int32_t num) const
 get current preprocessor
void set_preprocessed (int32_t num)
bool is_preprocessed (int32_t num) const
int32_t get_num_preprocessed () const
 get whether specified preprocessor (or all if num=1) was/were already applied
int32_t get_num_preprocessors () const
void clean_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 CFeaturescreate_merged_copy (CFeatures *other)
virtual void add_subset (SGVector< index_t > subset)
virtual void remove_subset ()
virtual void remove_all_subsets ()
virtual CSubsetStackget_subset_stack ()
virtual void subset_changed_post ()
virtual CFeaturescopy_subset (SGVector< index_t > indices)
virtual CSGObjectshallow_copy () const
virtual CSGObjectdeep_copy () const
virtual bool is_generic (EPrimitiveType *generic) const
template<class T >
void set_generic ()
void unset_generic ()
virtual void print_serializable (const char *prefix="")
virtual bool save_serializable (CSerializableFile *file, const char *prefix="", int32_t param_version=VERSION_PARAMETER)
virtual bool load_serializable (CSerializableFile *file, const char *prefix="", int32_t param_version=VERSION_PARAMETER)
DynArray< TParameter * > * load_file_parameters (const SGParamInfo *param_info, int32_t file_version, CSerializableFile *file, const char *prefix="")
DynArray< TParameter * > * load_all_file_parameters (int32_t file_version, int32_t current_version, CSerializableFile *file, const char *prefix="")
void map_parameters (DynArray< TParameter * > *param_base, int32_t &base_version, DynArray< const SGParamInfo * > *target_param_infos)
void set_global_io (SGIO *io)
SGIOget_global_io ()
void set_global_parallel (Parallel *parallel)
Parallelget_global_parallel ()
void set_global_version (Version *version)
Versionget_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_parameter_dictionary (CMap< TParameter *, CSGObject * > &dict)

Public Attributes

SGIOio
Parallelparallel
Versionversion
Parameterm_parameters
Parameterm_model_selection_parameters
ParameterMapm_parameter_map
uint32_t m_hash

Protected Member Functions

virtual TParametermigrate (DynArray< TParameter * > *param_base, const SGParamInfo *target)
virtual void one_to_one_migration_prepare (DynArray< TParameter * > *param_base, const SGParamInfo *target, TParameter *&replacement, TParameter *&to_migrate, char *old_name=NULL)
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)
virtual bool update_parameter_hash ()

Protected Attributes

CInputParser< T > parser
 The parser object, which reads from input and returns parsed example objects.
CAlphabetalphabet
 Alphabet to use.
CAlphabetalpha_ascii
 If remapping is enabled, this is the source alphabet.
CAlphabetalpha_bin
 If remapping is enabled, this is the target alphabet.
CStreamingFileworking_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.
CSubsetStackm_subset_stack

Constructor & Destructor Documentation

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.

Destructor.

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

Definition at line 27 of file StreamingStringFeatures.cpp.

Member Function Documentation

int32_t add_preprocessor ( CPreprocessor p)
virtualinherited

set preprocessor

add preprocessor

Parameters
ppreprocessor to set
Returns
something inty

Definition at line 81 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 o subset. Calls subset_changed_post() afterwards

Parameters
subsetsubset of indices to add

Reimplemented in CCombinedFeatures.

Definition at line 351 of file Features.cpp.

void build_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 1204 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 326 of file Features.cpp.

void clean_preprocessors ( )
inherited

clears all preprocs

Definition at line 137 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 374 of file Features.cpp.

virtual CFeatures* create_merged_copy ( CFeatures other)
virtualinherited

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

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 234 of file Features.h.

virtual CSGObject* deep_copy ( ) const
virtualinherited

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

Definition at line 131 of file SGObject.h.

CPreprocessor * del_preprocessor ( int32_t  num)
virtualinherited

del current preprocessor

delete preprocessor from list caller has to clean up returned preproc

Parameters
numindex of preprocessor in list

Definition at line 143 of file Features.cpp.

CFeatures * duplicate ( ) const
virtual

Duplicate the object.

Returns
a duplicate object as CFeatures*

Implements CFeatures.

Definition at line 83 of file StreamingStringFeatures.cpp.

void end_parser ( )
virtual

Ends the parsing thread.

Waits for the thread to join.

Implements CStreamingFeatures.

Definition at line 177 of file StreamingStringFeatures.cpp.

CAlphabet * get_alphabet ( )

Return the alphabet being used as a CAlphabet*

Returns

Definition at line 70 of file StreamingStringFeatures.cpp.

int32_t get_cache_size ( ) const
inherited

get cache size

Returns
cache size

Definition at line 203 of file Features.cpp.

EFeatureClass get_feature_class ( ) const
virtual

Return the feature class

Returns
C_STREAMING_STRING

Implements CFeatures.

Definition at line 258 of file StreamingStringFeatures.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 224 of file SGObject.cpp.

Parallel * get_global_parallel ( )
inherited

get the parallel object

Returns
parallel object

Definition at line 259 of file SGObject.cpp.

Version * get_global_version ( )
inherited

get the version object

Returns
version object

Definition at line 272 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 20 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 238 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 1108 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 1132 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 1145 of file SGObject.cpp.

virtual const char* get_name ( ) const
virtual

Return the name.

Returns
StreamingSparseFeatures

Implements CSGObject.

Definition at line 210 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 183 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 103 of file StreamingStringFeatures.cpp.

int32_t get_num_preprocessed ( ) const
inherited

get whether specified preprocessor (or all if num=1) was/were already applied

get the number of applied preprocs

Returns
number of applied preprocessors

Definition at line 123 of file Features.cpp.

int32_t get_num_preprocessors ( ) const
inherited

get number of preprocessors

Returns
number of preprocessors

Definition at line 198 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 77 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 89 of file StreamingStringFeatures.cpp.

CPreprocessor * get_preprocessor ( int32_t  num) const
inherited

get current preprocessor

get specified preprocessor

Parameters
numindex of preprocessor in list

Definition at line 111 of file Features.cpp.

int32_t get_size ( ) const
virtual

Return the size of one T object.

Returns
Size of T.

Implements CFeatures.

Definition at line 97 of file StreamingStringFeatures.cpp.

CSubsetStack * get_subset_stack ( )
virtualinherited

returns subset stack

Returns
subset stack

Definition at line 369 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 229 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 252 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 336 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 278 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 193 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 25 of file StreamingFeatures.cpp.

void list_feature_obj ( ) const
inherited

list feature object

Definition at line 214 of file Features.cpp.

void load ( CFile loader)
virtualinherited
DynArray< TParameter * > * load_all_file_parameters ( int32_t  file_version,
int32_t  current_version,
CSerializableFile file,
const char *  prefix = "" 
)
inherited

maps all parameters of this instance to the provided file version and loads all parameter data from the file into an array, which is sorted (basically calls load_file_parameter(...) for all parameters and puts all results into a sorted array)

Parameters
file_versionparameter version of the file
current_versionversion from which mapping begins (you want to use VERSION_PARAMETER for this in most cases)
filefile to load from
prefixprefix for members
Returns
(sorted) array of created TParameter instances with file data

Definition at line 679 of file SGObject.cpp.

DynArray< TParameter * > * load_file_parameters ( const SGParamInfo param_info,
int32_t  file_version,
CSerializableFile file,
const char *  prefix = "" 
)
inherited

loads some specified parameters from a file with a specified version The provided parameter info has a version which is recursively mapped until the file parameter version is reached. Note that there may be possibly multiple parameters in the mapping, therefore, a set of TParameter instances is returned

Parameters
param_infoinformation of parameter
file_versionparameter version of the file, must be <= provided parameter version
filefile to load from
prefixprefix for members
Returns
new array with TParameter instances with the attached data

Definition at line 523 of file SGObject.cpp.

bool load_serializable ( CSerializableFile file,
const char *  prefix = "",
int32_t  param_version = VERSION_PARAMETER 
)
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
param_version(optional) a parameter version different to (this is mainly for testing, better do not use)
Returns
TRUE if done, otherwise FALSE

Reimplemented in CModelSelectionParameters.

Definition at line 354 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 occurres.

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

Definition at line 1033 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 occurres.

Definition at line 1028 of file SGObject.cpp.

void map_parameters ( DynArray< TParameter * > *  param_base,
int32_t &  base_version,
DynArray< const SGParamInfo * > *  target_param_infos 
)
inherited

Takes a set of TParameter instances (base) with a certain version and a set of target parameter infos and recursively maps the base level wise to the current version using CSGObject::migrate(...). The base is replaced. After this call, the base version containing parameters should be of same version/type as the initial target parameter infos. Note for this to work, the migrate methods and all the internal parameter mappings have to match

Parameters
param_baseset of TParameter instances that are mapped to the provided target parameter infos
base_versionversion of the parameter base
target_param_infosset of SGParamInfo instances that specify the target parameter base

Definition at line 717 of file SGObject.cpp.

TParameter * migrate ( DynArray< TParameter * > *  param_base,
const SGParamInfo target 
)
protectedvirtualinherited

creates a new TParameter instance, which contains migrated data from the version that is provided. The provided parameter data base is used for migration, this base is a collection of all parameter data of the previous version. Migration is done FROM the data in param_base TO the provided param info Migration is always one version step. Method has to be implemented in subclasses, if no match is found, base method has to be called.

If there is an element in the param_base which equals the target, a copy of the element is returned. This represents the case when nothing has changed and therefore, the migrate method is not overloaded in a subclass

Parameters
param_baseset of TParameter instances to use for migration
targetparameter info for the resulting TParameter
Returns
a new TParameter instance with migrated data from the base of the type which is specified by the target parameter

Definition at line 923 of file SGObject.cpp.

void one_to_one_migration_prepare ( DynArray< TParameter * > *  param_base,
const SGParamInfo target,
TParameter *&  replacement,
TParameter *&  to_migrate,
char *  old_name = NULL 
)
protectedvirtualinherited

This method prepares everything for a one-to-one parameter migration. One to one here means that only ONE element of the parameter base is needed for the migration (the one with the same name as the target). Data is allocated for the target (in the type as provided in the target SGParamInfo), and a corresponding new TParameter instance is written to replacement. The to_migrate pointer points to the single needed TParameter instance needed for migration. If a name change happened, the old name may be specified by old_name. In addition, the m_delete_data flag of to_migrate is set to true. So if you want to migrate data, the only thing to do after this call is converting the data in the m_parameter fields. If unsure how to use - have a look into an example for this. (base_migration_type_conversion.cpp for example)

Parameters
param_baseset of TParameter instances to use for migration
targetparameter info for the resulting TParameter
replacement(used as output) here the TParameter instance which is returned by migration is created into
to_migratethe only source that is used for migration
old_namewith this parameter, a name change may be specified

Definition at line 864 of file SGObject.cpp.

void print_modsel_params ( )
inherited

prints all parameter registered for model selection and their type

Definition at line 1084 of file SGObject.cpp.

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

prints registered parameters out

Parameters
prefixprefix for members

Definition at line 290 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 246 of file StreamingStringFeatures.cpp.

void remove_all_subsets ( )
virtualinherited

removes all subsets Calls subset_changed_post() afterwards

Reimplemented in CCombinedFeatures.

Definition at line 363 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 357 of file Features.cpp.

void reset_stream ( )
virtualinherited

Function to reset the stream (if possible).

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

Definition at line 30 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 208 of file Features.cpp.

void save ( CFile writer)
virtualinherited
bool save_serializable ( CSerializableFile file,
const char *  prefix = "",
int32_t  param_version = VERSION_PARAMETER 
)
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
param_version(optional) a parameter version different to (this is mainly for testing, better do not use)
Returns
TRUE if done, otherwise FALSE

Reimplemented in CModelSelectionParameters.

Definition at line 296 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 occurres.

Reimplemented in CKernel.

Definition at line 1043 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 occurres.

Reimplemented in CKernel.

Definition at line 1038 of file SGObject.cpp.

void set_generic< floatmax_t > ( )
inherited

set generic type to T

Definition at line 41 of file SGObject.cpp.

void set_global_io ( SGIO io)
inherited

set the io object

Parameters
ioio object to use

Definition at line 217 of file SGObject.cpp.

void set_global_parallel ( Parallel parallel)
inherited

set the parallel object

Parameters
parallelparallel object to use

Definition at line 230 of file SGObject.cpp.

void set_global_version ( Version version)
inherited

set the version object

Parameters
versionversion object to use

Definition at line 265 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 188 of file Features.cpp.

void set_property ( EFeatureProperty  p)
inherited

set property

Parameters
pkernel property to set

Definition at line 341 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 14 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 54 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 62 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 113 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 108 of file StreamingStringFeatures.cpp.

virtual 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 122 of file SGObject.h.

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 167 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 262 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 285 of file SGObject.cpp.

void unset_property ( EFeatureProperty  p)
inherited

unset property

Parameters
pkernel property to unset

Definition at line 346 of file Features.cpp.

bool update_parameter_hash ( )
protectedvirtualinherited

Updates the hash of current parameter combination.

Returns
bool if parameter combination has changed since last update.

Definition at line 237 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 34 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 44 of file StreamingStringFeatures.cpp.

Member Data Documentation

CAlphabet* alpha_ascii
protected

If remapping is enabled, this is the source alphabet.

Definition at line 259 of file StreamingStringFeatures.h.

CAlphabet* alpha_bin
protected

If remapping is enabled, this is the target alphabet.

Definition at line 262 of file StreamingStringFeatures.h.

CAlphabet* alphabet
protected

Alphabet to use.

Definition at line 256 of file StreamingStringFeatures.h.

float64_t current_label
protected

The label of the current example, if applicable.

Definition at line 277 of file StreamingStringFeatures.h.

int32_t current_length
protected

The length of the current string.

Definition at line 274 of file StreamingStringFeatures.h.

SGString<T> current_sgstring
protected

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

Definition at line 268 of file StreamingStringFeatures.h.

T* current_string
protected

The current example's string as a T*.

Definition at line 271 of file StreamingStringFeatures.h.

bool has_labels
protected

Whether examples are labelled or not.

Definition at line 280 of file StreamingStringFeatures.h.

SGIO* io
inherited

io

Definition at line 462 of file SGObject.h.

uint32_t m_hash
inherited

Hash of parameter values

Definition at line 480 of file SGObject.h.

Parameter* m_model_selection_parameters
inherited

model selection parameters

Definition at line 474 of file SGObject.h.

ParameterMap* m_parameter_map
inherited

map for different parameter versions

Definition at line 477 of file SGObject.h.

Parameter* m_parameters
inherited

parameters

Definition at line 471 of file SGObject.h.

CSubsetStack* m_subset_stack
protectedinherited

subset used for index transformations

Definition at line 296 of file Features.h.

int32_t num_symbols
protected

Number of symbols.

Definition at line 286 of file StreamingStringFeatures.h.

Parallel* parallel
inherited

parallel

Definition at line 465 of file SGObject.h.

CInputParser<T> parser
protected

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

Definition at line 253 of file StreamingStringFeatures.h.

bool remap_to_bin
protected

Whether remapping must be done.

Definition at line 283 of file StreamingStringFeatures.h.

bool seekable
protectedinherited

Whether the stream is seekable.

Definition at line 191 of file StreamingFeatures.h.

Version* version
inherited

version

Definition at line 468 of file SGObject.h.

CStreamingFile* working_file
protected

The StreamingFile object to read from.

Definition at line 265 of file StreamingStringFeatures.h.


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

SHOGUN Machine Learning Toolbox - Documentation