Public Member Functions
Playa::GenericLeftPreconditioner< Scalar > Class Template Reference
Inheritance diagram for Playa::GenericLeftPreconditioner< Scalar >:
Playa::PreconditionerBase< Scalar > Playa::PreconditionerBase< Scalar > Playa::Handleable< PreconditionerBase< Scalar > > Playa::Handleable< PreconditionerBase< Scalar > >

List of all members.

Public Member Functions

 GenericLeftPreconditioner (const LinearOperator< Scalar > &left)
virtual ~GenericLeftPreconditioner ()
virtual LinearOperator< Scalar > left () const
virtual LinearOperator< Scalar > right () const
virtual bool hasLeft () const
virtual bool hasRight () const
 GenericLeftPreconditioner (const LinearOperator< Scalar > &left)
virtual ~GenericLeftPreconditioner ()
virtual LinearOperator< Scalar > left () const
virtual LinearOperator< Scalar > right () const
virtual bool hasLeft () const
virtual bool hasRight () const

Private Attributes

Handleable interface
LinearOperator< Scalar > left_

Detailed Description

template<class Scalar>
class Playa::GenericLeftPreconditioner< Scalar >

A one-size-fits-most left preconditioner that can be constructed by accepting an operator for the left op of the preconditioner.

Definition at line 60 of file PlayaGenericLeftPreconditioner.hpp.


Constructor & Destructor Documentation

template<class Scalar >
Playa::GenericLeftPreconditioner< Scalar >::GenericLeftPreconditioner ( const LinearOperator< Scalar > &  left) [inline]

construct with an operator for the left preconditioner

Definition at line 64 of file PlayaGenericLeftPreconditioner.hpp.

template<class Scalar >
virtual Playa::GenericLeftPreconditioner< Scalar >::~GenericLeftPreconditioner ( ) [inline, virtual]

virtual dtor

Definition at line 68 of file PlayaGenericLeftPreconditioner.hpp.

template<class Scalar >
Playa::GenericLeftPreconditioner< Scalar >::GenericLeftPreconditioner ( const LinearOperator< Scalar > &  left) [inline]

construct with

Definition at line 64 of file PlayaLeftPreconditioner.hpp.

template<class Scalar >
virtual Playa::GenericLeftPreconditioner< Scalar >::~GenericLeftPreconditioner ( ) [inline, virtual]

virtual dtor

Definition at line 68 of file PlayaLeftPreconditioner.hpp.


Member Function Documentation

template<class Scalar >
virtual bool Playa::GenericLeftPreconditioner< Scalar >::hasLeft ( ) const [inline, virtual]

return true because this preconditioner has a nontrivial left component.

Implements Playa::PreconditionerBase< Scalar >.

Definition at line 84 of file PlayaGenericLeftPreconditioner.hpp.

template<class Scalar >
virtual bool Playa::GenericLeftPreconditioner< Scalar >::hasLeft ( ) const [inline, virtual]

return true because this preconditioner has a nontrivial left component.

Implements Playa::PreconditionerBase< Scalar >.

Definition at line 84 of file PlayaLeftPreconditioner.hpp.

template<class Scalar >
virtual bool Playa::GenericLeftPreconditioner< Scalar >::hasRight ( ) const [inline, virtual]

return false, because this preconditioner has no nontrivial right component

Implements Playa::PreconditionerBase< Scalar >.

Definition at line 88 of file PlayaGenericLeftPreconditioner.hpp.

template<class Scalar >
virtual bool Playa::GenericLeftPreconditioner< Scalar >::hasRight ( ) const [inline, virtual]

return false, because this preconditioner has no nontrivial right component

Implements Playa::PreconditionerBase< Scalar >.

Definition at line 88 of file PlayaLeftPreconditioner.hpp.

template<class Scalar >
virtual LinearOperator<Scalar> Playa::GenericLeftPreconditioner< Scalar >::left ( ) const [inline, virtual]

Return the left operator

Implements Playa::PreconditionerBase< Scalar >.

Definition at line 72 of file PlayaLeftPreconditioner.hpp.

References Playa::GenericLeftPreconditioner< Scalar >::left_.

template<class Scalar >
virtual LinearOperator<Scalar> Playa::GenericLeftPreconditioner< Scalar >::left ( ) const [inline, virtual]

Return the left operator

Implements Playa::PreconditionerBase< Scalar >.

Definition at line 72 of file PlayaGenericLeftPreconditioner.hpp.

References Playa::GenericLeftPreconditioner< Scalar >::left_.

template<class Scalar >
virtual LinearOperator<Scalar> Playa::GenericLeftPreconditioner< Scalar >::right ( ) const [inline, virtual]

A call to right() results in an error for a left precond.

Implements Playa::PreconditionerBase< Scalar >.

Definition at line 75 of file PlayaGenericLeftPreconditioner.hpp.

template<class Scalar >
virtual LinearOperator<Scalar> Playa::GenericLeftPreconditioner< Scalar >::right ( ) const [inline, virtual]

A call to right() results in an error for a left precond.

Implements Playa::PreconditionerBase< Scalar >.

Definition at line 75 of file PlayaLeftPreconditioner.hpp.


Member Data Documentation

template<class Scalar >
LinearOperator< Scalar > Playa::GenericLeftPreconditioner< Scalar >::left_ [private]

Site Contact