aboutsummaryrefslogtreecommitdiffstats
path: root/include/chilbert/chilbert.hpp
diff options
context:
space:
mode:
authorDavid Robillard <d@drobilla.net>2022-09-16 15:39:48 -0400
committerDavid Robillard <d@drobilla.net>2022-09-16 22:31:06 -0400
commit49dab5622b31421eb6af84eae376d73fae1cd4a0 (patch)
tree86290707551320ab35952bccc11c66df05714b26 /include/chilbert/chilbert.hpp
parent342a22b6d75597ee22c195b60607402e3ed028b2 (diff)
downloadchilbert-49dab5622b31421eb6af84eae376d73fae1cd4a0.tar.gz
chilbert-49dab5622b31421eb6af84eae376d73fae1cd4a0.tar.bz2
chilbert-49dab5622b31421eb6af84eae376d73fae1cd4a0.zip
Switch to meson build system
Diffstat (limited to 'include/chilbert/chilbert.hpp')
-rw-r--r--include/chilbert/chilbert.hpp96
1 files changed, 96 insertions, 0 deletions
diff --git a/include/chilbert/chilbert.hpp b/include/chilbert/chilbert.hpp
new file mode 100644
index 0000000..c55fc14
--- /dev/null
+++ b/include/chilbert/chilbert.hpp
@@ -0,0 +1,96 @@
+/*
+ Copyright (C) 2018 David Robillard <d@drobilla.net>
+ Copyright (C) 2006-2007 Chris Hamilton <chamilton@cs.dal.ca>
+
+ This program is free software: you can redistribute it and/or modify it under
+ the terms of the GNU General Public License as published by the Free Software
+ Foundation, either version 2 of the License, or (at your option) any later
+ version.
+
+ This program is distributed in the hope that it will be useful, but WITHOUT
+ ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
+ details.
+
+ You should have received a copy of the GNU General Public License along with
+ this program. If not, see <https://www.gnu.org/licenses/>.
+*/
+
+#ifndef CHILBERT_HILBERT_HPP
+#define CHILBERT_HILBERT_HPP
+
+#include <cstddef>
+
+namespace chilbert {
+
+/** Map the point `p` to a Hilbert Index.
+ *
+ * @tparam P Array-like type with [] operator that represents a point.
+ * @tparam H Hilbert Index.
+ *
+ * @param p Point with `n` dimensions.
+ * @param m Precision of each dimension in bits.
+ * @param n Number of dimensions.
+ * @param[out] h Hilbert Index.
+ */
+template <class P, class H>
+inline void coords_to_index(const P& p, size_t m, size_t n, H& h);
+
+/** Map the Hilbert Index `p` to a point.
+ *
+ * @tparam P Array-like type with [] operator that represents a point.
+ * @tparam H Hilbert Index.
+ *
+ * @param[out] p Point with `n` dimensions.
+ * @param m Precision of each dimension in bits.
+ * @param n Number of dimensions.
+ * @param h Hilbert Index.
+ */
+template <class P, class H>
+inline void index_to_coords(P& p, size_t m, size_t n, const H& h);
+
+/** Map the point `p` to a Compact Hilbert Index.
+ *
+ * @tparam P Array-like type with [] operator that represents a point.
+ * @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.
+ * @param[out] hc Compact Hilbert Index.
+ * @param M Optional net precision (sum of `ms`), the size of `hc` in bits.
+ * @param m Optional largest precision in `m`.
+ */
+template <class P, class H>
+inline void coords_to_compact_index(const P& p,
+ const size_t* ms,
+ size_t n,
+ H& hc,
+ size_t M = 0,
+ size_t m = 0);
+
+/** Map the Compact Hilbert Index `hc` to a point.
+ *
+ * @tparam P Array-like type with [] operator that represents a point.
+ * @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.
+ * @param hc Compact Hilbert Index.
+ * @param M Optional net precision (sum of `ms`), the size of `hc` in bits.
+ * @param m Optional largest precision in `m`.
+ */
+template <class P, class H>
+inline void compact_index_to_coords(P& p,
+ const size_t* ms,
+ size_t n,
+ const H& hc,
+ size_t M = 0,
+ size_t m = 0);
+
+} // namespace chilbert
+
+#include "chilbert/chilbert.ipp" // IWYU pragma: export
+
+#endif