Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes

CBinaryFile Class Reference


Detailed Description

A Binary file access class.

A file consists of a SG00 fourcc header then an alternation of a type header and data. The current implementation is capable of storing only a single header/data type. Multiple headers are currently not implemented.

Definition at line 28 of file BinaryFile.h.

Inheritance diagram for CBinaryFile:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 CBinaryFile ()
 CBinaryFile (FILE *f, const char *name=NULL)
 CBinaryFile (const char *fname, char rw='r', const char *name=NULL)
virtual ~CBinaryFile ()
virtual const char * get_name () const
void close ()
FILE * get_file_descriptor ()
void set_variable_name (const char *name)
char * get_variable_name ()
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)
Vector Access Functions

Functions to access vectors of one of the several base data types. These functions are used when writing vectors of length len to e.g. a file

virtual void get_vector (int8_t *&vector, int32_t &len)
virtual void get_vector (uint8_t *&vector, int32_t &len)
virtual void get_vector (char *&vector, int32_t &len)
virtual void get_vector (int32_t *&vector, int32_t &len)
virtual void get_vector (uint32_t *&vector, int32_t &len)
virtual void get_vector (float64_t *&vector, int32_t &len)
virtual void get_vector (float32_t *&vector, int32_t &len)
virtual void get_vector (floatmax_t *&vector, int32_t &len)
virtual void get_vector (int16_t *&vector, int32_t &len)
virtual void get_vector (uint16_t *&vector, int32_t &len)
virtual void get_vector (int64_t *&vector, int32_t &len)
virtual void get_vector (uint64_t *&vector, int32_t &len)
virtual void set_vector (const int8_t *vector, int32_t len)
virtual void set_vector (const uint8_t *vector, int32_t len)
virtual void set_vector (const char *vector, int32_t len)
virtual void set_vector (const int32_t *vector, int32_t len)
virtual void set_vector (const uint32_t *vector, int32_t len)
virtual void set_vector (const float32_t *vector, int32_t len)
virtual void set_vector (const float64_t *vector, int32_t len)
virtual void set_vector (const floatmax_t *vector, int32_t len)
virtual void set_vector (const int16_t *vector, int32_t len)
virtual void set_vector (const uint16_t *vector, int32_t len)
virtual void set_vector (const int64_t *vector, int32_t len)
virtual void set_vector (const uint64_t *vector, int32_t len)
Matrix Access Functions

Functions to access matrices of one of the several base data types. These functions are used when writing matrices of num_feat rows and num_vec columns to e.g. a file

virtual void get_matrix (uint8_t *&matrix, int32_t &num_feat, int32_t &num_vec)
virtual void get_int8_matrix (int8_t *&matrix, int32_t &num_feat, int32_t &num_vec)
virtual void get_matrix (char *&matrix, int32_t &num_feat, int32_t &num_vec)
virtual void get_matrix (int32_t *&matrix, int32_t &num_feat, int32_t &num_vec)
virtual void get_uint_matrix (uint32_t *&matrix, int32_t &num_feat, int32_t &num_vec)
virtual void get_long_matrix (int64_t *&matrix, int32_t &num_feat, int32_t &num_vec)
virtual void get_ulong_matrix (uint64_t *&matrix, int32_t &num_feat, int32_t &num_vec)
virtual void get_matrix (float32_t *&matrix, int32_t &num_feat, int32_t &num_vec)
virtual void get_matrix (float64_t *&matrix, int32_t &num_feat, int32_t &num_vec)
virtual void get_longreal_matrix (floatmax_t *&matrix, int32_t &num_feat, int32_t &num_vec)
virtual void get_matrix (int16_t *&matrix, int32_t &num_feat, int32_t &num_vec)
virtual void get_matrix (uint16_t *&matrix, int32_t &num_feat, int32_t &num_vec)
virtual void set_matrix (const uint8_t *matrix, int32_t num_feat, int32_t num_vec)
virtual void set_int8_matrix (const int8_t *matrix, int32_t num_feat, int32_t num_vec)
virtual void set_matrix (const char *matrix, int32_t num_feat, int32_t num_vec)
virtual void set_matrix (const int32_t *matrix, int32_t num_feat, int32_t num_vec)
virtual void set_uint_matrix (const uint32_t *matrix, int32_t num_feat, int32_t num_vec)
virtual void set_long_matrix (const int64_t *matrix, int32_t num_feat, int32_t num_vec)
virtual void set_ulong_matrix (const uint64_t *matrix, int32_t num_feat, int32_t num_vec)
virtual void set_matrix (const float32_t *matrix, int32_t num_feat, int32_t num_vec)
virtual void set_matrix (const float64_t *matrix, int32_t num_feat, int32_t num_vec)
virtual void set_longreal_matrix (const floatmax_t *matrix, int32_t num_feat, int32_t num_vec)
virtual void set_matrix (const int16_t *matrix, int32_t num_feat, int32_t num_vec)
virtual void set_matrix (const uint16_t *matrix, int32_t num_feat, int32_t num_vec)
N-Dimensional Array Access Functions

