#define __deal2__sparse_matrix_h
-/*---------------------------- sparsematrix.h ---------------------------*/
+/*---------------------------- sparse_matrix.h ---------------------------*/
#include <base/exceptions.h>
* matrix is of dimension
* $m \times n$.
*/
-
unsigned int n () const;
/**
* being this matrix.
*/
template <typename somenumber>
- void vmult (Vector<somenumber>& dst, const Vector<somenumber>& src) const;
+ void vmult (Vector<somenumber> &dst,
+ const Vector<somenumber> &src) const;
/**
* Matrix-vector multiplication:
* transposed matrix.
*/
template <typename somenumber>
- void Tvmult (Vector<somenumber>& dst, const Vector<somenumber>& src) const;
+ void Tvmult (Vector<somenumber> &dst,
+ const Vector<somenumber> &src) const;
/**
* Adding Matrix-vector
* matrix.
*/
template <typename somenumber>
- void vmult_add (Vector<somenumber>& dst, const Vector<somenumber>& src) const;
+ void vmult_add (Vector<somenumber> &dst,
+ const Vector<somenumber> &src) const;
/**
* Adding Matrix-vector
* the transposed matrix.
*/
template <typename somenumber>
- void Tvmult_add (Vector<somenumber>& dst, const Vector<somenumber>& src) const;
+ void Tvmult_add (Vector<somenumber> &dst,
+ const Vector<somenumber> &src) const;
/**
* Return the square of the norm
/**
* Compute the residual of an
- * equation @p{Ax=b}, where the
+ * equation @p{Mx=b}, where the
* residual is defined to be
- * @p{r=b-Ax} with @p{x} typically
+ * @p{r=b-Mx} with @p{x} typically
* being an approximate of the
* true solution of the
* equation. Write the residual
- * into @p{dst}.
+ * into @p{dst}. The l2 norm of
+ * the residual vector is
+ * returned.
*/
template <typename somenumber>
somenumber residual (Vector<somenumber> &dst,
const number omega = 1.) const;
/**
- * Apply SOR preconditioning to
+ * Apply SSOR preconditioning to
* @p{src}.
*/
template <typename somenumber>
};
-/*---------------------------- sparsematrix.h ---------------------------*/
+/*---------------------------- sparse_matrix.h ---------------------------*/
#endif
-/*---------------------------- sparsematrix.h ---------------------------*/
+/*---------------------------- sparse_matrix.h ---------------------------*/