Public Types | Public Member Functions | Protected Attributes | List of all members
Seldon::Matrix_ComplexSparse< T, Prop, Storage, Allocator > Class Template Reference

Complex sparse-matrix class. More...

#include <Matrix_ComplexSparse.hxx>

Inheritance diagram for Seldon::Matrix_ComplexSparse< T, Prop, Storage, Allocator >:
Seldon::Matrix_Base< T, typename SeldonDefaultAllocator< Storage, T >::allocator > Seldon::VirtualMatrix< T >

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 SeldonDefaultAllocator< VectFull, int >::allocator AllocatorInt
 
typedef SeldonDefaultAllocator< VectFull, long >::allocator AllocatorLong
 
typedef complex< value_type > entry_type
 
typedef complex< value_type > access_type
 
typedef complex< value_type > const_access_type
 

Public Member Functions

 Matrix_ComplexSparse ()
 Default constructor. More...
 
 Matrix_ComplexSparse (int i, int j)
 Constructor. More...
 
 Matrix_ComplexSparse (int i, int j, long real_nz, long imag_nz)
 Constructor. More...
 
template<class Storage0 , class Allocator0 , class Storage1 , class Allocator1 , class Storage2 , class Allocator2 >
 Matrix_ComplexSparse (int i, int j, Vector< value_type, Storage0, Allocator0 > &real_values, Vector< long, Storage1, Allocator1 > &real_ptr, Vector< int, Storage2, Allocator2 > &real_ind, Vector< value_type, Storage0, Allocator0 > &imag_values, Vector< long, Storage1, Allocator1 > &imag_ptr, Vector< int, Storage2, Allocator2 > &imag_ind)
 Constructor. More...
 
 Matrix_ComplexSparse (const Matrix_ComplexSparse< T, Prop, Storage, Allocator > &A)
 Copy constructor.
 
 ~Matrix_ComplexSparse ()
 Destructor.
 
void Clear ()
 Clears the matrix. More...
 
template<class Storage0 , class Allocator0 , class Storage1 , class Allocator1 , class Storage2 , class Allocator2 >
void SetData (int i, int j, Vector< value_type, Storage0, Allocator0 > &real_values, Vector< long, Storage1, Allocator1 > &real_ptr, Vector< int, Storage2, Allocator2 > &real_ind, Vector< value_type, Storage0, Allocator0 > &imag_values, Vector< long, Storage1, Allocator1 > &imag_ptr, Vector< int, Storage2, Allocator2 > &imag_ind)
 Redefines the matrix. More...
 
void SetData (int i, int j, long real_nz, pointer real_values, long *real_ptr, int *real_ind, long imag_nz, pointer imag_values, long *imag_ptr, int *imag_ind)
 
void Nullify ()
 Clears the matrix without releasing memory. More...
 
void Reallocate (int i, int j)
 Initialization of an empty matrix i x j.
 
void Reallocate (int i, int j, long real_nz, long imag_nz)
 Initialization of a matrix i x j with n non-zero entries.
 
void Resize (int i, int j)
 Changing the number of rows and columns. More...
 
void Resize (int i, int j, long real_nz, long imag_nz)
 Changing the number of rows, columns and non-zero entries. More...
 
void Copy (const Matrix_ComplexSparse< T, Prop, Storage, Allocator > &A)
 Copies a matrix.
 
long GetNonZeros () const
 Returns the number of elements stored in memory. More...
 
long GetDataSize () const
 Returns the number of elements stored in memory. More...
 
size_t GetMemorySize () const
 returns size of A in bytes used to store the matrix
 
long * GetRealPtr () const
 Returns (row or column) start indices for the real part. More...
 
long * GetImagPtr () const
 Returns (row or column) start indices for the imaginary part. More...
 
int * GetRealInd () const
 Returns (row or column) indices of non-zero entries for the real part. More...
 
int * GetImagInd () const
 Returns (row or column) indices of non-zero entries for the imaginary part. More...
 
int GetRealPtrSize () const
 Returns the length of the array of start indices for the real part. More...
 
int GetImagPtrSize () const
 Returns the length of the array of start indices for the imaginary part. More...
 
long GetRealIndSize () const
 Returns the length of the array of (column or row) indices for the real part. More...
 
long GetImagIndSize () const
 Returns the length of the array of (column or row) indices for the imaginary part. More...
 
long GetRealDataSize () const
 Returns the length of the array of (column or row) indices for the real part. More...
 
long GetImagDataSize () const
 Returns the length of the array of (column or row) indices for the imaginary part. More...
 
value_type * GetRealData () const
 Returns the array of values of the real part. More...
 
value_type * GetImagData () const
 Returns the array of values of the imaginary part. More...
 