Functions to access n-dimensional arrays of one of the several base data types. These functions are used when writing array of num_dims dimensions to e.g. a file. Dims contain sizes of every dimensions.

virtual void get_ndarray (uint8_t *&array, int32_t *&dims, int32_t &num_dims)
virtual void get_ndarray (char *&array, int32_t *&dims, int32_t &num_dims)
virtual void get_ndarray (int32_t *&array, int32_t *&dims, int32_t &num_dims)
virtual void get_ndarray (float32_t *&array, int32_t *&dims, int32_t &num_dims)
virtual void get_ndarray (float64_t *&array, int32_t *&dims, int32_t &num_dims)
virtual void get_ndarray (int16_t *&array, int32_t *&dims, int32_t &num_dims)
virtual void get_ndarray (uint16_t *&array, int32_t *&dims, int32_t &num_dims)
virtual void set_ndarray (const uint8_t *array, int32_t *dims, int32_t num_dims)
virtual void set_ndarray (const char *array, int32_t *dims, int32_t num_dims)
virtual void set_ndarray (const int32_t *array, int32_t *dims, int32_t num_dims)
virtual void set_ndarray (const float32_t *array, int32_t *dims, int32_t num_dims)
virtual void set_ndarray (const float64_t *array, int32_t *dims, int32_t num_dims)
virtual void set_ndarray (const int16_t *array, int32_t *dims, int32_t num_dims)
virtual void set_ndarray (const uint16_t *array, int32_t *dims, int32_t num_dims)
Sparse Matrix Access Functions

Functions to access sparse matrices of one of the several base data types. These functions are used when writing sparse matrices of num_feat rows and num_vec columns to e.g. a file

virtual void get_sparse_matrix (SGSparseVector< bool > *&matrix, int32_t &num_feat, int32_t &num_vec)
virtual void get_sparse_matrix (SGSparseVector< uint8_t > *&matrix, int32_t &num_feat, int32_t &num_vec)
virtual void get_int8_sparsematrix (SGSparseVector< int8_t > *&matrix, int32_t &num_feat, int32_t &num_vec)
virtual void get_sparse_matrix (SGSparseVector< char > *&matrix, int32_t &num_feat, int32_t &num_vec)
virtual void get_sparse_matrix (SGSparseVector< int32_t > *&matrix, int32_t &num_feat, int32_t &num_vec)
virtual void get_uint_sparsematrix (SGSparseVector< uint32_t > *&matrix, int32_t &num_feat, int32_t &num_vec)
virtual void get_long_sparsematrix (SGSparseVector< int64_t > *&matrix, int32_t &num_feat, int32_t &num_vec)
virtual void get_ulong_sparsematrix (SGSparseVector< uint64_t > *&matrix, int32_t &num_feat, int32_t &num_vec)
virtual void get_sparse_matrix (SGSparseVector< int16_t > *&matrix, int32_t &num_feat, int32_t &num_vec)
virtual void get_sparse_matrix (SGSparseVector< uint16_t > *&matrix, int32_t &num_feat, int32_t &num_vec)
virtual void get_sparse_matrix (SGSparseVector< float32_t > *&matrix, int32_t &num_feat, int32_t &num_vec)
virtual void get_sparse_matrix (SGSparseVector< float64_t > *&matrix, int32_t &num_feat, int32_t &num_vec)
virtual void get_longreal_sparsematrix (SGSparseVector< floatmax_t > *&matrix, int32_t &num_feat, int32_t &num_vec)
virtual void set_sparse_matrix (const SGSparseVector< bool > *matrix, int32_t num_feat, int32_t num_vec)
virtual void set_sparse_matrix (const SGSparseVector< uint8_t > *matrix, int32_t num_feat, int32_t num_vec)
virtual void set_int8_sparsematrix (const SGSparseVector< int8_t > *matrix, int32_t num_feat, int32_t num_vec)
virtual void set_sparse_matrix (const SGSparseVector< char > *matrix, int32_t num_feat, int32_t num_vec)
virtual void set_sparse_matrix (const SGSparseVector< int32_t > *matrix, int32_t num_feat, int32_t num_vec)
virtual void set_uint_sparsematrix (const SGSparseVector< uint32_t > *matrix, int32_t num_feat, int32_t num_vec)
virtual void set_long_sparsematrix (const SGSparseVector< int64_t > *matrix, int32_t num_feat, int32_t num_vec)
virtual void set_ulong_sparsematrix (const SGSparseVector< uint64_t > *matrix, int32_t num_feat, int32_t num_vec)
virtual void set_sparse_matrix (const SGSparseVector< int16_t > *matrix, int32_t num_feat, int32_t num_vec)
virtual void set_sparse_matrix (const SGSparseVector< uint16_t > *matrix, int32_t num_feat, int32_t num_vec)
virtual void set_sparse_matrix (const SGSparseVector< float32_t > *matrix, int32_t num_feat, int32_t num_vec)
virtual void set_sparse_matrix (const SGSparseVector< float64_t > *matrix, int32_t num_feat, int32_t num_vec)
virtual void set_longreal_sparsematrix (const SGSparseVector< floatmax_t > *matrix, int32_t num_feat, int32_t num_vec)
String Access Functions

