Playa::GenericTwoSidedPreconditioner< Scalar > Class Template Reference

Inheritance diagram for Playa::GenericTwoSidedPreconditioner< Scalar >:

List of all members.

Public Member Functions
	GenericTwoSidedPreconditioner (const LinearOperator< Scalar > &left, const LinearOperator< Scalar > &right)
virtual	~GenericTwoSidedPreconditioner ()
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_
LinearOperator< Scalar >	right_

---

Detailed Description

template<class Scalar>
class Playa::GenericTwoSidedPreconditioner< 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 PlayaGenericTwoSidedPreconditioner.hpp.

---

Constructor & Destructor Documentation

template<class Scalar>

Playa::GenericTwoSidedPreconditioner< Scalar >::GenericTwoSidedPreconditioner	(	const LinearOperator< Scalar > &	left,
		const LinearOperator< Scalar > &	right
	)		[inline]

construct with an operator for the two-sided preconditioner

Definition at line 64 of file PlayaGenericTwoSidedPreconditioner.hpp.

template<class Scalar>

virtual Playa::GenericTwoSidedPreconditioner< Scalar >::~GenericTwoSidedPreconditioner

(

)

[inline, virtual]

virtual dtor

Definition at line 68 of file PlayaGenericTwoSidedPreconditioner.hpp.

---

Member Function Documentation

template<class Scalar>

virtual bool Playa::GenericTwoSidedPreconditioner< Scalar >::hasLeft

(

)

const [inline, virtual]

return true because this preconditioner has a nontrivial left component.

Implements Playa::PreconditionerBase< Scalar >.

Definition at line 79 of file PlayaGenericTwoSidedPreconditioner.hpp.

template<class Scalar>

virtual bool Playa::GenericTwoSidedPreconditioner< Scalar >::hasRight

(

)

const [inline, virtual]

return true because this preconditioner has a nontrivial right component.

Implements Playa::PreconditionerBase< Scalar >.

Definition at line 83 of file PlayaGenericTwoSidedPreconditioner.hpp.

template<class Scalar>

virtual LinearOperator<Scalar> Playa::GenericTwoSidedPreconditioner< Scalar >::left

(

)

const [inline, virtual]

Return the left operator

Implements Playa::PreconditionerBase< Scalar >.

Definition at line 72 of file PlayaGenericTwoSidedPreconditioner.hpp.

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

template<class Scalar>

virtual LinearOperator<Scalar> Playa::GenericTwoSidedPreconditioner< Scalar >::right

(

)

const [inline, virtual]

Return the right operator

Implements Playa::PreconditionerBase< Scalar >.

Definition at line 75 of file PlayaGenericTwoSidedPreconditioner.hpp.

References Playa::GenericTwoSidedPreconditioner< Scalar >::right_.

---

Member Data Documentation

template<class Scalar>

LinearOperator<Scalar> Playa::GenericTwoSidedPreconditioner< Scalar >::left_ [private]

Definition at line 89 of file PlayaGenericTwoSidedPreconditioner.hpp.

Referenced by Playa::GenericTwoSidedPreconditioner< Scalar >::left().

template<class Scalar>

LinearOperator<Scalar> Playa::GenericTwoSidedPreconditioner< Scalar >::right_ [private]

Definition at line 90 of file PlayaGenericTwoSidedPreconditioner.hpp.

Referenced by Playa::GenericTwoSidedPreconditioner< Scalar >::right().