const entry_type operator() (int i, int j) const
 Access operator. More...
 
value_type & ValReal (int i, int j)
 Access method. More...
 
const value_type & ValReal (int i, int j) const
 Access method. More...
 
value_type & ValImag (int i, int j)
 Access method. More...
 
const value_type & ValImag (int i, int j) const
 Access method. More...
 
value_type & GetReal (int i, int j)
 Access method. More...
 
const value_type & GetReal (int i, int j) const
 Access method. More...
 
value_type & GetImag (int i, int j)
 Access method. More...
 
const value_type & GetImag (int i, int j) const
 Access method. More...
 
void Set (int i, int j, const entry_type &x)
 Sets an element (i, j) to a value. More...
 
void AddInteraction (int i, int j, const entry_type &x)
 Add a value to a non-zero entry. More...
 
void AddInteractionRow (int i, int nb, const IVect &col, const Vector< entry_type > &val, bool sorted=false)
 Adds values to several non-zero entries on a given row.
 
Matrix_ComplexSparse< T, Prop, Storage, Allocator > & operator= (const Matrix_ComplexSparse< T, Prop, Storage, Allocator > &A)
 Duplicates a matrix (assignment operator). More...
 
void Zero ()
 Resets all non-zero entries to 0-value. More...
 
void SetIdentity ()
 Sets the matrix to identity. More...
 
void Fill ()
 Fills the non-zero entries with 0, 1, 2, ... More...
 
void Fill (const entry_type &x)
 Fills the non-zero entries with a given value. More...
 
void FillRand ()
 Fills the non-zero entries randomly. More...
 
void Print () const
 Displays the matrix on the standard output. More...
 
void Write (string FileName) const
 Writes the matrix in a file. More...
 
void Write (ostream &FileStream) const
 Writes the matrix to an output stream. More...
 
void WriteText (string FileName, bool cplx=false) const
 Writes the matrix in a file. More...
 
void WriteText (ostream &FileStream, bool cplx=false) const
 Writes the matrix to an output stream. More...
 
void Read (string FileName)
 Reads the matrix from a file. More...
 
void Read (istream &FileStream)
 Reads the matrix from an input stream. More...
 
void ReadText (string FileName, bool cplx=false)
 Reads the matrix from a file. More...
 
void ReadText (istream &FileStream, bool cplx=false)
 Reads the matrix from an input stream. More...
 
template<class T , class Prop , class Storage , class Allocator >
void SetData (int i, int j, long real_nz, typename Matrix_ComplexSparse< T, Prop, Storage, Allocator > ::pointer real_values, long *real_ptr, int *real_ind, long imag_nz, typename Matrix_ComplexSparse< T, Prop, Storage, Allocator > ::pointer imag_values, long *imag_ptr, int *imag_ind)
 Redefines the matrix. More...
 
pointer GetData () const
 Returns a pointer to the data array. More...
 
const_pointer GetDataConst () const
 Returns a const pointer to the data array. More...
 
void * GetDataVoid () const
 Returns a pointer of type "void*" to the data array. More...
 
const void * GetDataConstVoid () const
 Returns a pointer of type "const void*" to the data array. More...
 
int GetM () const
 Returns the number of rows. More...
 
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
 Returns the number of columns. 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

long real_nz_
 
long imag_nz_
 
long * real_ptr_
 
long * imag_ptr_
 
int * real_ind_
 
int * imag_ind_
 
value_type * real_data_
 
value_type * imag_data_
 
pointer data_
 
int m_
 
int n_
 

Detailed Description

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

Complex sparse-matrix class.

Sparse matrices are defined by: (1) the number of rows and columns; (2) the number of non-zero entries; (3) an array 'ptr_' of start indices (i.e. indices of the first element of each row or column, depending on the storage); (4) an array 'ind_' of column or row indices of each non-zero entry; (5) values of non-zero entries.

Complex sparse matrices are defined in the same way except that real and imaginary parts are splitted. It is as if two matrices were stored. There are therefore 6 arrays: 'real_ptr_', 'real_ind_', 'real_data_', 'imag_ptr_', 'imag_ind_' and 'imag_data_'.

Definition at line 112 of file Matrix_ComplexSparse.hxx.

Constructor & Destructor Documentation

◆ Matrix_ComplexSparse() [1/4]

template<class T , class Prop , class Storage , class Allocator >
Seldon::Matrix_ComplexSparse< T, Prop, Storage, Allocator >::Matrix_ComplexSparse

Default constructor.

Builds an empty 0x0 matrix.

Definition at line 40 of file Matrix_ComplexSparse.cxx.

◆ Matrix_ComplexSparse() [2/4]

