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

Concrete decorator LinearOpBase subclass that wraps a LinearOpBase object and adds on an extra scaling factor and/or a transpose enum. More...

#include <Thyra_DefaultScaledAdjointLinearOpDecl.hpp>

Inheritance diagram for Thyra::DefaultScaledAdjointLinearOp< Scalar >:

[legend]
List of all members.

Constructors/initializers/accessors

 DefaultScaledAdjointLinearOp ()
 Constructs to uninitialized.
 DefaultScaledAdjointLinearOp (const Scalar &scalar, const ETransp &transp, const Teuchos::RefCountPtr< LinearOpBase< Scalar > > &Op)
 Calls initialize().
 DefaultScaledAdjointLinearOp (const Scalar &scalar, const ETransp &transp, const Teuchos::RefCountPtr< const LinearOpBase< Scalar > > &Op)
 Calls initialize().
void initialize (const Scalar &scalar, const ETransp &transp, const Teuchos::RefCountPtr< LinearOpBase< Scalar > > &Op)
 Initialize with an operator with by defining adjoint (transpose) and scaling arguments.
void initialize (const Scalar &scalar, const ETransp &transp, const Teuchos::RefCountPtr< const LinearOpBase< Scalar > > &Op)
 Initialize with an operator with by defining adjoint (transpose) and scaling arguments.
Teuchos::RefCountPtr< LinearOpBase<
Scalar > > 
getNonconstOp ()
 Return the non-const linear operator passed into initialize().
Teuchos::RefCountPtr< const
LinearOpBase< Scalar > > 
getOp () const
 Return the const linear operator passed into initialize().
void uninitialize ()
 Set to uninitialized and (optionally) extract the objects passed into initialize().

Overridden from Teuchos::Describable

std::string description () const
 Outputs DefaultScaledAdjointLinearOp<Scalar>{this->getOrigOp().description()) along with the dimensions.
void describe (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel) const
 Prints out the original operator as well as all of the scalings and transpositions in the order that they occurred.

Overridden from OpBase

Teuchos::RefCountPtr< const
VectorSpaceBase< Scalar > > 
range () const
 Return the range space of the logical linear operator.
Teuchos::RefCountPtr< const
VectorSpaceBase< Scalar > > 
domain () const
 Return the domain space of the logical linear operator.
Teuchos::RefCountPtr< const
LinearOpBase< Scalar > > 
clone () const
 
bool opSupported (ETransp M_trans) const

Overridden from LinearOpBase

void apply (const ETransp M_trans, const MultiVectorBase< Scalar > &X, MultiVectorBase< Scalar > *Y, const Scalar alpha, const Scalar beta) const
 Apply the linear operator (or its transpose) to a multi-vector : Y = alpha*op(M)*X + beta*Y.

Overridden from ScaledAdointLinearOpBase

Scalar overallScalar () const
 
ETransp overallTransp () const
 
Teuchos::RefCountPtr< LinearOpBase<
Scalar > > 
getNonconstOrigOp ()
 
Teuchos::RefCountPtr< const
LinearOpBase< Scalar > > 
getOrigOp () const
 

Related Functions

(Note that these are not member functions.)

Teuchos::RefCountPtr< LinearOpBase<
Scalar > > 
nonconstScale (const Scalar &scalar, const Teuchos::RefCountPtr< LinearOpBase< Scalar > > &Op)
 Build an implicit non-const scaled linear operator.
Teuchos::RefCountPtr< const
LinearOpBase< Scalar > > 
scale (const Scalar &scalar, const Teuchos::RefCountPtr< const LinearOpBase< Scalar > > &Op)
 Build an implicit const scaled linear operator.
Teuchos::RefCountPtr< LinearOpBase<
Scalar > > 
nonconstAdjoint (const Teuchos::RefCountPtr< LinearOpBase< Scalar > > &Op)
 Build an implicit non-const adjoined linear operator.
Teuchos::RefCountPtr< const
LinearOpBase< Scalar > > 
adjoint (const Teuchos::RefCountPtr< const LinearOpBase< Scalar > > &Op)
 Build an implicit const adjoined linear operator.
