Extract numeric helpers from src/runtime into src/numeric

Signed-off-by: Juan Cruz Viotti <jv@jviotti.com>
sourcemeta · Sep 27, 2024 · ee07931 · ee07931
1 parent 57bdae3
commit ee07931
Show file tree

Hide file tree

Showing 15 changed files with 53 additions and 47 deletions.
diff --git a/Makefile b/Makefile
@@ -13,6 +13,7 @@ configure: .always
 	$(CMAKE) -S . -B ./build \
 		-DCMAKE_BUILD_TYPE:STRING=$(PRESET) \
 		-DCMAKE_COMPILE_WARNING_AS_ERROR:BOOL=ON \
+		-DJSONBINPACK_NUMERIC:BOOL=ON \
 		-DJSONBINPACK_RUNTIME:BOOL=ON \
 		-DJSONBINPACK_COMPILER:BOOL=ON \
 		-DJSONBINPACK_TESTS:BOOL=ON \

diff --git a/src/numeric/CMakeLists.txt b/src/numeric/CMakeLists.txt
@@ -1,5 +1,6 @@
 noa_library(NAMESPACE sourcemeta PROJECT jsonbinpack NAME numeric
-  FOLDER "JSON BinPack/Numeric")
+  FOLDER "JSON BinPack/Numeric"
+  PRIVATE_HEADERS integral.h real.h zigzag.h)
 
 if(JSONBINPACK_INSTALL)
   noa_library_install(NAMESPACE sourcemeta PROJECT jsonbinpack NAME numeric)

diff --git a/src/numeric/include/sourcemeta/jsonbinpack/numeric.h b/src/numeric/include/sourcemeta/jsonbinpack/numeric.h
@@ -1,9 +1,6 @@
 #ifndef SOURCEMETA_JSONBINPACK_NUMERIC_H_
 #define SOURCEMETA_JSONBINPACK_NUMERIC_H_
 
-#include <cstdint> // std::uint8_t, std::int64_t
-#include <limits>  // std::numeric_limits
-
 /// @defgroup numeric Numeric
 /// @brief A comprehensive numeric library for JSON BinPack
 ///
@@ -13,23 +10,8 @@
 /// #include <sourcemeta/jsonbinpack/numeric.h>
 /// ```
 
-namespace sourcemeta::jsonbinpack {
-
-/// @ingroup numeric
-template <typename T> constexpr auto is_byte(const T value) noexcept -> bool {
-  return value <= std::numeric_limits<std::uint8_t>::max();
-}
-
-/// @ingroup numeric
-constexpr auto count_multiples(const std::int64_t minimum,
-                               const std::int64_t maximum,
-                               const std::int64_t multiplier) -> std::uint64_t {
-  assert(minimum <= maximum);
-  assert(multiplier > 0);
-  return static_cast<std::uint64_t>((maximum / multiplier) -
-                                    ((minimum - 1) / multiplier));
-}
-
-} // namespace sourcemeta::jsonbinpack
+#include <sourcemeta/jsonbinpack/numeric_integral.h>
+#include <sourcemeta/jsonbinpack/numeric_real.h>
+#include <sourcemeta/jsonbinpack/numeric_zigzag.h>
 
 #endif
diff --git a/.../sourcemeta/jsonbinpack/runtime_numeric.h → ...sourcemeta/jsonbinpack/numeric_integral.h b/.../sourcemeta/jsonbinpack/runtime_numeric.h → ...sourcemeta/jsonbinpack/numeric_integral.h
@@ -1,27 +1,39 @@
-#ifndef SOURCEMETA_JSONBINPACK_RUNTIME_NUMERIC_H_
-#define SOURCEMETA_JSONBINPACK_RUNTIME_NUMERIC_H_
+#ifndef SOURCEMETA_JSONBINPACK_NUMERIC_INTEGRAL_H_
+#define SOURCEMETA_JSONBINPACK_NUMERIC_INTEGRAL_H_
 
 #include <cassert> // assert
 #include <cmath>   // std::abs
 #include <cstdint> // std::uint8_t, std::int64_t, std::uint64_t
 #include <limits>  // std::numeric_limits
 