template<class T , class Prop , class Storage , class Allocator >
Seldon::Matrix_ComplexSparse< T, Prop, Storage, Allocator >::Matrix_ComplexSparse ( int  i,
int  j 
)
explicit

Constructor.

Builds a i by j sparse matrix.

Parameters
inumber of rows.
jnumber of columns.

Definition at line 61 of file Matrix_ComplexSparse.cxx.

◆ Matrix_ComplexSparse() [3/4]

template<class T , class Prop , class Storage , class Allocator >
Seldon::Matrix_ComplexSparse< T, Prop, Storage, Allocator >::Matrix_ComplexSparse ( int  i,
int  j,
long  real_nz,
long  imag_nz 
)

Constructor.

Builds a sparse matrix of size i by j , with real_nz non-zero elements in the real part of the matrix and imag_nz non-zero elements in the imaginary part of the matrix.

Parameters
inumber of rows.
jnumber of columns.
real_nznumber of non-zero elements in the real part.
imag_nznumber of non-zero elements in the imaginary part.
Note
Matrix values are not initialized. Indices of non-zero entries are not initialized either.

Definition at line 89 of file Matrix_ComplexSparse.cxx.

◆ Matrix_ComplexSparse() [4/4]

template<class T , class Prop , class Storage , class Allocator >
template<class Storage0 , class Allocator0 , class Storage1 , class Allocator1 , class Storage2 , class Allocator2 >
Seldon::Matrix_ComplexSparse< T, Prop, Storage, Allocator >::Matrix_ComplexSparse ( int  i,
int  j,
Vector< value_type, Storage0, Allocator0 > &  real_values,
Vector< long, Storage1, Allocator1 > &  real_ptr,
Vector< int, Storage2, Allocator2 > &  real_ind,
Vector< value_type, Storage0, Allocator0 > &  imag_values,
Vector< long, Storage1, Allocator1 > &  imag_ptr,
Vector< int, Storage2, Allocator2 > &  imag_ind 
)

Constructor.

Builds a i by j sparse matrix with non-zero values and indices provided by 'real_values' (values of the real part), 'real_ptr' (pointers for the real part), 'real_ind' (indices for the real part), 'imag_values' (values of the imaginary part), 'imag_ptr' (pointers for the imaginary part) and 'imag_ind' (indices for the imaginary part). Input vectors are released and are empty on exit.

Parameters
inumber of rows.
jnumber of columns.
real_valuesvalues of non-zero entries for the real part.
real_ptrrow or column start indices for the real part.
real_indrow or column indices for the real part.
imag_valuesvalues of non-zero entries for the imaginary part.
imag_ptrrow or column start indices for the imaginary part.
imag_indrow or column indices for the imaginary part.
Warning
Input vectors 'real_values', 'real_ptr' and 'real_ind', 'imag_values', 'imag_ptr' and 'imag_ind' are empty on exit.

Definition at line 129 of file Matrix_ComplexSparse.cxx.

Member Function Documentation

◆ AddInteraction()

template<class T , class Prop , class Storage , class Allocator >
void Seldon::Matrix_ComplexSparse< T, Prop, Storage, Allocator >::AddInteraction ( int  i,
int  j,
const entry_type &  val 
)
inline

Add a value to a non-zero entry.

This function adds val to the element (i, j), provided that this element is already a non-zero entry. Otherwise a non-zero entry is inserted equal to val.

Parameters
[in]irow index.
[in]jcolumn index.
[in]valvalue to be added to the element (i, j).

Definition at line 303 of file Matrix_ComplexSparseInline.cxx.

◆ Clear()

template<class T , class Prop , class Storage , class Allocator >
void Seldon::Matrix_ComplexSparse< T, Prop, Storage, Allocator >::Clear

Clears the matrix.

This methods is equivalent to the destructor. On exit, the matrix is empty (0x0).

Definition at line 316 of file Matrix_ComplexSparse.cxx.

◆ Fill() [1/2]

template<class T , class Prop , class Storage , class Allocator >
void Seldon::Matrix_ComplexSparse< T, Prop, Storage, Allocator >::Fill

Fills the non-zero entries with 0, 1, 2, ...

On exit, the non-zero entries are 0, 1, 2, 3, ... The order of the numbers depends on the storage.

Definition at line 2370 of file Matrix_ComplexSparse.cxx.

◆ Fill() [2/2]

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

Fills the non-zero entries with a given value.

Parameters
xthe value to set the non-zero entries to.

Definition at line 2386 of file Matrix_ComplexSparse.cxx.

◆ FillRand()

template<class T , class Prop , class Storage , class Allocator >
void Seldon::Matrix_ComplexSparse< T, Prop, Storage, Allocator >::FillRand

