#include <Xpetra_MatrixMatrix.hpp>

Static Public Member Functions
static void	Multiply (const Matrix &A, bool transposeA, const Matrix &B, bool transposeB, Matrix &C, bool call_FillComplete_on_result=true, bool doOptimizeStorage=true, const std::string &label=std::string(), const RCP< ParameterList > &params=null)

static RCP< Matrix >	Multiply (const Matrix &A, bool transposeA, const Matrix &B, bool transposeB, RCP< Matrix > C_in, Teuchos::FancyOStream &fos, bool doFillComplete=true, bool doOptimizeStorage=true, const std::string &label=std::string(), const RCP< ParameterList > &params=null)
	Helper function to do matrix-matrix multiply.

static RCP< Matrix >	Multiply (const Matrix &A, bool transposeA, const Matrix &B, bool transposeB, Teuchos::FancyOStream &fos, bool callFillCompleteOnResult=true, bool doOptimizeStorage=true, const std::string &label=std::string(), const RCP< ParameterList > &params=null)
	Helper function to do matrix-matrix multiply.

static RCP< Epetra_CrsMatrix >	MLTwoMatrixMultiply (const Epetra_CrsMatrix &, const Epetra_CrsMatrix &, Teuchos::FancyOStream &)

static RCP< BlockedCrsMatrix >	TwoMatrixMultiplyBlock (const BlockedCrsMatrix &A, bool transposeA, const BlockedCrsMatrix &B, bool transposeB, Teuchos::FancyOStream &fos, bool doFillComplete=true, bool doOptimizeStorage=true)
	Helper function to do matrix-matrix multiply "in-place".

static void	TwoMatrixAdd (const Matrix &A, bool transposeA, SC alpha, Matrix &B, SC beta)
	Helper function to calculate B = alphaA + betaB.

static void	TwoMatrixAdd (const Matrix &A, bool transposeA, const SC &alpha, const Matrix &B, bool transposeB, const SC &beta, RCP< Matrix > &C, Teuchos::FancyOStream &fos, bool AHasFixedNnzPerRow=false)
	Helper function to calculate C = alphaA + betaB.

static void	Multiply (const Matrix &A, bool transposeA, const Matrix &B, bool transposeB, Matrix &C, bool call_FillComplete_on_result=true, bool doOptimizeStorage=true, const std::string &label=std::string(), const RCP< ParameterList > &params=null)

static RCP< Matrix >	Multiply (const Matrix &A, bool transposeA, const Matrix &B, bool transposeB, RCP< Matrix > C_in, Teuchos::FancyOStream &fos, bool doFillComplete=true, bool doOptimizeStorage=true, const std::string &label=std::string(), const RCP< ParameterList > &params=null)
	Helper function to do matrix-matrix multiply.

static RCP< Matrix >	Multiply (const Matrix &A, bool transposeA, const Matrix &B, bool transposeB, Teuchos::FancyOStream &fos, bool callFillCompleteOnResult=true, bool doOptimizeStorage=true, const std::string &label=std::string(), const RCP< ParameterList > &params=null)
	Helper function to do matrix-matrix multiply.

static RCP< Epetra_CrsMatrix >	MLTwoMatrixMultiply (const Epetra_CrsMatrix &epA, const Epetra_CrsMatrix &epB, Teuchos::FancyOStream &fos)

static RCP< BlockedCrsMatrix >	TwoMatrixMultiplyBlock (const BlockedCrsMatrix &A, bool transposeA, const BlockedCrsMatrix &B, bool transposeB, Teuchos::FancyOStream &fos, bool doFillComplete=true, bool doOptimizeStorage=true)
	Helper function to do matrix-matrix multiply "in-place".

static void	TwoMatrixAdd (const Matrix &A, bool transposeA, SC alpha, Matrix &B, SC beta)
	Helper function to calculate B = alphaA + betaB.

static void	TwoMatrixAdd (const Matrix &A, bool transposeA, const SC &alpha, const Matrix &B, bool transposeB, const SC &beta, RCP< Matrix > &C, Teuchos::FancyOStream &fos, bool AHasFixedNnzPerRow=false)
	Helper function to calculate C = alphaA + betaB.

