From: Wolfgang Bangerth Date: Fri, 18 Mar 2016 07:10:50 +0000 (-0500) Subject: Update description of a couple of exceptions. X-Git-Tag: v8.5.0-rc1~1202^2 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=refs%2Fpull%2F2370%2Fhead;p=dealii.git Update description of a couple of exceptions. --- diff --git a/include/deal.II/base/exceptions.h b/include/deal.II/base/exceptions.h index 770bd2a679..722ab92ee0 100644 --- a/include/deal.II/base/exceptions.h +++ b/include/deal.II/base/exceptions.h @@ -1054,8 +1054,8 @@ namespace StandardExceptions /** - * Special assertion, testing whether vec has size dim1, and - * each entry of the vector has the size dim2 + * An assertion that tests whether vec has size dim1, and + * each entry of the vector is itself an array that has the size dim2. * * @ingroup Exceptions * @author Guido Kanschat 2010 @@ -1065,14 +1065,9 @@ namespace StandardExceptions /** - * Special assertion for index range of nonnegative indices. - * - * Since this is used very often and always repeats the arguments, we - * introduce this special assertion for ExcIndexRange in order to keep the - * user codes shorter. - * - * Called wit arguments index and range it asserts that - * index<range and throws ExcIndexRange(index,0,range) if it + * An assertion that tests that a given index is within the half-open + * range [0,range). It throws an exception object + * ExcIndexRange(index,0,range) if the assertion * fails. * * @ingroup Exceptions @@ -1081,6 +1076,18 @@ namespace StandardExceptions #define AssertIndexRange(index,range) Assert((index) < (range), \ dealii::ExcIndexRange((index),0,(range))) +/** + * An assertion that tests that a given index is within the half-open + * range [0,range). It throws an exception object + * ExcIndexRange(index,0,range) if the assertion + * fails. + * + * This variation of the AssertIndexRange assertion is used for indices of type + * types::global_dof_index for which we need to make special accommodations because + * they may not fit into the regular 32-bit integer indices used in AssertIndexRange. + * + * @ingroup Exceptions + */ #define AssertGlobalIndexRange(index,range) Assert((index) < (range), \ ExcIndexRange((index),0,(range)))