Fills the non-zero entries randomly.

Note
The random generator is very basic.

Definition at line 2401 of file Matrix_ComplexSparse.cxx.

◆ GetData()

Matrix_Base< T, typename SeldonDefaultAllocator< Storage, T >::allocator >::pointer Seldon::Matrix_Base< T, typename SeldonDefaultAllocator< Storage, T >::allocator >::GetData
inlineinherited

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 241 of file Matrix_BaseInline.cxx.

◆ GetDataConst()

Matrix_Base< T, typename SeldonDefaultAllocator< Storage, T >::allocator >::const_pointer Seldon::Matrix_Base< T, typename SeldonDefaultAllocator< Storage, T >::allocator >::GetDataConst
inlineinherited

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 254 of file Matrix_BaseInline.cxx.

◆ GetDataConstVoid()

const void * Seldon::Matrix_Base< T, typename SeldonDefaultAllocator< Storage, T >::allocator >::GetDataConstVoid
inlineinherited

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 280 of file Matrix_BaseInline.cxx.

◆ GetDataSize()

template<class T , class Prop , class Storage , class Allocator >
long Seldon::Matrix_ComplexSparse< T, Prop, Storage, Allocator >::GetDataSize
inline

Returns the number of elements stored in memory.

Returns the number of elements stored in memory, i.e. the cumulated number of non-zero entries of both the real and the imaginary part.

Returns
The number of elements stored in memory.

Definition at line 69 of file Matrix_ComplexSparseInline.cxx.

◆ GetDataVoid()

void * Seldon::Matrix_Base< T, typename SeldonDefaultAllocator< Storage, T >::allocator >::GetDataVoid
inlineinherited

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 267 of file Matrix_BaseInline.cxx.

◆ GetImag() [1/2]

template<class T , class Prop , class Storage , class Allocator >
Matrix_ComplexSparse< T, Prop, Storage, Allocator >::value_type & Seldon::Matrix_ComplexSparse< T, Prop, Storage, Allocator >::GetImag ( int  i,
int  j 
)

Access method.

Returns the imaginary part of element (i, j) if it can be returned as a reference. If the non-zero entry does not exit, it is created

Parameters
[in]irow index.
[in]jcolumn index.
Returns
Element (i, j) of the matrix.

Definition at line 2255 of file Matrix_ComplexSparse.cxx.

◆ GetImag() [2/2]

template<class T , class Prop , class Storage , class Allocator >
const Matrix_ComplexSparse< T, Prop, Storage, Allocator >::value_type & Seldon::Matrix_ComplexSparse< T, Prop, Storage, Allocator >::GetImag ( int  i,
int  j 
) const
inline

Access method.

Returns the imaginary part of element (i, j) if it can be returned as a reference. If the non-zero entry does not exit, it is created

Parameters
[in]irow index.
[in]jcolumn index.
Returns
Element (i, j) of the matrix.

Definition at line 287 of file Matrix_ComplexSparseInline.cxx.

◆ GetImagData()

template<class T , class Prop , class Storage , class Allocator >
Allocator::value_type * Seldon::Matrix_ComplexSparse< T, Prop, Storage, Allocator >::GetImagData
inline

Returns the array of values of the imaginary part.

Returns
The array 'imag_data_' of values of the imaginary part..

Definition at line 248 of file Matrix_ComplexSparseInline.cxx.

◆ GetImagDataSize()

template<class T , class Prop , class Storage , class Allocator >
long Seldon::Matrix_ComplexSparse< T, Prop, Storage, Allocator >::GetImagDataSize
inline

Returns the length of the array of (column or row) indices for the imaginary part.

Returns the length of the array ('ind_') of (row or column) indices of non-zero entries for the imaginary part. This array defines non-zero entries indices if coupled with (column or row) start indices.

Returns
The length of the array of (column or row) indices for the imaginary part.
Note
The length of the array of (column or row) indices is the number of non-zero entries.

Definition at line 224 of file Matrix_ComplexSparseInline.cxx.

◆ GetImagInd()

template<class T , class Prop , class Storage , class Allocator >
int * Seldon::Matrix_ComplexSparse< T, Prop, Storage, Allocator >::GetImagInd
inline

Returns (row or column) indices of non-zero entries for the imaginary part.

Returns the array ('ind_') of (row or column) indices of non-zero entries for the imaginary part. This array defines non-zero entries indices if coupled with (column or row) start indices.

Returns
The array of (row or column) indices of non-zero entries for the imaginary part.

Definition at line 124 of file Matrix_ComplexSparseInline.cxx.

◆ GetImagIndSize()

template<class T , class Prop , class Storage , class Allocator >
long Seldon::Matrix_ComplexSparse< T, Prop, Storage, Allocator >::GetImagIndSize
inline

