SGMatrixList< T > Class Template Reference

---

Detailed Description

template<class T>
class shogun::SGMatrixList< T >

shogun matrix list

Definition at line 21 of file SGMatrixList.h.

Inheritance diagram for SGMatrixList< T >:

List of all members.

Public Member Functions
	SGMatrixList ()
	SGMatrixList (SGMatrix< T > *ml, int32_t nmats, bool ref_counting=true)
	SGMatrixList (int32_t nmats, bool ref_counting=true)
	SGMatrixList (SGMatrixList const &orig)
virtual	~SGMatrixList ()
SGMatrix< T > &	get_matrix (index_t index) const
SGMatrix< T > &	operator[] (index_t index) const
int32_t	ref_count ()
Static Public Member Functions
static SGMatrixList< T >	split (SGMatrix< T > matrix, int32_t num_components)
Public Attributes
SGMatrix< T > *	matrix_list
int32_t	num_matrices
Protected Member Functions
virtual void	copy_data (SGReferencedData const &orig)
virtual void	init_data ()
virtual void	free_data ()
void	copy_refcount (const SGReferencedData &orig)
int32_t	ref ()
int32_t	unref ()

---

Constructor & Destructor Documentation

SGMatrixList

(

)

default constructor

Definition at line 16 of file SGMatrixList.cpp.

SGMatrixList	(	SGMatrix< T > *	ml,
		int32_t	nmats,
		bool	ref_counting = true
	)

constructor for setting parameters

Definition at line 22 of file SGMatrixList.cpp.

SGMatrixList	(	int32_t	nmats,
		bool	ref_counting = true
	)

constructor to create a new matrix list in memory

Definition at line 28 of file SGMatrixList.cpp.

SGMatrixList

(

SGMatrixList< T > const &

orig

)

copy constructor

Definition at line 38 of file SGMatrixList.cpp.

~SGMatrixList

(

)

[virtual]

destructor

Definition at line 44 of file SGMatrixList.cpp.

---

Member Function Documentation

void copy_data

(

SGReferencedData const &

orig

)

[protected, virtual]

copy data

Implements SGReferencedData.

Definition at line 50 of file SGMatrixList.cpp.

void copy_refcount

(

const SGReferencedData &

orig

)

[protected, inherited]

copy refcount

Definition at line 102 of file SGReferencedData.h.

void free_data

(

)

[protected, virtual]

free data

Implements SGReferencedData.

Definition at line 64 of file SGMatrixList.cpp.

SGMatrix<T>& get_matrix

(

index_t

index

)

const

get a matrix of the list

Parameters:

index

matrix index, index must be less than num_matrices although no check is performed in the method

Returns:

the matrix at position index of the list

Definition at line 46 of file SGMatrixList.h.

void init_data

(

)

[protected, virtual]

initialize empty data

Implements SGReferencedData.

Definition at line 57 of file SGMatrixList.cpp.

SGMatrix<T>& operator[]

(

index_t

index

)

const

operator overload to get a matrix for read & write access

Parameters:

index

matrix index, index must be less than num_matrices although no check is performed in the method

Returns:

the matrix at position index of the list

Definition at line 58 of file SGMatrixList.h.

int32_t ref

(

)

[protected, inherited]

increase reference counter

Returns:

reference count

Definition at line 111 of file SGReferencedData.h.

int32_t ref_count

(

)

[inherited]

display reference counter

Returns:

reference count

Definition at line 81 of file SGReferencedData.h.

SGMatrixList< T > split	(	SGMatrix< T >	matrix,
		int32_t	num_components
	)			[static]

divide the matrix into a list of matrices. Each of the new matrices has the same number of rows as the original so the splits to the original matrix are done column-wise.

Parameters:

	matrix	matrix to split
	num_components	number of new matrices

Returns:

list of matrices

Definition at line 87 of file SGMatrixList.cpp.

int32_t unref

(

)

[protected, inherited]

decrement reference counter and deallocate object if refcount is zero before or after decrementing it

Returns:

reference count

Definition at line 136 of file SGReferencedData.h.

---

Member Data Documentation

SGMatrix<T>* matrix_list

matrix list

Definition at line 91 of file SGMatrixList.h.

int32_t num_matrices

number of matrices of matrix list

Definition at line 94 of file SGMatrixList.h.

---

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

• SGMatrixList.h
• SGMatrixList.cpp