#include <CSRMatrixOperationsDefault.h>

Inheritance diagram for AMP::LinearAlgebra::CSRMatrixOperationsDefault< Config >:

Public Types
using	allocator_type = typename Config::allocator_type

using	gidx_t = typename Config::gidx_t

using	lidx_t = typename Config::lidx_t

using	localmatrixdata_t = typename matrixdata_t::localmatrixdata_t

using	localops_t = CSRLocalMatrixOperationsDefault< Config >

using	matrixdata_t = CSRMatrixData< Config >

using	scalar_t = typename Config::scalar_t

Public Member Functions
void	axpy (AMP::Scalar alpha, const MatrixData &X, MatrixData &Y) override
	Compute the linear combination of two matrices.

void	copy (const MatrixData &X, MatrixData &Y) override
	Set Y matrix with the same non-zero and distributed structure as x and copy the coefficients.

void	copyCast (const MatrixData &X, MatrixData &Y) override
	Set Y matrix with the same non-zero and distributed structure as x and copy the coefficients after up/down casting.

	CSRMatrixOperationsDefault ()

	CSRMatrixOperationsDefault (int64_t, AMP::IO::RestartManager *)

void	extractDiagonal (MatrixData const &A, std::shared_ptr< Vector > buf) override
	Extract the diagonal values into a vector.

uint64_t	getID () const
	Get a unique id hash for the vector operation.

void	getRowSums (MatrixData const &A, std::shared_ptr< Vector > buf) override
	Extract the row sums into a vector.

void	getRowSumsAbsolute (MatrixData const &A, std::shared_ptr< Vector > buf, const bool remove_zeros=false) override
	Extract the absolute row sums into a vector.

AMP::Scalar	LinfNorm (const MatrixData &X) const override
	Compute the maximum row sum.

void	matMatMult (std::shared_ptr< MatrixData > A, std::shared_ptr< MatrixData > B, std::shared_ptr< MatrixData > C) override
	Compute the product of two matrices.

void	mult (std::shared_ptr< const Vector > x, MatrixData const &A, std::shared_ptr< Vector > y) override
	Matrix-vector multiplication.

void	multTranspose (std::shared_ptr< const Vector > in, MatrixData const &A, std::shared_ptr< Vector > out) override
	Matrix transpose-vector multiplication.

virtual void	registerChildObjects (AMP::IO::RestartManager *manager) const
	Register any child objects.

void	scale (AMP::Scalar alpha, MatrixData &A) override
	Scale the matrix by a scalar.

void	scale (AMP::Scalar alpha, std::shared_ptr< const Vector > D, MatrixData &A) override
	Scale the matrix by a scalar and diagonal matrix.

void	scaleInv (AMP::Scalar alpha, std::shared_ptr< const Vector > D, MatrixData &A) override
	Scale the matrix by a scalar and inverse of diagonal matrix.

void	setDiagonal (std::shared_ptr< const Vector > in, MatrixData &A) override
	Set the diagonal to the values in a vector.

void	setIdentity (MatrixData &A) override
	Set the matrix to the identity matrix.

void	setScalar (AMP::Scalar alpha, MatrixData &A) override
	Set the non-zeros of the matrix to a scalar.

std::string	type () const override
	Return the type of the matrix operations class.

void	writeRestart (int64_t fid) const override
	Write restart data to file.

void	zero (MatrixData &A) override
	Set the non-zeros of the matrix to zero.

Static Public Member Functions
template<typename ConfigIn >
static void	copyCast (CSRMatrixData< typename ConfigIn::template set_alloc_t< Config::allocator > > X, matrixdata_t Y)

Protected Attributes
uint64_t	d_hash = 0
	unique hash for object

std::shared_ptr< localops_t >	d_localops_diag

std::shared_ptr< localops_t >	d_localops_offd

std::map< std::pair< std::shared_ptr< matrixdata_t >, std::shared_ptr< matrixdata_t > >, CSRMatrixSpGEMMDefault< Config > >	d_SpGEMMHelpers

Detailed Description

template<typename Config>
class AMP::LinearAlgebra::CSRMatrixOperationsDefault< Config >

Definition at line 16 of file CSRMatrixOperationsDefault.h.

Member Typedef Documentation

◆ allocator_type

template<typename Config >

using AMP::LinearAlgebra::CSRMatrixOperationsDefault< Config >::allocator_type = typename Config::allocator_type

Definition at line 19 of file CSRMatrixOperationsDefault.h.

◆ gidx_t

template<typename Config >

using AMP::LinearAlgebra::CSRMatrixOperationsDefault< Config >::gidx_t = typename Config::gidx_t

Definition at line 27 of file CSRMatrixOperationsDefault.h.

◆ lidx_t

