SHOGUN
v3.2.0
|
An I/O buffer class.
A file is read into buffer space, which is accessed through extents; 'space.begin' is the start of the buffer, 'space.end' is the address of the last read character.
The buffer grows in size if required, the default size being 64KB.
Definition at line 44 of file IOBuffer.h.
Public Member Functions | |
CIOBuffer () | |
CIOBuffer (int fd) | |
~CIOBuffer () | |
void | init () |
virtual void | use_file (int fd) |
virtual int | open_file (const char *name, char flag='r') |
virtual void | reset_file () |
void | set (char *p) |
virtual ssize_t | read_file (void *buf, size_t nbytes) |
size_t | fill () |
virtual ssize_t | write_file (const void *buf, size_t nbytes) |
virtual void | flush () |
virtual bool | close_file () |
ssize_t | readto (char *&pointer, char terminal) |
ssize_t | read_line (char *&pointer) |
void | buf_write (char *&pointer, int n) |
unsigned int | buf_read (char *&pointer, int n) |
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::get_version_parameter()) |
virtual bool | load_serializable (CSerializableFile *file, const char *prefix="", int32_t param_version=Version::get_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_gradient_parameter_dictionary (CMap< TParameter *, CSGObject * > *dict) |
virtual bool | update_parameter_hash () |
virtual bool | equals (CSGObject *other, float64_t accuracy=0.0) |
virtual CSGObject * | clone () |
Public Attributes | |
v_array< char > | space |
buffer space | |
char * | endloaded |
end of loaded values | |
int | working_file |
file descriptor | |
SGIO * | io |
Parallel * | parallel |
Version * | version |
Parameter * | m_parameters |
Parameter * | m_model_selection_parameters |
Parameter * | m_gradient_parameters |
ParameterMap * | m_parameter_map |
uint32_t | m_hash |
Protected Member Functions | |
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) |
CIOBuffer | ( | ) |
Constructor.
Definition at line 21 of file IOBuffer.cpp.
CIOBuffer | ( | int | fd | ) |
Constructor taking file descriptor as parameter
fd | file descriptor to use |
Definition at line 26 of file IOBuffer.cpp.
~CIOBuffer | ( | ) |
Destructor.
Definition at line 32 of file IOBuffer.cpp.
unsigned int buf_read | ( | char *& | pointer, |
int | n | ||
) |
Return a pointer to position in buffer after reading n bytes
pointer | returned pointer |
n | bytes to read |
Definition at line 184 of file IOBuffer.cpp.
void buf_write | ( | char *& | pointer, |
int | n | ||
) |
Return a pointer to the next n bytes to write into
pointer | returned pointer |
n | number of bytes to write |
Definition at line 164 of file IOBuffer.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.
dict | dictionary of parameters to be built. |
Definition at line 1156 of file SGObject.cpp.
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.
Definition at line 1273 of file SGObject.cpp.
bool close_file | ( | ) | [virtual] |
Close the file.
Definition at line 120 of file IOBuffer.cpp.
A deep copy. All the instance variables will also be copied.
Definition at line 126 of file SGObject.h.
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.
other | object to compare with |
accuracy | accuracy to use for comparison (optional) |
Definition at line 1177 of file SGObject.cpp.
size_t fill | ( | ) |
Fill the buffer by reading as many bytes from the file as required.
Definition at line 86 of file IOBuffer.cpp.
void flush | ( | ) | [virtual] |
Flush the stream; commit all operations to file.
Definition at line 109 of file IOBuffer.cpp.
SGIO * get_global_io | ( | ) | [inherited] |
Parallel * get_global_parallel | ( | ) | [inherited] |
Version * get_global_version | ( | ) | [inherited] |
SGStringList< char > get_modelsel_names | ( | ) | [inherited] |
Definition at line 1060 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
param_name | name of the parameter |
Definition at line 1084 of file SGObject.cpp.
index_t get_modsel_param_index | ( | const char * | param_name | ) | [inherited] |
Returns index of model selection parameter with provided index
param_name | name of model selection parameter |
Definition at line 1097 of file SGObject.cpp.
virtual const char* get_name | ( | ) | const [virtual] |
Returns the name of the SGSerializable instance. It MUST BE the CLASS NAME without the prefixed `C'.
Implements CSGObject.
Definition at line 179 of file IOBuffer.h.
void init | ( | ) |
Initialize the buffer, reserve 64K memory by default.
Reimplemented from CSGObject.
Definition at line 36 of file IOBuffer.cpp.
bool is_generic | ( | EPrimitiveType * | generic | ) | const [virtual, inherited] |
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 228 of file SGObject.cpp.
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)
file_version | parameter version of the file |
current_version | version from which mapping begins (you want to use Version::get_version_parameter() for this in most cases) |
file | file to load from |
prefix | prefix for members |
Definition at line 633 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
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 474 of file SGObject.cpp.
bool load_serializable | ( | CSerializableFile * | file, |
const char * | prefix = "" , |
||
int32_t | param_version = Version::get_version_parameter() |
||
) | [virtual, inherited] |
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) |
Definition at line 305 of file SGObject.cpp.
void load_serializable_post | ( | ) | throw (ShogunException) [protected, virtual, inherited] |
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, CInverseMultiQuadricKernel, CCircularKernel, and CExponentialKernel.
Definition at line 989 of file SGObject.cpp.
void load_serializable_pre | ( | ) | throw (ShogunException) [protected, virtual, inherited] |
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. |
Reimplemented in CDynamicArray< T >, CDynamicArray< float64_t >, CDynamicArray< float32_t >, CDynamicArray< int32_t >, CDynamicArray< char >, CDynamicArray< bool >, and CDynamicObjectArray.
Definition at line 984 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
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 671 of file SGObject.cpp.
TParameter * migrate | ( | DynArray< TParameter * > * | param_base, |
const SGParamInfo * | target | ||
) | [protected, virtual, inherited] |
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 878 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 |
||
) | [protected, virtual, inherited] |
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 818 of file SGObject.cpp.
int open_file | ( | const char * | name, |
char | flag = 'r' |
||
) | [virtual] |
Open a file, in read or write mode.
name | File name. |
flag | 'r' or 'w' |
Definition at line 49 of file IOBuffer.cpp.
void print_modsel_params | ( | ) | [inherited] |
prints all parameter registered for model selection and their type
Definition at line 1036 of file SGObject.cpp.
void print_serializable | ( | const char * | prefix = "" | ) | [virtual, inherited] |
prints registered parameters out
prefix | prefix for members |
Definition at line 240 of file SGObject.cpp.
ssize_t read_file | ( | void * | buf, |
size_t | nbytes | ||
) | [virtual] |
Read some bytes from the file into memory.
buf | void* buffer into which to read. |
nbytes | number of bytes to read |
Definition at line 81 of file IOBuffer.cpp.
ssize_t read_line | ( | char *& | pointer | ) |
Reads upto a newline character from the buffer.
pointer | Start of the string, set by reference |
Definition at line 156 of file IOBuffer.h.
ssize_t readto | ( | char *& | pointer, |
char | terminal | ||
) |
Reads upto a terminal character from the buffer.
pointer | Start of the string in the buffer, set by reference. |
terminal | Terminal character upto which to read. |
Definition at line 133 of file IOBuffer.cpp.
void reset_file | ( | ) | [virtual] |
Seek back to zero, reset the buffer markers.
Definition at line 69 of file IOBuffer.cpp.
bool save_serializable | ( | CSerializableFile * | file, |
const char * | prefix = "" , |
||
int32_t | param_version = Version::get_version_parameter() |
||
) | [virtual, inherited] |
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) |
Definition at line 246 of file SGObject.cpp.
void save_serializable_post | ( | ) | throw (ShogunException) [protected, virtual, inherited] |
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 999 of file SGObject.cpp.
void save_serializable_pre | ( | ) | throw (ShogunException) [protected, virtual, inherited] |
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, CDynamicArray< T >, CDynamicArray< float64_t >, CDynamicArray< float32_t >, CDynamicArray< int32_t >, CDynamicArray< char >, CDynamicArray< bool >, and CDynamicObjectArray.
Definition at line 994 of file SGObject.cpp.
void set | ( | char * | p | ) |
Set the buffer marker to a position.
p | Character pointer to which the end of buffer space is assigned. |
Definition at line 76 of file IOBuffer.cpp.
void set_generic< complex128_t > | ( | ) | [inherited] |
set generic type to T
Definition at line 41 of file SGObject.cpp.
void set_global_io | ( | SGIO * | io | ) | [inherited] |
void set_global_parallel | ( | Parallel * | parallel | ) | [inherited] |
set the parallel object
parallel | parallel object to use |
Definition at line 180 of file SGObject.cpp.
void set_global_version | ( | Version * | version | ) | [inherited] |
set the version object
version | version object to use |
Definition at line 215 of file SGObject.cpp.
virtual CSGObject* shallow_copy | ( | ) | const [virtual, inherited] |
A shallow copy. All the SGObject instance variables will be simply assigned and SG_REF-ed.
Reimplemented in CGaussianKernel.
Definition at line 117 of file SGObject.h.
void unset_generic | ( | ) | [inherited] |
unset generic type
this has to be called in classes specializing a template class
Definition at line 235 of file SGObject.cpp.
bool update_parameter_hash | ( | ) | [virtual, inherited] |
Updates the hash of current parameter combination.
Definition at line 187 of file SGObject.cpp.
void use_file | ( | int | fd | ) | [virtual] |
Uses the passed file descriptor
fd | file descriptor to use |
Definition at line 44 of file IOBuffer.cpp.
ssize_t write_file | ( | const void * | buf, |
size_t | nbytes | ||
) | [virtual] |
Write to the file from memory.
buf | void* buffer from which to write. |
nbytes | Number of bytes to write. |
Definition at line 104 of file IOBuffer.cpp.
char* endloaded |
end of loaded values
Definition at line 192 of file IOBuffer.h.
io
Definition at line 473 of file SGObject.h.
Parameter* m_gradient_parameters [inherited] |
parameters wrt which we can compute gradients
Definition at line 488 of file SGObject.h.
uint32_t m_hash [inherited] |
Hash of parameter values
Definition at line 494 of file SGObject.h.
Parameter* m_model_selection_parameters [inherited] |
model selection parameters
Definition at line 485 of file SGObject.h.
ParameterMap* m_parameter_map [inherited] |
map for different parameter versions
Definition at line 491 of file SGObject.h.
Parameter* m_parameters [inherited] |
parameters
Definition at line 482 of file SGObject.h.
parallel
Definition at line 476 of file SGObject.h.
buffer space
Definition at line 187 of file IOBuffer.h.
version
Definition at line 479 of file SGObject.h.
int working_file |
file descriptor
Definition at line 195 of file IOBuffer.h.