Returns the length of the array of (column or row) indices for the imaginary part.

Returns the length of the array ('ind_') of (row or column) indices of non-zero entries for the imaginary part. This array defines non-zero entries indices if coupled with (column or row) start indices.

Returns
The length of the array of (column or row) indices for the imaginary part.
Note
The length of the array of (column or row) indices is the number of non-zero entries.

Definition at line 186 of file Matrix_ComplexSparseInline.cxx.

◆ GetImagPtr()

template<class T , class Prop , class Storage , class Allocator >
long * Seldon::Matrix_ComplexSparse< T, Prop, Storage, Allocator >::GetImagPtr
inline

Returns (row or column) start indices for the imaginary part.

Returns the array ('ptr_') of start indices for the imaginary part.

Returns
The array of start indices for the imaginary part.

Definition at line 93 of file Matrix_ComplexSparseInline.cxx.

◆ GetImagPtrSize()

template<class T , class Prop , class Storage , class Allocator >
int Seldon::Matrix_ComplexSparse< T, Prop, Storage, Allocator >::GetImagPtrSize
inline

Returns the length of the array of start indices for the imaginary part.

Returns
The length of the array of start indices for the imaginary part.

Definition at line 148 of file Matrix_ComplexSparseInline.cxx.

◆ GetM() [1/3]

template<class T >
int Seldon::VirtualMatrix< T >::GetM
inlineinherited

Returns the number of rows.

Returns
The number of rows.

Definition at line 69 of file Matrix_BaseInline.cxx.

◆ GetM() [2/3]

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
statusassumed 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() [3/3]

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
statusassumed 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/3]

template<class T >
int Seldon::VirtualMatrix< T >::GetN
inlineinherited

Returns the number of columns.

Returns
The number of columns.

Definition at line 80 of file Matrix_BaseInline.cxx.

◆ GetN() [2/3]

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
statusassumed 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() [3/3]

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
statusassumed 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.

◆ GetNonZeros()

template<class T , class Prop , class Storage , class Allocator >
long Seldon::Matrix_ComplexSparse< T, Prop, Storage, Allocator >::GetNonZeros
inline

Returns the number of elements stored in memory.

Returns the number of elements stored in memory, i.e. the cumulated number of non-zero entries of both the real and the imaginary part.

Returns
The number of elements stored in memory.

Definition at line 55 of file Matrix_ComplexSparseInline.cxx.

◆ GetReal() [1/2]

template<class T , class Prop , class Storage , class Allocator >
Matrix_ComplexSparse< T, Prop, Storage, Allocator >::value_type & Seldon::Matrix_ComplexSparse< T, Prop, Storage, Allocator >::GetReal ( int  i,
int  j 
)

Access method.

Returns the real part of element (i, j) if it can be returned as a reference. If the non-zero entry does not exit, it is created

Parameters
[in]irow index.
[in]jcolumn index.
Returns
Element (i, j) of the matrix.

Definition at line 2190 of file Matrix_ComplexSparse.cxx.

◆ GetReal() [2/2]

template<class T , class Prop , class Storage , class Allocator >
const Matrix_ComplexSparse< T, Prop, Storage, Allocator >::value_type & Seldon::Matrix_ComplexSparse< T, Prop, Storage, Allocator >::GetReal ( int  i,
int  j 
) const
inline

Access method.

Returns the real part of element (i, j) if it can be returned as a reference. If the non-zero entry does not exit, it is created

Parameters
[in]irow index.
[in]jcolumn index.
Returns
Element (i, j) of the matrix.

Definition at line 270 of file Matrix_ComplexSparseInline.cxx.

◆ GetRealData()

template<class T , class Prop , class Storage , class Allocator >
Allocator::value_type * Seldon::Matrix_ComplexSparse< T, Prop, Storage, Allocator >::GetRealData
inline

Returns the array of values of the real part.

Returns
The array 'real_data_' of values of the real part..

Definition at line 236 of file Matrix_ComplexSparseInline.cxx.

◆ GetRealDataSize()

template<class T , class Prop , class Storage , class Allocator >
long Seldon::Matrix_ComplexSparse< T, Prop, Storage, Allocator >::GetRealDataSize
inline

Returns the length of the array of (column or row) indices for the real part.

Returns the length of the array ('ind_') of (row or column) indices of non-zero entries for the real part. This array defines non-zero entries indices if coupled with (column or row) start indices.

Returns
The length of the array of (column or row) indices for the real part.
Note
The length of the array of (column or row) indices is the number of non-zero entries.

Definition at line 205 of file Matrix_ComplexSparseInline.cxx.

