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

Default concrete LinearOpBase subclass for diagonal linear operators. More...

#include <Thyra_DefaultDiagonalLinearOpDecl.hpp>

Inheritance diagram for Thyra::DefaultDiagonalLinearOp< Scalar >:

Inheritance graph
[legend]
List of all members.

Constructors/initializers/accessors

 DefaultDiagonalLinearOp ()
 Constructs to uninitialized.
 DefaultDiagonalLinearOp (const RCP< const VectorSpaceBase< Scalar > > &space)
 Calls initialize() to construct given a vector space.
 DefaultDiagonalLinearOp (const RCP< VectorBase< Scalar > > &diag)
 Calls initialize() to construct for a non-const diagonal vector.
 DefaultDiagonalLinearOp (const RCP< const VectorBase< Scalar > > &diag)
 Calls initialize() to construct for a const diagonal vector.
void initialize (const RCP< const VectorSpaceBase< Scalar > > &space)
 Initialize given a vector space which allocates a vector internally.
void initialize (const RCP< VectorBase< Scalar > > &diag)
 Initialize given a non-const diagonal vector.
void initialize (const RCP< const VectorBase< Scalar > > &diag)
 Initialize given a const diagonal vector.
void uninitialize ()
 Uninitialize.

Overridden from DiagonalLinearOpBase

bool isDiagConst () const
 
RCP< VectorBase< Scalar > > getNonconstDiag ()
 
RCP< const VectorBase< Scalar > > getDiag () const
 

Overridden from LinearOpBase

RCP< const VectorSpaceBase<
Scalar > > 
range () const
 Returns this->getDiag()->space().
RCP< const VectorSpaceBase<
Scalar > > 
domain () const
 Returns this->getDiag()->space().
RCP< const LinearOpBase< Scalar > > clone () const
 

Overridden from SingleScalarLinearOpBase

bool opSupported (EOpTransp M_trans) const
 

Overridden from SingleRhsLinearOpBase

void apply (const EOpTransp M_trans, const VectorBase< Scalar > &x, VectorBase< Scalar > *y, const Scalar alpha, const Scalar beta) const
 

Related Functions

(Note that these are not member functions.)

RCP< const LinearOpBase< Scalar > > diagonal (const RCP< VectorBase< Scalar > > &diag, const std::string &label="")
 Nonmember constructor function.

Detailed Description

template<class Scalar>
class Thyra::DefaultDiagonalLinearOp< Scalar >

Default concrete LinearOpBase subclass for diagonal linear operators.

This class represents a diagonal linear operator M of the form:

 M = diag(diag)

 

where diag is a VectorBase object.

The defined operator implements <tt>this->apply() as follows:

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

 y(i) = alpha*diag(i)*x(i) + beta*y(i), for i = 0 ... n-1

 

where n = this->domain()->dim().

Examples:

test_scalar_product.cpp.

Definition at line 68 of file Thyra_DefaultDiagonalLinearOpDecl.hpp.


Constructor & Destructor Documentation

template<class Scalar>
Thyra::DefaultDiagonalLinearOp< Scalar >::DefaultDiagonalLinearOp (  ) 

Constructs to uninitialized.

Postconditions:

Definition at line 45 of file Thyra_DefaultDiagonalLinearOp.hpp.

template<class Scalar>
Thyra::DefaultDiagonalLinearOp< Scalar >::DefaultDiagonalLinearOp ( const RCP< const VectorSpaceBase< Scalar > > &  space  ) 

Calls initialize() to construct given a vector space.

Definition at line 50 of file Thyra_DefaultDiagonalLinearOp.hpp.

template<class Scalar>
Thyra::DefaultDiagonalLinearOp< Scalar >::DefaultDiagonalLinearOp ( const RCP< VectorBase< Scalar > > &  diag  ) 

Calls initialize() to construct for a non-const diagonal vector.

Definition at line 59 of file Thyra_DefaultDiagonalLinearOp.hpp.

template<class Scalar>
Thyra::DefaultDiagonalLinearOp< Scalar >::DefaultDiagonalLinearOp ( const RCP< const VectorBase< Scalar > > &  diag  ) 

Calls initialize() to construct for a const diagonal vector.

Definition at line 68 of file Thyra_DefaultDiagonalLinearOp.hpp.


Member Function Documentation

template<class Scalar>
void Thyra::DefaultDiagonalLinearOp< Scalar >::initialize ( const RCP< const VectorSpaceBase< Scalar > > &  space  ) 

Initialize given a vector space which allocates a vector internally.

Parameters:
space [in] Smart pointer to vector space
Preconditions:

