From: Timo Heister Date: Wed, 31 Oct 2018 07:27:00 +0000 (+0100) Subject: improve documentation X-Git-Tag: v9.1.0-rc1~582^2 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=c652c65933a4c925e94929e7e5d3f5788f1e01a8;p=dealii.git improve documentation Co-Authored-By: davydden --- diff --git a/include/deal.II/base/utilities.h b/include/deal.II/base/utilities.h index 846357a59f..e1598c2787 100644 --- a/include/deal.II/base/utilities.h +++ b/include/deal.II/base/utilities.h @@ -104,12 +104,12 @@ namespace Utilities const int bits_per_dim = 64); /** - * Interleave the least significant @p bits_per_dim bits from each element of @p index + * Pack the least significant @p bits_per_dim bits from each element of @p index * (starting from last) into a single unsigned integer. The last element - * of @p index will be used to set the first @p bits_per_dim in the - * resulting integer, the pre last element is used to set the next @p bits_per_dim, - * etc. Clearly, the following should hold bits\_per\_dim * dim <= - * 64. + * of @p index will be used to set the first @p bits_per_dim bits in the + * resulting integer, the second to last element is used to set the next @p bits_per_dim bits, + * etc.. To fit all the data into the output, the following should hold + * bits\_per\_dim * dim <= 64. * * The function is useful in debugging and visualization of indices returned * by inverse_Hilbert_space_filling_curve().