Chronos

IDMat

This class is used to represent Identity Matrix. More…

#include "IDMat.h"

Inherits from MatrixProd

Public Functions

Name
void copy_IDMat(IDMat & other)
Copy members.
IDMat & operator=(IDMat & other)
Copy operator.
IDMat()
Creates an empty object.
IDMat(const iReg input_nrows)
Creates an identity matrix of given size.
~IDMat()
Deletes the object.
iReg get_nrows()
Retrieve the number of rows.
virtual iReg get_nrows() const
Retrieve the number of rows.
virtual iGlo Get_Globalnrows() const
Evaluates the total number of rows.
virtual void Prepare_MxV(const iReg nRHS)
Create all the data structure needed for MxV. This function has no effect, it is inserted only for compatibility with the parent class.
virtual void UndoPrepare_MxV()
Undo the data structure necessary for MxV. This function has no effect, it is inserted only for compatibility with the parent class.
virtual void MxV(DDMat &restrict x, DDMat &restrict b, bool Barrier_flag)
Computes the Matrix by vector Product.

Additional inherited members

Public Functions inherited from MatrixProd

Name
void copy_MatrixProd(MatrixProd & other)
Copy members.
bool get_Prepared_flag() const
Get flag for MxV prepare.
iReg get_nRHS_prep() const
Get the number of rhs the matrix is prepared for.
virtual ~MatrixProd() =0
Deletes the object.

Protected Attributes inherited from MatrixProd

Name
bool Prepared_flag
flag for MxV prepare.
iReg nRHS_prep
number of rhs the matrix is prepared for

Detailed Description

class IDMat;

This class is used to represent Identity Matrix.

class IDMat.

Public Functions Documentation

function copy_IDMat

inline void copy_IDMat(
    IDMat & other
)

Copy members.

function operator=

inline IDMat & operator=(
    IDMat & other
)

Copy operator.

function IDMat

inline IDMat()

Creates an empty object.

function IDMat

inline IDMat(
    const iReg input_nrows
)

Creates an identity matrix of given size.

function ~IDMat

inline ~IDMat()

Deletes the object.

function get_nrows

inline iReg get_nrows()

Retrieve the number of rows.

function get_nrows

inline virtual iReg get_nrows() const

Retrieve the number of rows.

Reimplements: MatrixProd::get_nrows

function Get_Globalnrows

virtual iGlo Get_Globalnrows() const

Evaluates the total number of rows.

Reimplements: MatrixProd::Get_Globalnrows

function Prepare_MxV

inline virtual void Prepare_MxV(
    const iReg nRHS
)

Create all the data structure needed for MxV. This function has no effect, it is inserted only for compatibility with the parent class.

Parameters:

  • nRHS number of Right Hand Sides.

Reimplements: MatrixProd::Prepare_MxV

function UndoPrepare_MxV

inline virtual void UndoPrepare_MxV()

Undo the data structure necessary for MxV. This function has no effect, it is inserted only for compatibility with the parent class.

Reimplements: MatrixProd::UndoPrepare_MxV

function MxV

virtual void MxV(
    DDMat &__restrict__ x,
    DDMat &__restrict__ b,
    bool Barrier_flag
)

Computes the Matrix by vector Product.

Parameters:

  • x vector that is multiplied by the matrix.
  • b vector where result is stored.
  • Barrier_flag if true global Barrier is called before return.

Reimplements: MatrixProd::MxV

Updated on 12 February 2021 at 11:59:50 CET