Private Types
typedef double	Scalar

typedef int	LocalOrdinal

typedef long long	GlobalOrdinal

typedef EpetraNode	Node

Detailed Description

Definition at line 1784 of file Xpetra_MatrixMatrix.hpp.

Member Typedef Documentation

◆ Scalar

typedef double Xpetra::MatrixMatrix< double, int, long long, EpetraNode >::Scalar

private

Definition at line 1785 of file Xpetra_MatrixMatrix.hpp.

◆ LocalOrdinal

typedef int Xpetra::MatrixMatrix< double, int, long long, EpetraNode >::LocalOrdinal

private

Definition at line 1786 of file Xpetra_MatrixMatrix.hpp.

◆ GlobalOrdinal

typedef long long Xpetra::MatrixMatrix< double, int, long long, EpetraNode >::GlobalOrdinal

private

Definition at line 1787 of file Xpetra_MatrixMatrix.hpp.

◆ Node

typedef EpetraNode Xpetra::MatrixMatrix< double, int, long long, EpetraNode >::Node

private

Definition at line 1788 of file Xpetra_MatrixMatrix.hpp.

Member Function Documentation

◆ Multiply() [1/6]

static void Xpetra::MatrixMatrix< double, int, long long, EpetraNode >::Multiply	(	const Matrix &	A,
		bool	transposeA,
		const Matrix &	B,
		bool	transposeB,
		Matrix &	C,
		bool	call_FillComplete_on_result = true,
		bool	doOptimizeStorage = true,
		const std::string &	label = std::string(),
		const RCP< ParameterList > &	params = null )

inlinestatic

Given CrsMatrix objects A, B and C, form the product C = A*B. In a parallel setting, A and B need not have matching distributions, but C needs to have the same row-map as A (if transposeA is false). At this time C=AT*B and C=A*BT are known to not work. However, C=A*B and C=AT*BT are known to work, Kurtis Nusbaum 03/24/2011

Parameters

A	Input, must already have had 'FillComplete()' called.
transposeA	Input, whether to use transpose of matrix A.
B	Input, must already have had 'FillComplete()' called.
transposeB	Input, whether to use transpose of matrix B.
C	Result. On entry to this method, it doesn't matter whether FillComplete() has already been called on C or not. If it has, then C's graph must already contain all nonzero locations that will be produced when forming the product A*B. On exit, C.FillComplete() will have been called, unless the last argument to this function is specified to be false.
call_FillComplete_on_result	Optional argument, defaults to true. Power users may specify this argument to be false if they DON'T want this function to call C.FillComplete. (It is often useful to allow this function to call C.FillComplete, in cases where one or both of the input matrices are rectangular and it is not trivial to know which maps to use for the domain- and range-maps.)

Definition at line 1817 of file Xpetra_MatrixMatrix.hpp.

◆ Multiply() [2/6]

static RCP< Matrix > Xpetra::MatrixMatrix< double, int, long long, EpetraNode >::Multiply	(	const Matrix &	A,
		bool	transposeA,
		const Matrix &	B,
		bool	transposeB,
		RCP< Matrix >	C_in,
		Teuchos::FancyOStream &	fos,
		bool	doFillComplete = true,
		bool	doOptimizeStorage = true,
		const std::string &	label = std::string(),
		const RCP< ParameterList > &	params = null )

inlinestatic

Helper function to do matrix-matrix multiply.

Given CrsMatrix objects A, B and C, form the product C = A*B. In a parallel setting, A and B need not have matching distributions, but C needs to have the same row-map as A (if transposeA is false). At this time C=AT*B and C=A*BT are known to not work. However, C=A*B and C=AT*BT are known to work, Kurtis Nusbaum 03/24/2011

Parameters

A	Input, must already have had 'FillComplete()' called.
transposeA	Input, whether to use transpose of matrix A.
B	Input, must already have had 'FillComplete()' called.
transposeB	Input, whether to use transpose of matrix B.
C	Result. If Teuchos::null, a new CrsMatrix is created with optimal number of nnz per row.
call_FillComplete_on_result	Optional argument, defaults to true. Power users may specify this argument to be false if they DON'T want this function to call C.FillComplete. (It is often useful to allow this function to call C.FillComplete, in cases where one or both of the input matrices are rectangular and it is not trivial to know which maps to use for the domain- and range-maps.)