Teuchos::RefCountPtr< LinearOpBase<
Scalar > > 
nonconstTranspose (const Teuchos::RefCountPtr< LinearOpBase< Scalar > > &Op)
 Build an implicit non-const transposed linear operator.
Teuchos::RefCountPtr< const
LinearOpBase< Scalar > > 
transpose (const Teuchos::RefCountPtr< const LinearOpBase< Scalar > > &Op)
 Build an implicit const transposed linear operator.
Teuchos::RefCountPtr< LinearOpBase<
Scalar > > 
nonconstScaleAndAdjoint (const Scalar &scalar, const ETransp &transp, const Teuchos::RefCountPtr< LinearOpBase< Scalar > > &Op)
 Build an implicit non-const scaled and/or adjoined (transposed) linear operator.
Teuchos::RefCountPtr< const
LinearOpBase< Scalar > > 
scaleAndAdjoint (const Scalar &scalar, const ETransp &transp, const Teuchos::RefCountPtr< const LinearOpBase< Scalar > > &Op)
 Build an implicit const scaled and/or adjoined (transposed) linear operator.

Detailed Description

template<class Scalar>
class Thyra::DefaultScaledAdjointLinearOp< Scalar >

Concrete decorator LinearOpBase subclass that wraps a LinearOpBase object and adds on an extra scaling factor and/or a transpose enum.

This class represents a scaled, adjointed (transposed) linear operator M of the form:

 
  M = scalar * op(Op)

where Op is another LinearOpBase object, scalar is a Scalar, and the operation op(Op) is specified by a ETransp and is given as op(Op) = Op (NOTRANS), or op(Op) = Op^T (TRANS), or op(Op) = Op^H (CONJTRANS). Of course the operator M is not constructed explicitly but instead just applies the decorated operator Op by modifying the apply() function that calls Op.apply().

This subclass is designed to allow the efficient handling of multiple implicit scalings and/or adjoints (transposes) and allow these implicit transformations to be reversed. A sequence of scalings/adjoints from some original LinearOpBase object origOp is shown as:


 M = scalar_n * op_n( ... scalar_2 * op_2( scalar_1 * op_1( origOp ) ) ... )

   =>

 M  = overallScalar * overall_op(origOp)

where overallScalar and overall_op(...) are the cumulative transformations given as:


 overallScalar = scalar_n * ... * scalar_2 * ... * scalar_1

 overall_op(origOp) = op_n( ... op_2( op_1( ... op_n( origOp ) ... ) ) )

Each individual transformation pair (scalar_i,op_i(...)) is specified with arguments Scalar scalar and ETransp transp. The overall scaling is returned using this->overallScalar(), the overall adjoint enum is returned using this->overallTransp(), and the original linear operator is returned from <tt>this->getOrigOp().

The operator most recently wrapped is returned from <tt>this->getOp(). The individual scalings and transformations are not exposed from this interface but can be viewed by calling this->description() with a verbosity level of ???. The arguments passed into the constructor DefaultScaledAdjointLinearOp() or initialize() can always be extracted using uninitialize().

This subclass keeps track of all of the individual scalings scalar_i and adjoining operations op_i(...) so that the description() function can print this out and also so that the operations can be reversed.

The copy constructor and assignment operators are declared private since some thought needs to be put into what they should mean.

Note: This class does not maintain any specific cached information about the original operator so it is safe, in some cases, to manipulate the original operator and still keep this intact and automatically updated for any changes that are made.

Examples:

test_composite_linear_ops.cpp.

Definition at line 112 of file Thyra_DefaultScaledAdjointLinearOpDecl.hpp.


Constructor & Destructor Documentation

template<class Scalar>
Thyra::DefaultScaledAdjointLinearOp< Scalar >::DefaultScaledAdjointLinearOp  )  [inline]
 

Constructs to uninitialized.

Postconditions:

Definition at line 507 of file Thyra_DefaultScaledAdjointLinearOpDecl.hpp.

template<class Scalar>
Thyra::DefaultScaledAdjointLinearOp< Scalar >::DefaultScaledAdjointLinearOp const Scalar &  scalar,
const ETransp transp,
const Teuchos::RefCountPtr< LinearOpBase< Scalar > > &  Op
[inline]
 

