Chronos

IDMat

This class is used to represent Identity Matrix. More…

#include "IDMat.h"

Inherits from MatrixProd

Public Functions

Name
virtual void copy(MatrixProd const & other)
Copy members.
IDMat & operator=(IDMat const & other)
Copy operator.
IDMat()
Creates an empty object.
IDMat(const iReg input_nrows)
Creates an identity matrix of given size.
~IDMat()
Deletes the object.
virtual iReg get_nrows() const
Retrieve the 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 & x, DDMat & b, bool Barrier_flag)
Computes the Matrix by vector Product.
virtual bool isOnGPU() const
Check if the matrix is on GPU.

Additional inherited members

Public Functions inherited from MatrixProd

Name
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.
iGlo Get_Globalnrows() const
Retrieve the global number of rows using internal variable.
iGlo Get_Globalnrows()
Retrieve the global number of rows using internal variable.
void set_Prepared_flag(const bool input_Prepared_flag)
Get flag for MxV prepare.
bool Check()
Checks that the MatrixProd instance has been correctly constructed.
virtual ~MatrixProd() =0
Deletes the object.

Protected Functions inherited from MatrixProd

Name
void copy_MatrixProd(MatrixProd const & other)
Copy members.

Protected Attributes inherited from MatrixProd

Name
iGlo glob_nrows
total number of rows (matrix size).
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

virtual void copy(
    MatrixProd const & other
)

Copy members.

Reimplements: MatrixProd::copy

function operator=

IDMat & operator=(
    IDMat const & other
)

Copy operator.

function IDMat

inline IDMat()

Creates an empty object.

function IDMat

IDMat(
    const iReg input_nrows
)

Creates an identity matrix of given size.

function ~IDMat

~IDMat()

Deletes the object.

function get_nrows

virtual iReg get_nrows() const

Retrieve the number of rows.

Reimplements: MatrixProd::get_nrows

function Prepare_MxV

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

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 & x,
    DDMat & 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

function isOnGPU

virtual bool isOnGPU() const

Check if the matrix is on GPU.

Reimplements: MatrixProd::isOnGPU

Updated on 19 November 2024 at 10:20:48 CET