Merge remote-tracking branch 'upstream/master' into feature/faster-CI

Author: burnpanck

.github/generate-job-matrix.py

@@ -88,7 +88,7 @@ def for_github(self):
         return ret
 
 
-def make_gcc_config(version: int) -> Platform:
+def make_gcc_platform(version: int) -> Platform:
     return Platform(
         name=f"GCC-{version}",
         os="ubuntu-24.04",
@@ -105,7 +105,7 @@ def make_gcc_config(version: int) -> Platform:
     )
 
 
-def make_clang_config(
+def make_clang_platform(
     version: int, architecture: typing.Literal["x86-64", "arm64"] = "x86-64"
 ) -> Platform:
     cfg = SimpleNamespace(
@@ -139,22 +139,24 @@ def make_clang_config(
     return Platform(**vars(ret))
 
 
-def make_apple_clang_config(version: int) -> Platform:
+def make_apple_clang_platform(
+    os: str, version: str, std_format_support: bool
+) -> Platform:
     ret = Platform(
         name=f"Apple Clang {version}",
-        os="macos-13",
+        os=os,
         compiler=Compiler(
             type="APPLE_CLANG",
-            version=f"{version}.0",
+            version=version,
             cc="clang",
             cxx="clang++",
         ),
-        feature_support=Features(),
+        feature_support=Features(std_format=std_format_support),
     )
     return ret
 
 
-def make_msvc_config(release: str, version: int) -> Platform:
+def make_msvc_platform(release: str, version: int) -> Platform:
     ret = Platform(
         name=f"MSVC {release}",
         os="windows-2022",
@@ -173,16 +175,24 @@ def make_msvc_config(release: str, version: int) -> Platform:
 
 platforms = {
     p.name: p
-    for p in [make_gcc_config(ver) for ver in [12, 13, 14]]
+    for p in [make_gcc_platform(ver) for ver in [12, 13, 14]]
     + [
-        make_clang_config(ver, arch)
+        make_clang_platform(ver, arch)
         for ver in [16, 17, 18]
         for arch in ["x86-64", "arm64"]
         # arm64 runners are expensive; only consider one version
         if ver == 18 or arch != "arm64"
     ]
-    + [make_apple_clang_config(ver) for ver in [15]]
-    + [make_msvc_config(release="14.4", version=194)]
+    + [
+        make_apple_clang_platform("macos-13", ver, std_format_support=False)
+        for ver in ["15.2"]
+    ]
+    # std::format is available in Xcode 16.1 or later
+    + [
+        make_apple_clang_platform("macos-14", ver, std_format_support=True)
+        for ver in ["16.1"]
+    ]
+    + [make_msvc_platform(release="14.4", version=194)]
 }
 
 full_matrix = dict(

.github/workflows/ci-test-package-cmake.yml

@@ -205,7 +205,13 @@ jobs:
         run: |
           cmake --preset conan-default -Dmp-units_DIR=../build -Bbuild/local
           cmake --build build/local --config ${{ matrix.build_type }}
+      - name: Run test_package-headers (local build)
+        shell: bash
+        working-directory: test_package/build/local/${{ matrix.build_type }}
+        run: |
+          ./test_package-headers
       - name: Run test_package (local build)
+        if: matrix.config.cxx_modules == 'True'
         shell: bash
         working-directory: test_package/build/local/${{ matrix.build_type }}
         run: |
@@ -225,7 +231,13 @@ jobs:
         run: |
           cmake --preset conan-default -DCMAKE_INSTALL_PREFIX=../out -Bbuild/install
           cmake --build build/install --config ${{ matrix.build_type }}
+      - name: Run test_package-headers (installation)
+        shell: bash
+        working-directory: test_package/build/install/${{ matrix.build_type }}
+        run: |
+          ./test_package-headers
       - name: Run test_package (installation)
+        if: matrix.config.cxx_modules == 'True'
         shell: bash
         working-directory: test_package/build/install/${{ matrix.build_type }}
         run: |

.gitignore

@@ -50,3 +50,6 @@ CMakeUserPresets.json
 # cxxdraft-htmlgen
 docs/api_reference/src/source/
 docs/api_reference/gen
+
+# macOS files
+.DS_Store

.pre-commit-config.yaml

@@ -1,17 +1,17 @@
-default_stages: [commit]
+default_stages: [pre-commit]
 
 repos:
   - repo: meta
     hooks:
       - id: check-hooks-apply
       - id: check-useless-excludes
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.3.0
+    rev: v5.0.0
     hooks:
       - id: trailing-whitespace
       - id: end-of-file-fixer
   - repo: https://github.com/pre-commit/mirrors-clang-format
-    rev: v19.1.2
+    rev: v19.1.5
     hooks:
       - id: clang-format
   - repo: https://github.com/cheshirekow/cmake-format-precommit
@@ -23,17 +23,17 @@ repos:
       #   additional_dependencies: ["cmakelang"]
       #   exclude: "cmake/.*"
   - repo: https://github.com/psf/black
-    rev: 22.10.0
+    rev: 24.10.0
     hooks:
       - id: black
         language_version: python3
   - repo: https://github.com/PyCQA/isort
-    rev: 5.12.0
+    rev: 5.13.2
     hooks:
       - id: isort
         args: [--profile, black, --multi-line, "3"]
   - repo: https://github.com/PyCQA/flake8
-    rev: 7.1.0
+    rev: 7.1.1
     hooks:
       - id: flake8
 

CHANGELOG.md

@@ -4,6 +4,115 @@
 
 ### 2.5.0 <small>WIP</small> { id="2.5.0" }
 
+- (!) feat: representation concepts improved
+- (!) feat: `representation_of` concept now also accepts a `quantity_spec` and accepts any representation character for quantity kinds
+- (!) feat: `quantity::one()` removed
+- (!) feat: `Representation` concept removed
+- feat: `SymbolicArg` applied to expression templates
+- feat: `per` and `power` made `final`
+- feat: `derived_XXX` are now constrained with `SymbolicConstant`
+- feat: prime factorization extended to any magnitude (thanks [@chiphogg](https://github.com/chiphogg))
+- feat: `cartesian_vector` added
+- feat: `equivalent` now accept any units (even non-convertible)
+- feat: text output should fallback to the portable mode when UTF-8 is not used for `text_encoding`
+- feat: precondition added to `to_u8string`
+- feat: text output of scaled units is now enclosed in parenthesis `(...)` instead of brackets `[...]`
+- feat: `abs(quantity)` exposed for conforming freestanding implementations
+- feat: proper constraints for `kind_of`
+- feat: missing precondition added for `quantity::op/`
+- feat: `quantity_spec` conversions improved
+- feat: `rankine` unit added
+- feat: `std::numeric_limits` support added
+- feat: `overflows_non_zero_values` added to detect conversions overflowing `rep`
+- feat: deprecation messages now provide the release version where the deprecation happened
+- feat: electromagnetism.h updated to IEC80000-6-2022
+- feat: `ConvertibleWithNumber` introduced to improve convertibility of unit `one` with raw numbers
+- feat(example): `is_vector` specialization no longer needed for `si_constants`
+- (!) refactor: `type_list` moved to implementation details
+- (!) refactor: from now `unit_symbol` and `dimension_symbol` always returns `std::string_view`
+- (!) refactor: `text_encoding` renamed to `character_set`
+- (!) refactor: `Magnitude` renamed to `UnitMagnitude` and `magnitude` to `unit_magnitude`
+- (!) refactor: `unit_magnitude` moved to `detail` namespace
+- (!) refactor: `absolute` renamed to `point`
+- (!) refactor: `power` members refactored to be explicitly exposition only
+- (!) refactor: `is_XXX` customization points for representation types removed
+- (!) refactor: `quantity_values` renamed to representation values
+- (!) refactor: `scalar` and `complex` characters renamed to `real_scalar` and `complex_scalar` respectively + concepts refactoring
+- (!) refactor: `MagConstant` concept renamed to `detail::is_mag_constant` variable trait
+- refactor: mp_units.core defined in terms of `core.h`
+- refactor: `MP_UNITS_NONCONST_TYPE` introduced to benefit from the C++23 feature
+- refactor: `SymbolicConstant` concept refactored
+- refactor: explicit type of `op/` for `quantity` and `reference` replaced with constrained placeholder
+- refactor: private `unit_magnitude` interface renamed to not use leading `_`
+- refactor: `one_of` concept removed and replaced with `QSProperty` in `quantity_spec`
+- refactor: `std::is_trivial` will be deprecated in C++26
+- refactor: `SameQuantitySpec` concept removed and replaced with direct comparison
+- refactor: unused `SameReference` concept removed
+- refactor: `type_name_less` introduced and used as a default predicate for expression templates
+- refactor: "expression templates" renamed to "symbolic expressions"
+- refactor: `all_are_kinds` removed and `get_associated_quantity` simplified
+- refactor: `reference` now returns explicit types for `inverse`, `pow`, `sqrt`, and `cbrt`
+- refactor: repeated concept checks removed from `get_common_reference`
+- refactor: `std::assignable_from` used in `ValuePreservingTo` concept
+- refactor: `quantity` constructor refactored to use another constructor with the result of `sudo_cast`
+- refactor: preconditions for quantity operations now use `is_neq_zero`
+- refactor: implicit expression variations used in `quantity` and `quantity_point` constraints
+- refactor: `inverse()` constraints improved
+- refactor: `make_quantity_point` introduced
+- refactor: `point_origin_interface::op+` return type unified with the rest of the interfaces
+- refactor: `std::convertible_to` replaced with `std::same_as` in `basic_fixed_string`
+- refactor: `less`, `ceil`, and `round` refactored and improved + more unit tests for `round`
+- refactor: `math_concepts.h` removed and concepts replaced with explicit expression in constraints
+- (!) fix: `electric_current_phasor`, `voltage_phasor`, `apparent_power` switched to complex character
+- (!) fix: `position_vector` and `displacement` moved to a different place in a tree
+- (!) fix: `velocity` is now defined in terms of `displacement` instead of `position_vector`
+- fix: missing `core.h` added to CMake
+- fix: `const` was leaking to some `SymbolicConstant`s
+- fix: `make_reference` should skip only the exact kinds deduced from a unit
+- fix: inconsistencies in `get_common_quantity_spec()` fixed
+- fix: unused `convertible_kinds()` argument removed
+- fix: compile-time branch condition fixed in `quantity_point::point_for`
+- fix: `inverse(Quantity)` fixed for subkinds of `dimensionless`
+- fix: `point_origin_interface::op+` constraints fixed
+- fix: missing `get_common_unit()` overload added
+- fix: `floor` and `ceil` constraints fixed
+- fix: quantity characters fixed in electromagnetism quantities
+- test: lots of tests for complex quantities
+- test: runtime unit tests refactored to have a bigger granularity (less top level tests)
+- test: _surface tension_ replaced with _entropy_ in an fmt test
+- test: test_package now is tested also with C++20 modules
+- test: tests for dimensionless quantities static data members
+- test: a few more natural units tests added
+- test: tests to check if `quantity` satisfies `Scalar`
+- test: add static tests for concept `DimensionOf` (thanks [@jvocht](https://github.com/jvocht))
+- test: quantity character concepts tests for quantities added
+- docs: ISQ part 6 released
+- docs: new chapter about our documentation added to the contributing guide
+- docs: directory name updated in the contributing guide
+- docs: mp-units Conan options added to conanfile.txt examples
+- docs: `contracts` Conan option default value description improved
+- docs: outdated note removed from the "Text Output" chapter
+- docs: a paragraph about additional formatting options removed (applicable only to quantity symbols which we do not support)
+- docs: Wrocław 2024 meeting report
+- docs: explicit unit conversion example added to the "Symbols of common units" chapter
+- docs: "Bringing Quantity-Safety To The Next Level" blog post added
+- docs: quantity-safety mentioned in the docs
+- docs: `complex` character added to the "Quantity character" chapter
+- docs: intro to "Value Conversions" chapter added
+- docs: "Scaling overflow prevention" chapter added
+- docs: "Concepts" chapter updated
+- docs: old customization points removed from the "Character of a Quantity" chapter
+- docs(ref): document most of `mp_units.core` (thanks [@JohelEGP](https://github.com/JohelEGP))
+- build: `CheckCacheVarValues` CMake module file added
+- build: `MP_UNITS_DEV_TIME_TRACE` CMake option added
+- build: `MP_UNITS_API_NO_CRTP` removed from `test_package` CMake
+- build: require at least CMake 3.31 with Conan
+- build: fmt/11.1.1
+- ci: CI matrix generation added (thanks [@burnpanck](https://github.com/burnpanck))
+- ci: `import_std` now checks if at least C++23 is being used
+- perf: caching of the results of heavy `consteval` functions execution added
+- perf: `expr_projectable` concept removed to improve compilation performance
+
 ### 2.4.0 <small>November 5, 2024</small> { id="2.4.0" }
 
 - (!) feat: `phase_velocity` and `group_velocity` aliases removed from ISQ by ISO
@@ -204,7 +313,7 @@
 - feat: `quantity_point` support added for `quantity_cast` and `value_cast`
 - feat: `value_cast<Unit, Representation>` added
 - feat: `value_cast<Quantity>(q)`, `value_cast<Quantity>(qp)` and `value_cast<QuantityPoint>(qp)` added by [@burnpanck](https://github.com/burnpanck)
-- feat: `interconvertible(QuantitySpec, QuantitySpec)` added
+- feat: `interconvertible(quantity_spec, quantity_spec)` added
 - feat: `qp.quantity_from_zero()` added
 - feat: `value_type` type trait added
 - feat: do not print space between a number and `percent` or `per_mille`
@@ -248,7 +357,7 @@
 - refactor: not needed `remove_reference_t` and `remove_cvref_t` removed
 - refactor: binary operators of `quantity` and `quantity_point` are now hidden friends
 - fix: `QuantityLike` conversions required `Q::rep` instead of using one provided by `quantity_like_traits`
-- fix: `QuantitySpec[Unit]` replaced with `make_reference` in `value_cast`
+- fix: `quantity_spec[Unit]` replaced with `make_reference` in `value_cast`
 - fix: `ice_point` is now defined with the integral offset from `absolute_zero`
 - fix: performance regression in `sudo_cast` fixed
 - fix: explicit object parameter support fixed

conanfile.py

@@ -99,7 +99,7 @@ def _feature_compatibility(self):
                 "compiler": {
                     "gcc": "13",
                     "clang": "17",
-                    "apple-clang": "",
+                    "apple-clang": "16",
                     "msvc": "194",
                 },
             },
@@ -213,10 +213,10 @@ def requirements(self):
             elif self.options.contracts == "ms-gsl":
                 self.requires("ms-gsl/4.0.0", transitive_headers=True)
             if not self.options.std_format:
-                self.requires("fmt/11.0.1", transitive_headers=True)
+                self.requires("fmt/11.1.1", transitive_headers=True)
 
     def build_requirements(self):
-        self.tool_requires("cmake/[>=3.30 <4]")
+        self.tool_requires("cmake/[>=3.31 <4]")
         if self._build_all:
             if not self.options.freestanding:
                 self.test_requires("catch2/3.7.0")
@@ -252,9 +252,9 @@ def generate(self):
         tc.absolute_paths = True  # only needed for CMake CI
         if self._build_all:
             tc.cache_variables["CMAKE_EXPORT_COMPILE_COMMANDS"] = True
-            tc.cache_variables[
-                "CMAKE_VERIFY_INTERFACE_HEADER_SETS"
-            ] = not opt.import_std
+            tc.cache_variables["CMAKE_VERIFY_INTERFACE_HEADER_SETS"] = (
+                not opt.import_std
+            )
             tc.cache_variables["MP_UNITS_DEV_BUILD_LA"] = not self._skip_la
             if self._run_clang_tidy:
                 tc.cache_variables["MP_UNITS_DEV_CLANG_TIDY"] = True
@@ -264,9 +264,9 @@ def generate(self):
         if opt.import_std:
             tc.cache_variables["CMAKE_CXX_MODULE_STD"] = True
             # Current experimental support according to `Help/dev/experimental.rst`
-            tc.cache_variables[
-                "CMAKE_EXPERIMENTAL_CXX_IMPORT_STD"
-            ] = "0e5b6991-d74f-4b3d-a41c-cf096e0b2508"
+            tc.cache_variables["CMAKE_EXPERIMENTAL_CXX_IMPORT_STD"] = (
+                "0e5b6991-d74f-4b3d-a41c-cf096e0b2508"
+            )
 
         # TODO remove the below when Conan will learn to handle C++ modules
         if opt.freestanding:

docs/api_reference/src/CMakeLists.txt

@@ -5,8 +5,8 @@ include(JEGPAddStandardeseSources)
 
 set(pdf_title "mp-units Library")
 set(page_license "MIT License")
-set(first_library_chapter "qties")
-set(last_library_chapter "qties")
+set(first_library_chapter "quantities")
+set(last_library_chapter "quantities")
 set(cover_title "mp-units Library Reference Documentations")
 set(reply_to "\\href{${PROJECT_HOMEPAGE_URL}/discussions}{Discussions}, \\href{${PROJECT_HOMEPAGE_URL}/issues}{issues}")
 jegp_add_standardese_sources(
@@ -21,6 +21,7 @@ jegp_add_standardese_sources(
              # Latex commands.
              [[\\href{([^}]+)}{([^}]+)};HREF(\1)(\2)]]
              # Macros extensions.
+             [[\\txtrm;\\textrm]]
              [[\\refcpp{([^}]+)};REFCPP(\1)]]
              [[\\irefcpp{([^}]+)};~(REFCPP(\1))]]
              [[\\refcppx{([^}]+)}{([^}]+)};REFCPPX(\1)(\2)]]

docs/api_reference/src/intro.tex

@@ -38,6 +38,11 @@
 Available from: \url{https://wg21.link/\IsoCpp{}}
 \item
 The \Cpp{} Standards Committee.
+P3094R5: \doccite{\tcode{std::basic_fixed_string}}.
+Edited by Mateusz Pusz.
+Available from: \url{https://wg21.link/P3094R5}
+\item
+The \Cpp{} Standards Committee.
 SD-8: \doccite{Standard Library Compatibility}.
 Edited by Bryce Lelbach.
 Available from: \url{https://wg21.link/SD8}
@@ -102,11 +107,11 @@
 {ll}
 \topline
 \hdstyle{Clause}        & \hdstyle{Category}                              \\ \capsep
-\ref{qties}             & Quantities library                              \\
+\ref{quantities}        & Quantities library                              \\
 \end{floattable}
 
 \pnum
-The quantities library\iref{qties}
+The quantities library\iref{quantities}
 describes components for dealing with quantities.
 
 \rSec1[spec.mods]{Modules}