Functions to access strings of one of the several base data types. These functions are used when writing variable length datatypes like strings to a file. Here num_str denotes the number of strings and strings is a pointer to a string structure.

virtual void get_string_list (SGString< uint8_t > *&strings, int32_t &num_str, int32_t &max_string_len)
virtual void get_int8_string_list (SGString< int8_t > *&strings, int32_t &num_str, int32_t &max_string_len)
virtual void get_string_list (SGString< char > *&strings, int32_t &num_str, int32_t &max_string_len)
virtual void get_string_list (SGString< int32_t > *&strings, int32_t &num_str, int32_t &max_string_len)
virtual void get_uint_string_list (SGString< uint32_t > *&strings, int32_t &num_str, int32_t &max_string_len)
virtual void get_string_list (SGString< int16_t > *&strings, int32_t &num_str, int32_t &max_string_len)
virtual void get_string_list (SGString< uint16_t > *&strings, int32_t &num_str, int32_t &max_string_len)
virtual void get_long_string_list (SGString< int64_t > *&strings, int32_t &num_str, int32_t &max_string_len)
virtual void get_ulong_string_list (SGString< uint64_t > *&strings, int32_t &num_str, int32_t &max_string_len)
virtual void get_string_list (SGString< float32_t > *&strings, int32_t &num_str, int32_t &max_string_len)
virtual void get_string_list (SGString< float64_t > *&strings, int32_t &num_str, int32_t &max_string_len)
virtual void get_longreal_string_list (SGString< floatmax_t > *&strings, int32_t &num_str, int32_t &max_string_len)
virtual void set_string_list (const SGString< uint8_t > *strings, int32_t num_str)
virtual void set_int8_string_list (const SGString< int8_t > *strings, int32_t num_str)
virtual void set_string_list (const SGString< char > *strings, int32_t num_str)
virtual void set_string_list (const SGString< int32_t > *strings, int32_t num_str)
virtual void set_uint_string_list (const SGString< uint32_t > *strings, int32_t num_str)
virtual void set_string_list (const SGString< int16_t > *strings, int32_t num_str)
virtual void set_string_list (const SGString< uint16_t > *strings, int32_t num_str)
virtual void set_long_string_list (const SGString< int64_t > *strings, int32_t num_str)
virtual void set_ulong_string_list (const SGString< uint64_t > *strings, int32_t num_str)
virtual void set_string_list (const SGString< float32_t > *strings, int32_t num_str)
virtual void set_string_list (const SGString< float64_t > *strings, int32_t num_str)
virtual void set_longreal_string_list (const SGString< floatmax_t > *strings, int32_t num_str)
Vector Access Functions

vector access functions

Functions to access vectors of one of the several base data types. These functions are used when writing vectors of length len to e.g. a file

virtual void get_vector (bool *&vector, int32_t &len)
virtual void set_vector (const bool *vector, int32_t len)
Matrix Access Functions

Functions to access matrices of one of the several base data types. These functions are used when writing matrices of num_feat rows and num_vec columns to e.g. a file

virtual void get_matrix (bool *&matrix, int32_t &num_feat, int32_t &num_vec)
virtual void set_matrix (const bool *matrix, int32_t num_feat, int32_t num_vec)
String Access Functions

Functions to access strings of one of the several base data types. These functions are used when writing variable length datatypes like strings to a file. Here num_str denotes the number of strings and strings is a pointer to a string structure.

virtual void get_string_list (SGString< bool > *&strings, int32_t &num_str, int32_t &max_string_len)
virtual void set_string_list (const SGString< bool > *strings, int32_t num_str)

Static Public Member Functions

static char * read_whole_file (char *fname, size_t &len)

Public Attributes

