CDynamicObjectArray类 参考

详细描述

Dynamic array class for CSGObject pointers that creates an array that can be used like a list or an array.

It grows and shrinks dynamically, while elements can be accessed via index. It only stores CSGObject pointers, which ARE automagically SG_REF'd/deleted.

在文件 DynamicObjectArray.h 第 31 行定义.

类 CDynamicObjectArray 继承关系图:

Public 成员函数
	CDynamicObjectArray ()
	CDynamicObjectArray (int32_t dim1, int32_t dim2=1, int32_t dim3=1)
	CDynamicObjectArray (CSGObject **p_array, int32_t p_dim1_size, bool p_free_array=true, bool p_copy_array=false)
	CDynamicObjectArray (CSGObject **p_array, int32_t p_dim1_size, int32_t p_dim2_size, bool p_free_array=true, bool p_copy_array=false)
	CDynamicObjectArray (CSGObject **p_array, int32_t p_dim1_size, int32_t p_dim2_size, int32_t p_dim3_size, bool p_free_array=true, bool p_copy_array=false)
virtual	~CDynamicObjectArray ()
int32_t	set_granularity (int32_t g)
int32_t	get_array_size ()
void	get_array_size (int32_t &dim1, int32_t &dim2)
void	get_array_size (int32_t &dim1, int32_t &dim2, int32_t &dim3)
int32_t	get_dim1 ()
int32_t	get_dim2 ()
int32_t	get_dim3 ()
int32_t	get_num_elements () const
CSGObject *	get_element (int32_t index) const
CSGObject *	element (int32_t idx1, int32_t idx2=0, int32_t idx3=0)
CSGObject *	get_last_element () const
CSGObject *	get_element_safe (int32_t index) const
bool	set_element (CSGObject *e, int32_t idx1, int32_t idx2=0, int32_t idx3=0)
bool	insert_element (CSGObject *e, int32_t index)
bool	append_element (CSGObject *e)
void	push_back (CSGObject *e)
void	pop_back ()
CSGObject *	back () const
int32_t	find_element (CSGObject *elem) const
bool	delete_element (int32_t idx)
void	clear_array ()
void	reset_array ()
CDynamicObjectArray &	operator= (CDynamicObjectArray &orig)
CSGObject **	get_array () const
void	shuffle ()
void	shuffle (CRandom *rand)
void	set_array_name (const char *p_name)
const char *	get_array_name () const
virtual const char *	get_name () const
virtual void	load_serializable_pre () throw (ShogunException)
virtual void	save_serializable_pre () throw (ShogunException)
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 void	load_serializable_post () throw (ShogunException)
virtual void	save_serializable_post () throw (ShogunException)

构造及析构函数说明

CDynamicObjectArray

(

)

default constructor

在文件 DynamicObjectArray.h 第 35 行定义.

CDynamicObjectArray	(	int32_t	dim1,
		int32_t	dim2 = 1,
		int32_t	dim3 = 1
	)

constructor

参数

dim1	dimension 1
dim2	dimension 2
dim3	dimension 3

在文件 DynamicObjectArray.h 第 51 行定义.

CDynamicObjectArray	(	CSGObject **	p_array,
		int32_t	p_dim1_size,
		bool	p_free_array = true,
		bool	p_copy_array = false
	)

constructor

参数

p_array	another array
p_dim1_size	dimension 1
p_free_array	if array must be freed
p_copy_array	if array must be copied

在文件 DynamicObjectArray.h 第 68 行定义.

CDynamicObjectArray	(	CSGObject **	p_array,
		int32_t	p_dim1_size,
		int32_t	p_dim2_size,
		bool	p_free_array = true,
		bool	p_copy_array = false
	)

constructor

参数

p_array	another array
p_dim1_size	dimension 1
p_dim2_size	dimension 2
p_free_array	if array must be freed
p_copy_array	if array must be copied

在文件 DynamicObjectArray.h 第 86 行定义.

CDynamicObjectArray	(	CSGObject **	p_array,
		int32_t	p_dim1_size,
		int32_t	p_dim2_size,
		int32_t	p_dim3_size,
		bool	p_free_array = true,
		bool	p_copy_array = false
	)

constructor

参数

p_array	another array
p_dim1_size	dimension 1
p_dim2_size	dimension 2
p_dim3_size	dimension 3
p_free_array	if array must be freed
p_copy_array	if array must be copied

在文件 DynamicObjectArray.h 第 106 行定义.

virtual ~CDynamicObjectArray ( )

virtual

在文件 DynamicObjectArray.h 第 117 行定义.

成员函数说明

bool append_element

(

CSGObject *

e

)

append array element to the end of array

参数

e	element to append

返回

if setting was successful

在文件 DynamicObjectArray.h 第 285 行定义.

CSGObject* back

(

)

const

STD VECTOR compatible. Return array element at the end of array.

返回

element at the end of array

在文件 DynamicObjectArray.h 第 321 行定义.

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 行定义.

void clear_array

(

)

clear the array (with zeros)

在文件 DynamicObjectArray.h 第 355 行定义.

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 行定义.

CSGObject * deep_copy ( ) const

virtualinherited

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

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

bool delete_element

(

int32_t

idx

)

delete array element at idx (does not call SG_FREE() or the like)

参数

idx

index

返回

if deleting was successful

