base class for a banded-matrix More...

#include <BandMatrix.hxx>

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

Public Types
typedef T	entry_type

Public Member Functions
	Matrix_Band ()
	default constructor

int	GetKL () const
	returns the number of extra-diagonals in lower part of the matrix

int	GetKU () const
	returns the number of extra-diagonals in upper part of the matrix

int	GetM () const
	returns the number of rows

int	GetN () const
	returns the number of rows

long	GetDataSize () const
	returns the number of elements stored in the matrix

size_t	GetMemorySize () const
	returns the memory used by the object in bytes

void	Clear ()
	clears the matrix

void	Zero ()
	fills non-zero entries with 0

void	HideMessages ()
	present for compatibility

void	Reallocate (int m, int n)
	changes the size of the matrix, previous entries are lost

void	Reallocate (int m, int n, int kl, int ku)
	changes the size of the matrix, previous entries are lost

T *	GetData () const
	returns a pointer to the array containing values

void	AddInteraction (int i, int j, const T &val)
	sets A(i, j) = A(i, j) + val

void	AddInteractionRow (int i, int n, const IVect &num, const Vector< T > &val, bool sorted=false)
	adds severals values on a single row of the matrix More...

void	ClearRow (int i)
	clears row i, fills it with 0 More...

const T	operator() (int i, int j) const
	returns entry (i, j) of the matrix

Matrix< T, Prop, Storage, Allocator > &	operator*= (const T &alpha)
	multiplication by a scalar

T &	Get (int i, int j)
	returns a reference to A(i, j)

const T &	Get (int i, int j) const
	returns a reference to A(i, j)

T &	Val (int i, int j)
	returns a reference to A(i, j)

const T &	Val (int i, int j) const
	returns a reference to A(i, j)

void	Set (int, int, const T &)
	sets A(i, j)

void	SetEntry (int, int, const T &)
	sets A(i, j)

void	SetIdentity ()
	sets the matrix to the identity matrix

template<class T0 >
void	Fill (const T0 &x)
	sets all non-zero entries to a same value

void	FillRand ()
	sets all non-zero entries to random values

void	Copy (const Matrix< T, General, ArrayRowSparse > &A)
	conversion from a CSR matrix

void	Factorize ()
	performs LU factorisation without pivoting

void	Factorize (IVect &)
	performs LU factorisation with pivoting

template<class T0 >
void	Add_ (const T0 &alpha, const Matrix< T, General, BandedCol, Allocator > &A)
	performs the operation this = this + alpha A

template<class T0 , class T1 >
void	MltAdd (const T0 &alpha, const SeldonTranspose &trans, const Vector< T1 > &x, Vector< T1 > &y) const
	performs matrix-vector product y = y + alpha A x

template<class T1 >
void	Solve (Vector< T1 > &x) const
	solves A x = b, assuming that Factorize has been previously called

template<class T1 >
void	Solve (const IVect &, Vector< T1 > &x) const

void	Write (string FileName) const
	writes the matrix in a file in binary format

void	Write (ostream &FileStream) const
	writes the matrix in binary format

void	WriteText (string FileName) const
	writes the matrix in a file in text format

void	WriteText (ostream &FileStream) const
	writes the matrix in text format

template<class T1 >
void	Solve (const Vector< int > &ipivot, Vector< T1 > &x) const
	solves A x = b, assuming that Factorize has been previously called (with pivoting)

int	GetM (const Seldon::SeldonTranspose &status) const
	Returns the number of rows of the matrix possibly transposed. More...

int	GetM (const CBLAS_TRANSPOSE &status) const
	Returns the number of rows of the matrix possibly transposed. More...

int	GetN (const Seldon::SeldonTranspose &status) const
	Returns the number of columns of the matrix possibly transposed. More...

int	GetN (const CBLAS_TRANSPOSE &status) const
	Returns the number of columns of the matrix possibly transposed. More...

long	GetSize () const
	Returns the number of elements in the matrix. More...

Protected Attributes
int	kl_
	number of extra-diagonals in lower part

int	ku_
	number of extra-diagonals in upper part

Matrix< T, General, ColMajor, Allocator >	data_
	values are stored in a dense matrix (in Lapack format)

int	m_

int	n_

Detailed Description

template<class T, class Prop, class Storage, class Allocator = typename SeldonDefaultAllocator<Storage, T>::allocator>
class Seldon::Matrix_Band< T, Prop, Storage, Allocator >

base class for a banded-matrix

Definition at line 36 of file BandMatrix.hxx.

Member Function Documentation

◆ AddInteractionRow()

template<class T , class Prop , class Storage , class Allocator >

void Seldon::Matrix_Band< T, Prop, Storage, Allocator >::AddInteractionRow	(	int	i,
		int	n,
		const IVect &	num,
		const Vector< T > &	val,
		bool	sorted = `false`
	)

adds severals values on a single row of the matrix

Parameters

[in]	i	row on which values are added
[in]	n	number of values to add
[in]	num	column numbers
[in]	val	values

Definition at line 94 of file BandMatrix.cxx.

◆ ClearRow()

template<class T , class Prop , class Storage , class Allocator >

void Seldon::Matrix_Band< T, Prop, Storage, Allocator >::ClearRow ( int i )

clears row i, fills it with 0

Parameters

[in] i row to clear

Definition at line 107 of file BandMatrix.cxx.

◆ GetM() [1/2]

template<class T >

int Seldon::VirtualMatrix< T >::GetM ( const CBLAS_TRANSPOSE & status ) const

inlineinherited

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.

Definition at line 122 of file Matrix_BaseInline.cxx.

◆ GetM() [2/2]

template<class T >

int Seldon::VirtualMatrix< T >::GetM ( const Seldon::SeldonTranspose & status ) const

inlineinherited

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.

Definition at line 92 of file Matrix_BaseInline.cxx.

◆ GetN() [1/2]

template<class T >

int Seldon::VirtualMatrix< T >::GetN ( const CBLAS_TRANSPOSE & status ) const

inlineinherited

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.

Definition at line 137 of file Matrix_BaseInline.cxx.

◆ GetN() [2/2]

template<class T >

int Seldon::VirtualMatrix< T >::GetN ( const Seldon::SeldonTranspose & status ) const

inlineinherited

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.

Definition at line 107 of file Matrix_BaseInline.cxx.

◆ GetSize()

template<class T >

long Seldon::VirtualMatrix< T >::GetSize

inlineinherited

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.

Definition at line 153 of file Matrix_BaseInline.cxx.

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

matrix_sparse/BandMatrix.hxx
lib/Compil/Seldon/BandMatrix.cpp
matrix_sparse/BandMatrix.cxx
matrix_sparse/BandMatrixInline.cxx

Public Types

Public Member Functions

Protected Attributes

Detailed Description

template<class T, class Prop, class Storage, class Allocator = typename SeldonDefaultAllocator<Storage, T>::allocator> class Seldon::Matrix_Band< T, Prop, Storage, Allocator >

Member Function Documentation

◆ AddInteractionRow()

◆ ClearRow()

◆ GetM() [1/2]

◆ GetM() [2/2]

◆ GetN() [1/2]

◆ GetN() [2/2]

◆ GetSize()

template<class T, class Prop, class Storage, class Allocator = typename SeldonDefaultAllocator<Storage, T>::allocator>
class Seldon::Matrix_Band< T, Prop, Storage, Allocator >