Public Types | Public Member Functions | Protected Attributes | Static Protected Attributes

Seldon::Matrix_SymPacked< T, Prop, Storage, Allocator > Class Template Reference

Symmetric packed matrix class. More...

#include <Matrix_SymPacked.hxx>

Inheritance diagram for Seldon::Matrix_SymPacked< T, Prop, Storage, Allocator >:
Seldon::Matrix_Base< T, Allocator >

List of all members.

Public Types

typedef Allocator::value_type value_type
typedef Allocator::pointer pointer
typedef Allocator::const_pointer const_pointer
typedef Allocator::reference reference
typedef Allocator::const_reference const_reference
typedef Allocator::value_type entry_type
typedef Allocator::reference access_type
typedef Allocator::const_reference const_access_type

Public Member Functions

 Matrix_SymPacked ()
 Default constructor.
 Matrix_SymPacked (int i, int j=0)
 Main constructor.
 Matrix_SymPacked (const Matrix_SymPacked< T, Prop, Storage, Allocator > &A)
 Copy constructor.
 ~Matrix_SymPacked ()
 Destructor.
void Clear ()
 Clears the matrix.
int GetDataSize () const
 Returns the number of elements stored in memory.
void Reallocate (int i, int j)
 Reallocates memory to resize the matrix.
void SetData (int i, int j, pointer data)
void Nullify ()
 Clears the matrix without releasing memory.
reference operator() (int i, int j)
 Access operator.
const_reference operator() (int i, int j) const
 Access operator.
reference Val (int i, int j)
 Direct access method.
const_reference Val (int i, int j) const
 Direct access method.
reference Get (int i, int j)
 Returns the element (i, j).
const_reference Get (int i, int j) const
 Returns the element (i, j).
reference operator[] (int i)
 Access to elements of the data array.
const_reference operator[] (int i) const
 Access to elements of the data array.
Matrix_SymPacked< T, Prop,
Storage, Allocator > & 		operator= (const Matrix_SymPacked< T, Prop, Storage, Allocator > &A)
 Duplicates a matrix (assignment operator).
void Set (int i, int j, const T &x)
 Sets an element of the matrix.
void Copy (const Matrix_SymPacked< T, Prop, Storage, Allocator > &A)
 Duplicates a matrix.
void Zero ()
 Sets all elements to zero.
void SetIdentity ()
 Sets the matrix to the identity.
void Fill ()
 Fills the matrix with 0, 1, 2, ...
template<class T0 >
void Fill (const T0 &x)
 Fills the matrix with a given value.
template<class T0 >
Matrix_SymPacked< T, Prop,
Storage, Allocator > & 		operator= (const T0 &x)
 Fills the matrix with a given value.
void FillRand ()
 Fills the matrix randomly.
void Print () const
 Displays the matrix on the standard output.
void Print (int a, int b, int m, int n) const
 Displays a sub-matrix on the standard output.
void Print (int l) const
 Displays a square sub-matrix on the standard output.
void Write (string FileName) const
 Writes the matrix in a file.
void Write (ostream &FileStream) const
 Writes the matrix to an output stream.
void WriteText (string FileName) const
 Writes the matrix in a file.
void WriteText (ostream &FileStream) const
 Writes the matrix to an output stream.
void Read (string FileName)
 Reads the matrix from a file.
void Read (istream &FileStream)
 Reads the matrix from an input stream.
void ReadText (string FileName)
 Reads the matrix from a file.
void ReadText (istream &FileStream)
 Reads the matrix from an input stream.
int GetM () const
 Returns the number of rows.
int GetM (const Seldon::SeldonTranspose &status) const
 Returns the number of rows of the matrix possibly transposed.
int GetN () const
 Returns the number of columns.
int GetN (const Seldon::SeldonTranspose &status) const
 Returns the number of columns of the matrix possibly transposed.
int GetSize () const
 Returns the number of elements in the matrix.
pointer GetData () const
 Returns a pointer to the data array.
const_pointer GetDataConst () const
 Returns a const pointer to the data array.
void * GetDataVoid () const
 Returns a pointer of type "void*" to the data array.
const void * GetDataConstVoid () const
 Returns a pointer of type "const void*" to the data array.