◆ GetRealInd()

template<class T , class Prop , class Storage , class Allocator >
int * Seldon::Matrix_ComplexSparse< T, Prop, Storage, Allocator >::GetRealInd
inline

Returns (row or column) indices of non-zero entries for the real part.

Returns the array ('ind_') of (row or column) indices of non-zero entries for the real part. This array defines non-zero entries indices if coupled with (column or row) start indices.

Returns
The array of (row or column) indices of non-zero entries for the real part.

Definition at line 108 of file Matrix_ComplexSparseInline.cxx.

◆ GetRealIndSize()

template<class T , class Prop , class Storage , class Allocator >
long Seldon::Matrix_ComplexSparse< T, Prop, Storage, Allocator >::GetRealIndSize
inline

Returns the length of the array of (column or row) indices for the real part.

Returns the length of the array ('ind_') of (row or column) indices of non-zero entries for the real part. This array defines non-zero entries indices if coupled with (column or row) start indices.

Returns
The length of the array of (column or row) indices for the real part.
Note
The length of the array of (column or row) indices is the number of non-zero entries.

Definition at line 167 of file Matrix_ComplexSparseInline.cxx.

◆ GetRealPtr()

template<class T , class Prop , class Storage , class Allocator >
long * Seldon::Matrix_ComplexSparse< T, Prop, Storage, Allocator >::GetRealPtr
inline

Returns (row or column) start indices for the real part.

Returns the array ('ptr_') of start indices for the real part.

Returns
The array of start indices for the real part.

Definition at line 81 of file Matrix_ComplexSparseInline.cxx.

◆ GetRealPtrSize()

template<class T , class Prop , class Storage , class Allocator >
int Seldon::Matrix_ComplexSparse< T, Prop, Storage, Allocator >::GetRealPtrSize
inline

Returns the length of the array of start indices for the real part.

Returns
The length of the array of start indices for the real part.

Definition at line 136 of file Matrix_ComplexSparseInline.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.

◆ Nullify()

template<class T , class Prop , class Storage , class Allocator >
void Seldon::Matrix_ComplexSparse< T, Prop, Storage, Allocator >::Nullify

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 698 of file Matrix_ComplexSparse.cxx.

◆ operator()()

template<class T , class Prop , class Storage , class Allocator >
const Matrix_ComplexSparse< T, Prop, Storage, Allocator >::entry_type Seldon::Matrix_ComplexSparse< T, Prop, Storage, Allocator >::operator() ( int  i,
int  j 
) const

Access operator.

Returns the value of element (i, j).

Parameters
irow index.
jcolumn index.
Returns
Element (i, j) of the matrix.

Definition at line 1896 of file Matrix_ComplexSparse.cxx.

◆ operator=()

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

Duplicates a matrix (assignment operator).

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

Definition at line 347 of file Matrix_ComplexSparseInline.cxx.

◆ Print()

template<class T , class Prop , class Storage , class Allocator >
void Seldon::Matrix_ComplexSparse< T, Prop, Storage, Allocator >::Print

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 2421 of file Matrix_ComplexSparse.cxx.

◆ Read() [1/2]

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

Reads the matrix from an input stream.

Reads a matrix in binary format from an input stream.

Parameters
FileStreaminput stream

Definition at line 2588 of file Matrix_ComplexSparse.cxx.

◆ Read() [2/2]

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

Reads the matrix from a file.

Reads a matrix stored in binary format in a file.

Parameters
FileNameinput file name.

Definition at line 2563 of file Matrix_ComplexSparse.cxx.

◆ ReadText() [1/2]

template<class T , class Prop , class Storage , class Allocator >
void Seldon::Matrix_ComplexSparse< T, Prop, Storage, Allocator >::ReadText ( istream &  FileStream,
bool  cplx = false 
)

Reads the matrix from an input stream.

Reads a matrix from a stream in text format.

Parameters
FileStreaminput stream.

Definition at line 2662 of file Matrix_ComplexSparse.cxx.

◆ ReadText() [2/2]

template<class T , class Prop , class Storage , class Allocator >
void Seldon::Matrix_ComplexSparse< T, Prop, Storage, Allocator >::ReadText ( string  FileName,
bool  cplx = false 
)

Reads the matrix from a file.

Reads the matrix from a file in text format.

Parameters
FileNameinput file name.

Definition at line 2637 of file Matrix_ComplexSparse.cxx.

◆ Resize() [1/2]

template<class T , class Prop , class Storage , class Allocator >
void Seldon::Matrix_ComplexSparse< T, Prop, Storage, Allocator >::Resize ( int  i,
int  j 
)

Changing the number of rows and columns.

Parameters
inumber of rows
jnumber of columns

