From: David Wells Date: Tue, 3 Apr 2018 11:20:17 +0000 (-0400) Subject: Reword a comment in make_array_view. X-Git-Tag: v9.0.0-rc1~243^2 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=refs%2Fpull%2F6147%2Fhead;p=dealii.git Reword a comment in make_array_view. The term 'undefined' is not accurate; the order *is* defined, but it is an implementation detail. From this stack overflow post: https://stackoverflow.com/questions/49071748/data-alignment-and-ordering-in-recursively-defined-array/49627551#49627551 --- diff --git a/include/deal.II/base/array_view.h b/include/deal.II/base/array_view.h index 50ffacbb00..60f836de87 100644 --- a/include/deal.II/base/array_view.h +++ b/include/deal.II/base/array_view.h @@ -575,8 +575,8 @@ make_array_view (ArrayView &array_view) * * @param[in] vector The Tensor for which we want to have an array view * object. The array view corresponds to the entire object but the - * order in which the entries are presented in the array is undefined and can - * not be relied upon. + * order in which the entries are presented in the array is an implementation + * detail and should not be relied upon. * * @relatesalso ArrayView */ @@ -601,8 +601,8 @@ make_array_view (const Tensor &tensor) * * @param[in] vector The Tensor for which we want to have an array view * object. The array view corresponds to the entire object but the - * order in which the entries are presented in the array is undefined and can - * not be relied upon. + * order in which the entries are presented in the array is an implementation + * detail and should not be relied upon. * * @relatesalso ArrayView */ @@ -627,8 +627,8 @@ make_array_view (Tensor &tensor) * * @param[in] vector The SymmetricTensor for which we want to have an array * view object. The array view corresponds to the entire object but - * the order in which the entries are presented in the array is undefined and - * can not be relied upon. + * the order in which the entries are presented in the array is an + * implementation detail and should not be relied upon. * * @relatesalso ArrayView */ @@ -652,10 +652,10 @@ make_array_view (const SymmetricTensor &tensor) * Consequently, the return type of this function is a view to a set of writable * objects. * - * @param[in] vector The SymmetricTensor for which we want to have an array view - * object. The array view corresponds to the entire object but the - * order in which the entries are presented in the array is undefined and can - * not be relied upon. + * @param[in] vector The SymmetricTensor for which we want to have an array + * view object. The array view corresponds to the entire object but + * the order in which the entries are presented in the array is an + * implementation detail and should not be relied upon. * * @relatesalso ArrayView */ @@ -897,8 +897,8 @@ make_array_view (Table<2,ElementType> &table, * * @param[in] table The Table for which we want to have an array view object. * The array view corresponds to the entire table but the order in - * which the entries are presented in the array is undefined and can not be - * relied upon. + * which the entries are presented in the array is an implementation detail + * and should not be relied upon. * * @relatesalso ArrayView */ @@ -923,8 +923,8 @@ make_array_view (Table<2,ElementType> &table) * * @param[in] table The Table for which we want to have an array view object. * The array view corresponds to the entire table but the order in - * which the entries are presented in the array is undefined and can not be - * relied upon. + * which the entries are presented in the array is an implementation detail + * and should not be relied upon. * * @relatesalso ArrayView */ @@ -947,10 +947,10 @@ make_array_view (const Table<2,ElementType> &table) * Consequently, the return type of this function is a view to a set of * @p non-const objects. * - * @param[in] table The LAPACKFullMatrix for which we want to have an array view - * object. The array view corresponds to the entire object but the - * order in which the entries are presented in the array is undefined and can - * not be relied upon. + * @param[in] table The LAPACKFullMatrix for which we want to have an array + * view object. The array view corresponds to the entire object but + * the order in which the entries are presented in the array is an + * implementation detail and should not be relied upon. * * @relatesalso ArrayView */ @@ -973,10 +973,10 @@ make_array_view (LAPACKFullMatrix &matrix) * type because they contain immutable elements. Consequently, the return type * of this function is a view to a set of @p const objects. * - * @param[in] table The LAPACKFullMatrix for which we want to have an array view - * object. The array view corresponds to the entire object but the - * order in which the entries are presented in the array is undefined and can - * not be relied upon. + * @param[in] table The LAPACKFullMatrix for which we want to have an array + * view object. The array view corresponds to the entire object but + * the order in which the entries are presented in the array is an + * implementation detail and should not be relied upon. * * @relatesalso ArrayView */