Allocator & GetAllocator ()
 Returns the allocator of the matrix.

Protected Attributes

int m_
int n_
pointer data_

Static Protected Attributes

static Allocator allocator_

Detailed Description

template<class T, class Prop, class Storage, class Allocator = SELDON_DEFAULT_ALLOCATOR<T>>
class Seldon::Matrix_SymPacked< T, Prop, Storage, Allocator >

Symmetric packed matrix class.

Definition at line 37 of file Matrix_SymPacked.hxx.

Constructor & Destructor Documentation

template<class T , class Prop , class Storage , class Allocator >
Seldon::Matrix_SymPacked< T, Prop, Storage, Allocator >::Matrix_SymPacked (  )  [inline]

Default constructor.

On exit, the matrix is an empty 0x0 matrix.

Definition at line 37 of file Matrix_SymPacked.cxx.

template<class T , class Prop , class Storage , class Allocator >
Seldon::Matrix_SymPacked< T, Prop, Storage, Allocator >::Matrix_SymPacked ( int  i,
int  j = 0 
) [inline]

Main constructor.

Builds a i x j hermitian matrix in packed form.

Parameters:
i number of rows.
j number of columns.
Note:
'j' is assumed to be equal to 'i' and is therefore discarded.

Definition at line 51 of file Matrix_SymPacked.cxx.

Member Function Documentation

template<class T , class Prop , class Storage , class Allocator >
void Seldon::Matrix_SymPacked< T, Prop, Storage, Allocator >::Clear (  )  [inline]

Clears the matrix.

Destructs the matrix.

Warning:
On exit, the matrix is an empty 0x0 matrix.

Definition at line 136 of file Matrix_SymPacked.cxx.

template<class T, class Prop, class Storage, class Allocator>
void Seldon::Matrix_SymPacked< T, Prop, Storage, Allocator >::Copy ( const Matrix_SymPacked< T, Prop, Storage, Allocator > &  A  )  [inline]

Duplicates a matrix.

Parameters:
A matrix to be copied.
Note:
Memory is duplicated: 'A' is therefore independent from the current instance after the copy.

Definition at line 520 of file Matrix_SymPacked.cxx.

template<class T , class Prop , class Storage , class Allocator >
void Seldon::Matrix_SymPacked< T, Prop, Storage, Allocator >::Fill (  ) 

Fills the matrix with 0, 1, 2, ...

On exit, the matrix is filled with 0, 1, 2, 3, ... The order of those numbers depends on the storage.

Definition at line 564 of file Matrix_SymPacked.cxx.

template<class T , class Prop , class Storage , class Allocator >
template<class T0 >
void Seldon::Matrix_SymPacked< T, Prop, Storage, Allocator >::Fill ( const T0 &  x  ) 

Fills the matrix with a given value.

Parameters:
x value to fill the matrix with.

Definition at line 577 of file Matrix_SymPacked.cxx.

template<class T , class Prop , class Storage , class Allocator >
void Seldon::Matrix_SymPacked< T, Prop, Storage, Allocator >::FillRand (  ) 

Fills the matrix randomly.

Note:
The random generator is very basic.

Definition at line 604 of file Matrix_SymPacked.cxx.

template<class T , class Prop , class Storage , class Allocator >
Matrix_SymPacked< T, Prop, Storage, Allocator >::reference Seldon::Matrix_SymPacked< T, Prop, Storage, Allocator >::Get ( int  i,
int  j 
) [inline]

Returns the element (i, j).

Returns the value of element (i, j).

Parameters:
i row index.
j column index.
Returns:
Element (i, j) of the matrix.

Definition at line 428 of file Matrix_SymPacked.cxx.

template<class T , class Prop , class Storage , class Allocator >
Matrix_SymPacked< T, Prop, Storage, Allocator >::const_reference Seldon::Matrix_SymPacked< T, Prop, Storage, Allocator >::Get ( int  i,
int  j 
) const [inline]

Returns the element (i, j).

Returns the value of element (i, j).

Parameters:
i row index.
j column index.
Returns:
Element (i, j) of the matrix.

Definition at line 413 of file Matrix_SymPacked.cxx.

