From ecebfc67413af42505a761efacb4a618697b5c95 Mon Sep 17 00:00:00 2001 From: Wolfgang Bangerth Date: Sat, 22 Jul 2017 13:33:50 -0600 Subject: [PATCH] Better document the extract_subvector_to() functions. This commit deals with the variant of the function that takes vectors. --- include/deal.II/lac/block_vector_base.h | 13 +++++++++++-- include/deal.II/lac/la_parallel_vector.h | 17 +++++++++++++---- include/deal.II/lac/petsc_vector_base.h | 17 +++++++++++++---- include/deal.II/lac/read_write_vector.h | 17 +++++++++++++---- include/deal.II/lac/trilinos_precondition.h | 2 +- include/deal.II/lac/trilinos_vector.h | 17 +++++++++++++---- include/deal.II/lac/vector.h | 13 +++++++++++-- 7 files changed, 75 insertions(+), 21 deletions(-) diff --git a/include/deal.II/lac/block_vector_base.h b/include/deal.II/lac/block_vector_base.h index 2e61d86c03..e68248f13d 100644 --- a/include/deal.II/lac/block_vector_base.h +++ b/include/deal.II/lac/block_vector_base.h @@ -681,10 +681,19 @@ public: reference operator[] (const size_type i); /** - * A collective get operation: instead of getting individual elements of a - * vector, this function allows to get a whole set of elements at once. The + * Instead of getting individual elements of a vector via operator(), + * this function allows getting a whole set of elements at once. The * indices of the elements to be read are stated in the first argument, the * corresponding values are returned in the second. + * + * If the current vector is called @p v, then this function is the equivalent + * to the code + * @code + * for (unsigned int i=0; i void extract_subvector_to (const std::vector &indices, diff --git a/include/deal.II/lac/la_parallel_vector.h b/include/deal.II/lac/la_parallel_vector.h index 7edb31bee4..1ed2f5ef1e 100644 --- a/include/deal.II/lac/la_parallel_vector.h +++ b/include/deal.II/lac/la_parallel_vector.h @@ -875,10 +875,19 @@ namespace LinearAlgebra Number &local_element (const size_type local_index); /** - * A collective get operation: instead of getting individual elements of - * a vector, this function allows to get a whole set of elements at - * once. The indices of the elements to be read are stated in the first - * argument, the corresponding values are returned in the second. + * Instead of getting individual elements of a vector via operator(), + * this function allows getting a whole set of elements at once. The + * indices of the elements to be read are stated in the first argument, the + * corresponding values are returned in the second. + * + * If the current vector is called @p v, then this function is the equivalent + * to the code + * @code + * for (unsigned int i=0; i void extract_subvector_to (const std::vector &indices, diff --git a/include/deal.II/lac/petsc_vector_base.h b/include/deal.II/lac/petsc_vector_base.h index e3eefbba8d..046add9481 100644 --- a/include/deal.II/lac/petsc_vector_base.h +++ b/include/deal.II/lac/petsc_vector_base.h @@ -415,10 +415,19 @@ namespace PETScWrappers const std::vector &values); /** - * A collective get operation: instead of getting individual elements of a - * vector, this function allows to get a whole set of elements at once. - * The indices of the elements to be read are stated in the first - * argument, the corresponding values are returned in the second. + * Instead of getting individual elements of a vector via operator(), + * this function allows getting a whole set of elements at once. The + * indices of the elements to be read are stated in the first argument, the + * corresponding values are returned in the second. + * + * If the current vector is called @p v, then this function is the equivalent + * to the code + * @code + * for (unsigned int i=0; i &indices, std::vector &values) const; diff --git a/include/deal.II/lac/read_write_vector.h b/include/deal.II/lac/read_write_vector.h index 80f29e2425..4d3ee82d39 100644 --- a/include/deal.II/lac/read_write_vector.h +++ b/include/deal.II/lac/read_write_vector.h @@ -409,10 +409,19 @@ namespace LinearAlgebra Number &operator [] (const size_type global_index); /** - * Instead of getting individual elements of a vector, this function - * allows to get a whole set of elements at once. The indices of the - * elements to be read are stated in the first argument, the corresponding - * values are returned in the second. + * Instead of getting individual elements of a vector via operator(), + * this function allows getting a whole set of elements at once. The + * indices of the elements to be read are stated in the first argument, the + * corresponding values are returned in the second. + * + * If the current vector is called @p v, then this function is the equivalent + * to the code + * @code + * for (unsigned int i=0; i void extract_subvector_to (const std::vector &indices, diff --git a/include/deal.II/lac/trilinos_precondition.h b/include/deal.II/lac/trilinos_precondition.h index 1bec3c5c73..f5380c1594 100644 --- a/include/deal.II/lac/trilinos_precondition.h +++ b/include/deal.II/lac/trilinos_precondition.h @@ -1527,7 +1527,7 @@ namespace TrilinosWrappers * * This initialization routine is useful in cases where the operator to be * preconditioned is not a TrilinosWrappers::SparseMatrix object but still - * allows to get a copy of the entries in each of the locally owned matrix + * allows getting a copy of the entries in each of the locally owned matrix * rows (method ExtractMyRowCopy) and implements a matrix-vector product * (methods Multiply or Apply). An example are operators which provide * faster matrix-vector multiplications than possible with matrix entries diff --git a/include/deal.II/lac/trilinos_vector.h b/include/deal.II/lac/trilinos_vector.h index a2bfbd686c..812f712b39 100644 --- a/include/deal.II/lac/trilinos_vector.h +++ b/include/deal.II/lac/trilinos_vector.h @@ -905,10 +905,19 @@ namespace TrilinosWrappers operator[] (const size_type index) const; /** - * A collective get operation: instead of getting individual elements of a - * vector, this function allows to get a whole set of elements at once. - * The indices of the elements to be read are stated in the first - * argument, the corresponding values are returned in the second. + * Instead of getting individual elements of a vector via operator(), + * this function allows getting a whole set of elements at once. The + * indices of the elements to be read are stated in the first argument, the + * corresponding values are returned in the second. + * + * If the current vector is called @p v, then this function is the equivalent + * to the code + * @code + * for (unsigned int i=0; i &indices, std::vector &values) const; diff --git a/include/deal.II/lac/vector.h b/include/deal.II/lac/vector.h index d81bb464ef..5563227287 100644 --- a/include/deal.II/lac/vector.h +++ b/include/deal.II/lac/vector.h @@ -567,10 +567,19 @@ public: Number &operator[] (const size_type i); /** - * A collective get operation: instead of getting individual elements of a - * vector, this function allows to get a whole set of elements at once. The + * Instead of getting individual elements of a vector via operator(), + * this function allows getting a whole set of elements at once. The * indices of the elements to be read are stated in the first argument, the * corresponding values are returned in the second. + * + * If the current vector is called @p v, then this function is the equivalent + * to the code + * @code + * for (unsigned int i=0; i void extract_subvector_to (const std::vector &indices, -- 2.39.5