SGIOio
Parallelparallel
Versionversion
Parameterm_parameters
Parameterm_model_selection_parameters
ParameterMapm_parameter_map
uint32_t m_hash

Protected Member Functions

void read_header (TSGDataType *dest)
void write_header (const TSGDataType *datatype)
int32_t parse_first_header (TSGDataType &type)
int32_t parse_next_header (TSGDataType &type)
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

FILE * file
char task
char * filename
char * variable_name

Constructor & Destructor Documentation

CBinaryFile (  ) 

default constructor

Definition at line 17 of file BinaryFile.cpp.

CBinaryFile ( FILE *  f,
const char *  name = NULL 
)

constructor

Parameters:
f already opened file
name variable name (e.g. "x" or "/path/to/x")

Definition at line 22 of file BinaryFile.cpp.

CBinaryFile ( const char *  fname,
char  rw = 'r',
const char *  name = NULL 
)

constructor

Parameters:
fname filename to open
rw mode, 'r' or 'w'
name variable name (e.g. "x" or "/path/to/x")

Definition at line 26 of file BinaryFile.cpp.

~CBinaryFile (  )  [virtual]

default destructor

Definition at line 30 of file BinaryFile.cpp.


Member Function Documentation

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:
dict dictionary of parameters to be built.

Definition at line 1201 of file SGObject.cpp.

void close (  )  [inherited]

close

Definition at line 58 of file File.h.

virtual CSGObject* deep_copy (  )  const [virtual, inherited]

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

Definition at line 131 of file SGObject.h.

FILE* get_file_descriptor (  )  [inherited]

get the file descriptor

Returns:
FILE ptr

Definition at line 73 of file File.h.

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.

virtual void get_int8_matrix ( int8_t *&  matrix,
int32_t &  num_feat,
int32_t &  num_vec 
) [virtual]

Implements CFile.

virtual void get_int8_sparsematrix ( SGSparseVector< int8_t > *&  matrix,
int32_t &  num_feat,
int32_t &  num_vec 
) [virtual]

Implements CFile.

virtual void get_int8_string_list ( SGString< int8_t > *&  strings,
int32_t &  num_str,
int32_t &  max_string_len 
) [virtual]

Implements CFile.

virtual void get_long_matrix ( int64_t *&  matrix,
int32_t &  num_feat,
int32_t &  num_vec 
) [virtual]

Implements CFile.

virtual void get_long_sparsematrix ( SGSparseVector< int64_t > *&  matrix,
int32_t &  num_feat,
int32_t &  num_vec 
) [virtual]

Implements CFile.

virtual void get_long_string_list ( SGString< int64_t > *&  strings,
int32_t &  num_str,
int32_t &  max_string_len 
) [virtual]

Implements CFile.

virtual void get_longreal_matrix ( floatmax_t *&  matrix,
int32_t &  num_feat,
int32_t &  num_vec 
) [virtual]

Implements CFile.

virtual void get_longreal_sparsematrix ( SGSparseVector< floatmax_t > *&  matrix,
int32_t &  num_feat,
int32_t &  num_vec 
) [virtual]

Implements CFile.

virtual void get_longreal_string_list ( SGString< floatmax_t > *&  strings,
int32_t &  num_str,
int32_t &  max_string_len 
) [virtual]

Implements CFile.

virtual void get_matrix ( int32_t *&  matrix,
int32_t &  num_feat,
int32_t &  num_vec 
) [virtual]

Implements CFile.

virtual void get_matrix ( float64_t *&  matrix,
int32_t &  num_feat,
int32_t &  num_vec 
) [virtual]

Implements CFile.

virtual void get_matrix ( float32_t *&  matrix,
int32_t &  num_feat,
int32_t &  num_vec 
) [virtual]

Implements CFile.

virtual void get_matrix ( int16_t *&  matrix,
int32_t &  num_feat,
int32_t &  num_vec 
) [virtual]

Implements CFile.

virtual void get_matrix ( uint8_t *&  matrix,
int32_t &  num_feat,
int32_t &  num_vec 
) [virtual]

Implements CFile.

virtual void get_matrix ( uint16_t *&  matrix,
int32_t &  num_feat,
int32_t &  num_vec 
) [virtual]

Implements CFile.

virtual void get_matrix ( char *&  matrix,
int32_t &  num_feat,
int32_t &  num_vec 
) [virtual]

Implements CFile.

void get_matrix ( bool *&  matrix,
int32_t &  num_feat,
int32_t &  num_vec 
) [virtual, inherited]

Definition at line 92 of file File.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_name name 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_name name 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]
Returns:
object name

Reimplemented from CFile.

Definition at line 363 of file BinaryFile.h.