template<class T , class Allocator >
Allocator & Seldon::Matrix_Base< T, Allocator >::GetAllocator (  )  [inherited]

Returns the allocator of the matrix.

Returns:
The allocator.

Definition at line 258 of file Matrix_Base.cxx.

template<class T , class Allocator >
Matrix_Base< T, Allocator >::pointer Seldon::Matrix_Base< T, Allocator >::GetData (  )  const [inherited]

Returns a pointer to the data array.

Returns a pointer to data, i.e. the data array 'data_'.

Returns:
A pointer to the data array.

Definition at line 208 of file Matrix_Base.cxx.

template<class T , class Allocator >
Matrix_Base< T, Allocator >::const_pointer Seldon::Matrix_Base< T, Allocator >::GetDataConst (  )  const [inherited]

Returns a const pointer to the data array.

Returns a const pointer to data, i.e. the data array 'data_'.

Returns:
A const pointer to the data array.

Definition at line 221 of file Matrix_Base.cxx.

template<class T , class Allocator >
const void * Seldon::Matrix_Base< T, Allocator >::GetDataConstVoid (  )  const [inherited]

Returns a pointer of type "const void*" to the data array.

Returns a pointer of type "const void*" to data, i.e. the data array 'data_'.

Returns:
A const pointer of type "void*" to the data array.

Definition at line 247 of file Matrix_Base.cxx.

template<class T , class Prop , class Storage , class Allocator >
int Seldon::Matrix_SymPacked< T, Prop, Storage, Allocator >::GetDataSize (  )  const

Returns the number of elements stored in memory.

Returns:
The number of elements stored in memory.

Definition at line 154 of file Matrix_SymPacked.cxx.

template<class T , class Allocator >
void * Seldon::Matrix_Base< T, Allocator >::GetDataVoid (  )  const [inherited]

Returns a pointer of type "void*" to the data array.

Returns a pointer of type "void*" to data, i.e. the data array 'data_'.

Returns:
A pointer of type "void*" to the data array.

Definition at line 234 of file Matrix_Base.cxx.

template<class T , class Allocator >
int Seldon::Matrix_Base< T, Allocator >::GetM (  )  const [inherited]

Returns the number of rows.

Returns:
The number of rows.

Reimplemented in Seldon::HeterogeneousMatrixCollection< Prop0, Storage0, Prop1, Storage1, Allocator >, Seldon::MatrixCollection< T, Prop, Storage, Allocator >, Seldon::SubMatrix_Base< T, Prop, M, Allocator >, Seldon::HeterogeneousMatrixCollection< General, RowMajor, General, RowSparse, Allocator >, Seldon::MatrixCollection< T, Prop, RowMajor, Allocator >, Seldon::MatrixCollection< T, Prop, ColMajor, Allocator >, Seldon::MatrixCollection< T, Prop, ColSymPacked, Allocator >, and Seldon::MatrixCollection< T, Prop, RowSymPacked, Allocator >.

Definition at line 107 of file Matrix_Base.cxx.

template<class T , class Allocator >
int Seldon::Matrix_Base< T, Allocator >::GetM ( const Seldon::SeldonTranspose &  status  )  const [inherited]

Returns the number of rows of the matrix possibly transposed.

Parameters:
status assumed status about the transposition of the matrix.
Returns:
The number of rows of the possibly-transposed matrix.

Reimplemented in Seldon::SubMatrix_Base< T, Prop, M, Allocator >.

Definition at line 130 of file Matrix_Base.cxx.

template<class T , class Allocator >
int Seldon::Matrix_Base< T, Allocator >::GetN ( const Seldon::SeldonTranspose &  status  )  const [inherited]

Returns the number of columns of the matrix possibly transposed.

Parameters:
status assumed status about the transposition of the matrix.
Returns:
The number of columns of the possibly-transposed matrix.

Reimplemented in Seldon::SubMatrix_Base< T, Prop, M, Allocator >.

Definition at line 145 of file Matrix_Base.cxx.

template<class T , class Allocator >
int Seldon::Matrix_Base< T, Allocator >::GetN (  )  const [inherited]

Returns the number of columns.

Returns:
The number of columns.

