SHOGUN
v2.0.0
|
Class CParseBuffer implements a ring of examples of a defined size. The ring stores objects of the Example type.
The feature vector and label are provided to this class from an external source. CParseBuffer is only responsible for managing how these examples are represented and stored in the memory. It is also responsible for returning stored examples to be used by an external caller, and freeing up the space when the example is used to make room for another example to take its place.
Writing of examples is done into whichever position in the ring is free to be overwritten, or empty.
Definition at line 65 of file ParseBuffer.h.
Public Member Functions | |
CParseBuffer (int32_t size=1024) | |
~CParseBuffer () | |
Example< T > * | get_free_example () |
int32_t | write_example (Example< T > *ex) |
Example< T > * | return_example_to_read () |
Example< T > * | get_unused_example () |
int32_t | copy_example (Example< T > *ex) |
void | finalize_example (bool free_after_release) |
void | set_free_vectors_on_destruct (bool destroy) |
bool | get_free_vectors_on_destruct () |
virtual const char * | get_name () const |
virtual CSGObject * | shallow_copy () const |
virtual CSGObject * | deep_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) |
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_parameter_dictionary (CMap< TParameter *, CSGObject * > &dict) |
Public Attributes | |
SGIO * | io |
Parallel * | parallel |
Version * | version |
Parameter * | m_parameters |
Parameter * | m_model_selection_parameters |
ParameterMap * | m_parameter_map |
uint32_t | m_hash |
Protected Member Functions | |
virtual void | inc_read_index () |
virtual void | inc_write_index () |
virtual TParameter * | migrate (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 | |
int32_t | ring_size |
Size of ring as number of examples. | |
Example< T > * | ex_ring |
Ring of examples. | |
E_IS_EXAMPLE_USED * | ex_used |
Enum used for representing used/unused/empty state of example. | |
pthread_mutex_t * | ex_in_use_mutex |
Lock on state of example - used or unused. | |
pthread_cond_t * | ex_in_use_cond |
Condition variable triggered when example is being/not being used. | |
pthread_mutex_t * | read_lock |
Lock for reading examples from the ring. | |
pthread_mutex_t * | write_lock |
Lock for writing new examples. | |
int32_t | ex_write_index |
Write position for next example. | |
int32_t | ex_read_index |
Position of next example to be read. | |
bool | free_vectors_on_destruct |
Whether examples on the ring will be freed on destruction. |
CParseBuffer | ( | int32_t | size = 1024 | ) |
Constructor, taking buffer size as argument.
size | Ring size as number of examples |
Definition at line 213 of file ParseBuffer.h.
~CParseBuffer | ( | ) |
Destructor, frees up buffer.
Definition at line 244 of file ParseBuffer.h.
|
inherited |
Builds a dictionary of all parameters in SGObject as well of those of SGObjects that are parameters of this object. Dictionary maps parameters to the objects that own them.
dict | dictionary of parameters to be built. |
Definition at line 1204 of file SGObject.cpp.
int32_t copy_example | ( | Example< T > * | ex | ) |
Copies an example into the buffer, waiting for the destination example to be used if necessary.
ex | Example to copy into buffer |
Definition at line 306 of file ParseBuffer.h.
|
virtualinherited |
A deep copy. All the instance variables will also be copied.
Definition at line 131 of file SGObject.h.
void finalize_example | ( | bool | free_after_release | ) |
Mark the example in 'read' position as 'used'.
It will then be free to be overwritten.
free_after_release | whether to SG_FREE() the vector or not |
Definition at line 327 of file ParseBuffer.h.
Example<T>* get_free_example | ( | ) |
Return the next position to write the example into the ring.
Definition at line 87 of file ParseBuffer.h.
bool get_free_vectors_on_destruct | ( | ) |
Return whether all example objects will be freed on destruction.
Definition at line 158 of file ParseBuffer.h.
|
inherited |
|
inherited |
|
inherited |
|
inherited |
Definition at line 1108 of file SGObject.cpp.
|
inherited |
Returns description of a given parameter string, if it exists. SG_ERROR otherwise
param_name | name of the parameter |
Definition at line 1132 of file SGObject.cpp.
|
inherited |
Returns index of model selection parameter with provided index
param_name | name of model selection parameter |
Definition at line 1145 of file SGObject.cpp.
|
virtual |
Return the name of the object
Implements CSGObject.
Definition at line 165 of file ParseBuffer.h.
Example< T > * get_unused_example | ( | ) |
Returns the next example from the buffer if unused, or NULL.
Definition at line 284 of file ParseBuffer.h.
|
protectedvirtual |
Increments the 'read' position in the buffer.
Definition at line 172 of file ParseBuffer.h.
|
protectedvirtual |
Increments the 'write' position in the buffer.
Definition at line 181 of file ParseBuffer.h.
|
virtualinherited |
If the SGSerializable is a class template then TRUE will be returned and GENERIC is set to the type of the generic.
generic | set to the type of the generic if returning TRUE |
Definition at line 278 of file SGObject.cpp.
|
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)
file_version | parameter version of the file |
current_version | version from which mapping begins (you want to use VERSION_PARAMETER for this in most cases) |
file | file to load from |
prefix | prefix for members |
Definition at line 679 of file SGObject.cpp.
|
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
param_info | information of parameter |
file_version | parameter version of the file, must be <= provided parameter version |
file | file to load from |
prefix | prefix for members |
Definition at line 523 of file SGObject.cpp.
|
virtualinherited |
Load this object from file. If it will fail (returning FALSE) then this object will contain inconsistent data and should not be used!
file | where to load from |
prefix | prefix for members |
param_version | (optional) a parameter version different to (this is mainly for testing, better do not use) |
Reimplemented in CModelSelectionParameters.
Definition at line 354 of file SGObject.cpp.
|
protectedvirtualinherited |
Can (optionally) be overridden to post-initialize some member variables which are not PARAMETER::ADD'ed. Make sure that at first the overridden method BASE_CLASS::LOAD_SERIALIZABLE_POST is called.
ShogunException | Will be thrown if an error occurres. |
Reimplemented in CKernel, CWeightedDegreePositionStringKernel, CList, CAlphabet, CLinearHMM, CGaussianKernel, CANOVAKernel, CInverseMultiQuadricKernel, CCircularKernel, and CExponentialKernel.
Definition at line 1033 of file SGObject.cpp.
|
protectedvirtualinherited |
Can (optionally) be overridden to pre-initialize some member variables which are not PARAMETER::ADD'ed. Make sure that at first the overridden method BASE_CLASS::LOAD_SERIALIZABLE_PRE is called.
ShogunException | Will be thrown if an error occurres. |
Definition at line 1028 of file SGObject.cpp.
|
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
param_base | set of TParameter instances that are mapped to the provided target parameter infos |
base_version | version of the parameter base |
target_param_infos | set of SGParamInfo instances that specify the target parameter base |
Definition at line 717 of file SGObject.cpp.
|
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
param_base | set of TParameter instances to use for migration |
target | parameter info for the resulting TParameter |
Definition at line 923 of file SGObject.cpp.
|
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)
param_base | set of TParameter instances to use for migration |
target | parameter info for the resulting TParameter |
replacement | (used as output) here the TParameter instance which is returned by migration is created into |
to_migrate | the only source that is used for migration |
old_name | with this parameter, a name change may be specified |
Definition at line 864 of file SGObject.cpp.
|
inherited |
prints all parameter registered for model selection and their type
Definition at line 1084 of file SGObject.cpp.
|
virtualinherited |
prints registered parameters out
prefix | prefix for members |
Definition at line 290 of file SGObject.cpp.
Example< T > * return_example_to_read | ( | ) |
Returns the example that should be read next from the buffer.
Definition at line 275 of file ParseBuffer.h.
|
virtualinherited |
Save this object to file.
file | where to save the object; will be closed during returning if PREFIX is an empty string. |
prefix | prefix for members |
param_version | (optional) a parameter version different to (this is mainly for testing, better do not use) |
Reimplemented in CModelSelectionParameters.
Definition at line 296 of file SGObject.cpp.
|
protectedvirtualinherited |
Can (optionally) be overridden to post-initialize some member variables which are not PARAMETER::ADD'ed. Make sure that at first the overridden method BASE_CLASS::SAVE_SERIALIZABLE_POST is called.
ShogunException | Will be thrown if an error occurres. |
Reimplemented in CKernel.
Definition at line 1043 of file SGObject.cpp.
|
protectedvirtualinherited |
Can (optionally) be overridden to pre-initialize some member variables which are not PARAMETER::ADD'ed. Make sure that at first the overridden method BASE_CLASS::SAVE_SERIALIZABLE_PRE is called.
ShogunException | Will be thrown if an error occurres. |
Reimplemented in CKernel.
Definition at line 1038 of file SGObject.cpp.
void set_free_vectors_on_destruct | ( | bool | destroy | ) |
Set whether all vectors are to be freed on destruction. This is true by default.
The features object should set this to false if the vectors are freed manually later.
destroy | free examples on destruction or not |
Definition at line 152 of file ParseBuffer.h.
|
inherited |
set generic type to T
Definition at line 41 of file SGObject.cpp.
|
inherited |
|
inherited |
set the parallel object
parallel | parallel object to use |
Definition at line 230 of file SGObject.cpp.
|
inherited |
set the version object
version | version object to use |
Definition at line 265 of file SGObject.cpp.
|
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.
|
inherited |
unset generic type
this has to be called in classes specializing a template class
Definition at line 285 of file SGObject.cpp.
|
protectedvirtualinherited |
Updates the hash of current parameter combination.
Definition at line 237 of file SGObject.cpp.
int32_t write_example | ( | Example< T > * | ex | ) |
Writes the given example into the appropriate buffer space. Feature vector is copied into a separate block.
ex | Example to copy into buffer |
Definition at line 263 of file ParseBuffer.h.
|
protected |
Condition variable triggered when example is being/not being used.
Definition at line 198 of file ParseBuffer.h.
|
protected |
Lock on state of example - used or unused.
Definition at line 196 of file ParseBuffer.h.
|
protected |
Position of next example to be read.
Definition at line 207 of file ParseBuffer.h.
|
protected |
Ring of examples.
Definition at line 191 of file ParseBuffer.h.
|
protected |
Enum used for representing used/unused/empty state of example.
Definition at line 194 of file ParseBuffer.h.
|
protected |
Write position for next example.
Definition at line 205 of file ParseBuffer.h.
|
protected |
Whether examples on the ring will be freed on destruction.
Definition at line 210 of file ParseBuffer.h.
|
inherited |
io
Definition at line 462 of file SGObject.h.
|
inherited |
Hash of parameter values
Definition at line 480 of file SGObject.h.
|
inherited |
model selection parameters
Definition at line 474 of file SGObject.h.
|
inherited |
map for different parameter versions
Definition at line 477 of file SGObject.h.
|
inherited |
parameters
Definition at line 471 of file SGObject.h.
|
inherited |
parallel
Definition at line 465 of file SGObject.h.
|
protected |
Lock for reading examples from the ring.
Definition at line 200 of file ParseBuffer.h.
|
protected |
Size of ring as number of examples.
Definition at line 189 of file ParseBuffer.h.
|
inherited |
version
Definition at line 468 of file SGObject.h.
|
protected |
Lock for writing new examples.
Definition at line 202 of file ParseBuffer.h.