在文件 DynamicObjectArray.h 第 345 行定义.

CSGObject* element	(	int32_t	idx1,
		int32_t	idx2 = 0,
		int32_t	idx3 = 0
	)

get array element at index

参数

idx1	index 1
idx2	index 2
idx3	index 3

返回

array element at index

在文件 DynamicObjectArray.h 第 208 行定义.

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 行定义.

int32_t find_element

(

CSGObject *

elem

)

const

find first occurence of array element and return its index or -1 if not available

参数

elem	element to search for

返回

index of element or -1

在文件 DynamicObjectArray.h 第 334 行定义.

CSGObject** get_array

(

)

const

返回

underlying array of pointers

在文件 DynamicObjectArray.h 第 388 行定义.

const char* get_array_name

(

)

const

get array's name

返回

array's name

在文件 DynamicObjectArray.h 第 409 行定义.

int32_t get_array_size

(

)

get array size (including granularity buffer)

返回

total array size (including granularity buffer)

在文件 DynamicObjectArray.h 第 131 行定义.

void get_array_size	(	int32_t &	dim1,
		int32_t &	dim2
	)

return 2d array size

参数

dim1	dimension 1 will be stored here
dim2	dimension 2 will be stored here

在文件 DynamicObjectArray.h 第 141 行定义.

void get_array_size	(	int32_t &	dim1,
		int32_t &	dim2,
		int32_t &	dim3
	)

return 3d array size

参数

dim1	dimension 1 will be stored here
dim2	dimension 2 will be stored here
dim3	dimension 3 will be stored here

在文件 DynamicObjectArray.h 第 153 行定义.

int32_t get_dim1

(

)

get dimension 1

返回

dimension 1

在文件 DynamicObjectArray.h 第 164 行定义.

int32_t get_dim2

(

)

get dimension 2

返回

dimension 2

在文件 DynamicObjectArray.h 第 170 行定义.

int32_t get_dim3

(

)

get dimension 3

返回

dimension 3

在文件 DynamicObjectArray.h 第 176 行定义.

CSGObject* get_element

(

int32_t

index

)

const

get array element at index

(does NOT do bounds checking)

参数

index

index

返回

array element at index

在文件 DynamicObjectArray.h 第 194 行定义.

CSGObject* get_element_safe

(

int32_t

index

)

const

get array element at index

(does bounds checking)

参数

index

index

返回

array element at index

在文件 DynamicObjectArray.h 第 231 行定义.

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 行定义.

CSGObject* get_last_element

(

)

const

get last array element

返回

last array element

在文件 DynamicObjectArray.h 第 217 行定义.

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.

在文件 DynamicObjectArray.h 第 412 行定义.

int32_t get_num_elements

(

)

const

get number of elements

返回

number of elements

在文件 DynamicObjectArray.h 第 182 行定义.

bool insert_element	(	CSGObject *	e,
		int32_t	index
	)

insert array element at index

参数

e	element to insert
index	index

返回

if setting was successful

在文件 DynamicObjectArray.h 第 271 行定义.

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 行定义.

virtual void load_serializable_pre ( ) throw ( ShogunException )

virtual

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

重载 CSGObject .

在文件 DynamicObjectArray.h 第 423 行定义.

CDynamicObjectArray& operator=

(

CDynamicObjectArray &

orig

)

operator overload for array assignment

参数

orig	original array

返回

new array

在文件 DynamicObjectArray.h 第 373 行定义.

bool parameter_hash_changed ( )

virtualinherited

返回

whether parameter combination has changed since last update

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

void pop_back

(

)

STD VECTOR compatible. Delete array element at the end of array.

在文件 DynamicObjectArray.h 第 308 行定义.

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 push_back

(

CSGObject *

e

)

STD VECTOR compatible. Append array element to the end of array.

参数

e	element to append

在文件 DynamicObjectArray.h 第 299 行定义.

void reset_array

(

)

resets the array

在文件 DynamicObjectArray.h 第 362 行定义.

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 行定义.

virtual void save_serializable_pre ( ) throw ( ShogunException )

virtual

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

重载 CSGObject .

在文件 DynamicObjectArray.h 第 438 行定义.

void set_array_name

(

const char *

p_name

)

set array's name

参数

p_name

new name

在文件 DynamicObjectArray.h 第 400 行定义.

bool set_element	(	CSGObject *	e,
		int32_t	idx1,
		int32_t	idx2 = 0,
		int32_t	idx3 = 0
	)

set array element at index

参数

e	element to set
idx1	index 1
idx2	index 2
idx3	index 2

返回

if setting was successful

在文件 DynamicObjectArray.h 第 246 行定义.

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 行定义.

int32_t set_granularity

(

int32_t

g

)

set the resize granularity

参数

g	new granularity

返回

what has been set (minimum is 128)

在文件 DynamicObjectArray.h 第 124 行定义.

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 shuffle

(

)

shuffles the array (not thread safe!)

在文件 DynamicObjectArray.h 第 391 行定义.

void shuffle

(

CRandom *

rand

)

shuffles the array with external random state

在文件 DynamicObjectArray.h 第 394 行定义.

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 行定义.

类成员变量说明

SGIO* io

inherited

io

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

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 行定义.

Parallel* parallel

inherited

parallel

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

Version* version

inherited

version

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

---

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

• DynamicObjectArray.h