CMap< K, T > 模板类 参考

详细描述

template<class K, class T>
class shogun::CMap< K, T >

the class CMap, a map based on the hash-table. w: http://en.wikipedia.org/wiki/Hash_table

在文件 SGObject.h 第 36 行定义.

类 CMap< K, T > 继承关系图:

Public 成员函数
	CMap (int32_t size=41, int32_t reserved=128, bool tracable=true)
virtual	~CMap ()
virtual const char *	get_name () const
int32_t	add (const K &key, const T &data)
bool	contains (const K &key)
void	remove (const K &key)
int32_t	index_of (const K &key)
T	get_element (const K &key)
void	set_element (const K &key, const T &data)
int32_t	get_num_elements () const
int32_t	get_array_size () const
T *	get_element_ptr (int32_t index)
CMapNode< K, T > *	get_node_ptr (int32_t index)
CMapNode< K, T > **	get_array ()
CMap &	operator= (const CMap &orig)
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 属性
SGIO *	io
Parallel *	parallel
Version *	version
Parameter *	m_parameters
Parameter *	m_model_selection_parameters
Parameter *	m_gradient_parameters
uint32_t	m_hash

Protected 成员函数
virtual uint32_t	get_hash_value (const K &key)
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 属性
bool	use_sg_mallocs
int32_t	hash_size
int32_t	free_index
int32_t	num_elements
CMapNode< K, T > **	hash_array
DynArray< CMapNode< K, T > * > *	array
CLock	lock

构造及析构函数说明

CMap	(	int32_t	size = 41,
		int32_t	reserved = 128,
		bool	tracable = true
	)

Custom constructor

在文件 Map.h 第 66 行定义.

virtual ~CMap ( )

virtual

Default destructor

在文件 Map.h 第 87 行定义.

成员函数说明

int32_t add	(	const K &	key,
		const T &	data
	)

Add an element to the map

参数

key	key to be added
data	data to be added

返回

index of added element

在文件 Map.h 第 101 行定义.

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

inherited

Builds a dictionary of all parameters in SGObject as well of those of SGObjects that are parameters of this object. Dictionary maps parameters to the objects that own them.

参数

dict	dictionary of parameters to be built.

在文件 SGObject.cpp 第 597 行定义.

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.

返回

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

在文件 SGObject.cpp 第 714 行定义.

bool contains

(

const K &

key

)

Check an element in the map

参数

key	key to be looked for

返回

true if element contains in the map

在文件 Map.h 第 122 行定义.

CSGObject * deep_copy ( ) const

virtualinherited

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

在文件 SGObject.cpp 第 198 行定义.

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.

参数

other	object to compare with
accuracy	accuracy to use for comparison (optional)
tolerant	allows linient check on float equality (within accuracy)

返回

true if all parameters were equal, false if not

在文件 SGObject.cpp 第 618 行定义.

CMapNode<K, T>** get_array

(

)

返回

underlying array of nodes in memory

在文件 Map.h 第 253 行定义.

int32_t get_array_size

(

)

const

Get size of auxilary array

返回

array size

在文件 Map.h 第 220 行定义.

T get_element

(

const K &

key

)

Get element by key

参数

key	key to be looked for

返回

