C++ mpi module for stochmagnet_main Package
Public Member Functions | Static Public Member Functions | List of all members
SMOMPI_PackedBlockSymmetricMatrix< T, P > Class Template Reference

This class describes an OpenMP/MPI implemntation of symmetric matrix by block of size \( P \times P \) in a packed storage. More...

#include <SMOMPI_PackedBlockSymmetricMatrix.h>

Inheritance diagram for SMOMPI_PackedBlockSymmetricMatrix< T, P >:
Inheritance graph
[legend]
Collaboration diagram for SMOMPI_PackedBlockSymmetricMatrix< T, P >:
Collaboration graph
[legend]

Public Member Functions

 SMOMPI_PackedBlockSymmetricMatrix (void)
 create a matrix of size 0
 
virtual ~SMOMPI_PackedBlockSymmetricMatrix (void)
 destroy
 
virtual void vectorProduct (const T *vX, T *vY) const override
 vector product More...
 
- Public Member Functions inherited from SM_PackedBlockSymmetricMatrix< T, P >
virtual tMemSize getMemorySize () const
 return the memory size of the class and the memory size of all its attributes/associations More...
 
virtual tMemSize getContentsMemorySize () const
 return the memory size of the included associations More...
 
virtual void reset () final
 reset the values
 
void setSize (const tIndex &nRowBlocks)
 set the number or rows & columns of the blocks matrix More...
 
virtual void setSize (const tIndex &nRowBlocks, const tIndex &nColBlocks) final
 set the number or rows & columns of the blocks matrix More...
 
virtual void setValue (const tIndex &i, const tIndex &j, const T &v) final
 set values at row i and column j More...
 
virtual const T & getValue (const tIndex &i, const tIndex &j) const final
 get values at row i and column j for reading More...
 
virtual T & getValue (const tIndex &i, const tIndex &j) final
 get values at row i and column j for writing More...
 
std::valarray< T > & getSupBlocksValues ()
 get the values of superior blocks of the matrix
 
std::valarray< T > & getDiagonalValues ()
 get the diagonal values : Diagonal[i].I_P
 
const std::valarray< T > & getSupBlocksValues () const
 get the values of superior blocks of the matrix
 
const std::valarray< T > & getDiagonalValues () const
 get the diagonal values : Diagonal[i].I_P
 
const T & operator() (tIndex i, tIndex j) const
 get values at row i and column j for reading More...
 
T & operator() (tIndex i, tIndex j)
 get values at row i and column j for writing More...
 
virtual tString toString () const override
 return string representaton of the operator
 
- Public Member Functions inherited from SM_PackedBlockMatrix< T, P >
virtual void setSize (const tInteger &nRowBlocks, const tInteger &nColBlocks)
 set the number or rows & columns of the blocks matrix More...
 
const tInteger & getRowBlocksNumber () const
 get the number of row blowks
 
const tInteger & getColumnBlocksNumber () const
 get the number of column blocks
 
- Public Member Functions inherited from CORE_Object
template<class T >
std::shared_ptr< T > getSharedPointer ()
 return the shared pointer for this More...
 
template<class T >
std::shared_ptr< const T > getConstSharedPointer () const
 return a const shared pointer for this More...
 
template<class T >
tBoolean isInstanceOf () const
 test if the clas T is an instance of this class More...
 
tString getClassName () const
 return the name of the class More...
 
tString getPointerString () const
 retrun the pointer of the class as a string More...
 
tString getIdentityString () const
 retrun the string identification of the class More...
 

Static Public Member Functions

static CORE_UniquePointer< SelfClassNew ()
 build a new instance of the operator More...
 
- Static Public Member Functions inherited from SM_PackedBlockSymmetricMatrix< T, P >
static CORE_UniquePointer< SelfClassNew ()
 build a new instance of the operator More...
 
static tIndex GetBlockIndex (const tIndex &ib, const tIndex &jb)
 get the value of the sub pack block at index More...
 
- Static Public Member Functions inherited from CORE_Object
static tBoolean EnableMemoryStack (const tBoolean &isMemoryChecked)
 enable the memory stack More...
 
static void EnableMemoryStack ()
 enable the memory stack
 
static void DisableMemoryStack ()
 disable the memory stack
 
static tBoolean IsMemoryStackEnabled ()
 return trur if the memory stack is enabled
 
static tString MemoryStackToString ()
 get the memory stack in string More...
 
static tIndex GetRegisteredClassesNumber ()
 get the memory stack in string More...
 

Additional Inherited Members

- Static Public Attributes inherited from SM_PackedBlockMatrix< T, P >
static constexpr tUCInt BLOCK_SIZE =P*(P+1)/2
 size of the block in packed storage with diagonal
 
- Protected Member Functions inherited from SM_PackedBlockSymmetricMatrix< T, P >
 SM_PackedBlockSymmetricMatrix (void)
 create a matrix of size 0
 
virtual ~SM_PackedBlockSymmetricMatrix (void)
 destroy
 
- Protected Member Functions inherited from SM_PackedBlockMatrix< T, P >
 SM_PackedBlockMatrix (void)
 create a matrix of size 0
 
virtual ~SM_PackedBlockMatrix (void)
 destroy
 
- Protected Member Functions inherited from CORE_Object
 CORE_Object ()
 build an instance of the object
 
virtual ~CORE_Object ()
 destroy the instance of object std

 
- Static Protected Member Functions inherited from SM_PackedBlockMatrix< T, P >
static tIndex GetPackedIndex (const tIndex &i, const tIndex &j)
 return the pack index of size Q in a column storage More...
 
static void BlockVectorProduct (const T *B, const T *X, T *Y, const T *eY, const T *Xi, const T *Xj, T *Yi, T *Yj)
 compute sthe vector product of the packed symmetric block B of dimension P by X to obtain Y=B.X More...
 

Detailed Description

template<typename T, tUCInt P>
class SMOMPI_PackedBlockSymmetricMatrix< T, P >

This class describes an OpenMP/MPI implemntation of symmetric matrix by block of size \( P \times P \) in a packed storage.

Template Parameters
T: type of the element of the block of the matrix
P: size of the block \( P \times P \)
Author
Stephane Despreaux
Version
2.0

Member Function Documentation

◆ New()

template<typename T , tUCInt P>
static CORE_UniquePointer<SelfClass> SMOMPI_PackedBlockSymmetricMatrix< T, P >::New ( )
inlinestatic

build a new instance of the operator

Returns
an unique pointer of the operator

◆ vectorProduct()

template<typename T , tUCInt P>
virtual void SMOMPI_PackedBlockSymmetricMatrix< T, P >::vectorProduct ( const T *  vX,
T *  vY 
) const
inlineoverridevirtual

vector product

Parameters
[in]Xvalues of X vector
[out]Y: values of return vector Y=A.X

Reimplemented from SM_PackedBlockSymmetricMatrix< T, P >.


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