Reimplemented in Seldon::HeterogeneousMatrixCollection< Prop0, Storage0, Prop1, Storage1, Allocator >, Seldon::MatrixCollection< T, Prop, Storage, Allocator >, Seldon::SubMatrix_Base< T, Prop, M, Allocator >, Seldon::HeterogeneousMatrixCollection< General, RowMajor, General, RowSparse, Allocator >, Seldon::MatrixCollection< T, Prop, RowMajor, Allocator >, Seldon::MatrixCollection< T, Prop, ColMajor, Allocator >, Seldon::MatrixCollection< T, Prop, ColSymPacked, Allocator >, and Seldon::MatrixCollection< T, Prop, RowSymPacked, Allocator >.

Definition at line 118 of file Matrix_Base.cxx.

template<class T , class Allocator >
int Seldon::Matrix_Base< T, Allocator >::GetSize (  )  const [inherited]

Returns the number of elements in the matrix.

Returns the number of elements in the matrix, i.e. the number of rows multiplied by the number of columns.

Returns:
The number of elements in the matrix.

Reimplemented in Seldon::HeterogeneousMatrixCollection< Prop0, Storage0, Prop1, Storage1, Allocator >, Seldon::MatrixCollection< T, Prop, Storage, Allocator >, Seldon::HeterogeneousMatrixCollection< General, RowMajor, General, RowSparse, Allocator >, Seldon::MatrixCollection< T, Prop, RowMajor, Allocator >, Seldon::MatrixCollection< T, Prop, ColMajor, Allocator >, Seldon::MatrixCollection< T, Prop, ColSymPacked, Allocator >, and Seldon::MatrixCollection< T, Prop, RowSymPacked, Allocator >.

Definition at line 195 of file Matrix_Base.cxx.

template<class T , class Prop , class Storage , class Allocator >
void Seldon::Matrix_SymPacked< T, Prop, Storage, Allocator >::Nullify (  )  [inline]

Clears the matrix without releasing memory.

On exit, the matrix is empty and the memory has not been released. It is useful for low level manipulations on a Matrix instance.

Definition at line 253 of file Matrix_SymPacked.cxx.

template<class T , class Prop , class Storage , class Allocator >
Matrix_SymPacked< T, Prop, Storage, Allocator >::reference Seldon::Matrix_SymPacked< T, Prop, Storage, Allocator >::operator() ( int  i,
int  j 
) [inline]

Access operator.

Returns the value of element (i, j).

Parameters:
i row index.
j column index.
Returns:
Element (i, j) of the matrix.

Definition at line 275 of file Matrix_SymPacked.cxx.

template<class T , class Prop , class Storage , class Allocator >
Matrix_SymPacked< T, Prop, Storage, Allocator >::const_reference Seldon::Matrix_SymPacked< T, Prop, Storage, Allocator >::operator() ( int  i,
int  j 
) const [inline]

Access operator.

Returns the value of element (i, j).

Parameters:
i row index.
j column index.
Returns:
Element (i, j) of the matrix.

Definition at line 309 of file Matrix_SymPacked.cxx.

template<class T , class Prop , class Storage , class Allocator >
template<class T0 >
Matrix_SymPacked< T, Prop, Storage, Allocator > & Seldon::Matrix_SymPacked< T, Prop, Storage, Allocator >::operator= ( const T0 &  x  ) 

Fills the matrix with a given value.

Parameters:
x value to fill the matrix with.

Reimplemented in Seldon::Matrix< T, Prop, ColSymPacked, Allocator >, and Seldon::Matrix< T, Prop, RowSymPacked, Allocator >.

Definition at line 591 of file Matrix_SymPacked.cxx.

template<class T, class Prop, class Storage, class Allocator>
Matrix_SymPacked< T, Prop, Storage, Allocator > & Seldon::Matrix_SymPacked< T, Prop, Storage, Allocator >::operator= ( const Matrix_SymPacked< T, Prop, Storage, Allocator > &  A  )  [inline]

Duplicates a matrix (assignment operator).

Parameters:
A matrix to be copied.
Note:
Memory is duplicated: 'A' is therefore independent from the current instance after the copy.

Definition at line 490 of file Matrix_SymPacked.cxx.

