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

#include <Thyra_DefaultIdentityLinearOp_decl.hpp>

Inheritance diagram for Thyra::DefaultIdentityLinearOp< Scalar >:

Private Member Functions
	DefaultIdentityLinearOp (const DefaultIdentityLinearOp &)
DefaultIdentityLinearOp &	operator= (const DefaultIdentityLinearOp &)
Private Attributes
RCP< const VectorSpaceBase < Scalar > >	space_
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 ( )

Constructs to uninitialized.

Postconditions:

this->range().get()==NULL

Definition at line 44 of file Thyra_DefaultIdentityLinearOp_def.hpp.

template<class Scalar >

Thyra::DefaultIdentityLinearOp< Scalar >::DefaultIdentityLinearOp ( const RCP< const VectorSpaceBase< Scalar > > & space )

Calls initialize().

template<class Scalar >

Thyra::DefaultIdentityLinearOp< Scalar >::DefaultIdentityLinearOp ( const DefaultIdentityLinearOp< Scalar > & ) [private]

Member Function Documentation

template<class Scalar >

void Thyra::DefaultIdentityLinearOp< Scalar >::initialize ( const RCP< const VectorSpaceBase< Scalar > > & space )

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:

this->range().get()==range.get()
this->domain().get()==domain.get()

template<class Scalar >

void Thyra::DefaultIdentityLinearOp< Scalar >::uninitialize ( )

Set to uninitialized.

Postconditions:

this->range().get()==NULL

Definition at line 67 of file Thyra_DefaultIdentityLinearOp_def.hpp.

template<class Scalar >

Teuchos::RCP< const VectorSpaceBase< Scalar > > Thyra::DefaultIdentityLinearOp< Scalar >::range ( ) const [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 [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 [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

Prints just the name DefaultIdentityLinearOp along with the overall dimensions.

Definition at line 107 of file Thyra_DefaultIdentityLinearOp_def.hpp.

template<class Scalar >

bool Thyra::DefaultIdentityLinearOp< Scalar >::opSupportedImpl ( EOpTransp M_trans ) const [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 `[protected, virtual]`