-// TODO: Move to src/numeric
-
 namespace sourcemeta::jsonbinpack {
 
-template <unsigned int T> constexpr auto uint_max = (2 << (T - 1)) - 1;
-
+/// @ingroup numeric
 template <typename T> constexpr auto is_byte(const T value) noexcept -> bool {
   return value <= std::numeric_limits<std::uint8_t>::max();
 }
 
+/// @ingroup numeric
+constexpr auto count_multiples(const std::int64_t minimum,
+                               const std::int64_t maximum,
+                               const std::int64_t multiplier) -> std::uint64_t {
+  assert(minimum <= maximum);
+  assert(multiplier > 0);
+  return static_cast<std::uint64_t>((maximum / multiplier) -
+                                    ((minimum - 1) / multiplier));
+}
+
+/// @ingroup numeric
+template <unsigned int T> constexpr auto uint_max = (2 << (T - 1)) - 1;
+
+/// @ingroup numeric
 template <typename T>
 constexpr auto is_within(const T value, const std::int64_t lower,
                          const std::int64_t higher) noexcept -> bool {
   return value >= lower && value <= higher;
 }
 
+/// @ingroup numeric
 template <typename T>
 constexpr auto is_within(const T value, const std::uint64_t lower,
                          const std::uint64_t higher) noexcept -> bool {
@@ -33,6 +45,7 @@ constexpr auto is_within(const T value, const std::uint64_t lower,
   }
 }
 
+/// @ingroup numeric
 constexpr auto abs(const std::int64_t value) noexcept -> std::uint64_t {
   if (value < 0) {
     return static_cast<std::uint64_t>(value * -1);
@@ -41,6 +54,7 @@ constexpr auto abs(const std::int64_t value) noexcept -> std::uint64_t {
   }
 }
 
+/// @ingroup numeric
 constexpr auto divide_ceil(const std::int64_t dividend,
                            const std::uint64_t divisor) noexcept
     -> std::int64_t {
@@ -68,6 +82,7 @@ constexpr auto divide_ceil(const std::int64_t dividend,
   }
 }
 
+/// @ingroup numeric
 constexpr auto divide_floor(const std::int64_t dividend,
                             const std::uint64_t divisor) noexcept
     -> std::int64_t {
@@ -88,6 +103,7 @@ constexpr auto divide_floor(const std::int64_t dividend,
   }
 }
 
+/// @ingroup numeric
 constexpr auto closest_smallest_exponent(const std::uint64_t value,
                                          const std::uint8_t base,
                                          const std::uint8_t exponent_start,

diff --git a/...cemeta/jsonbinpack/runtime_encoder_real.h → ...ude/sourcemeta/jsonbinpack/numeric_real.h b/...cemeta/jsonbinpack/runtime_encoder_real.h → ...ude/sourcemeta/jsonbinpack/numeric_real.h
@@ -1,19 +1,18 @@
-#ifndef SOURCEMETA_JSONBINPACK_RUNTIME_ENCODER_REAL_H_
-#define SOURCEMETA_JSONBINPACK_RUNTIME_ENCODER_REAL_H_
+#ifndef SOURCEMETA_JSONBINPACK_NUMERIC_REAL_H_
+#define SOURCEMETA_JSONBINPACK_NUMERIC_REAL_H_
 
 #include <cassert>  // assert
 #include <cmath>    // std::modf, std::floor, std::isfinite
 #include <concepts> // std::floating_point, std::integral
 
-// TODO: Move to src/numeric
-
 namespace sourcemeta::jsonbinpack {
 
 // IEEE764 floating-point encoding is not precise. Some real numbers
 // cannot be represented directly and thus approximations must be
 // used. Here, we abuse those imprecision characteristics for
 // space-efficiency by performing rounding on a very, very low
 // threshold.
+/// @ingroup numeric
 template <std::floating_point Real>
 constexpr auto correct_ieee764(const Real value) -> Real {
   assert(std::isfinite(value));
@@ -29,6 +28,7 @@ constexpr auto correct_ieee764(const Real value) -> Real {
   }
 }
 
+/// @ingroup numeric
 template <std::integral Integer, std::floating_point Real>
 constexpr auto real_digits(Real value, std::uint64_t *point_position)
     -> Integer {

diff --git a/...e/sourcemeta/jsonbinpack/runtime_zigzag.h → ...e/sourcemeta/jsonbinpack/numeric_zigzag.h b/...e/sourcemeta/jsonbinpack/runtime_zigzag.h → ...e/sourcemeta/jsonbinpack/numeric_zigzag.h
@@ -1,13 +1,12 @@
-#ifndef SOURCEMETA_JSONBINPACK_RUNTIME_ZIGZAG_H_
-#define SOURCEMETA_JSONBINPACK_RUNTIME_ZIGZAG_H_
+#ifndef SOURCEMETA_JSONBINPACK_NUMERIC_ZIGZAG_H_
+#define SOURCEMETA_JSONBINPACK_NUMERIC_ZIGZAG_H_
 
 #include <cmath>   // std::abs
 #include <cstdint> // std::uint64_t, std::int64_t
 
-// TODO: Move to src/numeric
-
 namespace sourcemeta::jsonbinpack {
 
+/// @ingroup numeric
 constexpr auto zigzag_encode(const std::int64_t value) noexcept
     -> std::uint64_t {
   if (value >= 0) {
@@ -17,6 +16,7 @@ constexpr auto zigzag_encode(const std::int64_t value) noexcept
   return (static_cast<std::uint64_t>(std::abs(value)) * 2) - 1;
 }
 
+/// @ingroup numeric
 constexpr auto zigzag_decode(const std::uint64_t value) noexcept
     -> std::int64_t {
   if (value % 2 == 0) {

diff --git a/src/runtime/CMakeLists.txt b/src/runtime/CMakeLists.txt
@@ -2,9 +2,9 @@ noa_library(NAMESPACE sourcemeta PROJECT jsonbinpack NAME runtime
   FOLDER "JSON BinPack/Runtime"
   PRIVATE_HEADERS
     decoder.h decoder_basic.h
-    encoder.h encoder_basic.h encoder_context.h encoder_real.h
+    encoder.h encoder_basic.h encoder_context.h
     plan.h plan_wrap.h parser.h
-    zigzag.h varint.h numeric.h
+    varint.h
   SOURCES runtime_parser.cc runtime_parser_v1.h)
 
 if(JSONBINPACK_INSTALL)
@@ -13,3 +13,5 @@ endif()
 
 target_link_libraries(sourcemeta_jsonbinpack_runtime PUBLIC
   sourcemeta::jsontoolkit::json)
+target_link_libraries(sourcemeta_jsonbinpack_runtime PUBLIC
+  sourcemeta::jsonbinpack::numeric)
diff --git a/src/runtime/include/sourcemeta/jsonbinpack/runtime_decoder.h b/src/runtime/include/sourcemeta/jsonbinpack/runtime_decoder.h
@@ -1,8 +1,9 @@
 #ifndef SOURCEMETA_JSONBINPACK_RUNTIME_DECODER_H_
 #define SOURCEMETA_JSONBINPACK_RUNTIME_DECODER_H_
 
+#include <sourcemeta/jsonbinpack/numeric.h>
+
 #include <sourcemeta/jsonbinpack/runtime_decoder_basic.h>
-#include <sourcemeta/jsonbinpack/runtime_numeric.h>
 #include <sourcemeta/jsonbinpack/runtime_plan.h>
 #include <sourcemeta/jsonbinpack/runtime_plan_wrap.h>
 

diff --git a/src/runtime/include/sourcemeta/jsonbinpack/runtime_decoder_basic.h b/src/runtime/include/sourcemeta/jsonbinpack/runtime_decoder_basic.h
@@ -2,8 +2,9 @@
 #define SOURCEMETA_JSONBINPACK_RUNTIME_DECODER_BASIC_H_
 #ifndef DOXYGEN
 
+#include <sourcemeta/jsonbinpack/numeric.h>
+
 #include <sourcemeta/jsonbinpack/runtime_varint.h>
-#include <sourcemeta/jsonbinpack/runtime_zigzag.h>
 
 #include <cassert> // assert
 #include <cmath>   // std::ceil

diff --git a/src/runtime/include/sourcemeta/jsonbinpack/runtime_encoder.h b/src/runtime/include/sourcemeta/jsonbinpack/runtime_encoder.h
@@ -1,9 +1,9 @@
 #ifndef SOURCEMETA_JSONBINPACK_RUNTIME_ENCODER_H_
 #define SOURCEMETA_JSONBINPACK_RUNTIME_ENCODER_H_
 
+#include <sourcemeta/jsonbinpack/numeric.h>
+
 #include <sourcemeta/jsonbinpack/runtime_encoder_basic.h>
-#include <sourcemeta/jsonbinpack/runtime_encoder_real.h>
-#include <sourcemeta/jsonbinpack/runtime_numeric.h>
 #include <sourcemeta/jsonbinpack/runtime_plan.h>
 #include <sourcemeta/jsonbinpack/runtime_plan_wrap.h>
 

diff --git a/src/runtime/include/sourcemeta/jsonbinpack/runtime_encoder_basic.h b/src/runtime/include/sourcemeta/jsonbinpack/runtime_encoder_basic.h
@@ -2,9 +2,10 @@
 #define SOURCEMETA_JSONBINPACK_RUNTIME_ENCODER_BASIC_H_
 #ifndef DOXYGEN
 
+#include <sourcemeta/jsonbinpack/numeric.h>
+
 #include <sourcemeta/jsonbinpack/runtime_encoder_context.h>
 #include <sourcemeta/jsonbinpack/runtime_varint.h>
-#include <sourcemeta/jsonbinpack/runtime_zigzag.h>
 
 #include <algorithm> // std::find_if
 #include <cassert>   // assert

diff --git a/src/runtime/include/sourcemeta/jsonbinpack/runtime_plan.h b/src/runtime/include/sourcemeta/jsonbinpack/runtime_plan.h
@@ -1,7 +1,8 @@
 #ifndef SOURCEMETA_JSONBINPACK_RUNTIME_ENCODING_H_
 #define SOURCEMETA_JSONBINPACK_RUNTIME_ENCODING_H_
 
-#include <sourcemeta/jsonbinpack/runtime_numeric.h>
+#include <sourcemeta/jsonbinpack/numeric.h>
+
 #include <sourcemeta/jsontoolkit/json.h>
 
 #include <cstdint> // std::int64_t, std::uint64_t

diff --git a/test/runtime/decode_zigzag_test.cc b/test/runtime/decode_zigzag_test.cc
@@ -1,6 +1,6 @@
 #include <gtest/gtest.h>
 
-#include <sourcemeta/jsonbinpack/runtime_zigzag.h>
+#include <sourcemeta/jsonbinpack/numeric.h>
 #include <sourcemeta/jsontoolkit/json.h>
 
 #include <limits> // std::numeric_limits

diff --git a/test/runtime/encode_real_test.cc b/test/runtime/encode_real_test.cc
@@ -1,6 +1,6 @@
 #include <gtest/gtest.h>
 
-#include <sourcemeta/jsonbinpack/runtime_encoder_real.h>
+#include <sourcemeta/jsonbinpack/numeric.h>
 
 TEST(JSONBinPack_Encoder, real_digits_1) {
   const double input{3.14};

diff --git a/test/runtime/encode_zigzag_test.cc b/test/runtime/encode_zigzag_test.cc
@@ -2,7 +2,7 @@
 
 #include <limits> // std::numeric_limits
 
-#include <sourcemeta/jsonbinpack/runtime_zigzag.h>
+#include <sourcemeta/jsonbinpack/numeric.h>
 
 TEST(JSONBinPack_Encoder, zigzag_int_0_0) {
   const int value = 0;