template<typename Config >

using AMP::LinearAlgebra::CSRMatrixOperationsDefault< Config >::lidx_t = typename Config::lidx_t

Definition at line 28 of file CSRMatrixOperationsDefault.h.

◆ localmatrixdata_t

template<typename Config >

using AMP::LinearAlgebra::CSRMatrixOperationsDefault< Config >::localmatrixdata_t = typename matrixdata_t::localmatrixdata_t

Definition at line 23 of file CSRMatrixOperationsDefault.h.

◆ localops_t

template<typename Config >

using AMP::LinearAlgebra::CSRMatrixOperationsDefault< Config >::localops_t = CSRLocalMatrixOperationsDefault<Config>

Definition at line 25 of file CSRMatrixOperationsDefault.h.

◆ matrixdata_t

template<typename Config >

using AMP::LinearAlgebra::CSRMatrixOperationsDefault< Config >::matrixdata_t = CSRMatrixData<Config>

Definition at line 22 of file CSRMatrixOperationsDefault.h.

◆ scalar_t

template<typename Config >

using AMP::LinearAlgebra::CSRMatrixOperationsDefault< Config >::scalar_t = typename Config::scalar_t

Definition at line 29 of file CSRMatrixOperationsDefault.h.

Constructor & Destructor Documentation

◆ CSRMatrixOperationsDefault() [1/2]

template<typename Config >

AMP::LinearAlgebra::CSRMatrixOperationsDefault< Config >::CSRMatrixOperationsDefault ( )

inline

Definition at line 31 of file CSRMatrixOperationsDefault.h.

◆ CSRMatrixOperationsDefault() [2/2]

template<typename Config >

AMP::LinearAlgebra::CSRMatrixOperationsDefault< Config >::CSRMatrixOperationsDefault	(	int64_t	,
		AMP::IO::RestartManager *
	)

inline

Definition at line 175 of file CSRMatrixOperationsDefault.h.

Member Function Documentation

◆ axpy()

template<typename Config >

void AMP::LinearAlgebra::CSRMatrixOperationsDefault< Config >::axpy	(	AMP::Scalar	alpha,
		const MatrixData &	X,
		MatrixData &	Y
	)

overridevirtual

Compute the linear combination of two matrices.

Parameters

[in]	alpha	scalar
[in]	X	matrix
[out]	Y	The output matrix

Compute \(\mathbf{THIS} = \alpha\mathbf{X} + \mathbf{THIS}\)

Implements AMP::LinearAlgebra::MatrixOperations.

◆ copy()

template<typename Config >

void AMP::LinearAlgebra::CSRMatrixOperationsDefault< Config >::copy	(	const MatrixData &	X,
		MatrixData &	Y
	)

overridevirtual

Set Y matrix with the same non-zero and distributed structure as x and copy the coefficients.

Parameters

[in]	X	matrix data to copy from
[in]	Y	matrix data to copy to

Implements AMP::LinearAlgebra::MatrixOperations.

◆ copyCast() [1/2]

template<typename Config >

void AMP::LinearAlgebra::CSRMatrixOperationsDefault< Config >::copyCast	(	const MatrixData &	X,
		MatrixData &	Y
	)

overridevirtual

Set Y matrix with the same non-zero and distributed structure as x and copy the coefficients after up/down casting.

Parameters

[in]	X	matrix data to copy from
[in]	Y	matrix data to copy to after up/down casting the coefficients

Reimplemented from AMP::LinearAlgebra::MatrixOperations.

◆ copyCast() [2/2]

template<typename Config >

template<typename ConfigIn >

static void AMP::LinearAlgebra::CSRMatrixOperationsDefault< Config >::copyCast	(	CSRMatrixData< typename ConfigIn::template set_alloc_t< Config::allocator > > *	X,
		matrixdata_t *	Y
	)

static

◆ extractDiagonal()

template<typename Config >

void AMP::LinearAlgebra::CSRMatrixOperationsDefault< Config >::extractDiagonal	(	MatrixData const &	A,
		std::shared_ptr< Vector >	buf
	)

overridevirtual

Extract the diagonal values into a vector.

Parameters

[in]	A	The matrix to read from
[out]	buf	Buffer to write diagonal into

Implements AMP::LinearAlgebra::MatrixOperations.

◆ getID()

uint64_t AMP::LinearAlgebra::MatrixOperations::getID ( ) const

inherited

Get a unique id hash for the vector operation.

◆ getRowSums()

template<typename Config >

void AMP::LinearAlgebra::CSRMatrixOperationsDefault< Config >::getRowSums	(	MatrixData const &	A,
		std::shared_ptr< Vector >	buf
	)

overridevirtual

Extract the row sums into a vector.

Parameters

