From 5849e8417f26a46d785058325b1346f15e20b8a2 Mon Sep 17 00:00:00 2001 From: bangerth Date: Mon, 23 Apr 2012 13:59:13 +0000 Subject: [PATCH] Move around a couple functions and create a new documentation section. git-svn-id: https://svn.dealii.org/trunk@25430 0785d39b-7218-0410-832d-ea1e28bc413d --- deal.II/include/deal.II/lac/full_matrix.h | 117 ++++++++++++---------- 1 file changed, 66 insertions(+), 51 deletions(-) diff --git a/deal.II/include/deal.II/lac/full_matrix.h b/deal.II/include/deal.II/lac/full_matrix.h index 591da0b451..5b3d307e26 100644 --- a/deal.II/include/deal.II/lac/full_matrix.h +++ b/deal.II/include/deal.II/lac/full_matrix.h @@ -291,7 +291,16 @@ class FullMatrix : public Table<2,number> * @endverbatim */ explicit FullMatrix (const IdentityMatrix &id); + /** + * @} + */ + /** + * @name Copying into and out of other matrices + */ + /** + * @{ + */ /** * Assignment operator. @@ -343,6 +352,7 @@ class FullMatrix : public Table<2,number> FullMatrix & operator = (const LAPACKFullMatrix&); + /** * Assignment from different * matrix classes. This @@ -365,7 +375,53 @@ class FullMatrix : public Table<2,number> template void copy_transposed (const MATRIX&); - /** + /** + * Fill matrix with elements + * extracted from a tensor, + * taking rows included between + * r_i and r_j + * and columns between + * c_i and + * c_j. The resulting + * matrix is then inserted in the + * destination matrix at position + * (dst_r, dst_c) Checks + * on the indices are made. + */ + template + void + copy_from (Tensor<2,dim> &T, + const unsigned int src_r_i=0, + const unsigned int src_r_j=dim-1, + const unsigned int src_c_i=0, + const unsigned int src_c_j=dim-1, + const unsigned int dst_r=0, + const unsigned int dst_c=0); + + /** + * Insert a submatrix (also + * rectangular) into a tensor, + * putting its upper left element + * at the specified position + * (dst_r, dst_c) and + * the other elements + * consequently. Default values + * are chosen so that no + * parameter needs to be specified + * if the size of the tensor and + * that of the matrix coincide. + */ + template + void + copy_to(Tensor<2,dim> &T, + const unsigned int src_r_i=0, + const unsigned int src_r_j=dim-1, + const unsigned int src_c_i=0, + const unsigned int src_c_j=dim-1, + const unsigned int dst_r=0, + const unsigned int dst_c=0) const; + + /** * Fill rectangular block. * * A rectangular block of the @@ -421,9 +477,15 @@ class FullMatrix : public Table<2,number> const std::vector &p_rows, const std::vector &p_cols); -//@} -///@name Non-modifying operators -//@{ + /** + * @} + */ + /** + * @name Non-modifying operators + */ + /** + * @{ + */ /** * Comparison operator. Be @@ -995,53 +1057,6 @@ class FullMatrix : public Table<2,number> template void right_invert (const FullMatrix &M); - /** - * Fill matrix with elements - * extracted from a tensor, - * taking rows included between - * r_i and r_j - * and columns between - * c_i and - * c_j. The resulting - * matrix is then inserted in the - * destination matrix at position - * (dst_r, dst_c) Checks - * on the indices are made. - */ - template - void - copy_from (Tensor<2,dim> &T, - const unsigned int src_r_i=0, - const unsigned int src_r_j=dim-1, - const unsigned int src_c_i=0, - const unsigned int src_c_j=dim-1, - const unsigned int dst_r=0, - const unsigned int dst_c=0); - - /** - * Insert a submatrix (also - * rectangular) into a tensor, - * putting its upper left element - * at the specified position - * (dst_r, dst_c) and - * the other elements - * consequently. Default values - * are chosen so that no - * parameter needs to be specified - * if the size of the tensor and - * that of the matrix coincide. - */ - template - void - copy_to(Tensor<2,dim> &T, - const unsigned int src_r_i=0, - const unsigned int src_r_j=dim-1, - const unsigned int src_c_i=0, - const unsigned int src_c_j=dim-1, - const unsigned int dst_r=0, - const unsigned int dst_c=0) const; - - //@} ///@name Multiplications //@{ -- 2.39.5