Postconditions:

Definition at line 77 of file Thyra_DefaultDiagonalLinearOp.hpp.

template<class Scalar>
void Thyra::DefaultDiagonalLinearOp< Scalar >::initialize ( const RCP< VectorBase< Scalar > > &  diag  ) 

Initialize given a non-const diagonal vector.

Parameters:
diag [in] Smart pointer to diagonal vector.
Preconditions:

Postconditions:

Definition at line 89 of file Thyra_DefaultDiagonalLinearOp.hpp.

template<class Scalar>
void Thyra::DefaultDiagonalLinearOp< Scalar >::initialize ( const RCP< const VectorBase< Scalar > > &  diag  ) 

Initialize given a const diagonal vector.

Parameters:
diag [in] Smart pointer to diagonal vector.
Preconditions:

Postconditions:

Definition at line 98 of file Thyra_DefaultDiagonalLinearOp.hpp.

template<class Scalar>
void Thyra::DefaultDiagonalLinearOp< Scalar >::uninitialize (  ) 

Uninitialize.

Postconditions:

Note: If the client wants to hold on to the underlying wrapped diagonal vector then they had better grab it using this->getDiag() or this->getNonconstDiag() before calling this function!

Definition at line 107 of file Thyra_DefaultDiagonalLinearOp.hpp.

template<class Scalar>
bool Thyra::DefaultDiagonalLinearOp< Scalar >::isDiagConst (  )  const [virtual]

Implements Thyra::DiagonalLinearOpBase< Scalar >.

Definition at line 117 of file Thyra_DefaultDiagonalLinearOp.hpp.

template<class Scalar>
RCP< VectorBase< Scalar > > Thyra::DefaultDiagonalLinearOp< Scalar >::getNonconstDiag (  )  [virtual]

Implements Thyra::DiagonalLinearOpBase< Scalar >.

Definition at line 125 of file Thyra_DefaultDiagonalLinearOp.hpp.

template<class Scalar>
RCP< const VectorBase< Scalar > > Thyra::DefaultDiagonalLinearOp< Scalar >::getDiag (  )  const [virtual]

Implements Thyra::DiagonalLinearOpBase< Scalar >.

Definition at line 133 of file Thyra_DefaultDiagonalLinearOp.hpp.

template<class Scalar>
RCP< const VectorSpaceBase< Scalar > > Thyra::DefaultDiagonalLinearOp< Scalar >::range (  )  const [virtual]

Returns this->getDiag()->space().

Preconditions:

Implements Thyra::LinearOpBase< Scalar >.

Definition at line 144 of file Thyra_DefaultDiagonalLinearOp.hpp.

template<class Scalar>
RCP< const VectorSpaceBase< Scalar > > Thyra::DefaultDiagonalLinearOp< Scalar >::domain (  )  const [virtual]

Returns this->getDiag()->space().

Preconditions:

Implements Thyra::LinearOpBase< Scalar >.

Definition at line 152 of file Thyra_DefaultDiagonalLinearOp.hpp.

template<class Scalar>
RCP< const LinearOpBase< Scalar > > Thyra::DefaultDiagonalLinearOp< Scalar >::clone (  )  const [virtual]

Reimplemented from Thyra::LinearOpBase< Scalar >.

Definition at line 160 of file Thyra_DefaultDiagonalLinearOp.hpp.

template<class Scalar>
bool Thyra::DefaultDiagonalLinearOp< Scalar >::opSupported ( EOpTransp  M_trans  )  const [protected, virtual]

Implements Thyra::SingleScalarLinearOpBase< Scalar >.

Definition at line 173 of file Thyra_DefaultDiagonalLinearOp.hpp.

template<class Scalar>
void Thyra::DefaultDiagonalLinearOp< Scalar >::apply ( const EOpTransp  M_trans,
const VectorBase< Scalar > &  x,
VectorBase< Scalar > *  y,
const Scalar  alpha,
const Scalar  beta 
) const [protected, virtual]

Implements Thyra::SingleRhsLinearOpBase< Scalar >.

Definition at line 183 of file Thyra_DefaultDiagonalLinearOp.hpp.


Friends And Related Function Documentation

template<class Scalar>
RCP< const LinearOpBase< Scalar > > diagonal ( const RCP< VectorBase< Scalar > > &  diag,
const std::string &  label = "" 
) [related]

Nonmember constructor function.

Definition at line 243 of file Thyra_DefaultDiagonalLinearOpDecl.hpp.


The documentation for this class was generated from the following files:
Generated on Wed May 12 21:42:32 2010 for Thyra Operator/Vector Support by  doxygen 1.4.7