[in]	A	The matrix to read from
[out]	buf	Buffer to write row sums into

Reimplemented from AMP::LinearAlgebra::MatrixOperations.

◆ getRowSumsAbsolute()

template<typename Config >

void AMP::LinearAlgebra::CSRMatrixOperationsDefault< Config >::getRowSumsAbsolute	(	MatrixData const &	A,
		std::shared_ptr< Vector >	buf,
		const bool	remove_zeros = `false`
	)

overridevirtual

Extract the absolute row sums into a vector.

Parameters

[in]	A	The matrix to read from
[out]	buf	Buffer to write row sums into
[in]	remove_zeros	If true zero values in sum are replaced with ones

Reimplemented from AMP::LinearAlgebra::MatrixOperations.

◆ LinfNorm()

template<typename Config >

AMP::Scalar AMP::LinearAlgebra::CSRMatrixOperationsDefault< Config >::LinfNorm ( const MatrixData & X ) const

overridevirtual

Compute the maximum row sum.

Parameters

[in] X Data for the input matrix

Returns: The L-infinity norm of the matrix

Implements AMP::LinearAlgebra::MatrixOperations.

◆ matMatMult()

template<typename Config >

void AMP::LinearAlgebra::CSRMatrixOperationsDefault< Config >::matMatMult	(	std::shared_ptr< MatrixData >	A,
		std::shared_ptr< MatrixData >	B,
		std::shared_ptr< MatrixData >	C
	)

overridevirtual

Compute the product of two matrices.

Parameters

[in]	A	Left multiplicand
[in]	B	Right multiplicand
[out]	C	The product \(\mathbf{AB}\).

Implements AMP::LinearAlgebra::MatrixOperations.

◆ mult()

template<typename Config >

void AMP::LinearAlgebra::CSRMatrixOperationsDefault< Config >::mult	(	std::shared_ptr< const Vector >	x,
		MatrixData const &	A,
		std::shared_ptr< Vector >	y
	)

overridevirtual

Matrix-vector multiplication.

Parameters

[in]	x	The vector to multiply
[in]	A	The input matrix A
[out]	y	The resulting vector

Compute \(\mathbf{Ax} = \mathbf{y}\).

Implements AMP::LinearAlgebra::MatrixOperations.

◆ multTranspose()

template<typename Config >

void AMP::LinearAlgebra::CSRMatrixOperationsDefault< Config >::multTranspose	(	std::shared_ptr< const Vector >	in,
		MatrixData const &	A,
		std::shared_ptr< Vector >	out
	)

overridevirtual

Matrix transpose-vector multiplication.

Parameters

[in]	in	The vector to multiply
[in]	A	The input matrix A
[out]	out	The resulting vectory

Compute \(\mathbf{A}^T\mathbf{in} = \mathbf{out}\).

Implements AMP::LinearAlgebra::MatrixOperations.

◆ registerChildObjects()

virtual void AMP::LinearAlgebra::MatrixOperations::registerChildObjects ( AMP::IO::RestartManager * manager ) const

virtualinherited

Register any child objects.

This function will register child objects with the manager

Parameters

manager Restart manager

◆ scale() [1/2]

template<typename Config >

void AMP::LinearAlgebra::CSRMatrixOperationsDefault< Config >::scale	(	AMP::Scalar	alpha,
		MatrixData &	A
	)

overridevirtual

Scale the matrix by a scalar.

Parameters

[in]	alpha	The value to scale by
[in,out]	A	The matrix A

Compute \(\mathbf{A} = \alpha\mathbf{A}\)

Implements AMP::LinearAlgebra::MatrixOperations.

◆ scale() [2/2]

template<typename Config >

void AMP::LinearAlgebra::CSRMatrixOperationsDefault< Config >::scale	(	AMP::Scalar	alpha,
		std::shared_ptr< const Vector >	D,
		MatrixData &	A
	)

overridevirtual

Scale the matrix by a scalar and diagonal matrix.

Parameters

[in]	alpha	The value to scale by
[in]	D	Vector representing the diagonal matrix
[in]	A	The input matrix A

Compute \(\mathbf{A} = \alpha\mathbf{D}\mathbf{A}\)

Implements AMP::LinearAlgebra::MatrixOperations.

◆ scaleInv()

template<typename Config >

void AMP::LinearAlgebra::CSRMatrixOperationsDefault< Config >::scaleInv	(	AMP::Scalar	alpha,
		std::shared_ptr< const Vector >	D,
		MatrixData &	A
	)

overridevirtual

Scale the matrix by a scalar and inverse of diagonal matrix.

Parameters

[in]	alpha	The value to scale by
[in]	D	Vector representing the diagonal matrix
[in]	A	The input matrix A