template<class T , class Prop , class Storage , class Allocator >
Matrix_SymPacked< T, Prop, Storage, Allocator >::reference Seldon::Matrix_SymPacked< T, Prop, Storage, Allocator >::operator[] ( int  i  )  [inline]

Access to elements of the data array.

Provides a direct access to the data array.

Parameters:
i index.
Returns:
i-th element of the data array.

Definition at line 442 of file Matrix_SymPacked.cxx.

template<class T , class Prop , class Storage , class Allocator >
Matrix_SymPacked< T, Prop, Storage, Allocator >::const_reference Seldon::Matrix_SymPacked< T, Prop, Storage, Allocator >::operator[] ( int  i  )  const [inline]

Access to elements of the data array.

Provides a direct access to the data array.

Parameters:
i index.
Returns:
i-th element of the data array.

Definition at line 466 of file Matrix_SymPacked.cxx.

template<class T , class Prop , class Storage , class Allocator >
void Seldon::Matrix_SymPacked< T, Prop, Storage, Allocator >::Print (  )  const

Displays the matrix on the standard output.

Displays elements on the standard output, in text format. Each row is displayed on a single line and elements of a row are delimited by tabulations.

Definition at line 619 of file Matrix_SymPacked.cxx.

template<class T , class Prop , class Storage , class Allocator >
void Seldon::Matrix_SymPacked< T, Prop, Storage, Allocator >::Print ( int  a,
int  b,
int  m,
int  n 
) const

Displays a sub-matrix on the standard output.

The sub-matrix is defined by its upper-left corner (a, b) and its bottom-right corner (m, n). So, elements with indices in [a, m] x [b, n] are displayed on the standard output, in text format. Each row is displayed on a single line and elements of a row are delimited by tabulations.

Parameters:
a row index of the upper-left corner.
b column index of the upper-left corner.
m row index of the bottom-right corner.
n column index of the bottom-right corner.

Definition at line 644 of file Matrix_SymPacked.cxx.

template<class T , class Prop , class Storage , class Allocator >
void Seldon::Matrix_SymPacked< T, Prop, Storage, Allocator >::Print ( int  l  )  const

Displays a square sub-matrix on the standard output.

The sub-matrix is defined by its bottom-right corner (l, l). So, elements with indices in [0, 0] x [l, l] are displayed on the standard output, in text format. Each row is displayed on a single line and elements of a row are delimited by tabulations.

Parameters:
l dimension of the square matrix to be displayed.

Definition at line 665 of file Matrix_SymPacked.cxx.

template<class T , class Prop , class Storage , class Allocator >
void Seldon::Matrix_SymPacked< T, Prop, Storage, Allocator >::Read ( istream &  FileStream  ) 

Reads the matrix from an input stream.

Reads a matrix in binary format from an input stream. The number of rows (integer) and the number of columns (integer) are read, and matrix elements are then read in the same order as it should be in memory (e.g. row-major storage).

Parameters:
FileStream input stream.

Definition at line 847 of file Matrix_SymPacked.cxx.

template<class T , class Prop , class Storage , class Allocator >
void Seldon::Matrix_SymPacked< T, Prop, Storage, Allocator >::Read ( string  FileName  ) 

Reads the matrix from a file.

Reads a matrix stored in binary format in a file. The number of rows (integer) and the number of columns (integer) are read, and matrix elements are then read in the same order as it should be in memory (e.g. row-major storage).

Parameters:
FileName input file name.

Definition at line 819 of file Matrix_SymPacked.cxx.

template<class T , class Prop , class Storage , class Allocator >
void Seldon::Matrix_SymPacked< T, Prop, Storage, Allocator >::ReadText ( istream &  FileStream  ) 

Reads the matrix from an input stream.

Reads a matrix in text format from an input stream.

Parameters:
FileStream input stream.

Definition at line 907 of file Matrix_SymPacked.cxx.

template<class T , class Prop , class Storage , class Allocator >
void Seldon::Matrix_SymPacked< T, Prop, Storage, Allocator >::ReadText ( string  FileName  ) 

Reads the matrix from a file.

Reads a matrix stored in text format in a file.

Parameters:
FileName input file name.

