From: wolf Date: Tue, 14 Aug 2001 09:47:52 +0000 (+0000) Subject: Add some docs. X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=58b9cef482fbff5feb98b243cbd5fb8d04728b0e;p=dealii-svn.git Add some docs. git-svn-id: https://svn.dealii.org/trunk@4881 0785d39b-7218-0410-832d-ea1e28bc413d --- diff --git a/deal.II/deal.II/include/fe/fe_update_flags.h b/deal.II/deal.II/include/fe/fe_update_flags.h index 5cbf01d3a0..5be06a2f93 100644 --- a/deal.II/deal.II/include/fe/fe_update_flags.h +++ b/deal.II/deal.II/include/fe/fe_update_flags.h @@ -206,33 +206,62 @@ enum UpdateFlags }; + +/** + * Global operator which sets the bits from the second argument also + * in the first one. + */ inline UpdateFlags & -operator |= (UpdateFlags& f1, const UpdateFlags& f2) +operator |= (UpdateFlags &f1, const UpdateFlags &f2) { f1 = static_cast (f1 | f2); return f1; } + +/** + * Global operator which returns an object in which all bits are set + * which are either set in the first or the second argument. This + * operator exists since if it did not then the result of the bit-or + * @p{operator |} would be an integer which would in turn trigger a + * compiler warning when we tried to assign it to an object of type + * @ref{UpdateFlags}. + */ inline UpdateFlags -operator | (const UpdateFlags& f1, const UpdateFlags& f2) +operator | (const UpdateFlags &f1, const UpdateFlags &f2) { UpdateFlags result = f1; result |= f2; return result; } + + +/** + * Global operator which clears all the bits in the first argument if + * they are not also set in the second argument. + */ inline UpdateFlags & -operator &= (UpdateFlags& f1, const UpdateFlags& f2) +operator &= (UpdateFlags &f1, const UpdateFlags &f2) { f1 = static_cast (f1 & f2); return f1; } + +/** + * Global operator which returns an object in which all bits are set + * which are set in the first as well as the second argument. This + * operator exists since if it did not then the result of the bit-and + * @p{operator &} would be an integer which would in turn trigger a + * compiler warning when we tried to assign it to an object of type + * @ref{UpdateFlags}. + */ inline UpdateFlags operator & (const UpdateFlags& f1, const UpdateFlags& f2)