Definition at line 1174 of file Matrix_ComplexSparse.cxx.

◆ Resize() [2/2]

template<class T , class Prop , class Storage , class Allocator >
void Seldon::Matrix_ComplexSparse< T, Prop, Storage, Allocator >::Resize ( int  i,
int  j,
long  real_nz,
long  imag_nz 
)

Changing the number of rows, columns and non-zero entries.

Parameters
inumber of rows
jnumber of columns Previous entries are kept during the operation

Definition at line 1192 of file Matrix_ComplexSparse.cxx.

◆ Set()

template<class T , class Prop , class Storage , class Allocator >
void Seldon::Matrix_ComplexSparse< T, Prop, Storage, Allocator >::Set ( int  i,
int  j,
const entry_type &  val 
)
inline

Sets an element (i, j) to a value.

This function sets val to the element (i, j)

Parameters
[in]irow index.
[in]jcolumn index.
[in]valA(i, j) = val

Definition at line 331 of file Matrix_ComplexSparseInline.cxx.

◆ SetData() [1/2]

template<class T , class Prop , class Storage , class Allocator = typename SeldonDefaultAllocator<Storage, T>::allocator>
template<class T , class Prop , class Storage , class Allocator >
void Seldon::Matrix_ComplexSparse< T, Prop, Storage, Allocator >::SetData ( int  i,
int  j,
long  real_nz,
typename Matrix_ComplexSparse< T, Prop, Storage, Allocator > ::pointer  real_values,
long *  real_ptr,
int *  real_ind,
long  imag_nz,
typename Matrix_ComplexSparse< T, Prop, Storage, Allocator > ::pointer  imag_values,
long *  imag_ptr,
int *  imag_ind 
)

Redefines the matrix.

It clears the matrix and sets it to a new matrix defined by arrays 'real_values' (values of the real part), 'real_ptr' (pointers for the real part), 'real_ind' (indices for the real part), 'imag_values' (values of the imaginary part), 'imag_ptr' (pointers for the imaginary part) and 'imag_ind' (indices for the imaginary part).

Parameters
inumber of rows.
jnumber of columns.
real_nznumber of non-zero entries (real part).
real_valuesvalues of non-zero entries for the real part.
real_ptrrow or column start indices for the real part.
real_indrow or column indices for the real part.
imag_nznumber of non-zero entries (imaginary part).
imag_valuesvalues of non-zero entries for the imaginary part.
imag_ptrrow or column start indices for the imaginary part.
imag_indrow or column indices for the imaginary part.
Warning
On exit, arrays 'real_values', 'real_ptr', 'real_ind', 'imag_values', 'imag_ptr' and 'imag_ind' are managed by the matrix. For example, it means that the destructor will release those arrays; therefore, the user mustn't release those arrays.

Definition at line 667 of file Matrix_ComplexSparse.cxx.

◆ SetData() [2/2]

template<class T , class Prop , class Storage , class Allocator >
template<class Storage0 , class Allocator0 , class Storage1 , class Allocator1 , class Storage2 , class Allocator2 >
void Seldon::Matrix_ComplexSparse< T, Prop, Storage, Allocator >::SetData ( int  i,
int  j,
Vector< value_type, Storage0, Allocator0 > &  real_values,
Vector< long, Storage1, Allocator1 > &  real_ptr,
Vector< int, Storage2, Allocator2 > &  real_ind,
Vector< value_type, Storage0, Allocator0 > &  imag_values,
Vector< long, Storage1, Allocator1 > &  imag_ptr,
Vector< int, Storage2, Allocator2 > &  imag_ind 
)

Redefines the matrix.

It clears the matrix and sets it to a new matrix defined by 'real_values' (values of the real part), 'real_ptr' (pointers for the real part), 'real_ind' (indices for the real part), 'imag_values' (values of the imaginary part), 'imag_ptr' (pointers for the imaginary part) and 'imag_ind' (indices for the imaginary part). Input vectors are released and are empty on exit.

Parameters
inumber of rows.
jnumber of columns.
real_valuesvalues of non-zero entries for the real part.
real_ptrrow or column start indices for the real part.
real_indrow or column indices for the real part.
imag_valuesvalues of non-zero entries for the imaginary part.
imag_ptrrow or column start indices for the imaginary part.
imag_indrow or column indices for the imaginary part.
Warning
Input vectors 'real_values', 'real_ptr' and 'real_ind', 'imag_values', 'imag_ptr' and 'imag_ind' are empty on exit.

Definition at line 487 of file Matrix_ComplexSparse.cxx.

◆ SetIdentity()

template<class T , class Prop , class Storage , class Allocator >
void Seldon::Matrix_ComplexSparse< T, Prop, Storage, Allocator >::SetIdentity