Calls initialize().

Note, instead of calling this constructor directly consider using the non-member functions described belos which create dynamically allocated Teuchos::RefCountPtr-wrapped objects.

Definition at line 514 of file Thyra_DefaultScaledAdjointLinearOpDecl.hpp.

template<class Scalar>
Thyra::DefaultScaledAdjointLinearOp< Scalar >::DefaultScaledAdjointLinearOp const Scalar &  scalar,
const ETransp transp,
const Teuchos::RefCountPtr< const LinearOpBase< Scalar > > &  Op
[inline]
 

Calls initialize().

Note, instead of calling this constructor directly consider using the non-member functions described belos which create dynamically allocated Teuchos::RefCountPtr-wrapped objects.

Definition at line 527 of file Thyra_DefaultScaledAdjointLinearOpDecl.hpp.


Member Function Documentation

template<class Scalar>
void Thyra::DefaultScaledAdjointLinearOp< Scalar >::initialize const Scalar &  scalar,
const ETransp transp,
const Teuchos::RefCountPtr< LinearOpBase< Scalar > > &  Op
 

Initialize with an operator with by defining adjoint (transpose) and scaling arguments.

Parameters:
scalar [in] Scalar argument defining scalar_0 (see introduction).
transp [in] Transpose argument defining op_0(...) (see introduction).
Op [in] Smart pointer to linear operator (persisting relationship).
Preconditions:
  • Op.get() != NULL

Postconditions:

  • ToDo: Fill these in!!!!

Definition at line 40 of file Thyra_DefaultScaledAdjointLinearOp.hpp.

template<class Scalar>
void Thyra::DefaultScaledAdjointLinearOp< Scalar >::initialize const Scalar &  scalar,
const ETransp transp,
const Teuchos::RefCountPtr< const LinearOpBase< Scalar > > &  Op
 

Initialize with an operator with by defining adjoint (transpose) and scaling arguments.

Parameters:
scalar [in] Scalar argument defining scalar_0 (see introduction).
transp [in] Transpose argument defining op_0(...) (see introduction).
Op [in] Smart pointer to linear operator (persisting relationship).
Preconditions:
  • Op.get() != NULL

Postconditions:

  • ToDo: Fill these in!!!!

Definition at line 50 of file Thyra_DefaultScaledAdjointLinearOp.hpp.

template<class Scalar>
Teuchos::RefCountPtr< LinearOpBase< Scalar > > Thyra::DefaultScaledAdjointLinearOp< Scalar >::getNonconstOp  ) 
 

Return the non-const linear operator passed into initialize().

Definition at line 61 of file Thyra_DefaultScaledAdjointLinearOp.hpp.

template<class Scalar>
Teuchos::RefCountPtr< const LinearOpBase< Scalar > > Thyra::DefaultScaledAdjointLinearOp< Scalar >::getOp  )  const
 

Return the const linear operator passed into initialize().

Definition at line 68 of file Thyra_DefaultScaledAdjointLinearOp.hpp.

template<class Scalar>
void Thyra::DefaultScaledAdjointLinearOp< Scalar >::uninitialize  ) 
 

Set to uninitialized and (optionally) extract the objects passed into initialize().

Postconditions:

Definition at line 74 of file Thyra_DefaultScaledAdjointLinearOp.hpp.

template<class Scalar>
std::string Thyra::DefaultScaledAdjointLinearOp< Scalar >::description  )  const
 

Outputs DefaultScaledAdjointLinearOp<Scalar>{this->getOrigOp().description()) along with the dimensions.

Definition at line 87 of file Thyra_DefaultScaledAdjointLinearOp.hpp.

template<class Scalar>
void Thyra::DefaultScaledAdjointLinearOp< Scalar >::describe Teuchos::FancyOStream out,
const Teuchos::EVerbosityLevel  verbLevel
const
 

Prints out the original operator as well as all of the scalings and transpositions in the order that they occurred.

This function outputs different levels of detail based on the value passed in for verbLevel:

ToDo: Finish documentation!

Reimplemented from Thyra::LinearOpDefaultBase< Scalar >.

Definition at line 99 of file Thyra_DefaultScaledAdjointLinearOp.hpp.

