MathTL::JacobiPreconditioner< MATRIX, VECTOR > Class Template Reference

#include <preconditioner.h>

Inheritance diagram for MathTL::JacobiPreconditioner< MATRIX, VECTOR >:

List of all members.

Public Types
typedef VECTOR::size_type	size_type
Public Member Functions
	JacobiPreconditioner (const MATRIX &A)
const size_type	row_dimension () const
void	apply (const VECTOR &x, VECTOR &Px) const
void	apply_preconditioner (const VECTOR &Px, VECTOR &x) const
Protected Attributes
const MATRIX &	A

---

Detailed Description

template<class MATRIX, class VECTOR>
class MathTL::JacobiPreconditioner< MATRIX, VECTOR >

As a nontrivial example class, provide the Jacobi preconditioner, i.e., P=diag(A).

---

Member Typedef Documentation

template<class MATRIX , class VECTOR >

typedef VECTOR::size_type MathTL::JacobiPreconditioner< MATRIX, VECTOR >::size_type

type of indices and size type (cf. STL containers)

Reimplemented from MathTL::Preconditioner< VECTOR >.

---

Constructor & Destructor Documentation

template<class MATRIX , class VECTOR >

MathTL::JacobiPreconditioner< MATRIX, VECTOR >::JacobiPreconditioner

(

const MATRIX &

A

)

default constructor, takes the matrix A as input parameter

---

Member Function Documentation

template<class MATRIX , class VECTOR >

void MathTL::JacobiPreconditioner< MATRIX, VECTOR >::apply	(	const VECTOR &	x,
		VECTOR &	Px
	)		const [virtual]

apply P, i.e., reverse the preconditioning

Implements MathTL::Preconditioner< VECTOR >.

template<class MATRIX , class VECTOR >

void MathTL::JacobiPreconditioner< MATRIX, VECTOR >::apply_preconditioner	(	const VECTOR &	Px,
		VECTOR &	x
	)		const [virtual]

apply P^{-1}, i.e., perform the preconditioning

Implements MathTL::Preconditioner< VECTOR >.

template<class MATRIX , class VECTOR >

const size_type MathTL::JacobiPreconditioner< MATRIX, VECTOR >::row_dimension

(

)

const [inline, virtual]

row dimension

Implements MathTL::Preconditioner< VECTOR >.

---

Member Data Documentation

template<class MATRIX , class VECTOR >

const MATRIX& MathTL::JacobiPreconditioner< MATRIX, VECTOR >::A [protected]

pointer to the matrix class under consideration

---

The documentation for this class was generated from the following files:

• numerics/preconditioner.h
• numerics/preconditioner.cpp