Definition at line 1938 of file Xpetra_MatrixMatrix.hpp.

◆ Multiply() [3/6]

static RCP< Matrix > Xpetra::MatrixMatrix< double, int, long long, EpetraNode >::Multiply	(	const Matrix &	A,
		bool	transposeA,
		const Matrix &	B,
		bool	transposeB,
		Teuchos::FancyOStream &	fos,
		bool	callFillCompleteOnResult = true,
		bool	doOptimizeStorage = true,
		const std::string &	label = std::string(),
		const RCP< ParameterList > &	params = null )

inlinestatic

Helper function to do matrix-matrix multiply.

Returns C = AB.

Parameters

A	left matrix
transposeA	if true, use the transpose of A
B	right matrix
transposeB	if true, use the transpose of B
callFillCompleteOnResult	if true, the resulting matrix should be fillComplete'd

Definition at line 1996 of file Xpetra_MatrixMatrix.hpp.

◆ MLTwoMatrixMultiply() [1/2]

static RCP< Epetra_CrsMatrix > Xpetra::MatrixMatrix< double, int, long long, EpetraNode >::MLTwoMatrixMultiply	(	const Epetra_CrsMatrix &	,
		const Epetra_CrsMatrix &	,
		Teuchos::FancyOStream &	)

inlinestatic

Definition at line 2008 of file Xpetra_MatrixMatrix.hpp.

◆ TwoMatrixMultiplyBlock() [1/2]

static RCP< BlockedCrsMatrix > Xpetra::MatrixMatrix< double, int, long long, EpetraNode >::TwoMatrixMultiplyBlock	(	const BlockedCrsMatrix &	A,
		bool	transposeA,
		const BlockedCrsMatrix &	B,
		bool	transposeB,
		Teuchos::FancyOStream &	fos,
		bool	doFillComplete = true,
		bool	doOptimizeStorage = true )

inlinestatic

Helper function to do matrix-matrix multiply "in-place".

Returns RCP to non-constant Xpetra::BlockedCrsMatrix.

Parameters

A	left matrix
transposeA	if true, use the transpose of A
B	right matrix
transposeB	if true, use the transpose of B
doOptimizeStorage	if true, the resulting matrix should be fillComplete'd

Definition at line 2027 of file Xpetra_MatrixMatrix.hpp.

◆ TwoMatrixAdd() [1/4]

static void Xpetra::MatrixMatrix< double, int, long long, EpetraNode >::TwoMatrixAdd	(	const Matrix &	A,
		bool	transposeA,
		SC	alpha,
		Matrix &	B,
		SC	beta )

inlinestatic

Helper function to calculate B = alpha*A + beta*B.

Parameters

A	left matrix operand
transposeA	indicate whether to use transpose of A
alpha	scalar multiplier for A
B	right matrix operand
beta	scalar multiplier for B

Returns: sum in B.

Note that B does not have to be fill-completed.

Definition at line 2152 of file Xpetra_MatrixMatrix.hpp.

◆ TwoMatrixAdd() [2/4]

static void Xpetra::MatrixMatrix< double, int, long long, EpetraNode >::TwoMatrixAdd	(	const Matrix &	A,
		bool	transposeA,
		const SC &	alpha,
		const Matrix &	B,
		bool	transposeB,
		const SC &	beta,
		RCP< Matrix > &	C,
		Teuchos::FancyOStream &	fos,
		bool	AHasFixedNnzPerRow = false )

inlinestatic

Helper function to calculate C = alpha*A + beta*B.

Parameters

A	left matrix operand
transposeA	indicate whether to use transpose of A
alpha	scalar multiplier for A, defaults to 1.0
B	right matrix operand
transposeB	indicate whether to use transpose of B
beta	scalar multiplier for B, defaults to 1.0
C	resulting sum
fos	output stream for printing to screen
AHasFixedNnzPerRow