template<class Scalar>
Teuchos::RefCountPtr< const VectorSpaceBase< Scalar > > Thyra::DefaultScaledAdjointLinearOp< Scalar >::range  )  const
 

Return the range space of the logical linear operator.

Simply returns:

   return ( this->overallTransp()==NOTRANS ? this->getOrigOp()->range() : this->getOrigOp()->domain() );

Definition at line 154 of file Thyra_DefaultScaledAdjointLinearOp.hpp.

template<class Scalar>
Teuchos::RefCountPtr< const VectorSpaceBase< Scalar > > Thyra::DefaultScaledAdjointLinearOp< Scalar >::domain  )  const
 

Return the domain space of the logical linear operator.

Simply returns:

   return ( this->overallTransp()==NOTRANS ? this->getOrigOp()->domain() : this->getOrigOp()->range() );

Definition at line 162 of file Thyra_DefaultScaledAdjointLinearOp.hpp.

template<class Scalar>
Teuchos::RefCountPtr< const LinearOpBase< Scalar > > Thyra::DefaultScaledAdjointLinearOp< Scalar >::clone  )  const
 

Definition at line 170 of file Thyra_DefaultScaledAdjointLinearOp.hpp.

template<class Scalar>
bool Thyra::DefaultScaledAdjointLinearOp< Scalar >::opSupported ETransp  M_trans  )  const [virtual]
 

Return if the operation is supported on the logical linear operator.

Simply returns:

   return this->getOrigOp()->opSupported(trans_trans(this->overallTransp(),M_trans));

Implements Thyra::SingleScalarLinearOpBase< Scalar >.

Definition at line 176 of file Thyra_DefaultScaledAdjointLinearOp.hpp.

template<class Scalar>
void Thyra::DefaultScaledAdjointLinearOp< Scalar >::apply const ETransp  M_trans,
const MultiVectorBase< Scalar > &  X,
MultiVectorBase< Scalar > *  Y,
const Scalar  alpha,
const Scalar  beta
const [virtual]
 

Apply the linear operator (or its transpose) to a multi-vector : Y = alpha*op(M)*X + beta*Y.

Simply calls:

   this->getOrigOp()->apply(trans_trans(M_trans,this->overallTransp()),X,Y,(this->overallScalar()*alpha),beta)

Implements Thyra::SingleScalarLinearOpBase< Scalar >.

Definition at line 185 of file Thyra_DefaultScaledAdjointLinearOp.hpp.

template<class Scalar>
Scalar Thyra::DefaultScaledAdjointLinearOp< Scalar >::overallScalar  )  const [virtual]
 

Implements Thyra::ScaledAdjointLinearOpBase< Scalar >.

Definition at line 203 of file Thyra_DefaultScaledAdjointLinearOp.hpp.

template<class Scalar>
ETransp Thyra::DefaultScaledAdjointLinearOp< Scalar >::overallTransp  )  const [virtual]
 

Implements Thyra::ScaledAdjointLinearOpBase< Scalar >.

Definition at line 209 of file Thyra_DefaultScaledAdjointLinearOp.hpp.

template<class Scalar>
Teuchos::RefCountPtr< LinearOpBase< Scalar > > Thyra::DefaultScaledAdjointLinearOp< Scalar >::getNonconstOrigOp  )  [virtual]
 

Implements Thyra::ScaledAdjointLinearOpBase< Scalar >.

Definition at line 216 of file Thyra_DefaultScaledAdjointLinearOp.hpp.

template<class Scalar>
Teuchos::RefCountPtr< const LinearOpBase< Scalar > > Thyra::DefaultScaledAdjointLinearOp< Scalar >::getOrigOp  )  const [virtual]
 

Implements Thyra::ScaledAdjointLinearOpBase< Scalar >.

Definition at line 223 of file Thyra_DefaultScaledAdjointLinearOp.hpp.


Friends And Related Function Documentation

template<class Scalar>
Teuchos::RefCountPtr< LinearOpBase< Scalar > > nonconstScale const Scalar &  scalar,
const Teuchos::RefCountPtr< LinearOpBase< Scalar > > &  Op
[related]
 

Build an implicit non-const scaled linear operator.