virtual void get_ndarray ( uint8_t *&  array,
int32_t *&  dims,
int32_t &  num_dims 
) [virtual]

Implements CFile.

virtual void get_ndarray ( char *&  array,
int32_t *&  dims,
int32_t &  num_dims 
) [virtual]

Implements CFile.

virtual void get_ndarray ( int32_t *&  array,
int32_t *&  dims,
int32_t &  num_dims 
) [virtual]

Implements CFile.

virtual void get_ndarray ( float32_t *&  array,
int32_t *&  dims,
int32_t &  num_dims 
) [virtual]

Implements CFile.

virtual void get_ndarray ( float64_t *&  array,
int32_t *&  dims,
int32_t &  num_dims 
) [virtual]

Implements CFile.

virtual void get_ndarray ( int16_t *&  array,
int32_t *&  dims,
int32_t &  num_dims 
) [virtual]

Implements CFile.

virtual void get_ndarray ( uint16_t *&  array,
int32_t *&  dims,
int32_t &  num_dims 
) [virtual]

Implements CFile.

virtual void get_sparse_matrix ( SGSparseVector< uint8_t > *&  matrix,
int32_t &  num_feat,
int32_t &  num_vec 
) [virtual]

Implements CFile.

virtual void get_sparse_matrix ( SGSparseVector< char > *&  matrix,
int32_t &  num_feat,
int32_t &  num_vec 
) [virtual]

Implements CFile.

virtual void get_sparse_matrix ( SGSparseVector< bool > *&  matrix,
int32_t &  num_feat,
int32_t &  num_vec 
) [virtual]

Implements CFile.

virtual void get_sparse_matrix ( SGSparseVector< int32_t > *&  matrix,
int32_t &  num_feat,
int32_t &  num_vec 
) [virtual]

Implements CFile.

virtual void get_sparse_matrix ( SGSparseVector< int16_t > *&  matrix,
int32_t &  num_feat,
int32_t &  num_vec 
) [virtual]

Implements CFile.

virtual void get_sparse_matrix ( SGSparseVector< uint16_t > *&  matrix,
int32_t &  num_feat,
int32_t &  num_vec 
) [virtual]

Implements CFile.

virtual void get_sparse_matrix ( SGSparseVector< float32_t > *&  matrix,
int32_t &  num_feat,
int32_t &  num_vec 
) [virtual]

Implements CFile.

virtual void get_sparse_matrix ( SGSparseVector< float64_t > *&  matrix,
int32_t &  num_feat,
int32_t &  num_vec 
) [virtual]

Implements CFile.

virtual void get_string_list ( SGString< uint8_t > *&  strings,
int32_t &  num_str,
int32_t &  max_string_len 
) [virtual]

Implements CFile.

virtual void get_string_list ( SGString< char > *&  strings,
int32_t &  num_str,
int32_t &  max_string_len 
) [virtual]

Implements CFile.

virtual void get_string_list ( SGString< int32_t > *&  strings,
int32_t &  num_str,
int32_t &  max_string_len 
) [virtual]

Implements CFile.

virtual void get_string_list ( SGString< int16_t > *&  strings,
int32_t &  num_str,
int32_t &  max_string_len 
) [virtual]

Implements CFile.

virtual void get_string_list ( SGString< uint16_t > *&  strings,
int32_t &  num_str,
int32_t &  max_string_len 
) [virtual]

Implements CFile.

virtual void get_string_list ( SGString< float32_t > *&  strings,
int32_t &  num_str,
int32_t &  max_string_len 
) [virtual]

Implements CFile.

virtual void get_string_list ( SGString< float64_t > *&  strings,
int32_t &  num_str,
int32_t &  max_string_len 
) [virtual]

Implements CFile.

void get_string_list ( SGString< bool > *&  strings,
int32_t &  num_str,
int32_t &  max_string_len 
) [virtual, inherited]

Definition at line 123 of file File.cpp.

virtual void get_uint_matrix ( uint32_t *&  matrix,
int32_t &  num_feat,
int32_t &  num_vec 
) [virtual]

Implements CFile.

virtual void get_uint_sparsematrix ( SGSparseVector< uint32_t > *&  matrix,
int32_t &  num_feat,
int32_t &  num_vec 
) [virtual]

Implements CFile.

virtual void get_uint_string_list ( SGString< uint32_t > *&  strings,
int32_t &  num_str,
int32_t &  max_string_len 
) [virtual]

Implements CFile.

virtual void get_ulong_matrix ( uint64_t *&  matrix,
int32_t &  num_feat,
int32_t &  num_vec 
) [virtual]

Implements CFile.

