Thyra::DefaultIdentityLinearOp< Scalar > Class Template Reference
[Development of linear Abstract Numerical Algorithms (ANAs) (Client Support)]

Represents a identity linear operator M = I. More...

#include <Thyra_DefaultIdentityLinearOp_decl.hpp>

Inheritance diagram for Thyra::DefaultIdentityLinearOp< Scalar >:
Inheritance graph
[legend]

List of all members.

Related Functions

(Note that these are not member functions.)



template<class Scalar >
RCP< const LinearOpBase< Scalar > > identity (const RCP< const VectorSpaceBase< Scalar > > &space, const std::string &label="")
 Create an identity linear operator with given a vector space.

Constructors/initializers/accessors



 DefaultIdentityLinearOp ()
 Constructs to uninitialized.
 DefaultIdentityLinearOp (const RCP< const VectorSpaceBase< Scalar > > &space)
void initialize (const RCP< const VectorSpaceBase< Scalar > > &space)
 Initialize given a list of non-const linear operators.
void uninitialize ()
 Set to uninitialized.

Overridden from LinearOpBase



RCP< const VectorSpaceBase
< Scalar > > 
range () const
 Returns Teuchos::null if uninitialized.
RCP< const VectorSpaceBase
< Scalar > > 
domain () const
 Returns Teuchos::null if uninitialized.
RCP< const LinearOpBase< Scalar > > clone () const
 
bool opSupportedImpl (EOpTransp M_trans) const
 Returns true .
void applyImpl (const EOpTransp M_trans, const MultiVectorBase< Scalar > &X, const Ptr< MultiVectorBase< Scalar > > &Y, const Scalar alpha, const Scalar beta) const
 

Overridden from Teuchos::Describable



std::string description () const
 Prints just the name DefaultIdentityLinearOp along with the overall dimensions.

Detailed Description

template<class Scalar>
class Thyra::DefaultIdentityLinearOp< Scalar >

Represents a identity linear operator M = I.

This class implements:


 y = alpha*op(M)*x + beta*y

 =>

 y = alpha*x + beta*y

 

Definition at line 54 of file Thyra_DefaultIdentityLinearOp_decl.hpp.


Constructor & Destructor Documentation

template<class Scalar >
Thyra::DefaultIdentityLinearOp< Scalar >::DefaultIdentityLinearOp (  )  [inline]

Constructs to uninitialized.

Postconditions:

Definition at line 44 of file Thyra_DefaultIdentityLinearOp_def.hpp.

template<class Scalar >
Thyra::DefaultIdentityLinearOp< Scalar >::DefaultIdentityLinearOp ( const RCP< const VectorSpaceBase< Scalar > > &  space  )  [inline]

Calls initialize().

Definition at line 49 of file Thyra_DefaultIdentityLinearOp_def.hpp.


Member Function Documentation

template<class Scalar >
void Thyra::DefaultIdentityLinearOp< Scalar >::initialize ( const RCP< const VectorSpaceBase< Scalar > > &  space  )  [inline]

Initialize given a list of non-const linear operators.

Parameters:
range [in] Range vector space.
range [in] Domain vector space.

Preconditions:

  • range.get()!=NULL
  • domain.get()!=NULL

Postconditions:

Definition at line 58 of file Thyra_DefaultIdentityLinearOp_def.hpp.

template<class Scalar >
void Thyra::DefaultIdentityLinearOp< Scalar >::uninitialize (  )  [inline]

Set to uninitialized.

Postconditions:

Definition at line 67 of file Thyra_DefaultIdentityLinearOp_def.hpp.

template<class Scalar >
Teuchos::RCP< const VectorSpaceBase< Scalar > > Thyra::DefaultIdentityLinearOp< Scalar >::range (  )  const [inline, virtual]

Returns Teuchos::null if uninitialized.

Implements Thyra::LinearOpBase< Scalar >.

Definition at line 78 of file Thyra_DefaultIdentityLinearOp_def.hpp.

template<class Scalar >
Teuchos::RCP< const VectorSpaceBase< Scalar > > Thyra::DefaultIdentityLinearOp< Scalar >::domain (  )  const [inline, virtual]

Returns Teuchos::null if uninitialized.

Implements Thyra::LinearOpBase< Scalar >.

Definition at line 86 of file Thyra_DefaultIdentityLinearOp_def.hpp.

template<class Scalar >
Teuchos::RCP< const LinearOpBase< Scalar > > Thyra::DefaultIdentityLinearOp< Scalar >::clone (  )  const [inline, virtual]

Reimplemented from Thyra::LinearOpBase< Scalar >.

Definition at line 94 of file Thyra_DefaultIdentityLinearOp_def.hpp.

template<class Scalar >
std::string Thyra::DefaultIdentityLinearOp< Scalar >::description (  )  const [inline, virtual]

Prints just the name DefaultIdentityLinearOp along with the overall dimensions.

Reimplemented from Teuchos::Describable.

Definition at line 107 of file Thyra_DefaultIdentityLinearOp_def.hpp.

template<class Scalar >
bool Thyra::DefaultIdentityLinearOp< Scalar >::opSupportedImpl ( EOpTransp  M_trans  )  const [inline, protected, virtual]

Returns true .

Implements Thyra::LinearOpBase< Scalar >.

Definition at line 126 of file Thyra_DefaultIdentityLinearOp_def.hpp.

template<class Scalar >
void Thyra::DefaultIdentityLinearOp< Scalar >::applyImpl ( const EOpTransp  M_trans,
const MultiVectorBase< Scalar > &  X,
const Ptr< MultiVectorBase< Scalar > > &  Y,
const Scalar  alpha,
const Scalar  beta 
) const [inline, protected, virtual]

Friends And Related Function Documentation

template<class Scalar >
RCP< const LinearOpBase< Scalar > > identity ( const RCP< const VectorSpaceBase< Scalar > > &  space,
const std::string &  label = "" 
) [related]

Create an identity linear operator with given a vector space.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Generated on Wed Apr 13 10:00:46 2011 for Thyra by  doxygen 1.6.3