SHOGUN  4.1.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
List of all members | 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 30 of file BinaryFile.h.

Inheritance diagram for CBinaryFile:
Inheritance graph
[legend]

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 ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 
void unset_generic ()
 
virtual void print_serializable (const char *prefix="")
 
virtual bool save_serializable (CSerializableFile *file, const char *prefix="")
 
virtual bool load_serializable (CSerializableFile *file, const char *prefix="")
 
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_gradient_parameter_dictionary (CMap< TParameter *, CSGObject * > *dict)
 
virtual void update_parameter_hash ()
 
virtual bool parameter_hash_changed ()
 
virtual bool equals (CSGObject *other, float64_t accuracy=0.0, bool tolerant=false)
 
virtual CSGObjectclone ()
 
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_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_matrix (uint32_t *&matrix, int32_t &num_feat, int32_t &num_vec)
 
virtual void get_matrix (int64_t *&matrix, int32_t &num_feat, int32_t &num_vec)
 
virtual void get_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_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_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_matrix (const uint32_t *matrix, int32_t num_feat, int32_t num_vec)
 
virtual void set_matrix (const int64_t *matrix, int32_t num_feat, int32_t num_vec)
 
virtual void set_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_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_sparse_matrix (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_sparse_matrix (SGSparseVector< uint32_t > *&matrix, int32_t &num_feat, int32_t &num_vec)
 
virtual void get_sparse_matrix (SGSparseVector< int64_t > *&matrix, int32_t &num_feat, int32_t &num_vec)
 
virtual void get_sparse_matrix (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_sparse_matrix (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_sparse_matrix (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_sparse_matrix (const SGSparseVector< uint32_t > *matrix, int32_t num_feat, int32_t num_vec)
 
virtual void set_sparse_matrix (const SGSparseVector< int64_t > *matrix, int32_t num_feat, int32_t num_vec)
 
virtual void set_sparse_matrix (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_sparse_matrix (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_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_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_string_list (SGString< int64_t > *&strings, int32_t &num_str, int32_t &max_string_len)
 
virtual void get_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_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_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_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_string_list (const SGString< int64_t > *strings, int32_t num_str)
 
virtual void set_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_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)
 
Sparse Vector Access Functions

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

virtual void get_sparse_vector (SGSparseVectorEntry< bool > *&entries, int32_t &num_feat)
 
virtual void get_sparse_vector (SGSparseVectorEntry< uint8_t > *&entries, int32_t &num_feat)
 
virtual void get_sparse_vector (SGSparseVectorEntry< int8_t > *&entries, int32_t &num_feat)
 
virtual void get_sparse_vector (SGSparseVectorEntry< char > *&entries, int32_t &num_feat)
 
virtual void get_sparse_vector (SGSparseVectorEntry< int32_t > *&entries, int32_t &num_feat)
 
virtual void get_sparse_vector (SGSparseVectorEntry< uint32_t > *&entries, int32_t &num_feat)
 
virtual void get_sparse_vector (SGSparseVectorEntry< int64_t > *&entries, int32_t &num_feat)
 
virtual void get_sparse_vector (SGSparseVectorEntry< uint64_t > *&entries, int32_t &num_feat)
 
virtual void get_sparse_vector (SGSparseVectorEntry< int16_t > *&entries, int32_t &num_feat)
 
virtual void get_sparse_vector (SGSparseVectorEntry< uint16_t > *&entries, int32_t &num_feat)
 
virtual void get_sparse_vector (SGSparseVectorEntry< float32_t > *&entries, int32_t &num_feat)
 
virtual void get_sparse_vector (SGSparseVectorEntry< float64_t > *&entries, int32_t &num_feat)
 
virtual void get_sparse_vector (SGSparseVectorEntry< floatmax_t > *&entries, int32_t &num_feat)
 
virtual void set_sparse_vector (const SGSparseVectorEntry< bool > *entries, int32_t num_feat)
 
virtual void set_sparse_vector (const SGSparseVectorEntry< uint8_t > *entries, int32_t num_feat)
 
virtual void set_sparse_vector (const SGSparseVectorEntry< int8_t > *entries, int32_t num_feat)
 
virtual void set_sparse_vector (const SGSparseVectorEntry< char > *entries, int32_t num_feat)
 
virtual void set_sparse_vector (const SGSparseVectorEntry< int32_t > *entries, int32_t num_feat)
 
virtual void set_sparse_vector (const SGSparseVectorEntry< uint32_t > *entries, int32_t num_feat)
 
virtual void set_sparse_vector (const SGSparseVectorEntry< int64_t > *entries, int32_t num_feat)
 
virtual void set_sparse_vector (const SGSparseVectorEntry< uint64_t > *entries, int32_t num_feat)
 
virtual void set_sparse_vector (const SGSparseVectorEntry< int16_t > *entries, int32_t num_feat)
 
virtual void set_sparse_vector (const SGSparseVectorEntry< uint16_t > *entries, int32_t num_feat)
 
virtual void set_sparse_vector (const SGSparseVectorEntry< float32_t > *entries, int32_t num_feat)
 
virtual void set_sparse_vector (const SGSparseVectorEntry< float64_t > *entries, int32_t num_feat)
 
virtual void set_sparse_vector (const SGSparseVectorEntry< floatmax_t > *entries, int32_t num_feat)
 
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
 
Parameterm_gradient_parameters
 
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 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)
 

Protected Attributes

FILE * file
 
char task
 
char * filename
 
char * variable_name
 

Constructor & Destructor Documentation

default constructor

Definition at line 21 of file BinaryFile.cpp.

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

constructor

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

Definition at line 26 of file BinaryFile.cpp.

CBinaryFile ( 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 30 of file BinaryFile.cpp.

~CBinaryFile ( )
virtual

default destructor

Definition at line 34 of file BinaryFile.cpp.

Member Function Documentation

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.

Parameters
dictdictionary of parameters to be built.

Definition at line 597 of file SGObject.cpp.

CSGObject * clone ( )
virtualinherited

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.

Returns
an identical copy of the given object, which is disjoint in memory. NULL if the clone fails. Note that the returned object is SG_REF'ed

Definition at line 714 of file SGObject.cpp.

void close ( )
inherited

close

Definition at line 69 of file File.h.

CSGObject * deep_copy ( ) const
virtualinherited

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

Definition at line 198 of file SGObject.cpp.

bool equals ( CSGObject other,
float64_t  accuracy = 0.0,
bool  tolerant = false 
)
virtualinherited

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.

Parameters
otherobject to compare with
accuracyaccuracy to use for comparison (optional)
tolerantallows linient check on float equality (within accuracy)
Returns
true if all parameters were equal, false if not

Definition at line 618 of file SGObject.cpp.

FILE* get_file_descriptor ( )
inherited

get the file descriptor

Returns
FILE ptr

Definition at line 85 of file File.h.

SGIO * get_global_io ( )
inherited

get the io object

Returns
io object

Definition at line 235 of file SGObject.cpp.

Parallel * get_global_parallel ( )
inherited

get the parallel object

Returns
parallel object

Definition at line 277 of file SGObject.cpp.

Version * get_global_version ( )
inherited

get the version object

Returns
version object

Definition at line 290 of file SGObject.cpp.

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

Reimplemented from CFile.

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

Reimplemented from CFile.

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

Reimplemented from CFile.

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

Reimplemented from CFile.

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

Reimplemented from CFile.

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

Reimplemented from CFile.

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

Reimplemented from CFile.

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

Reimplemented from CFile.

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

Reimplemented from CFile.

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

Reimplemented from CFile.

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

Reimplemented from CFile.

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

Reimplemented from CFile.

void get_matrix ( bool *&  matrix,
int32_t &  num_feat,
int32_t &  num_vec 
)
virtualinherited

Definition at line 109 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 498 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 522 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 535 of file SGObject.cpp.

virtual const char* get_name ( ) const
virtual
Returns
object name

Reimplemented from CFile.

Definition at line 367 of file BinaryFile.h.

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

Reimplemented from CFile.

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

Reimplemented from CFile.

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

Reimplemented from CFile.

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

Reimplemented from CFile.

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

Reimplemented from CFile.

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

Reimplemented from CFile.

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

Reimplemented from CFile.

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

Reimplemented from CFile.

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

Reimplemented from CFile.

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

Reimplemented from CFile.

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

Reimplemented from CFile.

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

Reimplemented from CFile.

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

Reimplemented from CFile.

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

Reimplemented from CFile.

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

Reimplemented from CFile.

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

Reimplemented from CFile.

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

Reimplemented from CFile.

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

Reimplemented from CFile.

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

Reimplemented from CFile.

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

Reimplemented from CFile.

virtual void get_sparse_vector ( SGSparseVectorEntry< bool > *&  entries,
int32_t &  num_feat 
)
virtualinherited
virtual void get_sparse_vector ( SGSparseVectorEntry< uint8_t > *&  entries,
int32_t &  num_feat 
)
virtualinherited
virtual void get_sparse_vector ( SGSparseVectorEntry< int8_t > *&  entries,
int32_t &  num_feat 
)
virtualinherited
virtual void get_sparse_vector ( SGSparseVectorEntry< char > *&  entries,
int32_t &  num_feat 
)
virtualinherited
virtual void get_sparse_vector ( SGSparseVectorEntry< int32_t > *&  entries,
int32_t &  num_feat 
)
virtualinherited
virtual void get_sparse_vector ( SGSparseVectorEntry< uint32_t > *&  entries,
int32_t &  num_feat 
)
virtualinherited
virtual void get_sparse_vector ( SGSparseVectorEntry< int64_t > *&  entries,
int32_t &  num_feat 
)
virtualinherited
virtual void get_sparse_vector ( SGSparseVectorEntry< uint64_t > *&  entries,
int32_t &  num_feat 
)
virtualinherited
virtual void get_sparse_vector ( SGSparseVectorEntry< int16_t > *&  entries,
int32_t &  num_feat 
)
virtualinherited
virtual void get_sparse_vector ( SGSparseVectorEntry< uint16_t > *&  entries,
int32_t &  num_feat 
)
virtualinherited
virtual void get_sparse_vector ( SGSparseVectorEntry< float32_t > *&  entries,
int32_t &  num_feat 
)
virtualinherited
virtual void get_sparse_vector ( SGSparseVectorEntry< float64_t > *&  entries,
int32_t &  num_feat 
)
virtualinherited
virtual void get_sparse_vector ( SGSparseVectorEntry< floatmax_t > *&  entries,
int32_t &  num_feat 
)
virtualinherited
virtual void get_string_list ( SGString< uint8_t > *&  strings,
int32_t &  num_str,
int32_t &  max_string_len 
)
virtual

Reimplemented from CFile.

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

Reimplemented from CFile.

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

Reimplemented from CFile.

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

Reimplemented from CFile.

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

Reimplemented from CFile.

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

Reimplemented from CFile.

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

Reimplemented from CFile.

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

Reimplemented from CFile.

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

Reimplemented from CFile.

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

Reimplemented from CFile.

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

Reimplemented from CFile.

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

Reimplemented from CFile.

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

Definition at line 140 of file File.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 193 of file File.cpp.

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

Reimplemented from CFile.

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

Reimplemented from CFile.

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

Reimplemented from CFile.

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

Reimplemented from CFile.

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

Reimplemented from CFile.

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

Reimplemented from CFile.

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

Reimplemented from CFile.

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

Reimplemented from CFile.

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

Reimplemented from CFile.

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

Reimplemented from CFile.

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

Reimplemented from CFile.

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

Reimplemented from CFile.

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

Definition at line 81 of file File.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 296 of file SGObject.cpp.

bool load_serializable ( CSerializableFile file,
const char *  prefix = "" 
)
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
Returns
TRUE if done, otherwise FALSE

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

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

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

Reimplemented in CDynamicArray< T >, CDynamicArray< float64_t >, CDynamicArray< float32_t >, CDynamicArray< int32_t >, CDynamicArray< char >, CDynamicArray< bool >, and CDynamicObjectArray.

Definition at line 421 of file SGObject.cpp.

bool parameter_hash_changed ( )
virtualinherited
Returns
whether parameter combination has changed since last update

Definition at line 262 of file SGObject.cpp.

int32_t parse_first_header ( TSGDataType type)
protected

parse first header - defunct!

Parameters
typefeature type
Returns
-1

Definition at line 385 of file BinaryFile.cpp.

int32_t parse_next_header ( TSGDataType type)
protected

parse next header - defunct!

Parameters
typefeature type
Returns
-1

Definition at line 390 of file BinaryFile.cpp.

void print_modsel_params ( )
inherited

prints all parameter registered for model selection and their type

Definition at line 474 of file SGObject.cpp.

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

prints registered parameters out

Parameters
prefixprefix for members

Definition at line 308 of file SGObject.cpp.

void read_header ( TSGDataType dest)
protected

read header

Returns
datatype

Definition at line 396 of file BinaryFile.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 234 of file File.cpp.

bool save_serializable ( CSerializableFile file,
const char *  prefix = "" 
)
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
Returns
TRUE if done, otherwise FALSE

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

Reimplemented in CKernel.

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

Reimplemented in CKernel, CDynamicArray< T >, CDynamicArray< float64_t >, CDynamicArray< float32_t >, CDynamicArray< int32_t >, CDynamicArray< char >, CDynamicArray< bool >, and CDynamicObjectArray.

Definition at line 431 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 41 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 46 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 51 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 56 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 61 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 66 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 71 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 76 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 81 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 86 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 91 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 96 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 101 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 106 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 111 of file SGObject.cpp.

void set_generic ( )
inherited

set generic type to T

void set_global_io ( SGIO io)
inherited

set the io object

Parameters
ioio object to use

Definition at line 228 of file SGObject.cpp.

void set_global_parallel ( Parallel parallel)
inherited

set the parallel object

Parameters
parallelparallel object to use

Definition at line 241 of file SGObject.cpp.

void set_global_version ( Version version)
inherited

set the version object

Parameters
versionversion object to use

Definition at line 283 of file SGObject.cpp.

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

Reimplemented from CFile.

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

Reimplemented from CFile.

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

Reimplemented from CFile.

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

Reimplemented from CFile.

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

Reimplemented from CFile.

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

Reimplemented from CFile.

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

Reimplemented from CFile.

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

Reimplemented from CFile.

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

Reimplemented from CFile.

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

Reimplemented from CFile.

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

Reimplemented from CFile.

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

Reimplemented from CFile.

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

Definition at line 126 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

Reimplemented from CFile.

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

Reimplemented from CFile.

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

Reimplemented from CFile.

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

Reimplemented from CFile.

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

Reimplemented from CFile.

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

Reimplemented from CFile.

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

Reimplemented from CFile.

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

Reimplemented from CFile.

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

Reimplemented from CFile.

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

Reimplemented from CFile.

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

Reimplemented from CFile.

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

Reimplemented from CFile.

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

Reimplemented from CFile.

virtual void set_sparse_vector ( const SGSparseVectorEntry< bool > *  entries,
int32_t  num_feat 
)
virtualinherited
virtual void set_sparse_vector ( const SGSparseVectorEntry< uint8_t > *  entries,
int32_t  num_feat 
)
virtualinherited
virtual void set_sparse_vector ( const SGSparseVectorEntry< int8_t > *  entries,
int32_t  num_feat 
)
virtualinherited
virtual void set_sparse_vector ( const SGSparseVectorEntry< char > *  entries,
int32_t  num_feat 
)
virtualinherited
virtual void set_sparse_vector ( const SGSparseVectorEntry< int32_t > *  entries,
int32_t  num_feat 
)
virtualinherited
virtual void set_sparse_vector ( const SGSparseVectorEntry< uint32_t > *  entries,
int32_t  num_feat 
)
virtualinherited
virtual void set_sparse_vector ( const SGSparseVectorEntry< int64_t > *  entries,
int32_t  num_feat 
)
virtualinherited
virtual void set_sparse_vector ( const SGSparseVectorEntry< uint64_t > *  entries,
int32_t  num_feat 
)
virtualinherited
virtual void set_sparse_vector ( const SGSparseVectorEntry< int16_t > *  entries,
int32_t  num_feat 
)
virtualinherited
virtual void set_sparse_vector ( const SGSparseVectorEntry< uint16_t > *  entries,
int32_t  num_feat 
)
virtualinherited
virtual void set_sparse_vector ( const SGSparseVectorEntry< float32_t > *  entries,
int32_t  num_feat 
)
virtualinherited
virtual void set_sparse_vector ( const SGSparseVectorEntry< float64_t > *  entries,
int32_t  num_feat 
)
virtualinherited
virtual void set_sparse_vector ( const SGSparseVectorEntry< floatmax_t > *  entries,
int32_t  num_feat 
)
virtualinherited
virtual void set_string_list ( const SGString< uint8_t > *  strings,
int32_t  num_str 
)
virtual

Reimplemented from CFile.

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

Reimplemented from CFile.

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

Reimplemented from CFile.

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

Reimplemented from CFile.

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

Reimplemented from CFile.

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

Reimplemented from CFile.

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

Reimplemented from CFile.

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

Reimplemented from CFile.

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

Reimplemented from CFile.

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

Reimplemented from CFile.

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

Reimplemented from CFile.

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

Reimplemented from CFile.

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

Definition at line 163 of file File.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 187 of file File.cpp.

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

Reimplemented from CFile.

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

Reimplemented from CFile.

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

Reimplemented from CFile.

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

Reimplemented from CFile.

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

Reimplemented from CFile.

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

Reimplemented from CFile.

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

Reimplemented from CFile.

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

Reimplemented from CFile.

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

Reimplemented from CFile.

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

Reimplemented from CFile.

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

Reimplemented from CFile.

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

Reimplemented from CFile.

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

Definition at line 95 of file File.cpp.

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

void unset_generic ( )
inherited

unset generic type

this has to be called in classes specializing a template class

Definition at line 303 of file SGObject.cpp.

void update_parameter_hash ( )
virtualinherited

Updates the hash of current parameter combination

Definition at line 248 of file SGObject.cpp.

void write_header ( const TSGDataType datatype)
protected

write header

Parameters
datatypewe are writing

Definition at line 422 of file BinaryFile.cpp.

Member Data Documentation

FILE* file
protectedinherited

file object

Definition at line 505 of file File.h.

char* filename
protectedinherited

name of the handled file

Definition at line 509 of file File.h.

SGIO* io
inherited

io

Definition at line 369 of file SGObject.h.

Parameter* m_gradient_parameters
inherited

parameters wrt which we can compute gradients

Definition at line 384 of file SGObject.h.

uint32_t m_hash
inherited

Hash of parameter values

Definition at line 387 of file SGObject.h.

Parameter* m_model_selection_parameters
inherited

model selection parameters

Definition at line 381 of file SGObject.h.

Parameter* m_parameters
inherited

parameters

Definition at line 378 of file SGObject.h.

Parallel* parallel
inherited

parallel

Definition at line 372 of file SGObject.h.

char task
protectedinherited

task

Definition at line 507 of file File.h.

char* variable_name
protectedinherited

variable name / path to variable

Definition at line 511 of file File.h.

Version* version
inherited

version

Definition at line 375 of file SGObject.h.


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

SHOGUN Machine Learning Toolbox - Documentation