It is up to the caller to ensure that the resulting matrix sum is fillComplete'd.

Definition at line 2202 of file Xpetra_MatrixMatrix.hpp.

◆ Multiply() [4/6]

static void Xpetra::MatrixMatrix< double, int, long long, EpetraNode >::Multiply	(	const Matrix &	A,
		bool	transposeA,
		const Matrix &	B,
		bool	transposeB,
		Matrix &	C,
		bool	call_FillComplete_on_result = true,
		bool	doOptimizeStorage = true,
		const std::string &	label = std::string(),
		const RCP< ParameterList > &	params = null )

inlinestatic

Given CrsMatrix objects A, B and C, form the product C = A*B. In a parallel setting, A and B need not have matching distributions, but C needs to have the same row-map as A (if transposeA is false). At this time C=AT*B and C=A*BT are known to not work. However, C=A*B and C=AT*BT are known to work, Kurtis Nusbaum 03/24/2011

Parameters

A	Input, must already have had 'FillComplete()' called.
transposeA	Input, whether to use transpose of matrix A.
B	Input, must already have had 'FillComplete()' called.
transposeB	Input, whether to use transpose of matrix B.
C	Result. On entry to this method, it doesn't matter whether FillComplete() has already been called on C or not. If it has, then C's graph must already contain all nonzero locations that will be produced when forming the product A*B. On exit, C.FillComplete() will have been called, unless the last argument to this function is specified to be false.
call_FillComplete_on_result	Optional argument, defaults to true. Power users may specify this argument to be false if they DON'T want this function to call C.FillComplete. (It is often useful to allow this function to call C.FillComplete, in cases where one or both of the input matrices are rectangular and it is not trivial to know which maps to use for the domain- and range-maps.)

Definition at line 464 of file Xpetra_MatrixMatrix.hpp.

◆ Multiply() [5/6]

static RCP< Matrix > Xpetra::MatrixMatrix< double, int, long long, EpetraNode >::Multiply	(	const Matrix &	A,
		bool	transposeA,
		const Matrix &	B,
		bool	transposeB,
		RCP< Matrix >	C_in,
		Teuchos::FancyOStream &	fos,
		bool	doFillComplete = true,
		bool	doOptimizeStorage = true,
		const std::string &	label = std::string(),
		const RCP< ParameterList > &	params = null )

inlinestatic

Helper function to do matrix-matrix multiply.

Given CrsMatrix objects A, B and C, form the product C = A*B. In a parallel setting, A and B need not have matching distributions, but C needs to have the same row-map as A (if transposeA is false). At this time C=AT*B and C=A*BT are known to not work. However, C=A*B and C=AT*BT are known to work, Kurtis Nusbaum 03/24/2011

Parameters

A	Input, must already have had 'FillComplete()' called.
transposeA	Input, whether to use transpose of matrix A.
B	Input, must already have had 'FillComplete()' called.
transposeB	Input, whether to use transpose of matrix B.
C	Result. If Teuchos::null, a new CrsMatrix is created with optimal number of nnz per row.
call_FillComplete_on_result	Optional argument, defaults to true. Power users may specify this argument to be false if they DON'T want this function to call C.FillComplete. (It is often useful to allow this function to call C.FillComplete, in cases where one or both of the input matrices are rectangular and it is not trivial to know which maps to use for the domain- and range-maps.)

Definition at line 580 of file Xpetra_MatrixMatrix.hpp.

◆ Multiply() [6/6]

static RCP< Matrix > Xpetra::MatrixMatrix< double, int, long long, EpetraNode >::Multiply	(	const Matrix &	A,
		bool	transposeA,
		const Matrix &	B,
		bool	transposeB,
		Teuchos::FancyOStream &	fos,
		bool	callFillCompleteOnResult = true,
		bool	doOptimizeStorage = true,
		const std::string &	label = std::string(),
		const RCP< ParameterList > &	params = null )

inlinestatic

Helper function to do matrix-matrix multiply.

Returns C = AB.

Parameters

A	left matrix
transposeA	if true, use the transpose of A
B	right matrix
transposeB	if true, use the transpose of B
callFillCompleteOnResult	if true, the resulting matrix should be fillComplete'd