Returns Teuchos::rcp(new DefaultScaledAdjointLinearOp<Scalar>(scalar,NOTRANS,Op).

Preconditions:

  • Op.get()!=NULL

Postconditions:

  • return.get()!=NULL

template<class Scalar>
Teuchos::RefCountPtr< const LinearOpBase< Scalar > > scale const Scalar &  scalar,
const Teuchos::RefCountPtr< const LinearOpBase< Scalar > > &  Op
[related]
 

Build an implicit const scaled linear operator.

Returns Teuchos::rcp(new DefaultScaledAdjointLinearOp<Scalar>(scalar,NOTRANS,Op).

Preconditions:

  • Op.get()!=NULL

Postconditions:

  • return.get()!=NULL

template<class Scalar>
Teuchos::RefCountPtr< LinearOpBase< Scalar > > nonconstAdjoint const Teuchos::RefCountPtr< LinearOpBase< Scalar > > &  Op  )  [related]
 

Build an implicit non-const adjoined linear operator.

Returns Teuchos::rcp(new DefaultScaledAdjointLinearOp<Scalar>(Teuchos::ScalarTraits<Scalar>::one(),CONJTRANS,Op).

Preconditions:

  • Op.get()!=NULL

Postconditions:

  • return.get()!=NULL

template<class Scalar>
Teuchos::RefCountPtr< const LinearOpBase< Scalar > > adjoint const Teuchos::RefCountPtr< const LinearOpBase< Scalar > > &  Op  )  [related]
 

Build an implicit const adjoined linear operator.

Returns Teuchos::rcp(new DefaultScaledAdjointLinearOp<Scalar>(Teuchos::ScalarTraits<Scalar>::one(),CONJTRANS,Op).

Preconditions:

  • Op.get()!=NULL

Postconditions:

  • return.get()!=NULL

template<class Scalar>
Teuchos::RefCountPtr< LinearOpBase< Scalar > > nonconstTranspose const Teuchos::RefCountPtr< LinearOpBase< Scalar > > &  Op  )  [related]
 

Build an implicit non-const transposed linear operator.

Returns Teuchos::rcp(new DefaultScaledAdjointLinearOp<Scalar>(Teuchos::ScalarTraits<Scalar>::one(),TRANS,Op).

Preconditions:

  • Op.get()!=NULL

Postconditions:

  • return.get()!=NULL

template<class Scalar>
Teuchos::RefCountPtr< const LinearOpBase< Scalar > > transpose const Teuchos::RefCountPtr< const LinearOpBase< Scalar > > &  Op  )  [related]
 

Build an implicit const transposed linear operator.

Returns Teuchos::rcp(new DefaultScaledAdjointLinearOp<Scalar>(Teuchos::ScalarTraits<Scalar>::one(),TRANS,Op).

Preconditions:

  • Op.get()!=NULL

Postconditions:

  • return.get()!=NULL

template<class Scalar>
Teuchos::RefCountPtr< LinearOpBase< Scalar > > nonconstScaleAndAdjoint const Scalar &  scalar,
const ETransp transp,
const Teuchos::RefCountPtr< LinearOpBase< Scalar > > &  Op
[related]
 

Build an implicit non-const scaled and/or adjoined (transposed) linear operator.

Returns Teuchos::rcp(new DefaultScaledAdjointLinearOp<Scalar>(scale,transp,Op).

Preconditions:

  • Op.get()!=NULL

Postconditions:

  • return.get()!=NULL

template<class Scalar>
Teuchos::RefCountPtr< const LinearOpBase< Scalar > > scaleAndAdjoint const Scalar &  scalar,
const ETransp transp,
const Teuchos::RefCountPtr< const LinearOpBase< Scalar > > &  Op
[related]
 

Build an implicit const scaled and/or adjoined (transposed) linear operator.

Returns Teuchos::rcp(new DefaultScaledAdjointLinearOp<Scalar>(scale,transp,Op).

Preconditions:

  • Op.get()!=NULL

Postconditions:

  • return.get()!=NULL


The documentation for this class was generated from the following files:
Generated on Thu Sep 18 12:32:33 2008 for Thyra Operator/Vector Support by doxygen 1.3.9.1