Sets the matrix to identity.

This method fills the diagonal of the matrix with ones. It can be applied to non square matrix.

Definition at line 2331 of file Matrix_ComplexSparse.cxx.

◆ ValImag() [1/2]

template<class T , class Prop , class Storage , class Allocator >
Matrix_ComplexSparse< T, Prop, Storage, Allocator >::value_type & Seldon::Matrix_ComplexSparse< T, Prop, Storage, Allocator >::ValImag ( int  i,
int  j 
)

Access method.

Returns the imaginary part of element (i, j) if it can be returned as a reference.

Parameters
[in]irow index.
[in]jcolumn index.
Returns
Element (i, j) of the matrix.
Exceptions
WrongArgumentNo reference can be returned because the element is a zero entry (not stored in the matrix).

Definition at line 2087 of file Matrix_ComplexSparse.cxx.

◆ ValImag() [2/2]

template<class T , class Prop , class Storage , class Allocator >
const Matrix_ComplexSparse< T, Prop, Storage, Allocator >::value_type & Seldon::Matrix_ComplexSparse< T, Prop, Storage, Allocator >::ValImag ( int  i,
int  j 
) const

Access method.

Returns the imaginary part of element (i, j) if it can be returned as a reference.

Parameters
[in]irow index.
[in]jcolumn index.
Returns
Element (i, j) of the matrix.
Exceptions
WrongArgumentNo reference can be returned because the element is a zero entry (not stored in the matrix).

Definition at line 2139 of file Matrix_ComplexSparse.cxx.

◆ ValReal() [1/2]

template<class T , class Prop , class Storage , class Allocator >
Matrix_ComplexSparse< T, Prop, Storage, Allocator >::value_type & Seldon::Matrix_ComplexSparse< T, Prop, Storage, Allocator >::ValReal ( int  i,
int  j 
)

Access method.

Returns the real value of element (i, j) if it can be returned as a reference.

Parameters
[in]irow index.
[in]jcolumn index.
Returns
Element (i, j) of the matrix.
Exceptions
WrongArgumentNo reference can be returned because the element is a zero entry (not stored in the matrix).

Definition at line 1983 of file Matrix_ComplexSparse.cxx.

◆ ValReal() [2/2]

template<class T , class Prop , class Storage , class Allocator >
const Matrix_ComplexSparse< T, Prop, Storage, Allocator >::value_type & Seldon::Matrix_ComplexSparse< T, Prop, Storage, Allocator >::ValReal ( int  i,
int  j 
) const

Access method.

Returns the real value of element (i, j) if it can be returned as a reference.

Parameters
[in]irow index.
[in]jcolumn index.
Returns
Element (i, j) of the matrix.
Exceptions
WrongArgumentNo reference can be returned because the element is a zero entry (not stored in the matrix).

Definition at line 2035 of file Matrix_ComplexSparse.cxx.

◆ Write() [1/2]

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

Writes the matrix to an output stream.

Stores the matrix in an output stream in binary format.

Parameters
FileStreamoutput stream.

Definition at line 2464 of file Matrix_ComplexSparse.cxx.

◆ Write() [2/2]

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

Writes the matrix in a file.

Stores the matrix in a file in binary format.

Parameters
FileNameoutput file name.

Definition at line 2439 of file Matrix_ComplexSparse.cxx.

◆ WriteText() [1/2]

template<class T , class Prop , class Storage , class Allocator >
void Seldon::Matrix_ComplexSparse< T, Prop, Storage, Allocator >::WriteText ( ostream &  FileStream,
bool  cplx = false 
) const

Writes the matrix to an output stream.

Stores the matrix in a file in ascii format. The entries are written in coordinate format (row column value) 1-index convention is used

Parameters
FileStreamoutput stream.

Definition at line 2537 of file Matrix_ComplexSparse.cxx.

◆ WriteText() [2/2]

template<class T , class Prop , class Storage , class Allocator >
void Seldon::Matrix_ComplexSparse< T, Prop, Storage, Allocator >::WriteText ( string  FileName,
bool  cplx = false 
) const

Writes the matrix in a file.

Stores the matrix in a file in ascii format. The entries are written in coordinate format (row column value) 1-index convention is used

Parameters
FileNameoutput file name.

Definition at line 2507 of file Matrix_ComplexSparse.cxx.

◆ Zero()

template<class T , class Prop , class Storage , class Allocator >
void Seldon::Matrix_ComplexSparse< T, Prop, Storage, Allocator >::Zero

Resets all non-zero entries to 0-value.

The sparsity pattern remains unchanged.

Definition at line 2316 of file Matrix_ComplexSparse.cxx.


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