Definition at line 636 of file Xpetra_MatrixMatrix.hpp.

◆ MLTwoMatrixMultiply() [2/2]

static RCP< Epetra_CrsMatrix > Xpetra::MatrixMatrix< double, int, long long, EpetraNode >::MLTwoMatrixMultiply	(	const Epetra_CrsMatrix &	epA,
		const Epetra_CrsMatrix &	epB,
		Teuchos::FancyOStream &	fos )

inlinestatic

Definition at line 644 of file Xpetra_MatrixMatrix.hpp.

◆ TwoMatrixMultiplyBlock() [2/2]

static RCP< BlockedCrsMatrix > Xpetra::MatrixMatrix< double, int, long long, EpetraNode >::TwoMatrixMultiplyBlock	(	const BlockedCrsMatrix &	A,
		bool	transposeA,
		const BlockedCrsMatrix &	B,
		bool	transposeB,
		Teuchos::FancyOStream &	fos,
		bool	doFillComplete = true,
		bool	doOptimizeStorage = true )

inlinestatic

Helper function to do matrix-matrix multiply "in-place".

Returns RCP to non-constant Xpetra::BlockedCrsMatrix.

Parameters

A	left matrix
transposeA	if true, use the transpose of A
B	right matrix
transposeB	if true, use the transpose of B
doOptimizeStorage	if true, the resulting matrix should be fillComplete'd

Definition at line 662 of file Xpetra_MatrixMatrix.hpp.

◆ TwoMatrixAdd() [3/4]

static void Xpetra::MatrixMatrix< double, int, long long, EpetraNode >::TwoMatrixAdd	(	const Matrix &	A,
		bool	transposeA,
		SC	alpha,
		Matrix &	B,
		SC	beta )

inlinestatic

Helper function to calculate B = alpha*A + beta*B.

Parameters

A	left matrix operand
transposeA	indicate whether to use transpose of A
alpha	scalar multiplier for A
B	right matrix operand
beta	scalar multiplier for B

Returns: sum in B.

Note that B does not have to be fill-completed.

Definition at line 787 of file Xpetra_MatrixMatrix.hpp.

◆ TwoMatrixAdd() [4/4]

static void Xpetra::MatrixMatrix< double, int, long long, EpetraNode >::TwoMatrixAdd	(	const Matrix &	A,
		bool	transposeA,
		const SC &	alpha,
		const Matrix &	B,
		bool	transposeB,
		const SC &	beta,
		RCP< Matrix > &	C,
		Teuchos::FancyOStream &	fos,
		bool	AHasFixedNnzPerRow = false )

inlinestatic

Helper function to calculate C = alpha*A + beta*B.

Parameters

A	left matrix operand
transposeA	indicate whether to use transpose of A
alpha	scalar multiplier for A, defaults to 1.0
B	right matrix operand
transposeB	indicate whether to use transpose of B
beta	scalar multiplier for B, defaults to 1.0
C	resulting sum
fos	output stream for printing to screen
AHasFixedNnzPerRow

It is up to the caller to ensure that the resulting matrix sum is fillComplete'd.

Definition at line 820 of file Xpetra_MatrixMatrix.hpp.

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

Xpetra_MatrixMatrix.hpp

Static Public Member Functions

Private Types

Detailed Description

Member Typedef Documentation

◆ Scalar

◆ LocalOrdinal

◆ GlobalOrdinal

◆ Node

Member Function Documentation

◆ Multiply() [1/6]

◆ Multiply() [2/6]

◆ Multiply() [3/6]

◆ MLTwoMatrixMultiply() [1/2]

◆ TwoMatrixMultiplyBlock() [1/2]

◆ TwoMatrixAdd() [1/4]

◆ TwoMatrixAdd() [2/4]

◆ Multiply() [4/6]

◆ Multiply() [5/6]

◆ Multiply() [6/6]

◆ MLTwoMatrixMultiply() [2/2]

◆ TwoMatrixMultiplyBlock() [2/2]

◆ TwoMatrixAdd() [3/4]

◆ TwoMatrixAdd() [4/4]