virtual void get_ulong_sparsematrix ( SGSparseVector< uint64_t > *&  matrix,
int32_t &  num_feat,
int32_t &  num_vec 
) [virtual]

Implements CFile.

virtual void get_ulong_string_list ( SGString< uint64_t > *&  strings,
int32_t &  num_str,
int32_t &  max_string_len 
) [virtual]

Implements CFile.

char * get_variable_name (  )  [inherited]

get the path to the variable to be accessed

only supported by some file interfaces like CHDF5File

Returns:
name variable path & name

Definition at line 176 of file File.cpp.

virtual void get_vector ( floatmax_t *&  vector,
int32_t &  len 
) [virtual]

Implements CFile.

virtual void get_vector ( uint8_t *&  vector,
int32_t &  len 
) [virtual]

Implements CFile.

virtual void get_vector ( int32_t *&  vector,
int32_t &  len 
) [virtual]

Implements CFile.

virtual void get_vector ( int16_t *&  vector,
int32_t &  len 
) [virtual]

Implements CFile.

virtual void get_vector ( uint16_t *&  vector,
int32_t &  len 
) [virtual]

Implements CFile.

virtual void get_vector ( uint32_t *&  vector,
int32_t &  len 
) [virtual]

Implements CFile.

virtual void get_vector ( int64_t *&  vector,
int32_t &  len 
) [virtual]

Implements CFile.

virtual void get_vector ( uint64_t *&  vector,
int32_t &  len 
) [virtual]

Implements CFile.

virtual void get_vector ( char *&  vector,
int32_t &  len 
) [virtual]

Implements CFile.

virtual void get_vector ( float64_t *&  vector,
int32_t &  len 
) [virtual]

Implements CFile.

virtual void get_vector ( float32_t *&  vector,
int32_t &  len 
) [virtual]

Implements CFile.

virtual void get_vector ( int8_t *&  vector,
int32_t &  len 
) [virtual]

Implements CFile.

void get_vector ( bool *&  vector,
int32_t &  len 
) [virtual, inherited]

Definition at line 64 of file File.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.

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

Definition at line 278 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)

Parameters:
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
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_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
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 
) [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!

Parameters:
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)
Returns:
TRUE if done, otherwise FALSE

Reimplemented in CModelSelectionParameters.

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

Exceptions:
ShogunException Will be thrown if an error occurres.

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

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

Exceptions:
ShogunException Will 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_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.

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

Parameters:
param_base set of TParameter instances to use for migration
target parameter 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 
) [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)

Parameters:
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.

int32_t parse_first_header ( TSGDataType type  )  [protected]

parse first header - defunct!

Parameters:
type feature type
Returns:
-1

Definition at line 380 of file BinaryFile.cpp.

int32_t parse_next_header ( TSGDataType type  )  [protected]

parse next header - defunct!

Parameters:
type feature type
Returns:
-1

Definition at line 385 of file BinaryFile.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 = ""  )  [virtual, inherited]

prints registered parameters out

Parameters:
prefix prefix for members

Definition at line 290 of file SGObject.cpp.

void read_header ( TSGDataType dest  )  [protected]

read header

Returns:
datatype

Definition at line 391 of file BinaryFile.cpp.

char * read_whole_file ( char *  fname,
size_t &  len 
) [static, inherited]

read whole file in memory

Parameters:
fname - file name
len - length of file (returned by reference)
Returns:
buffer to read file - needs to be freed with SG_FREE

Definition at line 181 of file File.cpp.

bool save_serializable ( CSerializableFile file,
const char *  prefix = "",
int32_t  param_version = VERSION_PARAMETER 
) [virtual, inherited]

Save this object to file.

Parameters:
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)
Returns:
TRUE if done, otherwise FALSE

Reimplemented in CModelSelectionParameters.

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

Exceptions:
ShogunException Will be thrown if an error occurres.

Reimplemented in CKernel.

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

Exceptions:
ShogunException Will 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

void set_global_io ( SGIO io  )  [inherited]

set the io object

Parameters:
io io object to use

Definition at line 217 of file SGObject.cpp.

void set_global_parallel ( Parallel parallel  )  [inherited]

set the parallel object

Parameters:
parallel parallel object to use

Definition at line 230 of file SGObject.cpp.

void set_global_version ( Version version  )  [inherited]

set the version object

Parameters:
version version object to use

Definition at line 265 of file SGObject.cpp.

virtual void set_int8_matrix ( const int8_t *  matrix,
int32_t  num_feat,
int32_t  num_vec 
) [virtual]

Implements CFile.

virtual void set_int8_sparsematrix ( const SGSparseVector< int8_t > *  matrix,
int32_t  num_feat,
int32_t  num_vec 
) [virtual]

