SHOGUN  v2.0.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes
CAsciiFile Class Reference

Detailed Description

A Ascii File access class.

Definition at line 35 of file AsciiFile.h.

Inheritance diagram for CAsciiFile:
Inheritance graph
[legend]

Public Member Functions

 CAsciiFile ()
 CAsciiFile (FILE *f, const char *name=NULL)
 CAsciiFile (const char *fname, char rw='r', const char *name=NULL)
virtual ~CAsciiFile ()
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 (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 (float64_t *&vector, int32_t &len)
virtual void get_vector (float32_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 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 float32_t *vector, int32_t len)
virtual void set_vector (const float64_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)
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_int8_ndarray (int8_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_uint_ndarray (uint32_t *&array, int32_t *&dims, int32_t &num_dims)
virtual void get_long_ndarray (int64_t *&array, int32_t *&dims, int32_t &num_dims)
virtual void get_ulong_ndarray (uint64_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_longreal_ndarray (floatmax_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_int8_ndarray (const int8_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_uint_ndarray (const uint32_t *array, int32_t *dims, int32_t num_dims)
virtual void set_long_ndarray (const int64_t *array, int32_t *dims, int32_t num_dims)
virtual void set_ulong_ndarray (const uint64_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_longreal_ndarray (const floatmax_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 ssize_t getdelim (char **lineptr, size_t *n, char delimiter, FILE *stream)
static ssize_t getline (char **lineptr, size_t *n, FILE *stream)
static void tokenize (char delim, substring s, v_array< substring > &ret)
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

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

CIOBuffer buf
 IOBuffer through which the file can be read.
FILE * file
char task
char * filename
char * variable_name

Constructor & Destructor Documentation

default constructor

Definition at line 24 of file AsciiFile.cpp.

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

constructor

Parameters
falready opened file
namevariable name (e.g. "x" or "/path/to/x")

Definition at line 29 of file AsciiFile.cpp.

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

constructor

Parameters
fnamefilename to open
rwmode, 'r' or 'w'
namevariable name (e.g. "x" or "/path/to/x")

Definition at line 33 of file AsciiFile.cpp.

~CAsciiFile ( )
virtual

default destructor

Definition at line 37 of file AsciiFile.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
dictdictionary of parameters to be built.

Definition at line 1204 of file SGObject.cpp.

void close ( )
inherited

close

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

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_ndarray ( int8_t *&  array,
int32_t *&  dims,
int32_t &  num_dims 
)
virtual
virtual void get_int8_sparsematrix ( SGSparseVector< int8_t > *&  matrix,
int32_t &  num_feat,
int32_t &  num_vec 
)
virtual

Implements CFile.

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

Implements CFile.

Definition at line 550 of file AsciiFile.cpp.

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

Implements CFile.

virtual void get_long_ndarray ( int64_t *&  array,
int32_t *&  dims,
int32_t &  num_dims 
)
virtual
virtual void get_long_sparsematrix ( SGSparseVector< int64_t > *&  matrix,
int32_t &  num_feat,
int32_t &  num_vec 
)
virtual

Implements CFile.

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

Implements CFile.

Definition at line 764 of file AsciiFile.cpp.

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

Implements CFile.

virtual void get_longreal_ndarray ( floatmax_t *&  array,
int32_t *&  dims,
int32_t &  num_dims 
)
virtual
virtual void get_longreal_sparsematrix ( SGSparseVector< floatmax_t > *&  matrix,
int32_t &  num_feat,
int32_t &  num_vec 
)
virtual

Implements CFile.

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

Implements CFile.

Definition at line 792 of file AsciiFile.cpp.

virtual void get_matrix ( uint8_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.

virtual void get_matrix ( int32_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 ( float64_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 ( uint16_t *&  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 
)
virtualinherited

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_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
Returns
object name

Reimplemented from CFile.

Definition at line 380 of file AsciiFile.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< bool > *&  matrix,
int32_t &  num_feat,
int32_t &  num_vec 
)
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< 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.

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

Implements CFile.

Definition at line 457 of file AsciiFile.cpp.

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

Implements CFile.

Definition at line 643 of file AsciiFile.cpp.

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

Implements CFile.

Definition at line 736 of file AsciiFile.cpp.

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

Implements CFile.

Definition at line 750 of file AsciiFile.cpp.

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

Implements CFile.

Definition at line 757 of file AsciiFile.cpp.

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

Implements CFile.

Definition at line 778 of file AsciiFile.cpp.

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

Implements CFile.

Definition at line 785 of file AsciiFile.cpp.

void get_string_list ( SGString< bool > *&  strings,
int32_t &  num_str,
int32_t &  max_string_len 
)
virtualinherited

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_ndarray ( uint32_t *&  array,
int32_t *&  dims,
int32_t &  num_dims 
)
virtual
virtual void get_uint_sparsematrix ( SGSparseVector< uint32_t > *&  matrix,
int32_t &  num_feat,
int32_t &  num_vec 
)
virtual

Implements CFile.

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

Implements CFile.

Definition at line 743 of file AsciiFile.cpp.

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

Implements CFile.

virtual void get_ulong_ndarray ( uint64_t *&  array,
int32_t *&  dims,
int32_t &  num_dims 
)
virtual
virtual void get_ulong_sparsematrix ( SGSparseVector< uint64_t > *&  matrix,
int32_t &  num_feat,
int32_t &  num_vec 
)
virtual

Implements CFile.

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

Implements CFile.

Definition at line 771 of file AsciiFile.cpp.

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 ( uint8_t *&  vector,
int32_t &  len 
)
virtual

Implements CFile.

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

Implements CFile.

virtual void get_vector ( int32_t *&  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 ( int16_t *&  vector,
int32_t &  len 
)
virtual

Implements CFile.

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

Implements CFile.

void get_vector ( bool *&  vector,
int32_t &  len 
)
virtualinherited

Definition at line 64 of file File.cpp.

ssize_t getdelim ( char **  lineptr,
size_t *  n,
char  delimiter,
FILE *  stream 
)
static

getdelim() implementation.

Reads upto delimiter from stream into a dynamically expanding buffer, lineptr, and returns the number of characters read. See specification of standard getdelim() for details.

Parameters
lineptrBuffer to store the string.
nSize of buffer.
delimiterDelimiter upto (and including) which to read.
streamFILE pointer to read from.
Returns
Number of bytes read.

Definition at line 1078 of file AsciiFile.cpp.

ssize_t getline ( char **  lineptr,
size_t *  n,
FILE *  stream 
)
static

getline() implementation.

Reads upto and including the first
from the file.

Parameters
lineptrBuffer
nSize of buffer
streamFILE pointer to read from
Returns
Number of bytes read

Definition at line 1083 of file AsciiFile.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.

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.

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

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 
)
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.

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

Implements CFile.

virtual void set_int8_ndarray ( const int8_t *  array,
int32_t *  dims,
int32_t  num_dims 
)
virtual
virtual void set_int8_sparsematrix ( const SGSparseVector< int8_t > *  matrix,
int32_t  num_feat,
int32_t  num_vec 
)
virtual

Implements CFile.

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

Implements CFile.

Definition at line 942 of file AsciiFile.cpp.

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

Implements CFile.

virtual void set_long_ndarray ( const int64_t *  array,
int32_t *  dims,
int32_t  num_dims 
)
virtual
virtual void set_long_sparsematrix ( const SGSparseVector< int64_t > *  matrix,
int32_t  num_feat,
int32_t  num_vec 
)
virtual

Implements CFile.

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

Implements CFile.

Definition at line 984 of file AsciiFile.cpp.

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

Implements CFile.

virtual void set_longreal_ndarray ( const floatmax_t array,
int32_t *  dims,
int32_t  num_dims 
)
virtual
virtual void set_longreal_sparsematrix ( const SGSparseVector< floatmax_t > *  matrix,
int32_t  num_feat,
int32_t  num_vec 
)
virtual

Implements CFile.

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

Implements CFile.

Definition at line 1000 of file AsciiFile.cpp.

virtual void set_matrix ( const uint8_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 int32_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.

virtual void set_matrix ( const float64_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.

void set_matrix ( const bool *  matrix,
int32_t  num_feat,
int32_t  num_vec 
)
virtualinherited

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 char *  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 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_ndarray ( const uint16_t *  array,
int32_t *  dims,
int32_t  num_dims 
)
virtual
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< 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_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< uint16_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< float64_t > *  matrix,
int32_t  num_feat,
int32_t  num_vec 
)
virtual

Implements CFile.

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

Implements CFile.

Definition at line 929 of file AsciiFile.cpp.

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

Implements CFile.

Definition at line 955 of file AsciiFile.cpp.

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

Implements CFile.

Definition at line 968 of file AsciiFile.cpp.

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

Implements CFile.

Definition at line 976 of file AsciiFile.cpp.

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

Implements CFile.

Definition at line 980 of file AsciiFile.cpp.

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

Implements CFile.

Definition at line 992 of file AsciiFile.cpp.

void set_string_list ( const SGString< bool > *  strings,
int32_t  num_str 
)
virtualinherited

Definition at line 146 of file File.cpp.

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

Implements CFile.

Definition at line 996 of file AsciiFile.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_ndarray ( const uint32_t *  array,
int32_t *  dims,
int32_t  num_dims 
)
virtual
virtual void set_uint_sparsematrix ( const SGSparseVector< uint32_t > *  matrix,
int32_t  num_feat,
int32_t  num_vec 
)
virtual

Implements CFile.

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

Implements CFile.

Definition at line 972 of file AsciiFile.cpp.

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

Implements CFile.

virtual void set_ulong_ndarray ( const uint64_t *  array,
int32_t *  dims,
int32_t  num_dims 
)
virtual
virtual void set_ulong_sparsematrix ( const SGSparseVector< uint64_t > *  matrix,
int32_t  num_feat,
int32_t  num_vec 
)
virtual

Implements CFile.

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

Implements CFile.

Definition at line 988 of file AsciiFile.cpp.

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
namevariable path & name

Definition at line 170 of file File.cpp.

virtual void set_vector ( const uint8_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 int32_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 float64_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 uint16_t *  vector,
int32_t  len 
)
virtual

Implements CFile.

void set_vector ( const bool *  vector,
int32_t  len 
)
virtualinherited

Definition at line 78 of file File.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 tokenize ( char  delim,
substring  s,
v_array< substring > &  ret 
)
static

Split a given substring into an array of substrings based on a specified delimiter

Parameters
delimdelimiter to use
ssubstring to tokenize
retarray of substrings, returned

Definition at line 1089 of file AsciiFile.cpp.

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 ( )
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.

Member Data Documentation

CIOBuffer buf
protected

IOBuffer through which the file can be read.

Definition at line 433 of file AsciiFile.h.

FILE* file
protectedinherited

file object

Definition at line 412 of file File.h.

char* filename
protectedinherited

name of the handled file

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

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.

Parallel* parallel
inherited

parallel

Definition at line 465 of file SGObject.h.

char task
protectedinherited

task

Definition at line 414 of file File.h.

char* variable_name
protectedinherited

variable name / path to variable

Definition at line 418 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:

SHOGUN Machine Learning Toolbox - Documentation