Definition at line 882 of file Matrix_SymPacked.cxx.

template<class T , class Prop , class Storage , class Allocator >
void Seldon::Matrix_SymPacked< T, Prop, Storage, Allocator >::Reallocate ( int  i,
int  j 
) [inline]

Reallocates memory to resize the matrix.

On exit, the matrix is a i x j matrix.

Parameters:
i new number of rows.
j new number of columns.
Warning:
Depending on your allocator, data may be lost.

Definition at line 173 of file Matrix_SymPacked.cxx.

template<class T, class Prop , class Storage , class Allocator >
void Seldon::Matrix_SymPacked< T, Prop, Storage, Allocator >::Set ( int  i,
int  j,
const T &  x 
) [inline]

Sets an element of the matrix.

Parameters:
i row index.
j column index.
x new value for the matrix element (i, j).

Definition at line 506 of file Matrix_SymPacked.cxx.

template<class T , class Prop , class Storage , class Allocator >
Matrix_SymPacked< T, Prop, Storage, Allocator >::reference Seldon::Matrix_SymPacked< T, Prop, Storage, Allocator >::Val ( int  i,
int  j 
) [inline]

Direct access method.

This method allows access to elements stored in memory, i.e. elements from the upper part. i <= j must be satisfied.

Parameters:
i row index.
j column index.
Returns:
The value of the matrix at (i, j).

Definition at line 344 of file Matrix_SymPacked.cxx.

template<class T , class Prop , class Storage , class Allocator >
Matrix_SymPacked< T, Prop, Storage, Allocator >::const_reference Seldon::Matrix_SymPacked< T, Prop, Storage, Allocator >::Val ( int  i,
int  j 
) const [inline]

Direct access method.

This method allows access to elements stored in memory, i.e. elements from the upper part. i <= j must be satisfied.

Parameters:
i row index.
j column index.
Returns:
The value of the matrix at (i, j).

Definition at line 379 of file Matrix_SymPacked.cxx.

template<class T , class Prop , class Storage , class Allocator >
void Seldon::Matrix_SymPacked< T, Prop, Storage, Allocator >::Write ( string  FileName  )  const

Writes the matrix in a file.

Stores the matrix in a file in binary format. The number of rows (integer) and the number of columns (integer) are written, and matrix elements are then written in the same order as in memory (e.g. row-major storage).

Parameters:
FileName output file name.

Definition at line 686 of file Matrix_SymPacked.cxx.

template<class T , class Prop , class Storage , class Allocator >
void Seldon::Matrix_SymPacked< T, Prop, Storage, Allocator >::Write ( ostream &  FileStream  )  const

Writes the matrix to an output stream.

Writes the matrix to an output stream in binary format. The number of rows (integer) and the number of columns (integer) are written, and matrix elements are then written in the same order as in memory (e.g. row-major storage).

Parameters:
FileStream output stream.

Definition at line 714 of file Matrix_SymPacked.cxx.

template<class T , class Prop , class Storage , class Allocator >
void Seldon::Matrix_SymPacked< T, Prop, Storage, Allocator >::WriteText ( ostream &  FileStream  )  const

Writes the matrix to an output stream.

Writes the matrix to an output stream in text format. Only matrix elements are written (not dimensions). Each row is written on a single line and elements of a row are delimited by tabulations.

Parameters:
FileStream output stream.

Definition at line 782 of file Matrix_SymPacked.cxx.

template<class T , class Prop , class Storage , class Allocator >
void Seldon::Matrix_SymPacked< T, Prop, Storage, Allocator >::WriteText ( string  FileName  )  const

Writes the matrix in a file.

Stores the matrix in a file in text format. Only matrix elements are written (not dimensions). Each row is written on a single line and elements of a row are delimited by tabulations.

Parameters:
FileName output file name.

Definition at line 752 of file Matrix_SymPacked.cxx.

template<class T , class Prop , class Storage , class Allocator >
void Seldon::Matrix_SymPacked< T, Prop, Storage, Allocator >::Zero (  ) 

Sets all elements to zero.

Warning:
It fills the memory with zeros. If the matrix stores complex structures, use 'Fill' instead.

Definition at line 539 of file Matrix_SymPacked.cxx.

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