CArray3< T >模板类参考


详细描述

template<class T>
class shogun::CArray3< T >

Template class Array3 implements a dense three dimensional array.

Note that depending on compile options everything will be inlined, such that this is as high performance 3d-array implementation without error checking.

在文件Array3.h28行定义。

继承图,类CArray3< T >
Inheritance graph
[图例]

所有成员的列表。

公有成员

 CArray3 ()
 CArray3 (int32_t dim1, int32_t dim2, int32_t dim3)
 CArray3 (T *p_array, int32_t dim1, int32_t dim2, int32_t dim3, bool p_free_array=true, bool p_copy_array=false)
 CArray3 (const T *p_array, int32_t dim1, int32_t dim2, int32_t dim3)
virtual ~CArray3 ()
void set_name (const char *p_name)
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 ()
void zero ()
void set_const (T const_elem)
T * get_array ()
void set_array (T *p_array, int32_t dim1, int32_t dim2, int32_t dim3, bool p_free_array, bool copy_array=false)
bool resize_array (int32_t dim1, int32_t dim2, int32_t dim3)
get_element (int32_t idx1, int32_t idx2, int32_t idx3) const
bool set_element (T p_element, int32_t idx1, int32_t idx2, int32_t idx3)
const T & element (int32_t idx1, int32_t idx2, int32_t idx3) const
T & element (int32_t idx1, int32_t idx2, int32_t idx3)
T & element (T *p_array, int32_t idx1, int32_t idx2, int32_t idx3)
T & element (T *p_array, int32_t idx1, int32_t idx2, int32_t idx3, int32_t p_dim1_size, int32_t p_dim2_size)
CArray3< T > & operator= (const CArray3< T > &orig)
void display_size () const
void display_array () const
virtual const char * get_name ()

保护属性

int32_t dim1_size
int32_t dim2_size
int32_t dim3_size

构造及析构函数文档

CArray3 (  ) 

default constructor

在文件Array3.h32行定义。

CArray3 ( int32_t  dim1,
int32_t  dim2,
int32_t  dim3 
)

constructor

参数:
dim1 dimension 1
dim2 dimension 2
dim3 dimension 3

在文件Array3.h43行定义。

CArray3 ( T *  p_array,
int32_t  dim1,
int32_t  dim2,
int32_t  dim3,
bool  p_free_array = true,
bool  p_copy_array = false 
)

constructor

参数:
p_array another array
dim1 dimension 1
dim2 dimension 2
dim3 dimension 3
p_free_array if array must be freed
p_copy_array if array must be copied

在文件Array3.h57行定义。

CArray3 ( const T *  p_array,
int32_t  dim1,
int32_t  dim2,
int32_t  dim3 
)

constructor

参数:
p_array another array
dim1 dimension 1
dim2 dimension 2
dim3 dimension 3

在文件Array3.h72行定义。

virtual ~CArray3 (  )  [virtual]

在文件Array3.h78行定义。


成员函数文档

void display_array (  )  const

display array

重载CArray< T >

在文件Array3.h291行定义。

void display_size (  )  const

display array size

重载CArray< T >

在文件Array3.h285行定义。

T& element ( T *  p_array,
int32_t  idx1,
int32_t  idx2,
int32_t  idx3,
int32_t  p_dim1_size,
int32_t  p_dim2_size 
)

get element of given array at given index

参数:
p_array another array
idx1 index 1
idx2 index 2
idx3 index 3
p_dim1_size size of dimension 1
p_dim2_size size of dimension 2
返回:
element of given array at given index

在文件Array3.h259行定义。

T& element ( T *  p_array,
int32_t  idx1,
int32_t  idx2,
int32_t  idx3 
)

get element of given array at given index

参数:
p_array another array
idx1 index 1
idx2 index 2
idx3 index 3
返回:
array element at index

在文件Array3.h240行定义。

T& element ( int32_t  idx1,
int32_t  idx2,
int32_t  idx3 
)

get array element at index

参数:
idx1 index 1
idx2 index 2
idx3 index 3
返回:
array element at index

在文件Array3.h224行定义。

const T& element ( int32_t  idx1,
int32_t  idx2,
int32_t  idx3 
) const

get array element at index

参数:
idx1 index 1
idx2 index 2
idx3 index 3
返回:
array element at index

在文件Array3.h209行定义。

T* get_array (  ) 

get the array call get_array just before messing with it DO NOT call any [],resize/delete functions after get_array(), the pointer may become invalid !

返回:
the array

重载CArray< T >

在文件Array3.h137行定义。

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

return total array size (including granularity buffer)

参数:
dim1 dimension 1 will be stored here
dim2 dimension 2 will be stored here
dim3 dimension 3 will be stored here

在文件Array3.h95行定义。

int32_t get_dim1 (  ) 

get dimension 1

返回:
dimension 1

重载CArray< T >

在文件Array3.h106行定义。

int32_t get_dim2 (  ) 

get dimension 2

返回:
dimension 2

在文件Array3.h112行定义。

int32_t get_dim3 (  ) 

get dimension 3

返回:
dimension 3

在文件Array3.h118行定义。

T get_element ( int32_t  idx1,
int32_t  idx2,
int32_t  idx3 
) const

get array element at index

参数:
idx1 index 1
idx2 index 2
idx3 index 3
返回:
array element at index

在文件Array3.h178行定义。

virtual const char* get_name (  )  [virtual]
返回:
object name

在文件Array3.h308行定义。

CArray3<T>& operator= ( const CArray3< T > &  orig  ) 

operator overload for array assignment

参数:
orig original array
返回:
new array

重载CArray< T >

在文件Array3.h275行定义。

bool resize_array ( int32_t  dim1,
int32_t  dim2,
int32_t  dim3 
)

resize array

参数:
dim1 new dimension 1
dim2 new dimension 2
dim3 new dimension 3
返回:
if resizing was successful

在文件Array3.h163行定义。

void set_array ( T *  p_array,
int32_t  dim1,
int32_t  dim2,
int32_t  dim3,
bool  p_free_array,
bool  copy_array = false 
)

set the array pointer and free previously allocated memory

参数:
p_array another array
dim1 dimension 1
dim2 dimensino 2
dim3 dimensino 3
p_free_array if array must be freed
copy_array if array must be copied

在文件Array3.h148行定义。

void set_const ( const_elem  ) 

set array with a constant

重载CArray< T >

在文件Array3.h125行定义。

bool set_element ( p_element,
int32_t  idx1,
int32_t  idx2,
int32_t  idx3 
)

set array element at index 'index'

参数:
p_element array element
idx1 index 1
idx2 index 2
idx3 index 3
返回:
if setting was successful

在文件Array3.h194行定义。

void set_name ( const char *  p_name  ) 

set array's name

参数:
p_name new name

重载CArray< T >

在文件Array3.h84行定义。

void zero (  ) 

zero array

重载CArray< T >

在文件Array3.h122行定义。


成员数据文档

int32_t dim1_size [protected]

size of array's dimension 1

在文件Array3.h312行定义。

int32_t dim2_size [protected]

size of array's dimension 2

在文件Array3.h314行定义。

int32_t dim3_size [protected]

size of array's dimension 3

在文件Array3.h316行定义。


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

SHOGUN Machine Learning Toolbox - Documentation