Detailed Description

template<class T>
class shogun::CMemoryMappedFile< T >

memory mapped file

Implements a memory mapped file for super fast file access.

Definition at line 25 of file StringFileFeatures.h.

Inheritance diagram for CMemoryMappedFile< T >:

Public Member Functions
	CMemoryMappedFile ()

	CMemoryMappedFile (const char *fname, char flag='r', int64_t fsize=0)

virtual	~CMemoryMappedFile ()

T *	get_map ()

uint64_t	get_length ()

uint64_t	get_size ()

char *	get_line (uint64_t &len, uint64_t &offs)

void	write_line (const char *line, uint64_t len, uint64_t &offs)

void	set_truncate_size (uint64_t sz=0)

int32_t	get_num_lines ()

T	operator[] (uint64_t index) const

T	operator[] (int32_t index) const

virtual const char *	get_name () const

virtual CSGObject *	shallow_copy () const

virtual CSGObject *	deep_copy () const

virtual bool	is_generic (EPrimitiveType *generic) const

template<class T >
void	set_generic ()

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)

SGIO *	get_global_io ()

void	set_global_parallel (Parallel *parallel)

Parallel *	get_global_parallel ()

void	set_global_version (Version *version)

Version *	get_global_version ()

SGStringList< char >	get_modelsel_names ()

void	print_modsel_params ()

char *	get_modsel_param_descr (const char *param_name)

index_t	get_modsel_param_index (const char *param_name)

void	build_gradient_parameter_dictionary (CMap< TParameter , CSGObject > *dict)

virtual void	update_parameter_hash ()

virtual bool	parameter_hash_changed ()

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

virtual CSGObject *	clone ()

Public Attributes
SGIO *	io

Parallel *	parallel

Version *	version

Parameter *	m_parameters

Parameter *	m_model_selection_parameters

Parameter *	m_gradient_parameters

uint32_t	m_hash

Protected Member Functions
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
int	fd

uint64_t	length

void *	address

char	rw

uint64_t	last_written_byte

Constructor & Destructor Documentation

CMemoryMappedFile ( )

default constructor

Definition at line 37 of file MemoryMappedFile.h.

CMemoryMappedFile	(	const char *	fname,
		char	flag = `'r'`,
		int64_t	fsize = `0`
	)

constructor

open a memory mapped file for read or read/write mode

Parameters

fname	name of file, zero terminated string
flag	determines read or read write mode (can be 'r' or 'w')
fsize	overestimate of expected file size (in bytes) when opened in write mode; Underestimating the file size will result in an error to occur upon writing. In case the exact file size is known later on, it can be reduced via set_truncate_size() before closing the file.

Definition at line 64 of file MemoryMappedFile.h.

virtual ~CMemoryMappedFile ( )

virtual

destructor

Definition at line 107 of file MemoryMappedFile.h.

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

dict	dictionary 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.

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

other	object to compare with
accuracy	accuracy to use for comparison (optional)
tolerant	allows 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.

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.

uint64_t get_length ( )

get the number of objects of type T cointained in the file

Returns: length of file

Definition at line 137 of file MemoryMappedFile.h.

char* get_line	(	uint64_t &	len,
		uint64_t &	offs
	)

get next line from file

The returned line may be modfied in case the file was opened read/write. It is otherwise read-only.

Parameters

len	length of line (returned via reference)
offs	offset to be passed for reading next line, should be 0 initially (returned via reference)

Returns: line (NOT ZERO TERMINATED)

Definition at line 162 of file MemoryMappedFile.h.

T* get_map ( )

get the mapping address It can now be accessed via, e.g.

double* x = get_map() x[index]= foo; (for write mode) foo = x[index]; (for read and write mode)

Returns: length of file

Definition at line 128 of file MemoryMappedFile.h.

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_name name 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_name name 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

Implements CSGObject.

Definition at line 263 of file MemoryMappedFile.h.

int32_t get_num_lines ( )

count the number of lines in a file

Returns: number of lines

Definition at line 225 of file MemoryMappedFile.h.

uint64_t get_size ( )

get the size of the file in bytes

Returns: size of file in bytes

Definition at line 146 of file MemoryMappedFile.h.

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

generic set 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

file	where to load from
prefix	prefix 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

ShogunException will 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

ShogunException will 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.

T operator[] ( uint64_t index ) const

operator overload for file read only access

DOES NOT DO ANY BOUNDS CHECKING

Parameters

index index

Returns: element at index

Definition at line 245 of file MemoryMappedFile.h.

T operator[] ( int32_t index ) const

operator overload for file read only access

DOES NOT DO ANY BOUNDS CHECKING

Parameters

index index

Returns: element at index

Definition at line 257 of file MemoryMappedFile.h.

bool parameter_hash_changed ( )

virtualinherited

Returns: whether parameter combination has changed since last update

Definition at line 262 of file SGObject.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

prefix prefix for members

Definition at line 308 of file SGObject.cpp.

bool save_serializable	(	CSerializableFile *	file,
		const char *	prefix = `""`
	)

virtualinherited

Save this object to file.

Parameters

file	where to save the object; will be closed during returning if PREFIX is an empty string.
prefix	prefix for members

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

ShogunException will 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

ShogunException will 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

io	io object to use

Definition at line 228 of file SGObject.cpp.

void set_global_parallel ( Parallel * parallel )

inherited

set the parallel object

Parameters

parallel parallel object to use

Definition at line 241 of file SGObject.cpp.

void set_global_version ( Version * version )

inherited

set the version object

Parameters

version version object to use

Definition at line 283 of file SGObject.cpp.

void set_truncate_size ( uint64_t sz = 0 )

set file size

When the file is opened for read/write mode, it will be truncated upon destruction of the CMemoryMappedFile object. This is automagically determined when writing lines, but might have to be set manually for other data types, which is what this function is for.

Parameters

sz	byte number at which to truncate the file, zero to disable file truncation. Has an effect only when file is opened with in read/write mode 'w'

Definition at line 216 of file MemoryMappedFile.h.

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_line	(	const char *	line,
		uint64_t	len,
		uint64_t &	offs
	)

write line to file

Parameters

line	string to be written (must not contain ' ' and not required to be zero terminated)
len	length of the string to be written
offs	offset to be passed for writing next line, should be 0 initially (returned via reference)

Returns: line (NOT ZERO TERMINATED)

Definition at line 191 of file MemoryMappedFile.h.

Member Data Documentation

void* address

protected

mapping address

Definition at line 271 of file MemoryMappedFile.h.

int fd

protected

file descriptor

Definition at line 267 of file MemoryMappedFile.h.

SGIO* io

inherited

io

Definition at line 369 of file SGObject.h.

uint64_t last_written_byte

protected

last_written_byte

Definition at line 276 of file MemoryMappedFile.h.

uint64_t length

protected

size of file

Definition at line 269 of file MemoryMappedFile.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 rw

protected

mode

Definition at line 273 of file MemoryMappedFile.h.

Version* version

inherited

version

Definition at line 375 of file SGObject.h.

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

Detailed Description

template<class T> class shogun::CMemoryMappedFile< T >

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<class T>
class shogun::CMemoryMappedFile< T >