Util::Matrix< Data > Class Template Reference

Two-dimensional array container template (abstract). More...

#include <Matrix.h>

Inheritance diagram for Util::Matrix< Data >:

Public Member Functions
virtual	~Matrix ()
	Destructor.
int	capacity1 () const
	Get number of rows (range of the first array index).
int	capacity2 () const
	Get number of columns (range of the second array index).
Data const &	operator() (int i, int j) const
	Return element (i,j) of matrix by const reference.
Data &	operator() (int i, int j)
	Return element (i,j) of matrix by reference.
Data *	cArray ()
	Return pointer to underlying one-dimensional C array.
Data const *	cArray () const
	Return pointer to const to underlying one-dimensional C array.

Protected Member Functions
	Matrix ()
	Default constructor.

Protected Attributes
Data *	data_
	Pointer to 1D C array of all elements.
int	capacity1_
	Number of rows (range of first index).
int	capacity2_
	Number of columns (range of first index).

Detailed Description

template<typename Data>
class Util::Matrix< Data >

Two-dimensional array container template (abstract).

An Matrix object A is a two-dimensional array in which the operator A(i, j) returns a reference to element in column j of row i.

The memory for a Matrix is stored in a single one-dimensional C array, in which each row is stored as a consecutive block.

Class Matrix is an abstract class because it cannot allocate memory. Concrete subclasses include DMatrix and FMatrix.

Definition at line 31 of file Matrix.h.

Constructor & Destructor Documentation

~Matrix()

template<typename Data>

Util::Matrix< Data >::~Matrix ( )

virtual

Destructor.

Definition at line 129 of file Matrix.h.

Matrix()

template<typename Data>

Util::Matrix< Data >::Matrix ( )

inlineprotected

Default constructor.

Constructor (protected).

Protected to prevent direct instantiation.

Definition at line 119 of file Matrix.h.

References capacity1_, capacity2_, and data_.

Referenced by Util::DMatrix< Data >::DMatrix(), Util::DMatrix< Data >::DMatrix(), Util::FMatrix< Data, M, N >::FMatrix(), and Util::FMatrix< Data, M, N >::FMatrix().

Member Function Documentation

capacity1()

template<typename Data>

int Util::Matrix< Data >::capacity1 ( ) const

inline

Get number of rows (range of the first array index).

Definition at line 136 of file Matrix.h.

References capacity1_.

Referenced by Util::DMatrix< Data >::allocate(), Pscf::LuSolver::computeLU(), Pscf::Prdc::FieldIoReal< D, RFT, KFT, FFT >::estimateWBasis(), Pscf::Prdc::FieldIoReal< D, RFT, KFT, FFT >::estimateWBasis(), Util::DMatrix< Data >::serialize(), and Pscf::Prdc::Cpu::FieldBasisConverter< D >::setBasis().

capacity2()

template<typename Data>

int Util::Matrix< Data >::capacity2 ( ) const

inline

Get number of columns (range of the second array index).

Definition at line 143 of file Matrix.h.

References capacity2_.

Referenced by Util::DMatrix< Data >::allocate(), Pscf::LuSolver::computeLU(), Pscf::Prdc::FieldIoReal< D, RFT, KFT, FFT >::estimateWBasis(), Pscf::Prdc::FieldIoReal< D, RFT, KFT, FFT >::estimateWBasis(), Util::DMatrix< Data >::serialize(), and Pscf::Prdc::Cpu::FieldBasisConverter< D >::setBasis().

operator()() [1/2]

template<typename Data>

Data const & Util::Matrix< Data >::operator() ( int i, int j ) const

inline

Return element (i,j) of matrix by const reference.

Parameters

i	row index.
j	column index.

Definition at line 150 of file Matrix.h.

References capacity1_, capacity2_, and data_.

operator()() [2/2]

template<typename Data>

Data & Util::Matrix< Data >::operator() ( int i, int j )

inline

Return element (i,j) of matrix by reference.

Parameters

i	row index.
j	column index.

Definition at line 164 of file Matrix.h.

References capacity1_, capacity2_, and data_.

cArray() [1/2]

template<typename Data>

Data * Util::Matrix< Data >::cArray ( )

inline

Return pointer to underlying one-dimensional C array.

Definition at line 178 of file Matrix.h.

References data_.

Referenced by Pscf::LuSolver::inverse().

cArray() [2/2]

template<typename Data>

Data const * Util::Matrix< Data >::cArray ( ) const

inline

Return pointer to const to underlying one-dimensional C array.

Definition at line 185 of file Matrix.h.

References data_.

Member Data Documentation

data_

template<typename Data>

Data* Util::Matrix< Data >::data_

protected

Pointer to 1D C array of all elements.

Definition at line 84 of file Matrix.h.

Referenced by Util::DMatrix< Data >::allocate(), cArray(), cArray(), Util::DMatrix< Data >::deallocate(), Util::DMatrix< Data >::DMatrix(), Util::FMatrix< Data, M, N >::FMatrix(), Util::FMatrix< Data, M, N >::FMatrix(), Util::DMatrix< Data >::isAllocated(), Matrix(), operator()(), operator()(), Util::DMatrix< Data >::operator=(), Util::DMatrix< Data >::serialize(), and Util::DMatrix< Data >::~DMatrix().

capacity1_

template<typename Data>

int Util::Matrix< Data >::capacity1_

protected

Number of rows (range of first index).

Definition at line 87 of file Matrix.h.

Referenced by Util::DMatrix< Data >::allocate(), capacity1(), Util::DMatrix< Data >::deallocate(), Util::DMatrix< Data >::DMatrix(), Util::FMatrix< Data, M, N >::FMatrix(), Util::FMatrix< Data, M, N >::FMatrix(), Matrix(), operator()(), operator()(), Util::DMatrix< Data >::operator=(), Util::DMatrix< Data >::serialize(), and Util::DMatrix< Data >::~DMatrix().

capacity2_

template<typename Data>

int Util::Matrix< Data >::capacity2_

protected

Number of columns (range of first index).

Definition at line 90 of file Matrix.h.

Referenced by Util::DMatrix< Data >::allocate(), capacity2(), Util::DMatrix< Data >::deallocate(), Util::DMatrix< Data >::DMatrix(), Util::FMatrix< Data, M, N >::FMatrix(), Util::FMatrix< Data, M, N >::FMatrix(), Matrix(), operator()(), operator()(), Util::DMatrix< Data >::operator=(), Util::DMatrix< Data >::serialize(), and Util::DMatrix< Data >::~DMatrix().

---

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

• Matrix.h