Epetra Development
Loading...
Searching...
No Matches
List of all members
Epetra_SerialDenseOperator Class Referenceabstract

Epetra_SerialDenseOperator: A pure virtual class for using real-valued double-precision operators. More...

#include <Epetra_SerialDenseOperator.h>

Inheritance diagram for Epetra_SerialDenseOperator:
Inheritance graph
[legend]

Public Member Functions

Destructor
virtual ~Epetra_SerialDenseOperator ()
 Destructor.
 
Attribute set methods
virtual int SetUseTranspose (bool UseTranspose)=0
 If set true, transpose of this operator will be applied.
 
Mathematical functions
virtual int Apply (const Epetra_SerialDenseMatrix &X, Epetra_SerialDenseMatrix &Y)=0
 Returns the result of a Epetra_SerialDenseOperator applied to a Epetra_SerialDenseMatrix X in Y.
 
virtual int ApplyInverse (const Epetra_SerialDenseMatrix &X, Epetra_SerialDenseMatrix &Y)=0
 Returns the result of a Epetra_SerialDenseOperator inverse applied to an Epetra_SerialDenseMatrix X in Y.
 
virtual double NormInf () const =0
 Returns the infinity norm of the global matrix.
 
Attribute access functions
virtual const char * Label () const =0
 Returns a character string describing the operator.
 
virtual bool UseTranspose () const =0
 Returns the current UseTranspose setting.
 
virtual bool HasNormInf () const =0
 Returns true if the this object can provide an approximate Inf-norm, false otherwise.
 
virtual int RowDim () const =0
 Returns the row dimension of operator.
 
virtual int ColDim () const =0
 Returns the column dimension of operator.
 

Detailed Description

Epetra_SerialDenseOperator: A pure virtual class for using real-valued double-precision operators.

The Epetra_SerialDenseOperator class is a pure virtual class (specifies interface only) that enable the use of real-valued double-precision operators. It is currently implemented by the Epetra_SerialDenseMatrix, Epetra_SerialDenseSolver and Epetra_SerialDenseSVD classes.

Member Function Documentation

◆ Apply()

virtual int Epetra_SerialDenseOperator::Apply ( const Epetra_SerialDenseMatrix & X,
Epetra_SerialDenseMatrix & Y )
pure virtual

Returns the result of a Epetra_SerialDenseOperator applied to a Epetra_SerialDenseMatrix X in Y.

Parameters
InX - A Epetra_SerialDenseMatrix to multiply with operator.
OutY -A Epetra_SerialDenseMatrix containing result.
Returns
Integer error code, set to 0 if successful.

Implemented in Epetra_SerialDenseMatrix, and Epetra_SerialDenseSVD.

◆ ApplyInverse()

virtual int Epetra_SerialDenseOperator::ApplyInverse ( const Epetra_SerialDenseMatrix & X,
Epetra_SerialDenseMatrix & Y )
pure virtual

Returns the result of a Epetra_SerialDenseOperator inverse applied to an Epetra_SerialDenseMatrix X in Y.

Parameters
InX - A Epetra_SerialDenseMatrix to solve for.
OutY -A Epetra_SerialDenseMatrix containing result.
Returns
Integer error code, set to 0 if successful.

Implemented in Epetra_SerialDenseMatrix, and Epetra_SerialDenseSVD.

◆ ColDim()

virtual int Epetra_SerialDenseOperator::ColDim ( ) const
pure virtual

Returns the column dimension of operator.

Implemented in Epetra_SerialDenseMatrix, and Epetra_SerialDenseSVD.

◆ HasNormInf()

virtual bool Epetra_SerialDenseOperator::HasNormInf ( ) const
pure virtual

Returns true if the this object can provide an approximate Inf-norm, false otherwise.

Implemented in Epetra_SerialDenseMatrix, and Epetra_SerialDenseSVD.

◆ Label()

virtual const char * Epetra_SerialDenseOperator::Label ( ) const
pure virtual

Returns a character string describing the operator.

Implemented in Epetra_SerialDenseMatrix, and Epetra_SerialDenseSVD.

◆ NormInf()

virtual double Epetra_SerialDenseOperator::NormInf ( ) const
pure virtual

Returns the infinity norm of the global matrix.

Implemented in Epetra_SerialDenseMatrix, Epetra_SerialDenseSVD, Epetra_SerialDenseVector, and Epetra_SerialSymDenseMatrix.

Referenced by Epetra_SerialDenseMatrix::InfNorm().

◆ RowDim()

virtual int Epetra_SerialDenseOperator::RowDim ( ) const
pure virtual

Returns the row dimension of operator.

Implemented in Epetra_SerialDenseMatrix, and Epetra_SerialDenseSVD.

◆ SetUseTranspose()

virtual int Epetra_SerialDenseOperator::SetUseTranspose ( bool UseTranspose)
pure virtual

If set true, transpose of this operator will be applied.

This flag allows the transpose of the given operator to be used implicitly. Setting this flag affects only the Apply() and ApplyInverse() methods. If the implementation of this interface does not support transpose use, this method should return a value of -1.

Parameters
InUseTranspose -If true, multiply by the transpose of operator, otherwise just use operator.
Returns
Integer error code, set to 0 if successful. Set to -1 if this implementation does not support transpose.

Implemented in Epetra_SerialDenseSVD, and Epetra_SerialDenseMatrix.

◆ UseTranspose()

virtual bool Epetra_SerialDenseOperator::UseTranspose ( ) const
pure virtual

Returns the current UseTranspose setting.

Implemented in Epetra_SerialDenseMatrix, and Epetra_SerialDenseSVD.


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