physics-lib - Preparing the PR to upstream. Project CLang's configura…

…tion is upgraded to the 2b flag for the C++ standard. Internal partition for the details is a raw module
zerodaycode · TheRustifyer · May 4, 2023 · Mar 27, 2023 · Mar 29, 2023 · Mar 29, 2023
commit a527c909c1fdb2ef09f94ac14a99637026413031
diff --git a/zero/ifc/physics/README.md b/zero/ifc/physics/README.md
@@ -68,7 +68,7 @@ for define the symbol of kilogram, according to the `SI`
 ## Conversion
 
 We provide in the API an easy way to convert quantities of the same dimension (for the bases) or with the
-same dimensionality (for derived) with a simple template member function called `to<Magnitude Target>`.
+same dimensionality (for derived) with a simple template member function called `.to<Magnitude>()`.
 Here's an example:
 
 ```

diff --git a/zero/ifc/physics/quantities/internal/quantities_detail.cpp b/zero/ifc/physics/quantities/internal/quantities_detail.cpp
@@ -0,0 +1,66 @@
+/**
+ * @brief Partition for holding the implementation
+ * details that won't contribute to the external API of the
+ * units module.
+ *
+ * Due to the recursive function template for
+ * formatting the `derived magnitude symbols`, we can't use
+ * this as an internal partition, due to the linker is not able
+ * to resolve the template in order to link it at call site
+ */
+
+export module physics.quantities:quantities.detail;
+
+import std;
+
+import type_info;
+import str_manip;
+
+export namespace quantities::__detail {
+    template<typename T>
+    struct dimensions_exponents;
+
+    template<typename... BaseDimensions>
+    struct dimensions_exponents<std::tuple<BaseDimensions...>> {
+        static constexpr auto value = std::array<short, sizeof...(BaseDimensions)> {BaseDimensions::base_dimension::dimension::dimension_exp...};
+    };
+
+    template<typename T>
+    struct ratios_detail;
+
+    template<typename... BaseUnits>
+    struct ratios_detail<std::tuple<BaseUnits...>> {
+        using ratios = std::tuple<typename BaseUnits::ratio...>;
+    };
+
+    template <typename T>
+    struct ratios_product_calculator;
+
+    template<typename... BaseUnitsRatios>
+    struct ratios_product_calculator<std::tuple<BaseUnitsRatios...>> {
+        static constexpr auto value = (1 * ... * BaseUnitsRatios::value);
+    };
+
+    template<typename M, int N = 1>
+    void derived_magnitude_symbols(std::string& out) {
+        if constexpr (N == 1)
+            out += " ";
+
+        using type = typename std::tuple_element<N - 1, typename M::units>::type;
+        const auto total_elements = std::tuple_size<typename M::units>::value;
+        const int dim_exp = std::tuple_element<N - 1, typename M::derived_dimension::dimensions>::type::dimension_exp;
+
+        auto splitted = zero::split_str(zero::types::type_name<type>(), "::").back();
+        auto s_symbol = splitted.substr(0, splitted.length() - 1);
+
+        out += s_symbol;
+
+        if constexpr (dim_exp != 1)
+            out += std::to_string(dim_exp);
+        if constexpr (total_elements > N)
+            out += "*";
+
+        if constexpr (N - 1 < total_elements - 1)
+            derived_magnitude_symbols<M, N + 1>(out);
+    }
+}
diff --git a/zero/ifc/physics/quantities/internal/units_detail.cpp b/zero/ifc/physics/quantities/internal/units_detail.cpp
diff --git a/zero/ifc/physics/quantities/quantity.cppm b/zero/ifc/physics/quantities/quantity.cppm
@@ -1,6 +1,6 @@
 /**
  * @brief Module for design types and behavior associated with Physical Quantities.
- * 
+ *
  * A physical quantity can be understand as a real world magnitude, related with
  * their units in the international system
  */
@@ -15,7 +15,8 @@ import :ratios;
 import :dimensions;
 import :units;
 import :units.symbols;
-import :units.detail;
+import :quantities.detail;
+
 
 export namespace zero::physics {
     template <typename T>
@@ -275,30 +276,7 @@ export namespace zero::physics {
             return quantity<DM2, T2>((lhs.amount * dm1_dimensionality) / (rhs.amount * dm2_dimensionality));
     }
 
-    // TODO this template recursive function isn't linking from the details
-    // partition module, so it must be in the public API until we found a better solution
-    template<typename M, int N = 1>
-    void derived_magnitude_symbols(std::string& out) {
-        if constexpr (N == 1)
-            out += " ";
-
-        using type = typename std::tuple_element<N - 1, typename M::units>::type;
-        const auto total_elements = std::tuple_size<typename M::units>::value;
-        const int dim_exp = std::tuple_element<N - 1, typename M::derived_dimension::dimensions>::type::dimension_exp;
-
-        auto splitted = zero::split_str(zero::types::type_name<type>(), "::").back();
-        auto s_symbol = splitted.substr(0, splitted.length() - 1);
-
-        out += s_symbol;
 
-        if constexpr (dim_exp != 1)
-            out += std::to_string(dim_exp);
-        if constexpr (total_elements > N)
-            out += std::string{"*"};
-
-        if constexpr (N - 1 < total_elements - 1)
-            derived_magnitude_symbols<M, N + 1>(out);
-    }
 
     /**
      * Sends to an output stream a formatted version of some {@link quantity}
@@ -309,11 +287,10 @@ export namespace zero::physics {
             os << q.amount << " " << zero::split_str(zero::types::type_name<typename M::symbol>(), "::").back();
         else {
             std::string out;
-            derived_magnitude_symbols<M>(out);
+            ::derived_magnitude_symbols<M>(out);
             os << q.amount << out;
         }
 
         return os;
     }
 }
-
diff --git a/zero/ifc/physics/quantities/units.cppm b/zero/ifc/physics/quantities/units.cppm
@@ -11,7 +11,7 @@ import concepts;
 import :ratios;
 import :dimensions;
 import :units.symbols;
-import :units.detail;
+import :quantities.detail;
 
 using namespace quantities::__detail;
 

diff --git a/zork.toml b/zork.toml
@@ -56,7 +56,7 @@ interfaces = [
 
     # The physics library
         # The quantities library
-        { file = 'physics/quantities/internal/units_detail.cpp', partition = { module = 'physics.quantities', partition_name = 'units.detail' } },
+        { file = 'physics/quantities/internal/quantities_detail.cpp', partition = { module = 'physics.quantities', partition_name = 'quantities.detail' } },
 
         { file = 'physics/quantities/ratios.cppm', partition = { module = 'physics.quantities' } },
         { file = 'physics/quantities/units.symbols.cppm', module_name = 'units.symbols', partition = { module = 'physics.quantities' } },