Thyra operator/vector fundamental interfaces

These are the fundamental Operator/Vector Interfaces that provide the foundation for all ANAs. More...

Collaboration diagram for Thyra operator/vector fundamental interfaces:

Classes
class	Thyra::LinearOpBase< Scalar >
	Base class for all linear operators. More...
class	Thyra::MultiVectorBase< Scalar >
	Interface for a collection of column vectors called a multi-vector. More...
class	Thyra::Exceptions::UnInitialized
	Thrown if any member functions are called before initialize() has been called. More...
class	Thyra::Exceptions::IncompatibleVectorSpaces
	Thrown if vector spaces are incompatible. More...
class	Thyra::Exceptions::OpNotSupported
class	Thyra::VectorBase< Scalar >
	Abstract interface for finite-dimensional dense vectors. More...
class	Thyra::VectorSpaceBase< Scalar >
	Abstract interface for objects that represent a space for vectors. More...
class	Thyra::VectorSpaceFactoryBase< Scalar >
	Abstract interface for objects that can create vector spaces of a specified dimension. More...

Typedefs
typedef Teuchos::Range1D	Thyra::Range1D

Enumerations
enum	Thyra::EViewType { Thyra::VIEW_TYPE_DIRECT , Thyra::VIEW_TYPE_DETACHED }
	Determines if a view is a direct view of data or a detached copy of data. More...
enum	Thyra::EStrideType { Thyra::STRIDE_TYPE_UNIT , Thyra::STRIDE_TYPE_NONUNIT }
	Determine if data is unit stride or non-unit stride. More...

Functions
const char *	Thyra::toString (EOpTransp transp)
	Return a string name for a EOpTransp value.
EOpTransp	Thyra::real_trans (EOpTransp transp)
	Return NOTRANS or TRANS for real scalar valued operators and this also is used for determining structural transpose.
EOpTransp	Thyra::not_trans (EOpTransp transp)
	Perform a not operation on an EOpTransp value.
EOpTransp	Thyra::trans_trans (EOpTransp trans1, EOpTransp trans2)
	Combine two transpose arguments.
EConj	Thyra::transToConj (EOpTransp trans)
	Convert from EOpTransp to EConj.
EOpTransp	Thyra::applyConjToTrans (EConj conj)
	Convert from EConj to EOpTransp for forward apply.
EOpTransp	Thyra::applyTransposeConjToTrans (EConj conj)
	Convert from EConj to EOpTransp for forward apply.

Variables
	Thyra::NOTRANS
	Type for the dimension of a vector space. `**/ typedef Teuchos::Ordinal Ordinal;.

Detailed Description

These are the fundamental Operator/Vector Interfaces that provide the foundation for all ANAs.

Typedef Documentation

Range1D

typedef Teuchos::Range1D Thyra::Range1D

Definition at line 65 of file Thyra_OperatorVectorTypes.hpp.

Enumeration Type Documentation

EViewType

enum Thyra::EViewType

Determines if a view is a direct view of data or a detached copy of data.

Enumerator
VIEW_TYPE_DIRECT	The view is a direct view of data and no copies are made.
VIEW_TYPE_DETACHED	The view is a detached copy of the data.

Definition at line 277 of file Thyra_OperatorVectorTypes.hpp.

EStrideType

enum Thyra::EStrideType

Determine if data is unit stride or non-unit stride.

Enumerator
STRIDE_TYPE_UNIT	The stride between elements in an array is one.
STRIDE_TYPE_NONUNIT	The stride between elements in an array is greater than or equal to one.

Definition at line 287 of file Thyra_OperatorVectorTypes.hpp.

Function Documentation

toString()

const char * Thyra::toString ( EOpTransp transp )

inline

Return a string name for a EOpTransp value.

Definition at line 149 of file Thyra_OperatorVectorTypes.hpp.

real_trans()

EOpTransp Thyra::real_trans ( EOpTransp transp )

inline

Return NOTRANS or TRANS for real scalar valued operators and this also is used for determining structural transpose.

Definition at line 168 of file Thyra_OperatorVectorTypes.hpp.

not_trans()

EOpTransp Thyra::not_trans ( EOpTransp transp )

inline

Perform a not operation on an EOpTransp value.

Definition at line 186 of file Thyra_OperatorVectorTypes.hpp.

trans_trans()

EOpTransp Thyra::trans_trans ( EOpTransp trans1, EOpTransp trans2 )

inline

Combine two transpose arguments.

Definition at line 204 of file Thyra_OperatorVectorTypes.hpp.

transToConj()

EConj Thyra::transToConj ( EOpTransp trans )

inline

Convert from EOpTransp to EConj.

Definition at line 229 of file Thyra_OperatorVectorTypes.hpp.

applyConjToTrans()

EOpTransp Thyra::applyConjToTrans ( EConj conj )

inline

Convert from EConj to EOpTransp for forward apply.

Definition at line 246 of file Thyra_OperatorVectorTypes.hpp.

applyTransposeConjToTrans()

EOpTransp Thyra::applyTransposeConjToTrans ( EConj conj )

inline

Convert from EConj to EOpTransp for forward apply.

Definition at line 262 of file Thyra_OperatorVectorTypes.hpp.

Variable Documentation

NOTRANS

Thyra::NOTRANS

Type for the dimension of a vector space. `**/ typedef Teuchos::Ordinal Ordinal;.

/** Enumeration for determining how a linear operator is applied. `*

*/ enum EConj { NONCONJ_ELE ///< Use the linear operator with non-conjugate elements. ,CONJ_ELE ///< Use the linear operator with conjugate elements. };

/** Return a string name for a EOpTransp value. `*

*/ inline const char* toString(EConj conj) { switch(conj) { case NONCONJ_ELE: return "NONCONJ_ELE"; case CONJ_ELE: return "CONJ_ELE"; default: TEUCHOS_TEST_FOR_EXCEPT(true); } return "BAD"; // Should never be called! }

/** Enumeration for determining how a linear operator is applied. `*

*/ enum EOpTransp { /** Use the non-transposed operator.

Definition at line 130 of file Thyra_OperatorVectorTypes.hpp.