ShiftedMatrix< MATRIX > Class Template Reference
[Derived matrices]

List of all members.

Public Member Functions
	ShiftedMatrix (const MATRIX &A, const double sigma)
void	shift (const double sigma)
double	shift () const
template<class VECTOR >
void	vmult (VECTOR &dst, const VECTOR &src) const
template<class VECTOR >
double	residual (VECTOR &dst, const VECTOR &src, const VECTOR &rhs) const
Private Attributes
SmartPointer< const MATRIX >	A
double	sigma

---

Detailed Description

template<class MATRIX>
class ShiftedMatrix< MATRIX >

Matrix with shifted diagonal values.

Given a matrix A, this class implements a matrix-vector product with A+s I, where s is a provided shift parameter.

Author:

Guido Kanschat, 2000, 2001

---

Constructor & Destructor Documentation

template<class MATRIX >

ShiftedMatrix< MATRIX >::ShiftedMatrix	(	const MATRIX &	A,
		const double	sigma
	)			[inline]

Constructor. Provide the base matrix and a shift parameter.

---

Member Function Documentation

template<class MATRIX >

void ShiftedMatrix< MATRIX >::shift

(

const double

sigma

)

[inline]

Set the shift parameter.

References ShiftedMatrix< MATRIX >::sigma.

Referenced by EigenInverse< VECTOR >::solve().

template<class MATRIX >

double ShiftedMatrix< MATRIX >::shift

(

)

const [inline]

Access to the shift parameter.

References ShiftedMatrix< MATRIX >::sigma.

template<class MATRIX >

template<class VECTOR >

void ShiftedMatrix< MATRIX >::vmult	(	VECTOR &	dst,
		const VECTOR &	src
	)			const [inline]

Matrix-vector-product.

References ShiftedMatrix< MATRIX >::A, and ShiftedMatrix< MATRIX >::sigma.

template<class MATRIX >

template<class VECTOR >

double ShiftedMatrix< MATRIX >::residual	(	VECTOR &	dst,
		const VECTOR &	src,
		const VECTOR &	rhs
	)			const [inline]

Residual.

References ShiftedMatrix< MATRIX >::A, and ShiftedMatrix< MATRIX >::sigma.

---

Member Data Documentation

template<class MATRIX>

SmartPointer<const MATRIX> ShiftedMatrix< MATRIX >::A [private]

Storage for base matrix.

Referenced by ShiftedMatrix< MATRIX >::residual(), and ShiftedMatrix< MATRIX >::vmult().

template<class MATRIX>

double ShiftedMatrix< MATRIX >::sigma [private]

Auxiliary vector. Shift parameter.

Referenced by ShiftedMatrix< MATRIX >::residual(), ShiftedMatrix< MATRIX >::shift(), and ShiftedMatrix< MATRIX >::vmult().

---

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

• lac/include/lac/shifted_matrix.h