SGDynamicRefObjectArray类 参考

详细描述

Dynamic array class for CRefObject 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 CRefObject pointers, which ARE automagically SG_REF'd/deleted.

This array is optimized to have very little (storage) overhead

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

类 SGDynamicRefObjectArray 继承关系图:

Public 成员函数
	SGDynamicRefObjectArray ()
	SGDynamicRefObjectArray (int32_t dim1, int32_t dim2=1, int32_t dim3=1)
	SGDynamicRefObjectArray (CRefObject **p_array, int32_t p_dim1_size, bool p_free_array=true, bool p_copy_array=false)
	SGDynamicRefObjectArray (CRefObject **p_array, int32_t p_dim1_size, int32_t p_dim2_size, bool p_free_array=true, bool p_copy_array=false)
	SGDynamicRefObjectArray (CRefObject **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	~SGDynamicRefObjectArray ()
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
CRefObject *	get_element (int32_t index) const
CRefObject *	element (int32_t idx1, int32_t idx2=0, int32_t idx3=0)
CRefObject *	get_last_element () const
CRefObject *	get_element_safe (int32_t index) const
bool	set_element (CRefObject *e, int32_t idx1, int32_t idx2=0, int32_t idx3=0)
bool	insert_element (CRefObject *e, int32_t index)
bool	append_element (CRefObject *e)
void	push_back (CRefObject *e)
void	pop_back ()
CRefObject *	back () const
int32_t	find_element (CRefObject *elem) const
bool	delete_element (int32_t idx)
void	clear_array ()
void	reset_array ()
SGDynamicRefObjectArray &	operator= (SGDynamicRefObjectArray &orig)
CRefObject **	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

构造及析构函数说明

SGDynamicRefObjectArray() [1/5]

SGDynamicRefObjectArray

(

)

default constructor

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

SGDynamicRefObjectArray() [2/5]

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

constructor

参数

dim1	dimension 1
dim2	dimension 2
dim3	dimension 3

在文件 SGDynamicRefObjectArray.h 第 49 行定义.

SGDynamicRefObjectArray() [3/5]

SGDynamicRefObjectArray	(	CRefObject **	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

在文件 SGDynamicRefObjectArray.h 第 64 行定义.

SGDynamicRefObjectArray() [4/5]

SGDynamicRefObjectArray	(	CRefObject **	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

在文件 SGDynamicRefObjectArray.h 第 80 行定义.

SGDynamicRefObjectArray() [5/5]

SGDynamicRefObjectArray	(	CRefObject **	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

在文件 SGDynamicRefObjectArray.h 第 98 行定义.

~SGDynamicRefObjectArray()

virtual ~SGDynamicRefObjectArray ( )

virtual

在文件 SGDynamicRefObjectArray.h 第 107 行定义.

成员函数说明

append_element()

bool append_element

(

CRefObject *

e

)

append array element to the end of array

参数

e	element to append

返回

if setting was successful

在文件 SGDynamicRefObjectArray.h 第 275 行定义.

back()

CRefObject* back

(

)

const

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

返回

element at the end of array

在文件 SGDynamicRefObjectArray.h 第 311 行定义.

clear_array()

void clear_array

(

)

clear the array (with zeros)

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

delete_element()

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

在文件 SGDynamicRefObjectArray.h 第 335 行定义.

element()

CRefObject* 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

在文件 SGDynamicRefObjectArray.h 第 198 行定义.

find_element()

int32_t find_element

(

CRefObject *

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

在文件 SGDynamicRefObjectArray.h 第 324 行定义.

get_array()

CRefObject** get_array

(

)

const

返回

underlying array of pointers

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

get_array_name()

const char* get_array_name

(

)

const

get array's name

返回

array's name

在文件 SGDynamicRefObjectArray.h 第 399 行定义.

get_array_size() [1/3]

int32_t get_array_size

(

)

get array size (including granularity buffer)

返回

total array size (including granularity buffer)

在文件 SGDynamicRefObjectArray.h 第 121 行定义.

get_array_size() [2/3]

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

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

get_array_size() [3/3]

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

在文件 SGDynamicRefObjectArray.h 第 143 行定义.

get_dim1()

int32_t get_dim1

(

)

get dimension 1

返回

dimension 1

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

get_dim2()

int32_t get_dim2

(

)

get dimension 2

返回

dimension 2

在文件 SGDynamicRefObjectArray.h 第 160 行定义.

get_dim3()

int32_t get_dim3

(

)

get dimension 3

返回

dimension 3

在文件 SGDynamicRefObjectArray.h 第 166 行定义.

get_element()

CRefObject* get_element

(

int32_t

index

)

const

get array element at index

(does NOT do bounds checking)

参数

index

index

返回

array element at index

在文件 SGDynamicRefObjectArray.h 第 184 行定义.

get_element_safe()

CRefObject* get_element_safe

(

int32_t

index

)

const

get array element at index

(does bounds checking)

参数

index

index

返回

array element at index

在文件 SGDynamicRefObjectArray.h 第 221 行定义.

get_last_element()

CRefObject* get_last_element

(

)

const

get last array element

返回

last array element

在文件 SGDynamicRefObjectArray.h 第 207 行定义.

get_name()

virtual const char* get_name ( ) const

virtual

返回

object name

实现了 SGRefObject.

在文件 SGDynamicRefObjectArray.h 第 402 行定义.

get_num_elements()

int32_t get_num_elements

(

)

const

get number of elements

返回

number of elements

在文件 SGDynamicRefObjectArray.h 第 172 行定义.

insert_element()

bool insert_element	(	CRefObject *	e,
		int32_t	index
	)

insert array element at index

参数

e	element to insert
index	index

返回

if setting was successful

在文件 SGDynamicRefObjectArray.h 第 261 行定义.

operator=()

SGDynamicRefObjectArray& operator=

(

SGDynamicRefObjectArray &

orig

)

operator overload for array assignment

参数

orig	original array

返回

new array

在文件 SGDynamicRefObjectArray.h 第 363 行定义.

pop_back()

void pop_back

(

)

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

在文件 SGDynamicRefObjectArray.h 第 298 行定义.

push_back()

void push_back

(

CRefObject *

e

)

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

参数

e	element to append

在文件 SGDynamicRefObjectArray.h 第 289 行定义.

reset_array()

void reset_array

(

)

resets the array

在文件 SGDynamicRefObjectArray.h 第 352 行定义.

set_array_name()

void set_array_name

(

const char *

p_name

)

set array's name

参数

p_name

new name

在文件 SGDynamicRefObjectArray.h 第 390 行定义.

set_element()

bool set_element	(	CRefObject *	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

在文件 SGDynamicRefObjectArray.h 第 236 行定义.

set_granularity()

int32_t set_granularity

(

int32_t

g

)

set the resize granularity

参数

g	new granularity

返回

what has been set (minimum is 128)

在文件 SGDynamicRefObjectArray.h 第 114 行定义.

shuffle() [1/2]

void shuffle

(

)

shuffles the array (not thread safe!)

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

shuffle() [2/2]

void shuffle

(

CRandom *

rand

)

shuffles the array with external random state

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

---

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

• SGDynamicRefObjectArray.h