Compute \(\mathbf{A} = \alpha\mathbf{D}^{-1}\mathbf{A}\)

Implements AMP::LinearAlgebra::MatrixOperations.

◆ setDiagonal()

template<typename Config >

void AMP::LinearAlgebra::CSRMatrixOperationsDefault< Config >::setDiagonal	(	std::shared_ptr< const Vector >	in,
		MatrixData &	A
	)

overridevirtual

Set the diagonal to the values in a vector.

Parameters

[in]	in	The values to set the diagonal to
[out]	A	The matrix to set

Implements AMP::LinearAlgebra::MatrixOperations.

◆ setIdentity()

template<typename Config >

void AMP::LinearAlgebra::CSRMatrixOperationsDefault< Config >::setIdentity ( MatrixData & A )

overridevirtual

Set the matrix to the identity matrix.

Parameters

[out] A The matrix to set

Implements AMP::LinearAlgebra::MatrixOperations.

◆ setScalar()

template<typename Config >

void AMP::LinearAlgebra::CSRMatrixOperationsDefault< Config >::setScalar	(	AMP::Scalar	alpha,
		MatrixData &	A
	)

overridevirtual

Set the non-zeros of the matrix to a scalar.

Parameters

[in]	alpha	The value to set the non-zeros to
[out]	A	The input matrix A

Implements AMP::LinearAlgebra::MatrixOperations.

◆ type()

template<typename Config >

std::string AMP::LinearAlgebra::CSRMatrixOperationsDefault< Config >::type ( ) const

inlineoverridevirtual

Return the type of the matrix operations class.

Reimplemented from AMP::LinearAlgebra::MatrixOperations.

Definition at line 166 of file CSRMatrixOperationsDefault.h.

◆ writeRestart()

template<typename Config >

void AMP::LinearAlgebra::CSRMatrixOperationsDefault< Config >::writeRestart ( int64_t fid ) const

overridevirtual

Write restart data to file.

This function will write the mesh to an HDF5 file

Parameters

fid	File identifier to write

Reimplemented from AMP::LinearAlgebra::MatrixOperations.

◆ zero()

template<typename Config >

void AMP::LinearAlgebra::CSRMatrixOperationsDefault< Config >::zero ( MatrixData & A )

overridevirtual

Set the non-zeros of the matrix to zero.

Parameters

[in] A The input matrix A

Does not deallocate space.

Implements AMP::LinearAlgebra::MatrixOperations.

Member Data Documentation

◆ d_hash

uint64_t AMP::LinearAlgebra::MatrixOperations::d_hash = 0

protectedinherited

unique hash for object

Definition at line 169 of file MatrixOperations.h.

◆ d_localops_diag

template<typename Config >

std::shared_ptr<localops_t> AMP::LinearAlgebra::CSRMatrixOperationsDefault< Config >::d_localops_diag

protected

Definition at line 182 of file CSRMatrixOperationsDefault.h.

◆ d_localops_offd

template<typename Config >

std::shared_ptr<localops_t> AMP::LinearAlgebra::CSRMatrixOperationsDefault< Config >::d_localops_offd

protected

Definition at line 183 of file CSRMatrixOperationsDefault.h.

◆ d_SpGEMMHelpers

template<typename Config >

std::map<std::pair<std::shared_ptr<matrixdata_t>, std::shared_ptr<matrixdata_t> >, CSRMatrixSpGEMMDefault<Config> > AMP::LinearAlgebra::CSRMatrixOperationsDefault< Config >::d_SpGEMMHelpers

protected

Definition at line 186 of file CSRMatrixOperationsDefault.h.

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

src/matrices/operations/default/CSRMatrixOperationsDefault.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ allocator_type

◆ gidx_t

◆ lidx_t

◆ localmatrixdata_t

◆ localops_t

◆ matrixdata_t

◆ scalar_t

Constructor & Destructor Documentation

◆ CSRMatrixOperationsDefault() [1/2]

◆ CSRMatrixOperationsDefault() [2/2]

Member Function Documentation

◆ axpy()

◆ copy()

◆ copyCast() [1/2]

◆ copyCast() [2/2]

◆ extractDiagonal()

◆ getID()

◆ getRowSums()

◆ getRowSumsAbsolute()

◆ LinfNorm()

◆ matMatMult()

◆ mult()

◆ multTranspose()

◆ registerChildObjects()

◆ scale() [1/2]

◆ scale() [2/2]

◆ scaleInv()

◆ setDiagonal()

◆ setIdentity()

◆ setScalar()

◆ type()

◆ writeRestart()

◆ zero()

Member Data Documentation

◆ d_hash

◆ d_localops_diag

◆ d_localops_offd

◆ d_SpGEMMHelpers