Implements CFile.

virtual void set_int8_string_list ( const SGString< int8_t > *  strings,
int32_t  num_str 
) [virtual]

Implements CFile.

virtual void set_long_matrix ( const int64_t *  matrix,
int32_t  num_feat,
int32_t  num_vec 
) [virtual]

Implements CFile.

virtual void set_long_sparsematrix ( const SGSparseVector< int64_t > *  matrix,
int32_t  num_feat,
int32_t  num_vec 
) [virtual]

Implements CFile.

virtual void set_long_string_list ( const SGString< int64_t > *  strings,
int32_t  num_str 
) [virtual]

Implements CFile.

virtual void set_longreal_matrix ( const floatmax_t matrix,
int32_t  num_feat,
int32_t  num_vec 
) [virtual]

Implements CFile.

virtual void set_longreal_sparsematrix ( const SGSparseVector< floatmax_t > *  matrix,
int32_t  num_feat,
int32_t  num_vec 
) [virtual]

Implements CFile.

virtual void set_longreal_string_list ( const SGString< floatmax_t > *  strings,
int32_t  num_str 
) [virtual]

Implements CFile.

virtual void set_matrix ( const int32_t *  matrix,
int32_t  num_feat,
int32_t  num_vec 
) [virtual]

Implements CFile.

virtual void set_matrix ( const int16_t *  matrix,
int32_t  num_feat,
int32_t  num_vec 
) [virtual]

Implements CFile.

virtual void set_matrix ( const uint16_t *  matrix,
int32_t  num_feat,
int32_t  num_vec 
) [virtual]

Implements CFile.

virtual void set_matrix ( const float64_t matrix,
int32_t  num_feat,
int32_t  num_vec 
) [virtual]

Implements CFile.

virtual void set_matrix ( const char *  matrix,
int32_t  num_feat,
int32_t  num_vec 
) [virtual]

Implements CFile.

virtual void set_matrix ( const uint8_t *  matrix,
int32_t  num_feat,
int32_t  num_vec 
) [virtual]

Implements CFile.

virtual void set_matrix ( const float32_t matrix,
int32_t  num_feat,
int32_t  num_vec 
) [virtual]

Implements CFile.

void set_matrix ( const bool *  matrix,
int32_t  num_feat,
int32_t  num_vec 
) [virtual, inherited]

Definition at line 109 of file File.cpp.

virtual void set_ndarray ( const uint8_t *  array,
int32_t *  dims,
int32_t  num_dims 
) [virtual]
virtual void set_ndarray ( const uint16_t *  array,
int32_t *  dims,
int32_t  num_dims 
) [virtual]
virtual void set_ndarray ( const int32_t *  array,
int32_t *  dims,
int32_t  num_dims 
) [virtual]
virtual void set_ndarray ( const char *  array,
int32_t *  dims,
int32_t  num_dims 
) [virtual]
virtual void set_ndarray ( const float32_t array,
int32_t *  dims,
int32_t  num_dims 
) [virtual]
virtual void set_ndarray ( const float64_t array,
int32_t *  dims,
int32_t  num_dims 
) [virtual]
virtual void set_ndarray ( const int16_t *  array,
int32_t *  dims,
int32_t  num_dims 
) [virtual]
virtual void set_sparse_matrix ( const SGSparseVector< float64_t > *  matrix,
int32_t  num_feat,
int32_t  num_vec 
) [virtual]

Implements CFile.

virtual void set_sparse_matrix ( const SGSparseVector< uint16_t > *  matrix,
int32_t  num_feat,
int32_t  num_vec 
) [virtual]

Implements CFile.

virtual void set_sparse_matrix ( const SGSparseVector< bool > *  matrix,
int32_t  num_feat,
int32_t  num_vec 
) [virtual]

Implements CFile.

virtual void set_sparse_matrix ( const SGSparseVector< int32_t > *  matrix,
int32_t  num_feat,
int32_t  num_vec 
) [virtual]

Implements CFile.

virtual void set_sparse_matrix ( const SGSparseVector< int16_t > *  matrix,
int32_t  num_feat,
int32_t  num_vec 
) [virtual]

Implements CFile.

virtual void set_sparse_matrix ( const SGSparseVector< float32_t > *  matrix,
int32_t  num_feat,
int32_t  num_vec 
) [virtual]

Implements CFile.

virtual void set_sparse_matrix ( const SGSparseVector< uint8_t > *  matrix,
int32_t  num_feat,
int32_t  num_vec 
) [virtual]

Implements CFile.

virtual void set_sparse_matrix ( const SGSparseVector< char > *  matrix,
int32_t  num_feat,
int32_t  num_vec 
) [virtual]

