diff options
Diffstat (limited to 'chilbert/Hilbert.hpp')
| -rw-r--r-- | chilbert/Hilbert.hpp | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/chilbert/Hilbert.hpp b/chilbert/Hilbert.hpp index 80b0247..8db5b1c 100644 --- a/chilbert/Hilbert.hpp +++ b/chilbert/Hilbert.hpp @@ -25,6 +25,9 @@ namespace chilbert { /** Map the point `p` to a Hilbert Index. * + * @tparam P Type used to represent a value in a point dimension. + * @tparam H Hilbert Index. + * * @param p Point with `n` dimensions. * @param m Precision of each dimension in bits. * @param n Number of dimensions. @@ -38,6 +41,9 @@ inline void coords_to_index(const P* const p, /** Map the Hilbert Index `p` to a point. * + * @tparam P Type used to represent a value in a point dimension. + * @tparam H Hilbert Index. + * * @param[out] p Point with `n` dimensions. * @param m Precision of each dimension in bits. * @param n Number of dimensions. @@ -51,6 +57,9 @@ inline void index_to_coords(P* const p, /** Map the point `p` to a Compact Hilbert Index. * + * @tparam P Type used to represent a value in a point dimension. + * @tparam H Compact Hilbert Index. + * * @param p Point with `n` dimensions. * @param ms Array of `n` precision values for each dimension in bits. * @param n Number of dimensions. @@ -68,6 +77,9 @@ inline void coords_to_compact_index(const P* const p, /** Map the Compact Hilbert Index `hc` to a point. * + * @tparam P Type used to represent a value in a point dimension. + * @tparam H Compact Hilbert Index. + * * @param[out] p Point with `n` dimensions. * @param ms Array of `n` precision values for each dimension in bits. * @param n Number of dimensions. |