exist element or new element (if key doesn't consist in map)

在文件 Map.h 第 171 行定义.

T* get_element_ptr

(

int32_t

index

)

get element at index as reference

(does NOT do bounds checking)

参数

index

index

返回

array element at index

在文件 Map.h 第 232 行定义.

SGIO * get_global_io ( )

inherited

get the io object

返回

io object

在文件 SGObject.cpp 第 235 行定义.

Parallel * get_global_parallel ( )

inherited

get the parallel object

返回

parallel object

在文件 SGObject.cpp 第 277 行定义.

Version * get_global_version ( )

inherited

get the version object

返回

version object

在文件 SGObject.cpp 第 290 行定义.

virtual uint32_t get_hash_value ( const K &  key )

protectedvirtual

Get the hash of a given key

参数

key	a given key

返回

hash of the key

被 CStringMap< T >, CStringMap< float64_t >, CStringMap< shogun::SGVector< float64_t > > , 以及 CStringMap< int32_t > 重载.

在文件 Map.h 第 447 行定义.

SGStringList< char > get_modelsel_names ( )

inherited

返回

vector of names of all parameters which are registered for model selection

在文件 SGObject.cpp 第 498 行定义.

char * get_modsel_param_descr ( const char *  param_name )

inherited

Returns description of a given parameter string, if it exists. SG_ERROR otherwise

参数

param_name

name of the parameter

返回

description of the parameter

在文件 SGObject.cpp 第 522 行定义.

index_t get_modsel_param_index ( const char *  param_name )

inherited

Returns index of model selection parameter with provided index

参数

param_name

name of model selection parameter

返回

index of model selection parameter with provided name, -1 if there is no such

在文件 SGObject.cpp 第 535 行定义.

virtual const char* get_name ( ) const

virtual

返回

object name

实现了 CSGObject.

被 CStringMap< T >, CStringMap< float64_t >, CStringMap< shogun::SGVector< float64_t > > , 以及 CStringMap< int32_t > 重载.

在文件 Map.h 第 93 行定义.

CMapNode<K, T>* get_node_ptr

(

int32_t

index

)

get node at index as reference

(does NOT do bounds checking)

参数

index

index

返回

node at index

在文件 Map.h 第 247 行定义.

int32_t get_num_elements

(

)

const

Get number of elements

返回

number of elements

在文件 Map.h 第 211 行定义.

int32_t index_of

(

const K &

key

)

Index of element in the set

参数

key	key to be looked for

返回

index of the element or -1 if not found

在文件 Map.h 第 154 行定义.

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.

参数

generic

set to the type of the generic if returning TRUE

返回

TRUE if a class template.

在文件 SGObject.cpp 第 296 行定义.

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!

参数

file	where to load from
prefix	prefix for members

返回

TRUE if done, otherwise FALSE

在文件 SGObject.cpp 第 369 行定义.

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.

异常

ShogunException

will be thrown if an error occurs.

被 CKernel, CWeightedDegreePositionStringKernel, CList, CAlphabet, CLinearHMM, CGaussianKernel, CInverseMultiQuadricKernel, CCircularKernel , 以及 CExponentialKernel 重载.

在文件 SGObject.cpp 第 426 行定义.

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.

异常

ShogunException

will be thrown if an error occurs.

被 CDynamicArray< T >, CDynamicArray< float64_t >, CDynamicArray< float32_t >, CDynamicArray< int32_t >, CDynamicArray< char >, CDynamicArray< bool > , 以及 CDynamicObjectArray 重载.

在文件 SGObject.cpp 第 421 行定义.

CMap& operator=

(

const CMap< K, T > &

orig

)

assignment operator that copies map

在文件 Map.h 第 259 行定义.

bool parameter_hash_changed ( )

virtualinherited

返回

whether parameter combination has changed since last update

在文件 SGObject.cpp 第 262 行定义.

void print_modsel_params ( )

inherited

prints all parameter registered for model selection and their type

在文件 SGObject.cpp 第 474 行定义.

void print_serializable ( const char *  prefix = "" )

virtualinherited

prints registered parameters out

参数

prefix

prefix for members

在文件 SGObject.cpp 第 308 行定义.

void remove

(

const K &

key

)

Remove an element from the set

参数

key	key to be removed

在文件 Map.h 第 135 行定义.

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

virtualinherited

Save this object to file.

参数

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

返回

TRUE if done, otherwise FALSE

在文件 SGObject.cpp 第 314 行定义.

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.

异常

ShogunException

will be thrown if an error occurs.

被 CKernel 重载.

在文件 SGObject.cpp 第 436 行定义.

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.

异常

ShogunException

will be thrown if an error occurs.

被 CKernel, CDynamicArray< T >, CDynamicArray< float64_t >, CDynamicArray< float32_t >, CDynamicArray< int32_t >, CDynamicArray< char >, CDynamicArray< bool > , 以及 CDynamicObjectArray 重载.

在文件 SGObject.cpp 第 431 行定义.

void set_element	(	const K &	key,
		const T &	data
	)

Set element by key

参数

key	key of element
data	new data for element

在文件 Map.h 第 192 行定义.

void set_generic ( )

inherited

在文件 SGObject.cpp 第 41 行定义.

void set_generic ( )

inherited

在文件 SGObject.cpp 第 46 行定义.

void set_generic ( )

inherited

在文件 SGObject.cpp 第 51 行定义.

void set_generic ( )

inherited

在文件 SGObject.cpp 第 56 行定义.

void set_generic ( )

inherited

在文件 SGObject.cpp 第 61 行定义.

void set_generic ( )

inherited

在文件 SGObject.cpp 第 66 行定义.

void set_generic ( )

inherited

在文件 SGObject.cpp 第 71 行定义.

void set_generic ( )

inherited

在文件 SGObject.cpp 第 76 行定义.

void set_generic ( )

inherited

在文件 SGObject.cpp 第 81 行定义.

void set_generic ( )

inherited

在文件 SGObject.cpp 第 86 行定义.

void set_generic ( )

inherited

在文件 SGObject.cpp 第 91 行定义.

void set_generic ( )

inherited

在文件 SGObject.cpp 第 96 行定义.

void set_generic ( )

inherited

在文件 SGObject.cpp 第 101 行定义.

void set_generic ( )

inherited

在文件 SGObject.cpp 第 106 行定义.

void set_generic ( )

inherited

在文件 SGObject.cpp 第 111 行定义.

void set_generic ( )

inherited

set generic type to T

void set_global_io ( SGIO *  io )

inherited

set the io object

参数

io	io object to use

在文件 SGObject.cpp 第 228 行定义.

void set_global_parallel ( Parallel *  parallel )

inherited

set the parallel object

参数

parallel

parallel object to use

在文件 SGObject.cpp 第 241 行定义.

void set_global_version ( Version *  version )

inherited

set the version object

参数

version

version object to use

在文件 SGObject.cpp 第 283 行定义.

CSGObject * shallow_copy ( ) const

virtualinherited

A shallow copy. All the SGObject instance variables will be simply assigned and SG_REF-ed.

被 CGaussianKernel 重载.

在文件 SGObject.cpp 第 192 行定义.

void unset_generic ( )

inherited

unset generic type

this has to be called in classes specializing a template class

在文件 SGObject.cpp 第 303 行定义.

void update_parameter_hash ( )

virtualinherited

Updates the hash of current parameter combination

在文件 SGObject.cpp 第 248 行定义.

类成员变量说明

DynArray<CMapNode<K, T>*>* array

protected

array for index permission

在文件 Map.h 第 468 行定义.

int32_t free_index

protected

next free index for new element

在文件 Map.h 第 459 行定义.

CMapNode<K, T>** hash_array

protected

array of lists (chains)

在文件 Map.h 第 465 行定义.

int32_t hash_size

protected

hashtable size

在文件 Map.h 第 456 行定义.

SGIO* io

inherited

io

在文件 SGObject.h 第 369 行定义.

CLock lock

protected

concurrency lock

在文件 Map.h 第 471 行定义.

Parameter* m_gradient_parameters

inherited

parameters wrt which we can compute gradients

在文件 SGObject.h 第 384 行定义.

uint32_t m_hash

inherited

Hash of parameter values

在文件 SGObject.h 第 387 行定义.

Parameter* m_model_selection_parameters

inherited

model selection parameters

在文件 SGObject.h 第 381 行定义.

Parameter* m_parameters

inherited

parameters

在文件 SGObject.h 第 378 行定义.

int32_t num_elements

protected

number of elements

在文件 Map.h 第 462 行定义.

Parallel* parallel

inherited

parallel

在文件 SGObject.h 第 372 行定义.

bool use_sg_mallocs

protected

whether SG_MALLOC or just malloc etc shall be used

在文件 Map.h 第 453 行定义.

Version* version

inherited

version

在文件 SGObject.h 第 375 行定义.

---

该类的文档由以下文件生成:

• SGObject.h
• Map.h