Implements CFile.

virtual void set_string_list ( const SGString< int32_t > *  strings,
int32_t  num_str 
) [virtual]

Implements CFile.

virtual void set_string_list ( const SGString< uint16_t > *  strings,
int32_t  num_str 
) [virtual]

Implements CFile.

virtual void set_string_list ( const SGString< char > *  strings,
int32_t  num_str 
) [virtual]

Implements CFile.

virtual void set_string_list ( const SGString< uint8_t > *  strings,
int32_t  num_str 
) [virtual]

Implements CFile.

virtual void set_string_list ( const SGString< float64_t > *  strings,
int32_t  num_str 
) [virtual]

Implements CFile.

virtual void set_string_list ( const SGString< int16_t > *  strings,
int32_t  num_str 
) [virtual]

Implements CFile.

virtual void set_string_list ( const SGString< float32_t > *  strings,
int32_t  num_str 
) [virtual]

Implements CFile.

void set_string_list ( const SGString< bool > *  strings,
int32_t  num_str 
) [virtual, inherited]

Definition at line 146 of file File.cpp.

virtual void set_uint_matrix ( const uint32_t *  matrix,
int32_t  num_feat,
int32_t  num_vec 
) [virtual]

Implements CFile.

virtual void set_uint_sparsematrix ( const SGSparseVector< uint32_t > *  matrix,
int32_t  num_feat,
int32_t  num_vec 
) [virtual]

Implements CFile.

virtual void set_uint_string_list ( const SGString< uint32_t > *  strings,
int32_t  num_str 
) [virtual]

Implements CFile.

virtual void set_ulong_matrix ( const uint64_t *  matrix,
int32_t  num_feat,
int32_t  num_vec 
) [virtual]

Implements CFile.

virtual void set_ulong_sparsematrix ( const SGSparseVector< uint64_t > *  matrix,
int32_t  num_feat,
int32_t  num_vec 
) [virtual]

Implements CFile.

virtual void set_ulong_string_list ( const SGString< uint64_t > *  strings,
int32_t  num_str 
) [virtual]

Implements CFile.

void set_variable_name ( const char *  name  )  [inherited]

set the path to the variable to be accessed

only supported by some file interfaces like CHDF5File

Parameters:
name variable path & name

Definition at line 170 of file File.cpp.

virtual void set_vector ( const uint32_t *  vector,
int32_t  len 
) [virtual]

Implements CFile.

virtual void set_vector ( const int16_t *  vector,
int32_t  len 
) [virtual]

Implements CFile.

virtual void set_vector ( const char *  vector,
int32_t  len 
) [virtual]

Implements CFile.

virtual void set_vector ( const int64_t *  vector,
int32_t  len 
) [virtual]

Implements CFile.

virtual void set_vector ( const floatmax_t vector,
int32_t  len 
) [virtual]

Implements CFile.

virtual void set_vector ( const int8_t *  vector,
int32_t  len 
) [virtual]

Implements CFile.

virtual void set_vector ( const int32_t *  vector,
int32_t  len 
) [virtual]

Implements CFile.

virtual void set_vector ( const uint64_t *  vector,
int32_t  len 
) [virtual]

Implements CFile.

virtual void set_vector ( const float32_t vector,
int32_t  len 
) [virtual]

Implements CFile.

virtual void set_vector ( const uint16_t *  vector,
int32_t  len 
) [virtual]

Implements CFile.

virtual void set_vector ( const float64_t vector,
int32_t  len 
) [virtual]

Implements CFile.

void set_vector ( const bool *  vector,
int32_t  len 
) [virtual, inherited]

Definition at line 78 of file File.cpp.

virtual void set_vector ( const uint8_t *  vector,
int32_t  len 
) [virtual]

Implements CFile.

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

bool update_parameter_hash (  )  [protected, virtual, inherited]

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 write_header ( const TSGDataType datatype  )  [protected]

write header

Parameters:
datatype we are writing

Definition at line 417 of file BinaryFile.cpp.


Member Data Documentation

FILE* file [protected, inherited]

file object

Definition at line 422 of file File.h.

char* filename [protected, inherited]

name of the handled file

Definition at line 426 of file File.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.

model selection parameters

Definition at line 474 of file SGObject.h.

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.

Parallel* parallel [inherited]

parallel

Definition at line 465 of file SGObject.h.

char task [protected, inherited]

task

Definition at line 424 of file File.h.

char* variable_name [protected, inherited]

variable name / path to variable

Definition at line 428 of file File.h.

Version* version [inherited]

version

Definition at line 468 of file SGObject.h.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

SHOGUN Machine Learning Toolbox - Documentation