1 line
377 KiB
JSON
1 line
377 KiB
JSON
{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"Welcome to mp-units!","text":"<p>mp-units is a compile-time enabled feature-rich Modern C++ modular/header-only library that provides compile-time dimensional analysis and unit/quantity manipulation. Its key strengths include safety, performance, and developer experience.</p> <p>The library source code is hosted on GitHub with a permissive MIT license.</p> Supported compilers <p>This library tries to provide the best user experience possible with the C++ language. To achieve that, it extensively uses the latest C++ language features.</p> <p>Even though the library benefits from the latest C++ versions (if available), C++20 is enough to compile and use all of the library's functionality.</p> <p>Please refer to C++ compiler support chapter for more details.</p> C++ modulesHeader files <pre><code>#include <iostream>\n#include <print>\nimport mp_units;\n\nusing namespace mp_units;\n\ninline constexpr struct smoot final : named_unit<\"smoot\", mag<67> * usc::inch> {} smoot;\n\nint main()\n{\n constexpr quantity dist = 364.4 * smoot;\n std::println(\"Harvard Bridge length = {::N[.1f]} ({::N[.1f]}, {::N[.2f]}) \u00b1 1 \u03b5ar\",\n dist, dist.in(usc::foot), dist.in(si::metre));\n}\n</code></pre> <pre><code>#include <mp-units/format.h>\n#include <mp-units/systems/si.h>\n#include <mp-units/systems/usc.h>\n#include <print>\n\nusing namespace mp_units;\n\ninline constexpr struct smoot final : named_unit<\"smoot\", mag<67> * usc::inch> {} smoot;\n\nint main()\n{\n constexpr quantity dist = 364.4 * smoot;\n std::println(\"Harvard Bridge length = {::N[.1f]} ({::N[.1f]}, {::N[.2f]}) \u00b1 1 \u03b5ar\",\n dist, dist.in(usc::foot), dist.in(si::metre));\n}\n</code></pre> <p>Output:</p> <pre><code>Harvard Bridge length = 364.4 smoot (2034.6 ft, 620.14 m) \u00b1 1 \u03b5ar\n</code></pre> <p>Try it on Compiler Explorer</p> What is <code>smoot</code>? <p>The smoot (/\u02c8smu\u02d0t/) is a nonstandard unit of length created as part of an MIT fraternity prank. It is named after Oliver R. Smoot, a fraternity pledge to Lambda Chi Alpha, who, in October 1958, lay on the Harvard Bridge (between Boston and Cambridge, Massachusetts) and was used by his fraternity brothers to measure the length of the bridge.</p> <p>One smoot equals Oliver Smoot's height at the time of the prank (five feet and seven inches). The bridge's length was measured to be 364.4 smoots plus or minus one ear, with the \"plus or minus\" intended to express the measurement uncertainty.</p> <p>Oliver Smoot graduated from MIT with the class of 1962, became a lawyer, and later became chairman of the American National Standards Institute (ANSI) and president of the International Organization for Standardization (ISO).</p> <p>More on the smoot unit of length can be found at https://en.wikipedia.org/wiki/Smoot.</p> <p>Important: Help needed!</p> <p>The mp-units library might be the subject of ISO standardization for C++29. More on this can be found in the following ISO C++ proposals:</p> <ul> <li>P1935: A C++ Approach to Physical Units,</li> <li>P2980: A motivation, scope, and plan for a physical quantities and units library,</li> <li>P3045: Quantities and units library.</li> </ul> <p>We are actively looking for parties interested in field-trialing the library.</p>"},{"location":"release_notes/","title":"Release Notes","text":""},{"location":"release_notes/#mp-units","title":"mp-units","text":""},{"location":"release_notes/#2.2.0","title":"2.2.0 June 14, 2024","text":"<ul> <li>(!) feat: C++ modules support added by @JohelEGP</li> <li>(!) feat: New formatting specification implemented</li> <li>(!) feat: <code>has_unit_symbol</code> support removed</li> <li>(!) feat: ABI concerns resolved with introduction of u8 strings for symbols</li> <li>(!) feat: API-related Conan, CMake, and preprocessor options redesigned</li> <li>(!) feat: <code>core.h</code> removed</li> <li>(!) feat: from now on units, dimensions, quantity specifications, and point origins have to be marked as <code>final</code></li> <li>feat: implicit point origins support added</li> <li>feat: unit default point origin support added</li> <li>feat: <code>fma</code>, <code>isfinite</code>, <code>isinf</code>, and <code>isnan</code> math function added by @NAThompson</li> <li>feat: <code>fma</code> for quantity points added</li> <li>feat: <code>quantity_point</code> support added for <code>quantity_cast</code> and <code>value_cast</code></li> <li>feat: <code>value_cast<Unit, Representation></code> added</li> <li>feat: <code>value_cast<Quantity>(q)</code>, <code>value_cast<Quantity>(qp)</code> and <code>value_cast<QuantityPoint>(qp)</code> added by @burnpanck</li> <li>feat: <code>interconvertible(QuantitySpec, QuantitySpec)</code> added</li> <li>feat: <code>qp.quantity_from_zero()</code> added</li> <li>feat: <code>value_type</code> type trait added</li> <li>feat: do not print space between a number and <code>percent</code> or <code>per_mille</code></li> <li>feat: <code>ppm</code> parts per million added by @nebkat</li> <li>feat: <code>atan2</code> 2-argument arctangent added by @nebkat</li> <li>feat: <code>fmod</code> floating-point division remainder added by @nebkat</li> <li>feat: <code>remainder</code> IEEE division remainder added by @nebkat</li> <li>feat: <code>std::format</code> support added</li> <li>feat: unit text output support added</li> <li>feat: formatting error messages improved</li> <li>feat: improve types readability by eliminating extraneous <code>()</code> in references, prefixes, and <code>kind_of</code></li> <li>feat: dimension and unit text output added</li> <li>feat: some light and radiation ISQ quantities added</li> <li>feat: allow configuring GSL library use</li> <li>feat: freestanding support added</li> <li>(!) refactor: <code>zero_Fahrenheit</code> renamed to <code>zeroth_degree_Fahrenheit</code></li> <li>(!) refactor: SI-related trigonometric functions moved to the <code>si</code> subnamespace</li> <li>(!) refactor: <code>math.h</code> header file broke up to smaller pieces</li> <li>(!) refactor: <code>fixed_string</code> interface refactored</li> <li>(!) refactor: <code>ReferenceOf</code> does not take a dimension anymore</li> <li>(!) refactor: 'o' replaced with '1' as a modifier for <code>unit_symbol_solidus::one_denominator</code></li> <li>(!) refactor: <code>get_kind()</code> now returns <code>kind_of</code></li> <li>(!) refactor: FMT macros moved to <code>compat_macros.h</code></li> <li>(!) refactor: <code>fixed_string</code> refactored to reflect the latest changes to P3094R2</li> <li>(!) refactor: <code>basic_symbol_text</code> renamed to <code>symbol_text</code></li> <li>(!) refactor: <code>ratio</code> hidden as an implementation detail behind <code>mag_ratio</code></li> <li>(!) refactor: <code>framework.h</code> introduced</li> <li>(!) refactor: type list tools made an implementation detail of the library</li> <li>(!) refactor: header files with the entire system definitions moved up in the directory tree</li> <li>(!) refactor: <code>absolute_point_origin</code> does not use CRTP anymore</li> <li>refactor: system's units do not inherit from one another anymore</li> <li>refactor: all units made <code>final</code></li> <li>refactor: math functions constraints refactored</li> <li>refactor: <code>si_quantities.h</code> added to improve compile-times</li> <li>refactor: <code>validate_ascii_string</code> refactored to <code>is_basic_literal_character_set</code></li> <li>refactor: <code>underlying_type</code> split to <code>wrapped_type</code> and <code>value_type</code> and used in code</li> <li>refactor: code refactored to comply with clang-tidy</li> <li>refactor: remove dependency on <code><ranges></code> header and switch to use an iterator-based <code>copy</code> algorithm</li> <li>refactor: <code>terminate</code> replaced with <code>abort</code> and a header file added</li> <li>refactor: most <code>std::remove_const_t</code> removed and some replaced with the GCC-specific workaround</li> <li>refactor: not needed <code>remove_reference_t</code> and <code>remove_cvref_t</code> removed</li> <li>fix: <code>QuantityLike</code> conversions required <code>Q::rep</code> instead of using one provided by <code>quantity_like_traits</code></li> <li>fix: <code>QuantitySpec[Unit]</code> replaced with <code>make_reference</code> in <code>value_cast</code></li> <li>fix: <code>ice_point</code> is now defined with the integral offset from <code>absolute_zero</code></li> <li>fix: performance regression in <code>sudo_cast</code> fixed</li> <li>fix: explicit object parameter support fixed</li> <li>fix: missing <code>version</code> header file added to <code>hacks.h</code></li> <li>fix: <code>quantity_cast</code> to accept lvalue references (thanks @burnpanck)</li> <li>fix: <code>value_cast</code> with lvalue references to <code>quantity_point</code> (thanks @burnpanck)</li> <li>docs: project blog and first posts added</li> <li>docs: project documentation layout refactored</li> <li>docs: \"Interoperability with Other Libraries\" chapter added</li> <li>docs: \"Framework Basics\" chapters updated and cleaned up</li> <li>docs: <code>smoot</code> unit example added to the main page</li> <li>docs: \"Code Example\" chapter renamed to \"Look and Feel\" and reordered in TOC to be after \"Quick Start\"</li> <li>docs: \"Quick Start\" chapter reworked to be simpler and include quantity points</li> <li>docs: \"Quantity points\" chapter extended</li> <li>docs: \"The Affine Space\" chapter updated to reflect the recent design changes</li> <li>docs: \"Working with Legacy interfaces\" chapter added</li> <li>docs: \"Text Output\" chapter updated</li> <li>docs: mkdocs social plugin enabled</li> <li>docs: project logo and custom color scheme added</li> <li>docs: minimum compiler requirements updated</li> <li>docs: unit symbols admonition extended in the \"Quick Start\" chapter</li> <li>docs: Cairo dependency described in the MkDocs section</li> <li>docs: \"hello units\" example updated with dimensions output</li> <li>docs: \"Text Output\" chapter updated with the recent formatting changes</li> <li>docs: formatting grammar language changed to EBNF</li> <li>docs: \"Project structure\" chapter expanded</li> <li>docs: CITATION.cff updated</li> <li>(!) build: Conan and CMake options refactored</li> <li>(!) build: <code>MP_UNITS_AS_SYSTEM_HEADERS</code> renamed to <code>MP_UNITS_BUILD_AS_SYSTEM_HEADERS</code></li> <li>(!) build: <code>MP_UNITS_BUILD_LA</code> and <code>MP_UNITS_IWYU</code> CMake options now have <code>_DEV_</code> in the name</li> <li>build: gsl-lite updated to 0.41.0</li> <li>build: catch2 updated to 3.5.1</li> <li>build: fmt updated to 10.2.1</li> <li>build: gitpod environment updated</li> <li>build: <code>check_cxx_feature_supported</code> added</li> <li>build: IWYU path handling fixed</li> <li>build: IWYU enabled on GCC</li> <li>build: <code>CMAKE_EXPORT_COMPILE_COMMANDS</code> flag enabled for the developer's build</li> <li>build(conan): <code>generate()</code> now set <code>cache_variables</code></li> <li>build(conan): <code>can_run</code> check added before running tests</li> <li>ci: Conan and CMake CI now use different cache names</li> <li>ci: gcc-14 added</li> <li>ci: <code>clang-tidy</code> CI added</li> </ul>"},{"location":"release_notes/#2.1.1","title":"2.1.1 May 16, 2024","text":"<ul> <li>fix: unit tests compilation on gcc-14 fixed</li> <li>fix: explicit <code>this</code> parameter support fixed</li> </ul>"},{"location":"release_notes/#2.1.0","title":"2.1.0 December 9, 2023","text":"<ul> <li>(!) feat: <code>inverse()</code> support added for dimensions, quantity_spec, units, and references (<code>1 / s</code> will now create <code>quantity</code> and not a <code>Unit</code>)</li> <li>(!) feat: <code>quantity_point</code> does not provide <code>zero()</code> anymore</li> <li>(!) feat: <code>quantity_spec</code> and its kind should not compare equal</li> <li>(!) feat: mutating interface removed from <code>fixed_string</code></li> <li>(!) feat: <code>common_type</code> with a raw value is not needed anymore as for a long time now raw values are not convertible to the dimensionless quantities</li> <li>(!) feat: <code>symbol_text</code> definition simplified</li> <li>(!) feat: users are now allowed to inherit their own types from absolute point origins</li> <li>(!) feat: interoperability with other libraries redesigned</li> <li>feat: <code>basic_fixed_string(const CharT*, std::integral_constant<std::size_t, N>)</code> constructor added</li> <li>feat: <code>isq::activity</code> added and <code>becquerel</code> definition updated to benefit from it</li> <li>feat: <code>gray</code> and <code>sievert</code> now have correct associated quantity kinds</li> <li>feat: <code>UnitCompatibleWith</code> concept added and applied to <code>in(U)</code> and <code>force_in(U)</code> functions</li> <li>feat: quantities can now be multiplied and divided by units (no parenthesis needed anymore)</li> <li>feat: <code>Magnitude / Unit</code> operator added</li> <li>feat: equality for dimensions now will allow derived classes as well (but not from <code>derived_dimension</code>)</li> <li>feat: <code>zero_Fahrenheit</code> point origin added</li> <li>feat: equivalent point origins handling improved</li> <li>feat(example): unit symbols added to the currency example</li> <li>(!) refactor: <code>unit_symbol<fmt>(U)</code> signature refactored and the resulting text can now also be used at runtime</li> <li>(!) refactor: <code>make_xxx</code> factory functions replaced with two-parameter constructors</li> <li>(!) refactor: <code>unit_symbol</code> changed to <code>consteval</code></li> <li>refactor: <code>in(U)</code> and <code>force_in(U)</code> now return <code>auto</code> to provide better diagnostics on clang</li> <li>refactor: <code>quantity</code> operators constraints refactored</li> <li>refactor: more type members added to <code>fixed_string</code> definition</li> <li>refactor: <code>unit_symbol_formatting</code> enums now use <code>std::int8_t</code> as a representation type</li> <li>fix: symbols of named dimensionless units with the ratio = 1 were not printed</li> <li>fix: iterator is now properly updated for all cases in <code>unit_symbol</code></li> <li>fix: Fahrenheit conversion ratio was inverted</li> <li>fix: <code>CommonlyInvocableQuantities</code> was overconstrained for the current library design</li> <li>fix: <code>are_ingredients_convertible</code> now mandates explicit conversion for <code>To</code> dimensionless quantities</li> <li>fix: <code>quantity_point::point_for(PO)</code> constraints fixed</li> <li>fix(example): <code>latitude</code> and <code>longitude</code> fixed to include <code>0</code> for <code>N</code> and <code>E</code> respectively</li> <li>ci: clang-17 enabled</li> <li>ci: apple-clang-15 enabled</li> <li>ci: Added C++23 builds to the CI matrix</li> <li>docs: \"Getting Started\" chapters updated</li> <li>docs: \"Basic Concepts\" and \"Interface Introduction\" chapters updated</li> <li>docs: \"Design Overview\" chapter added and \"Concepts\" chapter reworked</li> <li>docs: \"Output stream formatting\" chapter updated</li> <li>docs: \"Default formatting\" chapter updated</li> <li>docs: \"Derived unit symbols generation\" chapter added</li> <li>docs: outdated affine space chapter updated</li> <li>docs: <code>CameCase</code> concept identifiers FAQ added</li> <li>docs: <code>gravitational_potential_energy</code> equation fixed on a graph</li> <li>docs: YouTube video link updated to the C++ on Sea 2023</li> <li>docs: ISO papers reference added to docs and README</li> <li>docs: a representation type in a dimensionless quantity FAQ fixed</li> <li>docs: titles added to some important admonitions</li> <li>docs: \"Terms and Definitions\" slightly updated</li> <li>docs: \"canonical unit\" added to glossary and its documentation in code was updated</li> <li>docs: Design overview graph updated</li> </ul>"},{"location":"release_notes/#2.0.0","title":"2.0.0 September 24, 2023","text":"<ul> <li><code>units</code> namespace renamed to <code>mp_units</code> (#317)</li> <li>header files in the <code><mp-units/...></code> rather then in <code><units/...></code> (#317)</li> <li>the downcasting facility is removed (#383, #211, #32)</li> <li>unified and simplified quantity creation (#274)</li> <li>determining the best way to create a quantity (#413)</li> <li>V2 <code>quantity_point</code> (#414)</li> <li>introduction of <code>quantity_spec</code> to store not only <code>dimension</code> but also additional information about quantities (#405)</li> <li><code>quantity</code> now takes <code>reference</code> object, which aggregates <code>quantity_spec</code> and a <code>unit</code> and a <code>representation</code> type</li> <li>units, prefixes, dimensions, quantity specifications, and references are passed as NTTPs to templates and provide arithmetic operations and comparison</li> <li>expression templates consistently used in all derived types to increase the readability (#351, #166)</li> <li>derived dimensions are now factors of only base dimensions (#281)</li> <li>convertibility of derived quantities (#427)</li> <li>dimensions, quantity specifications, units, and references are now composable, significantly reducing the number of definitions and resulting types</li> <li>heavily simplified unit systems definitions (no need to define unnamed derived units, systems-specific dimensions, aliases for quantities, concepts, UDLs, ... anymore)</li> <li>improved definition of all systems</li> <li>support for ISO 80000 Part 3-6 quantities</li> <li>faster than lightspeed constants (#169)</li> <li>extensions to quantity formatting with <code>fmt</code></li> <li><code>quantity_kind</code> removed</li> <li>improved casting of unit with <code>.in(Unit)</code>, <code>.force_in(Unit)</code> for <code>quantity</code> and <code>quantity_spec</code></li> <li>numerical value accessor safety improved with <code>.numerical_value_in(Unit)</code> and <code>.force_numerical_value_in(Unit)</code></li> <li><code>quantity</code> can no longer be constructed with a raw value (#434)</li> <li>Implicit construction of quantities from a value (#410)</li> <li><code>quantity_point</code> can no longer be constructed with just a <code>quantity</code> and an explicit <code>PointOrigin</code> is always needed</li> <li><code>ceil</code> and <code>floor</code> are dangerous (#432)</li> <li>quecto, ronto, ronna, quetta new SI prefixes support</li> <li>comparison against zero added (#487)</li> <li>documentation rewritten from scratch</li> <li>many smaller changes not possible to address with the previous design (#205, #210, #134)</li> </ul>"},{"location":"release_notes/#0.8.0","title":"0.8.0 June 14, 2023","text":"<ul> <li>(!) refactor: <code>common_quantity</code>, <code>common_quantity_for</code>, <code>common_quantity_point</code>, <code>common_quantity_kind</code>, and <code>common_quantity_point_kind</code> removed</li> <li>(!) refactor: <code>named_derived_unit</code> removed as it was not used</li> <li>(!) refactor: <code>derived_unit</code> renamed to <code>derived_scaled_unit</code></li> <li>(!) refactor: <code>unit</code> renamed to <code>derived_unit</code></li> <li>(!) refactor: <code>U::is_named</code> removed from the unit types and replaced with <code>NamedUnit</code> concept</li> <li>(!) refactor: <code>PrefixFamily</code> support removed</li> <li>(!) refactor: <code>mi(naut)</code> renamed to <code>nmi</code></li> <li>(!) refactor: <code>knot</code> unit helper renamed to <code>kn</code> in FPS</li> <li>(!) refactor: <code>knot</code> text symbol changed from <code>\"knot\"</code> to <code>\"kn\"</code></li> <li>refactor: <code>quantity</code> <code>op+()</code> and <code>op-()</code> reimplemented in terms of <code>reference</code> rather then <code>quantity</code> types</li> <li>refactor(example): <code>glide_computer</code> now use dimensionless quantities with <code>ranged_representation</code> as <code>rep</code></li> <li>feat: HEP system support added (thanks @RalphSteinhagen)</li> <li>feat: <code>floor()</code>, <code>ceil()</code>, and <code>round()</code> support added (thanks @hofbi)</li> <li>feat: <code>std::format</code> support for compliant compilers added</li> <li>feat: conversion helpers from <code>mp-units</code> to <code>std::chrono</code> types added</li> <li>feat: math functions can now be safely used with user-defined types</li> <li>feat: conversion from <code>quantity_point</code> to <code>std::chrono::time_point</code> added</li> <li>feat: <code>nautical_mile_per_hour</code> and <code>knot</code> added to <code>si::international</code> system</li> <li>(!) fix: add <code>quantity_point::origin</code>, like <code>std::chrono::time_point::clock</code></li> <li>fix: enable any prefixes for most of the named units (beside those that use prefixes already)</li> <li>fix: <code>hectare</code> definition fixed to be a prefixed version of <code>are</code> + other units</li> <li>fix: account for different dimensions in <code>quantity_point_cast</code>'s constraint</li> <li>fix: output stream operator now properly handles state</li> <li>fix: <code>fmt</code> algorithms were overconstrained with <code>forward_iterator</code></li> <li>fix: CTAD for aliases fixed</li> <li>fix: <code>derived_ratio</code> calculation</li> <li>fix: <code>fill_t</code> assignment operator fixed</li> <li>fix: improve downcast mode off</li> <li>fix: <code>radioactivity</code> header compilation fixed</li> <li>fix: <code>si::hep::dim_momentum</code> duplicated definition fixed</li> <li>fix: <code>fps</code> can now coexist with <code>international</code> system</li> <li>fix: public headers fixed to be standalone</li> <li>test: standalone public headers tests added</li> <li>(!) build: CMake generator in Conan is no longer obtained from an environment variable</li> <li>(!) build: Required Conan version bumped to 1.48</li> <li>(!) build: Conan 1.48 does not set <code>CMAKE_BUILD_TYPE</code> in the <code>conan_toolchain.cmake</code> anymore</li> <li>build: AppleClang 13 support added (thanks @fdischner)</li> <li>build: most of the <code>conanfile.py</code> refactored to be Conan 2.0 ready</li> <li>build: <code>validate()</code> replaced with <code>configure()</code> to raise errors during <code>conan install</code> in Conan 1.X</li> <li>build: minimum Conan version changed to 1.40</li> <li>build: <code>linear-algebra</code> Conan repo is no needed anymore</li> <li>build: Gitpod support added</li> <li>build: clang-format-15 support added</li> <li>build: export config to local build (#322)</li> <li>build: fix export name of <code>mp-units-system</code></li> <li>build: fmt updated to 8.0.1</li> <li>build: gsl-lite updated to 0.40.0</li> <li>build: catch2 updated to 2.13.9</li> <li>build: doxygen updated to 1.9.4</li> <li>build: linear_algebra/0.7.0 switched to wg21-linear_algebra/0.7.2</li> <li>ci: VS2022, gcc-11, clang-13, clang-14, and AppleClang 13 support added</li> <li>ci: pre-commit support added (thanks @hofbi)</li> <li>docs: Project documentation updated</li> <li>docs: <code>CITATION.cff</code> file added</li> <li>docs: <code>CONTRIBUTING.md</code> updated</li> </ul>"},{"location":"release_notes/#0.7.0","title":"0.7.0 May 11, 2021","text":"<ul> <li>(!) refactor: <code>ScalableNumber</code> renamed to <code>Representation</code></li> <li>(!) refactor: output stream operators moved to the <code>units/quantity_io.h</code> header file</li> <li>(!) refactor: Refactored the library file tree</li> <li>(!) refactor: <code>quantity::count()</code> renamed to <code>quantity::number()</code></li> <li>(!) refactor: <code>data</code> system renamed to <code>isq::iec80000</code> (quantity names renamed too)</li> <li>(!) refactor: <code>*deduced_unit</code> renamed to <code>*derived_unit</code></li> <li>(!) refactor: got rid of a <code>noble_derived_unit</code></li> <li>refactor: quantity (kind) point updated to reflect latest changes to <code>quantity</code></li> <li>refactor: basic concepts, <code>quantity</code> and <code>quantity_cast</code> refactored</li> <li>refactor: <code>abs()</code> definition refactored to be more explicit about the return type</li> <li>feat: quantity (point) kind support added (thanks @johelegp)</li> <li>feat: quantity references support added (thanks @johelegp)</li> <li>feat: quantity aliases support addded</li> <li>feat: interoperability with <code>std::chrono::duration</code> and other units libraries</li> <li>feat: CTAD for dimensionless quantity added</li> <li>feat: <code>modulation_rate</code> support added (thanks @go2sh)</li> <li>feat: SI prefixes for <code>isq::iec80000</code> support added (thanks @go2sh)</li> <li>feat: a possibility to disable quantity UDLs support with <code>UNITS_NO_LITERALS</code> preprocessor define</li> <li>feat: a support to define ISQ derived dimensions in terms of different number or order of components</li> <li>perf: preconditions check do not influence the runtime performance of a Release build</li> <li>perf: <code>quantity_cast()</code> generates less assembly instructions</li> <li>perf: temporary string creation removed from <code>quantity::op<<()</code></li> <li>perf: value initialization for quantity value removed (left with a default initialization)</li> <li>perf: limited the <code>equivalent</code> trait usage</li> <li>perf: limited the C++ Standard Library headers usage</li> <li>perf: rvalue references support added for constructors and getters</li> <li>(!) fix: <code>exp()</code> has sense only for dimensionless quantities</li> <li>(!) fix: <code>dim_torque</code> now properly divides by an angle (instead of multiply) + default unit name change</li> <li>fix: quantity's operators fixed to behave like the underlying types do</li> <li>fix: <code>quantity_cast()</code> fixed to work correctly with representation types not convertible from <code>std::intmax_t</code></li> <li>fix: ambiguous case for empty type list resolved</li> <li>fix: downcasting facility for non-default-constructible types</li> <li>fix: restore user-warnings within the library implementation</li> <li>fix: the text symbol of <code>foot_pound_force</code> and <code>foot_pound_force_per_second</code></li> <li>fix: quantity modulo arithmetics fixed</li> <li>(!) build: Conan testing version is now hosted on Artifactory</li> <li>(!) build: Linear Algebra is now hosted on its Artifactory</li> <li>(!) build: <code>BUILD_DOCS</code> CMake option renamed to <code>UNITS_BUILD_DOCS</code></li> <li>build: doxygen updated to 1.8.20</li> <li>build: catch2 updated to 2.13.4</li> <li>build: fmt updated to 7.1.3</li> <li>build: ms-gsl replaced with gsl-lite/0.38.0</li> <li>build: Conan generator switched to <code>cmake_find_package_multi</code></li> <li>build: Conan CMakeToolchain support added</li> <li>build: CMake scripts cleanup</li> <li>build: ccache support added</li> <li>ci: CI switched from Travis CI to GitHub Actions</li> </ul>"},{"location":"release_notes/#0.6.0","title":"0.6.0 September 13, 2020","text":"<ul> <li>feat: <code>quantity_point</code> support added (thanks @johelegp)</li> <li>feat: Added angle as SI base dimension (thanks @kwikius)</li> <li>feat: <code>si::angular_velocity</code> support added (thanks @mikeford3)</li> <li>feat: FPS system added (thanks @mikeford3)</li> <li>feat: Added support for mathematical function <code>exp(quantity)</code></li> <li>feat: Localization support for text output added (thanks @rbrugo)</li> <li>feat: Added STL random number distribution wrappers (thanks @yasamoka)</li> <li>(!) refactor: Refactored and cleaned up the library file tree</li> <li>(!) refactor: <code>q_*</code> UDL renamed to <code>_q_*</code></li> <li>(!) refactor: UDLs with \"per\" in name renamed from <code>*p*</code> to <code>*_per_*</code></li> <li>(!) refactor: <code>ratio</code> changed to the NTTP kind</li> <li>(!) refactor: <code>exp</code> and <code>Exp</code> renamed to <code>exponent</code> and <code>Exponent</code></li> <li>(!) refactor: <code>Scalar</code> concept renamed to <code>ScalableNumber</code></li> <li>(!) refactor: Dimensionless quantities redesigned to be of a <code>quantity</code> type</li> <li>refactor: <code>math.h</code> function signatures refactored to use a <code>Quantity</code> concept (thanks @kwikius)</li> <li>refactor: <code>[[nodiscard]]</code> added to many functions</li> <li>fix: <code>si::day</code> unit symbol fixed to <code>d</code> (thanks @komputerwiz)</li> <li>fix: <code>si::mole</code> unit symbol fixed to <code>mol</code> (thanks @mikeford3)</li> <li>(!) build: gcc-9 is no longer supported (at least gcc-10 is required)</li> <li>build: Visual Studio 16.7 support added</li> <li>build: linear_algebra updated to 0.7.0/stable</li> <li>build: fmt updated to 7.0.3</li> <li>build: range-v3 updated to 0.11.0</li> <li>build: catch2 updated to 2.13.0</li> <li>build: doxygen updated to 1.8.18</li> <li>build: ms-gsl 3.1.0 dependency added</li> <li>build: Removed the dependency on a git submodule with common CMake scripts</li> </ul>"},{"location":"release_notes/#0.5.0","title":"0.5.0 May 17, 2020","text":"<ul> <li>Major refactoring and rewrite of the library</li> <li>Units are now independent from dimensions</li> <li>Dimensions now depend on units (base or coherent units are provided in a class template)</li> <li>Quantity gets a Dimension template parameter again (as unit does not provide information about its dimension anymore)</li> <li>Spaceship operator support added</li> <li>Added official CGS system support</li> <li>Added official data information system support</li> <li>Repository file tree cleanup</li> <li><code>ratio</code> refactored to contain <code>Exp</code> template parameter (thanks a lot @oschonrock!)</li> <li>SI fundamental constants added</li> <li><code>q_</code> prefix applied to all the UDLs (thanks @kwikius)</li> <li><code>unknown_unit</code> renamed to <code>unknown_coherent_unit</code></li> <li>Project documentation greatly extended and switched to Sphinx</li> <li>A few more usage examples added</li> <li>ASCII-only output support added (thanks @yasamoka)</li> <li>Representation values formatting extended (thanks @rbrugo)</li> <li>Output streams formatting support added</li> <li>Linear algebra from <code>std::experimental::math</code> support added</li> <li>Named SI units and their dimensions added (thanks @rbrugo</li> <li>libfmt updated to 6.2.0</li> <li>Added absolute functions and epsilon to math.h (thanks @mikeford3)</li> <li>Added a lot of prefixes to named units and introduced <code>alias_unit</code> (thanks @yasamoka)</li> <li>Linking with Conan targets only when they exists (#98)</li> <li>All physical dimensions and units put into <code>physical</code> namespace</li> <li>CMake improvements</li> <li>Velocity renamed to speed</li> </ul> <p>Many thanks to GitHub users @oschonrock, @kwikius, and @i-ky for their support in drafting a new library design.</p>"},{"location":"release_notes/#0.4.0","title":"0.4.0 Nov 17, 2019","text":"<ul> <li>Support for derived dimensions in <code>exp</code> added</li> <li>Added <code>pow()</code> and <code>sqrt()</code> operations on quantities</li> <li><code>units</code> removed from a <code>std::experimental</code> namespace</li> <li>Downcasting facility refactored so the user does not have to write the boilerplate code anymore</li> <li>From now on base dimensions should inherit from <code>base_dimension</code> class template</li> <li>Added unit symbols definitions to <code>base_dimension</code> and derived units</li> <li>Added support for <code>operator<<</code> on <code>quantity</code></li> <li><code>fmt</code> support added</li> <li>Derived unit factory helpers refactored</li> <li>Refactored the way prefixed units are defined</li> </ul>"},{"location":"release_notes/#0.3.1","title":"0.3.1 Sep 18, 2019","text":"<ul> <li>cmcstl2 dependency changed to range-v3 0.9.1</li> </ul>"},{"location":"release_notes/#0.3.0","title":"0.3.0 Sep 16, 2019","text":"<ul> <li>The design as described on CppCon 2019 talk (https://youtu.be/0YW6yxkdhlU)</li> <li>Applied the feedback from the Cologne evening session</li> <li><code>upcasting_traits</code> renamed to <code>downcasting_traits</code></li> <li><code>Dimension</code> template parameter removed from quantity</li> <li><code>units</code> moved to a <code>std::experimental</code> namespace</li> <li>Leading underscore prefix removed from UDLs</li> <li>Added a few more derived dimensions</li> <li><code>meter</code> renamed to <code>metre</code></li> <li>Missing <code>operator*</code> added</li> <li>Predefined dimensions moved to a dedicated directory</li> <li><code>dimension_</code> prefix removed from names of derived dimensions</li> <li>cmcstl2 library updated to 2019.09.19</li> <li><code>base_dimension</code> is a value provided as <code>const&</code> to the <code>exp</code> type</li> <li>integrated with Compiler Explorer</li> <li>gsl-lite dependency removed</li> <li>Fractional dimension exponents support added</li> <li><code>QuantityOf</code> concept introduced</li> <li><code>quantity_cast<U, Rep>()</code> support added</li> </ul>"},{"location":"release_notes/#0.2.0","title":"0.2.0 July 18, 2019","text":"<ul> <li>The design as described on C++Now 2019 talk (https://youtu.be/wKchCktZPHU)</li> <li>Added C++20 features supported by gcc-9.1 (<code>std::remove_cvref_t</code>, down with typename, <code>std::type_identity</code>)</li> <li>Compile-time performance optimizations (<code>type_list</code>, <code>common_ratio</code>, <code>ratio</code>, <code>conditional_t</code>)</li> </ul>"},{"location":"release_notes/#0.1.0","title":"0.1.0 May 18, 2019","text":"<ul> <li>Initial library release</li> <li>Begin semantic versioning</li> <li>The last version to work with gcc-8</li> </ul>"},{"location":"appendix/glossary/","title":"Glossary","text":""},{"location":"appendix/glossary/#iso-definitions","title":"ISO definitions","text":"<p>Note</p> <p>The ISO terms provided below are only a few of many defined in the ISO/IEC Guide 99.</p> <code>quantity</code> <ul> <li>Property of a phenomenon, body, or substance, where the property has a magnitude that can be expressed by means of a number and a reference.</li> <li>A reference can be a measurement unit, a measurement procedure, a reference material, or a combination of such.</li> <li>A quantity as defined here is a scalar. However, a vector or a tensor, the components of which are quantities, is also considered to be a quantity.</li> <li>The concept \u2019quantity\u2019 may be generically divided into, e.g. \u2018physical quantity\u2019, \u2018chemical quantity\u2019, and \u2018biological quantity\u2019, or \u2018base quantity\u2019 and \u2018derived quantity\u2019.</li> <li>Examples of quantities are: length, radius, wavelength, energy, electric charge, etc.</li> </ul> <code>kind of quantity, kind</code> <ul> <li>Aspect common to mutually comparable quantities.</li> <li>The division of the concept \u2018quantity\u2019 into several kinds is to some extent arbitrary, for example:<ul> <li>the quantities diameter, circumference, and wavelength are generally considered to be quantities of the same kind, namely, of the kind of quantity called length,</li> <li>the quantities heat, kinetic energy, and potential energy are generally considered to be quantities of the same kind, namely of the kind of quantity called energy.</li> </ul> </li> <li>Quantities of the same kind within a given system of quantities have the same quantity dimension. However, quantities of the same dimension are not necessarily of the same kind.<ul> <li>For example, the quantities moment of force and energy are, by convention, not regarded as being of the same kind, although they have the same dimension. Similarly for heat capacity and entropy, as well as for number of entities, relative permeability, and mass fraction.</li> </ul> </li> </ul> <code>system of quantities</code> <ul> <li>Set of quantities together with a set of non-contradictory equations relating those quantities.</li> <li>Examples of systems of quantities are: the International System of Quantities, the Imperial System, etc.</li> </ul> <code>base quantity</code> <ul> <li>Quantity in a conventionally chosen subset of a given system of quantities, where no quantity in the subset can be expressed in terms of the others.</li> <li>Base quantities are referred to as being mutually independent since a base quantity cannot be expressed as a product of powers of the other base quantities.</li> <li>\u2018Number of entities\u2019 can be regarded as a base quantity in any system of quantities.</li> </ul> <code>derived quantity</code> <ul> <li>Quantity, in a system of quantities, defined in terms of the base quantities of that system.</li> </ul> <code>International System of Quantities, ISQ</code> <ul> <li>System of quantities based on the seven base quantities: length, mass, time, electric current, thermodynamic temperature, amount of substance, and luminous intensity.</li> <li>This system of quantities is published in the ISO 80000 and IEC 80000 series Quantities and units.</li> <li>The International System of Units (SI) is based on the ISQ.</li> </ul> <code>quantity dimension, dimension of a quantity, dimension</code> <ul> <li>Expression of the dependence of a quantity on the base quantities of a system of quantities as a product of powers of factors corresponding to the base quantities, omitting any numerical factor.<ul> <li>e.g. in the ISQ, the quantity dimension of force is denoted by \\(\\textsf{dim }F = \\mathsf{LMT}^{\u20132}\\).</li> </ul> </li> <li>A power of a factor is the factor raised to an exponent. Each factor is the dimension of a base quantity.</li> <li>In deriving the dimension of a quantity, no account is taken of its scalar, vector, or tensor character.</li> <li>In a given system of quantities:<ul> <li>quantities of the same kind have the same quantity dimension,</li> <li>quantities of different quantity dimensions are always of different kinds,</li> <li>quantities having the same quantity dimension are not necessarily of the same kind.</li> </ul> </li> <li> <p>Symbols representing the dimensions of the base quantities in the ISQ are:</p> Base quantity Symbol for dimension length \\(\\mathsf{L}\\) mass \\(\\mathsf{M}\\) time \\(\\mathsf{T}\\) electric current \\(\\mathsf{I}\\) thermodynamic temperature \\(\\mathsf{\u0398}\\) amount of substance \\(\\mathsf{N}\\) luminous intensity \\(\\mathsf{J}\\) <p>Thus, the dimension of a quantity \\(Q\\) is denoted by \\(\\textsf{dim }Q = \\mathsf{L}^\u03b1\\mathsf{M}^\u03b2\\mathsf{T}^\u03b3\\mathsf{I}^\u03b4\\mathsf{\u0398}^\u03b5\\mathsf{N}^\u03b6\\mathsf{J}^\u03b7\\) where the exponents, named dimensional exponents, are positive, negative, or zero.</p> </li> </ul> <code>quantity of dimension one, dimensionless quantity</code> <ul> <li>quantity for which all the exponents of the factors corresponding to the base quantities in its quantity dimension are zero.</li> <li>The term \u201cdimensionless quantity\u201d is commonly used and is kept here for historical reasons. It stems from the fact that all exponents are zero in the symbolic representation of the dimension for such quantities. The term \u201cquantity of dimension one\u201d reflects the convention in which the symbolic representation of the dimension for such quantities is the symbol \\(1\\).</li> <li>The measurement units and values of quantities of dimension one are numbers, but such quantities convey more information than a number.</li> <li>Some quantities of dimension one are defined as the ratios of two quantities of the same kind.</li> <li>Numbers of entities are quantities of dimension one.</li> </ul> <code>measurement unit, unit of measurement, unit</code> <ul> <li>Real scalar quantity, defined and adopted by convention, with which any other quantity of the same kind can be compared to express the ratio of the two quantities as a number.</li> <li>Measurement units are designated by conventionally assigned names and symbols.</li> <li>Measurement units of quantities of the same quantity dimension may be designated by the same name and symbol even when the quantities are not of the same kind.<ul> <li>For example, joule per kelvin and J/K are respectively the name and symbol of both a measurement unit of heat capacity and a measurement unit of entropy, which are generally not considered to be quantities of the same kind.</li> </ul> </li> <li>However, in some cases special measurement unit names are restricted to be used with quantities of specific kind only.<ul> <li>For example, the measurement unit \u2018second to the power minus one\u2019 (\\(\\mathsf{1/s}\\)) is called hertz (\\(\\mathsf{Hz}\\)) when used for frequencies and becquerel (\\(\\mathsf{Bq}\\)) when used for activities of radionuclides. As another example, the joule (\\(\\mathsf{J}\\)) is used as a unit of energy, but never as a unit of moment of force, e.g. the newton metre (\\(\\mathsf{N\u00b7m}\\)).</li> </ul> </li> <li>Measurement units of quantities of dimension one are numbers. In some cases, these measurement units are given special names, e.g. radian, steradian, and decibel, or are expressed by quotients such as millimole per mole equal to \\(10^{\u22123}\\) and microgram per kilogram equal to \\(10^{\u22129}\\).</li> </ul> <code>base unit</code> <ul> <li>Measurement unit that is adopted by convention for a base quantity.</li> <li>In each coherent system of units, there is only one base unit for each base quantity.<ul> <li>e.g. in the SI, the metre is the base unit of length. In the CGS systems, the centimetre is the base unit of length.</li> </ul> </li> <li>A base unit may also serve for a derived quantity of the same quantity dimension.</li> <li>For number of entities, the number one, symbol \\(1\\), can be regarded as a base unit in any system of units.</li> </ul> <code>derived unit</code> <ul> <li>Measurement unit for a derived quantity.</li> <li>For example, the metre per second, symbol m/s, and the centimetre per second, symbol cm/s, are derived units of speed in the SI. The kilometre per hour, symbol km/h, is a measurement unit of speed outside the SI but accepted for use with the SI. The knot, equal to one nautical mile per hour, is a measurement unit of speed outside the SI.</li> </ul> <code>coherent derived unit</code> <ul> <li>Derived unit that, for a given system of quantities and for a chosen set of base units, is a product of powers of base units with no other proportionality factor than one.</li> <li>A power of a base unit is the base unit raised to an exponent.</li> <li>Coherence can be determined only with respect to a particular system of quantities and a given set of base units.<ul> <li>For example, if the metre, the second, and the mole are base units, the metre per second is the coherent derived unit of velocity when velocity is defined by the quantity equation \\(v = \\mathsf{d}r/\\mathsf{d}t\\), and the mole per cubic metre is the coherent derived unit of amount-of-substance concentration when amount-of-substance concentration is defined by the quantity equation \\(c = n/V\\). The kilometre per hour and the knot, given as examples of derived units, are not coherent derived units in such a system of quantities.</li> </ul> </li> <li>A derived unit can be coherent with respect to one system of quantities but not to another.<ul> <li>For example, the centimetre per second is the coherent derived unit of speed in a CGS system of units but is not a coherent derived unit in the SI.</li> </ul> </li> <li>The coherent derived unit for every derived quantity of dimension one in a given system of units is the number one, symbol \\(1\\). The name and symbol of the measurement unit one are generally not indicated.</li> </ul> <code>system of units</code> <ul> <li>Set of base units and derived units, together with their multiples and submultiples, defined in accordance with given rules, for a given system of quantities.</li> </ul> <code>coherent system of units</code> <ul> <li>System of units, based on a given system of quantities, in which the measurement unit for each derived quantity is a coherent derived unit.</li> <li>A system of units can be coherent only with respect to a system of quantities and the adopted base units.</li> <li>For a coherent system of units, numerical value equations have the same form, including numerical factors, as the corresponding quantity equations.</li> </ul> <code>off-system measurement unit, off-system unit</code> <ul> <li>Measurement unit that does not belong to a given system of units.</li> <li>For example, the electronvolt (about \\(1.602\\;18 \u00d7 10^{\u201319}\\;\\mathsf{J}\\)) is an off-system measurement unit of energy with respect to the SI. Day, hour, minute are off-system measurement units of time with respect to the SI.</li> </ul> <code>International System of Units, SI</code> <ul> <li>System of units, based on the International System of Quantities, their names and symbols, including a series of prefixes and their names and symbols, together with rules for their use, adopted by the General Conference on Weights and Measures (CGPM).</li> </ul> <code>quantity value, value of a quantity, value</code> <ul> <li>Number and reference together expressing magnitude of a quantity.<ul> <li>For example, length of a given rod: \\(5.34\\;\\mathsf{m}\\) or \\(534\\;\\mathsf{cm}\\).</li> </ul> </li> <li>The number can be complex.</li> <li>A quantity value can be presented in more than one way.</li> <li>In the case of vector or tensor quantities, each component has a quantity value.<ul> <li>For example, force acting on a given particle, e.g. in Cartesian components \\((F_x; F_y; F_z) = (\u221231.5; 43.2; 17.0)\\;\\mathsf{N}\\).</li> </ul> </li> </ul> <code>numerical quantity value, numerical value of a quantity, numerical value</code> <ul> <li>Number in the expression of a quantity value, other than any number serving as the reference<ul> <li>For example, in an amount-of-substance fraction equal to \\(3\\;\\mathsf{mmol/mol}\\), the numerical quantity value is \\(3\\) and the unit is \\(\\mathsf{mmol/mol}\\). The unit \\(\\mathsf{mmol/mol}\\) is numerically equal to \\(0.001\\), but this number \\(0.001\\) is not part of the numerical quantity value, which remains \\(3\\).</li> </ul> </li> </ul> <code>quantity equation</code> <ul> <li>Mathematical relation between quantities in a given system of quantities, independent of measure\u00adment units.</li> <li>For example, \\(T = (1/2) mv^2\\) where \\(T\\) is the kinetic energy and \\(v\\) the speed of a specified particle of mass \\(m\\).</li> </ul> <code>unit equation</code> <ul> <li>Mathematical relation between base units, coher\u00adent derived units or other measurement units.</li> <li>For example, \\(\\mathsf{J} := \\mathsf{kg}\\:\\mathsf{m}^2/\\mathsf{s}^2\\), where, \\(\\mathsf{J}\\), \\(\\mathsf{kg}\\), \\(\\mathsf{m}\\), and \\(\\mathsf{s}\\) are the symbols for the joule, kilogram, metre, and second, respectively. (The symbol \\(:=\\) denotes \u201cis by definition equal to\u201d as given in the ISO 80000 and IEC 80000 series.). \\(1\\;\\mathsf{km/h} = (1/3.6)\\;\\mathsf{m/s}\\).</li> </ul> <code>numerical value equation, numerical quantity value equation</code> <ul> <li>Mathematical relation between numerical quantity values, based on a given quantity equation and specified measurement units.</li> <li>For example, in the quantity equation for kinetic energy of a particle, \\(T = (1/2) mv^2\\), if \\(m = 2\\;\\mathsf{kg}\\) and \\(v = 3\\;\\mathsf{m/s}\\), then \\({T} = (1/2)\\:\u00d7\\:2\\:\u00d7\\:3^2\\) is a numerical value equation giving the numerical value \\(9\\) of \\(T\\) in joules.</li> </ul>"},{"location":"appendix/glossary/#other-definitions","title":"Other definitions","text":"<p>Info</p> <p>The below terms extend the official ISO glossary and are commonly referred to by the mp-units library.</p> <code>base dimension</code> <ul> <li>A dimension of a base quantity.</li> </ul> <code>derived dimension</code> <ul> <li>A dimension of a derived quantity.</li> <li>Implemented as an expression template being the result of the dimension equation on base dimensions.</li> </ul> <code>dimension equation</code> <ul> <li>Mathematical relation between dimensions in a given system of quantities, independent of measure\u00adment units.</li> </ul> <code>quantity kind hierarchy, quantity hierarchy</code> <ul> <li>Quantities of the same kind form a hierarchy that determines their:<ul> <li>convertibility (e.g. every width is a length, but width should not be convertible to height)</li> <li>common quantity type (e.g. width + height -> length)</li> </ul> </li> </ul> <code>quantity character, character of a quantity, character</code> <ul> <li>Scalars, vectors and tensors are mathematical objects that can be used to denote certain physical quantities and their values. They are as such independent of the particular choice of a coordinate system, whereas each scalar component of a vector or a tensor and each component vector and component tensor depend on that choice.</li> <li>A vector is a tensor of the first order and a scalar is a tensor of order zero.</li> <li>For vectors and tensors, the components are quantities that can be expressed as a product of a number and a unit.</li> <li>Vectors and tensors can also be expressed as a numerical value vector or tensor, respectively, multiplied by a unit.</li> <li>Quantities of different characters support different set of operations.<ul> <li>For example, a quantity can be multiplied by another one only if any of them has scalar character. Vectors and tensors can't be multiplied or divided, but they support additional operations like dot and cross products, which are not available for scalars.</li> </ul> </li> <li>The term \u2019character\u2019 was borrowed from the below quote:</li> </ul> <p>ISO 80000-1_2009</p> <p>In deriving the dimension of a quantity, no account is taken of its scalar, vector, or tensor character.</p> <code>quantity specification, quantity_spec</code> <ul> <li>An entity storing all the information about a specific quantity:<ul> <li>location in a quantity hierarchy</li> <li>quantity equation</li> <li>dimension of a quantity</li> <li>quantity kind</li> <li>quantity character</li> <li>additional constraints (e.g. non-negative)</li> </ul> </li> <li>Dimension of a quantity is not enough to specify all the properties of a quantity.</li> </ul> <code>unit with an associated quantity, associated unit</code> <ul> <li>Unit that is used to measure quantities of a specific kind in a given system of units.</li> </ul> <code>quantity reference, reference</code> <ul> <li>According to its definition, quantity can be expressed by means of a number and a reference</li> <li>In the mp-units library, a reference describes all the required meta-information associated with a specific quantity (quantity specification and unit).</li> </ul> <code>canonical representation of a unit, canonical unit</code> <ul> <li>A canonical representation of a unit consists of:<ul> <li>a reference unit being the result of extraction of all the intermediate derived units,</li> <li>a magnitude being a product of all the prefixes and magnitudes of extracted scaled units.</li> </ul> </li> <li>All units having the same canonical unit are deemed equal.</li> <li>All units having the same reference unit are convertible (their magnitude may differ and is used during conversion).</li> </ul> <code>reference unit</code> <p>See canonical representation of a unit</p> <code>absolute quantity point origin</code>, <code>absolute point origin</code> <ul> <li>An explicit point on an axis of values of a specific quantity type that serves as an absolute reference point for all quantity points which definitions are (explicitly or implicitly) based on it.</li> <li>For example, mean sea level is commonly used as an absolute reference point to measure altitudes.</li> </ul> <code>relative quantity point origin</code>, <code>relative point origin</code> <ul> <li>An explicit, known at compile-time, point on an axis of values of a specific quantity type serving as a reference for other quantities.</li> <li>For example, an ice point is a quantity point with a value of \\(273.15\\;\\mathsf{K}\\) that is used as the zero point of a degree Celsius scale.</li> </ul> <code>quantity point origin</code>, <code>point origin</code> <ul> <li>Either an absolute point origin or a relative point origin.</li> </ul> <code>quantity point</code>, <code>absolute quantity</code> <ul> <li>An absolute quantity with respect to an origin.</li> <li>For example, timestamp (as opposed to duration), altitude (as opposed to height), absolute temperature (as opposed to temperature difference).</li> </ul>"},{"location":"appendix/references/","title":"References","text":"<code>ISO80000</code> <p>ISO 80000-1:2009(E) \"Quantities and units \u2014 Part 1: General\", International Organization for Standardization.</p> <code>Quincey</code> \"Angles in the SI: a detailed proposal for solving the problem, Quincey, Paul (1 October 2021). <code>SIBrochure</code> <p>The International System of Units (SI), International Bureau of Weights and Measures (20 May 2019), ISBN 978-92-822-2272-0.</p>"},{"location":"blog/","title":"Blog","text":""},{"location":"blog/2023/09/24/whats-new-in-mp-units-20/","title":"What's new in mp-units 2.0?","text":"<p>After a year of hard work, we've just released mp-units 2.0.0. It can be obtained from GitHub and Conan.</p> <p>The list of the most significant changes introduced by the new version can be found in our Release Notes. We will also describe some of them in this post.</p>"},{"location":"blog/2023/09/24/whats-new-in-mp-units-20/#why-20-if-10-was-never-released","title":"Why 2.0 if 1.0 was never released?","text":"<p>Version 2 of the mp-units project is a huge change and a new quality for the users. We did not want to pretend that 2.0 is an evolutionary upgrade of the previous version of the project. It feels like a different product.</p> <p>We could start a new repo named \"mp-units-v2\" similarly to range-v3 but we decided not to go this path. We kept the same repo and made the scope of the changes and potential breakage explicit with a drastic bump in the project version.</p>"},{"location":"blog/2023/09/24/whats-new-in-mp-units-20/#what-has-changed","title":"What has changed?","text":"<p>The answer is \"nearly everything\". The whole library and its documentation were rewritten nearly from scratch.</p> <p>Here are the significant changes that the users can observe:</p> <ul> <li> <p>Repository name</p> <p>If you didn't notice, the repository name was changed from \"mpusz/units\" to \"mpusz/mp-units\".</p> </li> <li> <p>Header files content and layout</p> <p>Previously, all the header files resided in the include/units directory. Now, they can be found in include/mp-units. The project file tree was significantly changed as well. Many files were moved to different subdirectories or renamed.</p> </li> <li> <p>Namespace</p> <p>Previously, all the definitions were provided in the <code>units</code> namespace, and now they are in the <code>mp_units</code> one.</p> </li> <li> <p>Abstractions, interfaces, definitions</p> <p>The interfaces of all of the types were refactored. We got unit symbols and a new way to construct a <code>quantity</code> and <code>quantity_point</code>. The readability of the generated types was improved thanks to the introduction of expression templates. Nearly all of the template arguments are now passed by values thanks to class NTTP extensions in C++20. As a result, unit definitions are much easier and terser. Also, the V2 has a powerful ability to model systems of quantities and provides definitions for many ISQ quantities.</p> </li> <li> <p>Conan 2.0</p> <p>Also, now we support Conan 2.0, which provides an updated way of handling dependencies.</p> </li> </ul>"},{"location":"blog/2023/09/24/whats-new-in-mp-units-20/#what-is-gone","title":"What is gone?","text":"<p>Some cornerstones of the initial design did not prove in practice and were removed while we moved to version 2.</p>"},{"location":"blog/2023/09/24/whats-new-in-mp-units-20/#the-downcasting-facility","title":"The downcasting facility","text":"<p>The first and the most important of such features was removing the downcasting facility. This feature is still a powerful metaprogramming technique that allows users to map long class template instantiations to nicely named, short, and easy-to-understand user's strong types.</p> <p>Such mapping works perfectly fine for 1-to-1 relationships. However, we often deal with N-to-1 connections in the quantities and units domain. Here are only a few such examples:</p> <ul> <li>work and torque have the same dimension \\(L^2MT^{-2}\\),</li> <li>becquerel and hertz have the same definition of \\(s^{-1}\\),</li> <li>litre and cubic decimetre have the same factor.</li> </ul> <p>In the above examples, multiple entities \"wanted\" to register different names for identical class template instantiations, resulting in compile-time errors. We had to invent some hacks and workarounds to make it work, but we were never satisfied with the outcome.</p> <p>Additionally, this facility could easily lead to ODR violations or provide different results depending on which header files were included in the translation units. This was too vulnerable to be considered a good practice here.</p>"},{"location":"blog/2023/09/24/whats-new-in-mp-units-20/#no-udls-anymore","title":"No UDLs anymore","text":"<p>Over the years, we have learned that UDLs are not a good solution. More information on this subject can be found in the Why don't we use UDLs to create quantities? chapter.</p>"},{"location":"blog/2023/09/24/whats-new-in-mp-units-20/#no-construction-of-a-quantity-from-a-raw-value","title":"No construction of a <code>quantity</code> from a raw value","text":"<p>To improve safety, we no longer allow the construction of quantities from raw values. In the new design, we always need to explicitly specify a unit to create a <code>quantity</code>:</p> <pre><code>quantity q1 = 42 * m;\nquantity<si::metre> = 2 * km;\nquantity q3(42, si::metre);\n</code></pre> <p>The previous approach was reported to be error-prone under maintenance. More on this subject can be found in the Why can't I create a quantity by passing a number to a constructor? chapter.</p>"},{"location":"blog/2023/09/24/whats-new-in-mp-units-20/#new-look-and-feel","title":"New look and feel","text":"<p>Here is a concise example showing you the new look and feel of the library:</p> <pre><code>#include <mp-units/format.h>\n#include <mp-units/systems/isq/isq.h>\n#include <mp-units/systems/si/si.h>\n#include <format>\n\nusing namespace mp_units;\nusing namespace mp_units::si::unit_symbols;\n\nquantity<isq::speed[m / s]> avg_speed(quantity<si::metre> d,\n quantity<si::second> t)\n{ return d / t; }\n\nint main()\n{\n auto speed = avg_speed(220 * km, 2 * h);\n std::println(\"{}\", speed); // 30.5556 m/s\n}\n</code></pre> <p>All of the changes we provided, although breaking ones, resulted in much better, easier, and safer abstractions. These offer a new quantity on the market and hopefully will be appreciated by our users.</p> <p>Please check our new documentation to learn about the latest version of the project and find out how to benefit from all the new cool stuff we have here.</p>"},{"location":"blog/2023/12/09/mp-units-210-released/","title":"mp-units 2.1.0 released!","text":"<p>A new product version can be obtained from GitHub and Conan.</p> <p>The list of the most significant changes introduced by the new version can be found in our Release Notes. We will also describe the most important of them in this post.</p>"},{"location":"blog/2023/12/09/mp-units-210-released/#no-more-parenthesis-while-creating-quantities-with-derived-units","title":"No more parenthesis while creating quantities with derived units","text":"<p>The V2 design introduced a way to create a <code>quantity</code> by multiplying a raw value and a unit:</p> <pre><code>quantity q1 = 42 * m;\n</code></pre> <p>However, this meant that when we wanted to create a quantity having a derived unit, we had to put parenthesis around the unit equation or create a custom value of the named unit:</p> <pre><code>quantity q2 = 60 * (km / h);\n\nconstexpr auto kmph = km / h;\nquantity q3 = 60 * kmph;\n\nquantity q4 = 50 * (1 / s);\n</code></pre> <p>With the new version, we removed this restriction, and now we can type:</p> <pre><code>quantity q5 = 60 * km / h;\nquantity q6 = 50 / s;\n</code></pre> <p>As a side effect, we introduced a breaking change . We can't use the following definition of hertz anymore:</p> <pre><code>inline constexpr struct hertz : named_unit<\"Hz\", 1 / second, kind_of<isq::frequency>> {} hertz;\n</code></pre> <p>and have to type either:</p> <pre><code>inline constexpr struct hertz : named_unit<\"Hz\", one / second, kind_of<isq::frequency>> {} hertz;\n</code></pre> <p>or</p> <pre><code>inline constexpr struct hertz : named_unit<\"Hz\", inverse(second), kind_of<isq::frequency>> {} hertz;\n</code></pre> <p>To be consistent, we applied the same change to the dimensions and quantity specifications definitions. Now, to define a frequency we have to type:</p> C++23C++20Portable <pre><code>inline constexpr struct frequency : quantity_spec<inverse(period_duration)> {} frequency;\n</code></pre> <pre><code>inline constexpr struct frequency : quantity_spec<frequency, inverse(period_duration)> {} frequency;\n</code></pre> <pre><code>QUANTITY_SPEC(frequency, inverse(period_duration));\n</code></pre>"},{"location":"blog/2023/12/09/mp-units-210-released/#make_xxx-factory-functions-replaced-with-two-parameter-constructors","title":"<code>make_xxx</code> factory functions replaced with two-parameter constructors","text":"<p>In the initial version of the V2 framework, if someone did not like the multiply syntax to create a <code>quantity</code> we provided the <code>make_quantity()</code> factory function. A similar approach was used for <code>quantity_point</code> creation.</p> <p>This version removes those ( breaking change ) and introduces two parameter constructors:</p> <pre><code>quantity q(42, si::metre);\nquantity_point qp(q, mean_sea_level);\n</code></pre> <p>The above change encourages a better design and results in a terser code.</p>"},{"location":"blog/2023/12/09/mp-units-210-released/#improved-definitions-of-becquerel-gray-and-sievert","title":"Improved definitions of becquerel, gray, and sievert","text":"<p>In the initial V2 version, we lacked the definitions of the atomic and nuclear physics quantities, which resulted in simplified and unsafe definitions of becquerel, gray, and sievert units. We still do not model most of the quantities from this domain, but we've added the ones that are necessary for the definition of those units.</p> <p>Thanks to the above, the following expressions will not compile:</p> <pre><code>quantity q1 = 1 * Hz + 1 * Bq;\nquantity<si::sievert> q2 = 42 * Gy;\n</code></pre>"},{"location":"blog/2023/12/09/mp-units-210-released/#compatibility-with-other-libraries-redesigned","title":"Compatibility with other libraries redesigned","text":"<p>Another significant improvement in this version was redesigning the way we provide compatibility with other similar libraries. The interfaces of <code>quantity_like_traits</code> and <code>quantity_point_like_traits</code> were changed and extended to provide conversion not only from but also to entities from other libraries ( breaking change ).</p> <p>We've also introduced an innovative approach that allows us to specify if such conversions should happen implicitly or if they need to be forced explicitly.</p> <p>More on this subject can be found in the Interoperability with Other Libraries chapter.</p>"},{"location":"blog/2023/12/09/mp-units-210-released/#point-origins-can-now-be-derived-from-each-other","title":"Point origins can now be derived from each other","text":"<p>Previously, each class derived from <code>absolute_point_origin</code> was considered a unique independent point origin. On the other hand, it was OK to derive multiple classes from the same <code>relative_point_origin</code>, and those were specifying the same point in the domain. We found this confusing and limiting. This is why, in this version, the <code>absolute_point_origin</code> uses a CRTP idiom to be able to detect between points that should be considered different from the ones that should be equivalent.</p> <p>If we derive from the same instantiation of <code>absolute_point_origin</code> we end up with an equivalent point origin. This change allows us to provide different names for the same temperature points:</p> <pre><code>inline constexpr struct absolute_zero : absolute_point_origin<absolute_zero, isq::thermodynamic_temperature> {} absolute_zero;\ninline constexpr struct zeroth_kelvin : decltype(absolute_zero) {} zeroth_kelvin;\n\ninline constexpr struct ice_point : relative_point_origin<absolute_zero + 273.15 * kelvin> {} ice_point;\ninline constexpr struct zeroth_degree_Celsius : decltype(ice_point) {} zeroth_degree_Celsius;\n</code></pre> <p>Please note that this is a breaking change as well.</p>"},{"location":"blog/2023/12/09/mp-units-210-released/#unit-symbol-text-can-now-be-properly-used-at-runtime","title":"Unit symbol text can now be properly used at runtime","text":"<p>The interface of the previous definition of <code>unit_symbol</code> function allowed the use of the returned buffer only at compile-time. This was too limiting as users often want to use unit symbols at runtime (e.g., print them to the console). The new version redesigned the interface of this function ( breaking change ) to return a buffer that can be properly used at both compilation and runtime:</p> <pre><code>std::string_view unit1 = unit_symbol(m / s);\nstd::cout << unit1 << \"\\n\"; // m/s\nstd::string_view unit2 = unit_symbol<{.solidus = unit_symbol_solidus::never}>(m / s);\nstd::cout << unit2 << \"\\n\"; // m s\u207b\u00b9\n</code></pre>"},{"location":"blog/2023/11/12/report-from-the-kona-2023-iso-c-committee-meeting/","title":"Report from the Kona 2023 ISO C++ Committee meeting","text":"<p>Several groups in the ISO C++ Committee reviewed the P1935: A C++ Approach to Physical Units proposal in Belfast 2019 and Prague 2020. All those groups expressed interest in the potential standardization of such a library and encouraged further work. The authors also got valuable initial feedback that highly influenced the design of the V2 version of the mp-units library.</p> <p>In the following years, we scoped on getting more feedback from the production and design. This resulted in version 2 of the mp-units library that resolved many issues the users and Committee members raised. The features and interfaces of this version are close to being the best we can get with the current version of the C++ language standard.</p> <p>We submitted three new proposals related to the standardization of the quantities and units library for the last ISO C++ Committee meeting:</p> <ul> <li>P2980: A motivation, scope, and plan for a physical quantities and units library,</li> <li>P2981: Improving our safety with a physical quantities and units library,</li> <li>P2982: <code>std::quantity</code> as a numeric type.</li> </ul> <p>Those were reviewed and briefly discussed in several groups: Numerics (SG6), Safety & Security (SG23), and Library Evolution Working Group (LEWG). Most of the feedback was positive, and the Committee is interested in spending more time on such proposals.</p> <p>The following poll was taken by the LEWG:</p> <p>LEWG POLL: Given that our time is limited, more time should be promised for a quantities and units library</p> Strongly in Favor In favor Neutral Against Strongly Against 10 13 4 0 0 <p>Attendance: 22 + 6</p> <p>Number of Authors: 4</p> <p>Authors\u2019 position: 4x SF</p> <p>Outcome: Strong consensus in favor</p> <p>Additionally, some concerns were raised about the large scope of the proposal. We were encouraged to return with more details and design rationale in a unified paper. This is what we are working on now for the next Committee meeting that will happen in mid-March 2024 in Tokyo.</p>"},{"location":"blog/2024/04/15/report-from-the-tokyo-2024-iso-c-committee-meeting/","title":"Report from the Tokyo 2024 ISO C++ Committee meeting","text":"<p>The Tokyo 2024 meeting was a very important step in the standardization of this library. Several WG21 groups reviewed proposals, and the feedback was really good.</p>"},{"location":"blog/2024/04/15/report-from-the-tokyo-2024-iso-c-committee-meeting/#p3045r0-quantities-and-units-library","title":"P3045R0: Quantities and units library","text":"<p>The Study Group 6 (Numerics) discussed the proposal for several hours. The initial feedback was positive. There were some concerns related to the description and design of the affine space abstractions in the library. Besides that, the people in the room liked what they saw.</p> <p>We run a few polls in SG6 as well:</p> <p>POLL: The syntax <code>number * unit</code> is the right solution for constructing quantities. Not allowing reordering the operands is correct.</p> Strongly in Favor In favor Neutral Against Strongly Against 5 4 1 0 1 <p>POLL: Not defining any UDLs is the right solution.</p> <p>No objection to unanimous consent.</p> <p>The paper was also briefly discussed in SG18 LEWG Incubator, and the initial feedback was also positive. No polls were taken.</p> <p>SG16 Unicode does not meet during ISO C++ Committee F2F meetings. Still, the text output chapter paper was also reviewed by it during an online meeting before Tokyo. We got good feedback and are expected to return with the updated version. No polls were taken.</p>"},{"location":"blog/2024/04/15/report-from-the-tokyo-2024-iso-c-committee-meeting/#p30942r1-stdbasic_fixed_string","title":"P30942R1: <code>std::basic_fixed_string</code>","text":"<p>In the SG18 LEWG Incubator, before we started to talk about P3045R0, we spent a few hours discussing the design of the <code>std::basic_fixed_string</code>, which is proposed for C++26. The group gave excellent feedback, and if the R2 version addresses it properly, the paper is expected to progress to LEWG (Library Evolution Working Group) in St. Louis.</p> <p>Plenty of polls were taken:</p> <p>POLL: We should promise more committee time to pursuing <code>std::basic_fixed_string</code>, knowing that our time is scarce and this will leave less time for other work.</p> Strongly in Favor In favor Neutral Against Strongly Against 11 0 0 0 0 <p>POLL: Should the constructor from a string literal be <code>consteval</code>?</p> Strongly in Favor In favor Neutral Against Strongly Against 6 3 2 0 0 <p>POLL: Do we want to add <code>.view()</code>?</p> Strongly in Favor In favor Neutral Against Strongly Against 3 5 3 0 0 <p>POLL: Do we want the <code>.size</code> member to be an <code>integral_constant<size_t, N></code> (and <code>.empty</code> to be <code>bool_constant<N==0></code>)?</p> Strongly in Favor In favor Neutral Against Strongly Against 5 2 2 2 0 <p>POLL: Should the index <code>operator[]</code> return a reference to <code>const</code>?</p> Strongly in Favor In favor Neutral Against Strongly Against 2 2 3 3 0 <p>POLL: Should the constructor from a string literal have a precondition that <code>txt[N] == 0</code>?</p> Strongly in Favor In favor Neutral Against Strongly Against 6 1 2 0 2"},{"location":"getting_started/cpp_compiler_support/","title":"C++ compiler support (API/ABI)","text":"<p>Info</p> <p>mp-units library tries to provide the best user experience possible with the C++ language. To achieve that, it extensively uses the latest C++ language features.</p> <p>Even though the library benefits from the latest C++ versions (if available), C++20 is enough to compile and use all of the library's functionality. Newer features can be hidden behind some preprocessor macros providing a backward-compatible way to use them.</p> <p>The table below provides the minimum compiler version required to compile the code using a specific C++ feature:</p> C++ Feature C++ version gcc clang apple-clang MSVC Minimum support 20 12 16 15 None <code>std::format</code> 20 13 17 None None C++ modules 20 None 17 None None Static <code>constexpr</code> variables in <code>constexpr</code> functions 23 13 17 None None Explicit <code>this</code> parameter 23 14 18 None None <p>Important</p> <p>Enabling/disabling features listed above may influence the API of the library and the ABI of the customers' projects.</p>"},{"location":"getting_started/cpp_compiler_support/#stdformat","title":"<code>std::format</code>","text":"<ul> <li>Provides powerful text formatting capabilities for C++.</li> <li>An alternative fmtlib library can be used instead if<ul> <li>the C++ language feature is not supported,</li> <li>the customer's project did not switch to <code>std::format</code> yet (even when the compiler supports it).</li> </ul> </li> <li>To write code with wide compatibility a dedicated macro may be used.</li> <li>Tested with <code>__cpp_lib_format</code> feature test macro.</li> <li>Related build options:<ul> <li>Conan: std_format</li> <li>CMake: MP_UNITS_API_STD_FORMAT</li> </ul> </li> </ul>"},{"location":"getting_started/cpp_compiler_support/#c-modules","title":"C++ modules","text":"<ul> <li>Provide new way to share declarations and definitions across translation units.</li> <li>If used, the library will distribute both \"old-style\" headers and module interface units<ul> <li>associated with the same CMake targets.</li> </ul> </li> <li>Even with full compiler support, a user may still decide to not pay for C++ modules compilation if they are not needed by the customer's project.</li> <li>Feature test macro is not used for testing here because even if the compiler does not support the entire C++ feature (e.g. header units), it is enough to build modules for this library.</li> <li>Related build options:<ul> <li>Conan: cxx_modules</li> <li>CMake: MP_UNITS_BUILD_CXX_MODULES</li> </ul> </li> </ul> <p>Note</p> <p>More requirements for C++ modules support can be found in the CMake's documentation.</p>"},{"location":"getting_started/cpp_compiler_support/#static-constexpr-variables-in-constexpr-functions","title":"Static <code>constexpr</code> variables in <code>constexpr</code> functions","text":"<ul> <li>Allows returning <code>std::string_view</code> from the <code>unit_symbol()</code> and <code>dimension_symbol()</code> functions<ul> <li><code>std::string_view</code> type has a reference semantics so it has to point to a storage with a longer lifetime.</li> </ul> </li> <li>If this feature is not available, the API returns <code>mp_units::basic_fixed_string<CharT, N></code> instead.</li> <li>Tested as <code>__cpp_constexpr >= 202211L</code> feature test macro.</li> <li>Related build options:<ul> <li>Conan: string_view_ret</li> <li>CMake: MP_UNITS_API_STRING_VIEW_RET</li> </ul> </li> </ul>"},{"location":"getting_started/cpp_compiler_support/#explicit-this-parameter","title":"Explicit <code>this</code> parameter","text":"<ul> <li>This feature removes the need for the usage of the CRTP idiom in the <code>quantity_spec</code> definitions.</li> <li>To write code with wide compatibility a dedicated macro may be used.</li> <li>Tested with <code>__cpp_explicit_this_parameter</code> feature test macro.</li> <li>Related build options:<ul> <li>Conan: no_crtp</li> <li>CMake: MP_UNITS_API_NO_CRTP</li> </ul> </li> </ul>"},{"location":"getting_started/faq/","title":"Frequently Asked Questions","text":""},{"location":"getting_started/faq/#why-do-we-spell-metre-instead-of-meter","title":"Why do we spell <code>metre</code> instead of <code>meter</code>?","text":"<p>This is how the BIPM defines it in the SI Brochure (British English spelling by default).</p>"},{"location":"getting_started/faq/#why-dont-we-use-udls-to-create-quantities","title":"Why don't we use UDLs to create quantities?","text":"<p>Many reasons make UDLs a poor choice for a physical units library:</p> <ol> <li>UDLs work only with literals (compile-time known values). Our observation is that besides the unit tests, there are only a few compile-time known quantity values used in the production code. Please note that for physical constants, we recommend using Faster-than-lightspeed Constants.</li> <li> <p>Typical implementations of UDLs tend to always use the widest representation type available. In the case of <code>std::chrono::duration</code>, the following is true:</p> <pre><code>using namespace std::chrono_literals;\nauto d1 = 42s;\nauto d2 = 42.s;\nstatic_assert(std::is_same_v<decltype(d1)::rep, std::int64_t>);\nstatic_assert(std::is_same_v<decltype(d2)::rep, long double>);\n</code></pre> </li> </ol> <p>When such UDL is intermixed in arithmetics with any quantity type of a shorter representation type, it will always expand it to the longest one. In other words, such long type spreads until all types use it everywhere.</p> <ol> <li> <p>While increasing the coverage for the library, we learned that many unit symbols conflict with built-in types or numeric extensions. A few of those are: <code>F</code> (farad), <code>J</code> (joule), <code>W</code> (watt), <code>K</code> (kelvin), <code>d</code> (day), <code>l</code> or <code>L</code> (litre), <code>erg</code>, <code>ergps</code>. Usage of the <code>_</code> prefix would make it work for mp-units, but in case the library is standardized, those naming collisions would be a big issue. This is why we came up with the <code>_q_</code> prefix that would become <code>q_</code> after standardization (e.g., <code>42q_s</code>), which is not that nice anymore.</p> </li> <li> <p>UDLs with the same identifiers defined in different namespace can't be disambiguated in the C++ language. If both SI and CGS systems define <code>_q_s</code> UDL for a second unit, then it would not be possible to specify which one to use in case both namespaces are \"imported\" with using directives.</p> </li> <li> <p>Another bad property of UDLs is that they do not compose. A coherent unit of angular momentum would have a UDL specified as <code>_q_kg_m2_per_s</code>. Now imagine that we want to make every possible user happy. How many variations of that unit would we predefine for differently scaled versions of all unit ingredients?</p> </li> <li> <p>UDLs are also really expensive to define and specify. Typically, for each unit, we need two definitions. One for integral and another one for floating-point representation. Before the V2 framework, the coherent unit of angular momentum was defined as:</p> <pre><code>constexpr auto operator\"\" _q_kg_m2_per_s(unsigned long long l)\n{\n gsl_Expects(std::in_range<std::int64_t>(l));\n return angular_momentum<kilogram_metre_sq_per_second, std::int64_t>(static_cast<std::int64_t>(l));\n}\n\nconstexpr auto operator\"\" _q_kg_m2_per_s(long double l)\n{\n return angular_momentum<kilogram_metre_sq_per_second, long double>(l);\n}\n</code></pre> </li> </ol>"},{"location":"getting_started/faq/#why-cant-i-create-a-quantity-by-passing-a-number-to-a-constructor","title":"Why can't I create a quantity by passing a number to a constructor?","text":"<p>A quantity class template in the mp-units library has no publicly available constructor taking a raw value. Such support is provided by the <code>std::chrono::duration</code> and was pointed out to us as a red flag safety issue by a few parties already.</p> <p>Consider the following structure and a code using it:</p> <pre><code>struct X {\n std::vector<std::chrono::milliseconds> vec;\n // ...\n};\n</code></pre> <pre><code>X x;\nx.vec.emplace_back(42);\n</code></pre> <p>Everything works fine for years until, at some point, someone changes the structure to:</p> <pre><code>struct X {\n std::vector<std::chrono::microseconds> vec;\n // ...\n};\n</code></pre> <p>The code continues to compile just fine, but all the calculations are off now. This is why we decided to not follow this path.</p> <p>In the mp-units library, both a number and a unit have to always be explicitly provided in order to form a quantity.</p> <p>Note</p> <p>The same applies to the construction of <code>quantity_point</code> using an explicit point origin. To prevent similar safety issues during maintenance, the initialization always requires providing both a <code>quantity</code> and a <code>PointOrigin</code> that we use as a reference point.</p>"},{"location":"getting_started/faq/#why-a-dimensionless-quantity-is-not-just-a-fundamental-arithmetic-type","title":"Why a dimensionless quantity is not just a fundamental arithmetic type?","text":"<p>In the initial design of this library, the resulting type of division of two quantities was their common representation type:</p> <pre><code>static_assert(std::is_same_v<decltype(10 * km / (5 * km)), int>);\n</code></pre> <p>First of all, this was consistent with <code>std::chrono::duration</code> behavior. Additional reasoning behind it was not providing a false impression of a strong <code>quantity</code> type for something that looks and feels like a regular number. Also, all of the mathematic and trigonometric functions were working fine out of the box with such representation types, so we did not have to rewrite <code>sin()</code>, <code>cos()</code>, <code>exp()</code>, and others.</p> <p>However, the feedback we got from the production usage was that such an approach is really bad for generic programming. It is hard to handle the result of the two quantities' division (or multiplication) as it might be either a quantity or a fundamental type. If we want to raise such a result to some power, we must use <code>units::pow</code> or <code>std::pow</code> depending on the resulting type. Those are only a few issues related to such an approach.</p> <p>Moreover, suppose we divide quantities of the same dimension but with units of significantly different magnitudes. In that case, we may end up with a really small or a huge floating-point value, which may result in losing lots of precision. Returning a dimensionless quantity from such cases allows us to benefit from all the properties of scaled units and is consistent with the rest of the library.</p> <p>Note</p> <p>More information on the current design can be found in the Dimensionless Quantities chapter.</p>"},{"location":"getting_started/faq/#why-do-the-identifiers-for-concepts-in-the-library-use-camelcase","title":"Why do the identifiers for concepts in the library use <code>CamelCase</code>?","text":"<p>Initially, C++20 was meant to use <code>CamelCase</code> for all the concept identifiers. All the concepts from the <code>std::ranges</code> library were merged with such names into the standard document draft. Frustratingly, <code>CamelCase</code> concepts got dropped from the C++ standard at the last moment before releasing C++20. Now, we are facing the predictable consequences of running out of names.</p> <p>As long as some concepts in the library could be easily named with a <code>standard_case</code> there are some that are hard to distinguish from the corresponding type names, such as <code>Quantity</code>, <code>QuantityPoint</code>, <code>QuantitySpec</code>, or <code>Reference</code>. This is why we decided to use <code>CamelCase</code> consistently for all the concept identifiers to make it clear when we are talking about a type or concept identifier.</p> <p>However, we are aware that this might be a temporary solution. In case the library gets standardized, we can expect the ISO C++ Committee to bikeshed/rename all of the concept identifiers to a <code>standard_case</code>, even if it will result in a harder to understand code.</p> <p>Note</p> <p>In case you have a good idea of how to rename existing concepts to the <code>standard_case</code>, please let us know in the associated GitHub Issue.</p>"},{"location":"getting_started/faq/#why-unicode-quantity-symbols-are-used-by-default-instead-of-ascii-only-characters","title":"Why Unicode quantity symbols are used by default instead of ASCII-only characters?","text":"<p>Both C++ and ISO 80000 are standardized by the ISO. ISO 80000 and the SI standards specify Unicode symbols as the official unit names for some quantities (e.g. <code>\u03a9</code> symbol for the resistance quantity). As the mp-units library will be proposed for standardization as a part of the C++ Standard Library we have to obey the rules and be consistent with ISO specifications.</p> <p>Note</p> <p>We do understand engineering reality and the constraints of some environments. This is why the library has the option of ASCII-only Quantity Symbols.</p>"},{"location":"getting_started/faq/#why-dont-we-have-cmake-options-to-disable-the-building-of-tests-and-examples","title":"Why don't we have CMake options to disable the building of tests and examples?","text":"<p>Over time, many people provided PRs proposing adding options to build tests and examples conditionally. Here are a few examples:</p> <ul> <li>Add CMake options for disabling docs, examples and tests</li> <li>build: add options to disable part of the build</li> <li>CMake Refactoring and Option Cleanup</li> </ul> <p>We admit this is a common practice in the industry, but we also believe this is a bad pattern.</p> <p>First, the only need for such options comes when a user wants to use <code>add_subdirectory()</code> in CMake to handle dependencies. Such an approach does not scale and should be discouraged. There is little use for such a practice in times when we have dedicated package managers like Conan.</p> <p>The second thing is that our observation is that many people are fixed on disabling \"unneeded\" subdirectories from compilation, but they do not see or address the biggest issue, which is polluting user's build environment with our development-specific settings. Propagating our restrictive compilation flags to user's project is not the best idea as it might cause a lot of harm if this project stops to compile because of that.</p> <p>Last but not least, not having those options is on purpose. Top level CMakeLists.txt file should only be used by mp-units developers and contributors as an entry point for the project's development. We want to ensure that everyone will build ALL the code correctly before pushing a commit. Having such options would allow unintended issues to leak to PRs and CI.</p> <p>This is why our projects have two entry points:</p> <ul> <li>./CMakeLists.txt is to be used by projects developers to build ALL the project code with really restrictive compilation flags,</li> <li>./src/CMakeLists.txt contains only a pure library definition and should be used by the customers that prefer to use CMake's <code>add_subdirectory()</code> to handle the dependencies.</li> </ul> <p>Note</p> <p>For more details on this please refer to the CMake + Conan: 3 Years Later - Mateusz Pusz lecture that Mateusz Pusz provided at the C++Now 2021 conference.</p>"},{"location":"getting_started/installation_and_usage/","title":"Installation And Usage","text":"<p>This chapter provides all the necessary information to obtain and build the code using mp-units. It also describes how to build or distribute the library and generate its documentation.</p>"},{"location":"getting_started/installation_and_usage/#project-structure","title":"Project structure","text":""},{"location":"getting_started/installation_and_usage/#repository-directory-tree-and-dependencies","title":"Repository directory tree and dependencies","text":"<p>The GitHub repository contains three independent CMake-based projects:</p> <ul> <li> <p>./src</p> <ul> <li>header-only project containing whole mp-units library</li> <li>./src/CMakeList.txt file is intended as an entry point for library users</li> <li> <p>in case this library becomes part of the C++ standard, it will have no external dependencies but until then, it depends on the following:</p> <ul> <li>gsl-lite or ms-gsl to verify runtime contracts (if contract checking is enabled),</li> <li>{fmt} to provide text formatting of quantities (if <code>std::format</code> is not supported yet on a specific compiler).</li> </ul> </li> </ul> </li> <li> <p>.</p> <ul> <li>project used as an entry point for library development and CI/CD</li> <li>it wraps ./src project together with usage examples and tests</li> <li> <p>additionally to the dependencies of ./src project, it uses:</p> <ul> <li>Catch2 library as a unit tests framework,</li> <li>linear algebra library based on proposal P1385 used in some examples and tests.</li> </ul> </li> </ul> </li> <li> <p>./test_package</p> <ul> <li>CMake library installation and Conan package verification.</li> </ul> </li> </ul> <p>Important: Library users should not use the top-level CMake file</p> <p>Top level CMakeLists.txt file should only be used by mp-units developers and contributors as an entry point for the project's development. We want to ensure that everyone will build ALL the code correctly before pushing a commit. Having such options would allow unintended issues to leak to PRs and CI.</p> <p>This is why our projects have two entry points:</p> <ul> <li>./CMakeLists.txt is to be used by projects developers to build ALL the project code with really restrictive compilation flags,</li> <li>./src/CMakeLists.txt contains only a pure library definition and should be used by the customers that prefer to use CMake's <code>add_subdirectory()</code> to handle the dependencies.</li> </ul> <p>To learn more about the rationale, please check our FAQ.</p>"},{"location":"getting_started/installation_and_usage/#modules","title":"Modules","text":"<p>The mp-units library provides the following C++ modules:</p> <pre><code>flowchart TD\n mp_units --- mp_units.systems --- mp_units.core</code></pre> C++ Module CMake Target Contents <code>mp_units.core</code> <code>mp-units::core</code> Core library framework and systems-independent utilities <code>mp_units.systems</code> <code>mp-units::systems</code> All the systems of quantities and units <code>mp_units</code> <code>mp-units::mp-units</code> Core + Systems <p>Note</p> <p>C++ modules are provided within the package only when:</p> <ul> <li><code>cxx_modules</code> Conan option is set to <code>True</code>,</li> <li><code>MP_UNITS_BUILD_CXX_MODULES</code> CMake option is set to <code>ON</code>.</li> </ul>"},{"location":"getting_started/installation_and_usage/#header-files","title":"Header files","text":"<p>All of the project's header files can be found in the <code>mp-units/...</code> subdirectory.</p>"},{"location":"getting_started/installation_and_usage/#core-library","title":"Core library","text":"<ul> <li><code>mp-units/framework.h</code> contains the entire library's framework definitions,</li> <li><code>mp-units/concepts.h</code> exposes only the library's concepts for generic code needs,</li> <li><code>mp-units/format.h</code> provides text formatting support,</li> <li><code>mp-units/ostream.h</code> enables streaming of the library's objects to the text output,</li> <li><code>mp-units/math.h</code> provides overloads of common math functions for quantities,</li> <li><code>mp-units/random.h</code> provides C++ pseudo-random number generators for quantities,</li> <li><code>mp-units/compat_macros.h</code> provides macros for wide compatibility.</li> </ul> More details <p>More detailed header files can be found in subfolders which typically should not be included by the end users:</p> <ul> <li><code>mp-units/framework/...</code> provides all the public interfaces of the framework,</li> <li><code>mp-units/bits/...</code> provides private implementation details only (no public definitions),</li> <li><code>mp-units/ext/...</code> contains external dependencies that at some point in the future should be replaced with C++ standard library facilities.</li> </ul>"},{"location":"getting_started/installation_and_usage/#systems-and-associated-utilities","title":"Systems and associated utilities","text":"<p>The systems definitions can be found in the <code>mp-units/systems/...</code> subdirectory:</p>"},{"location":"getting_started/installation_and_usage/#systems-of-quantities","title":"Systems of quantities","text":"<ul> <li><code>mp-units/systems/isq.h</code> provides International System of Quantities (ISQ) definitions,</li> </ul> Tip: Improving compile times <p><code>mp-units/systems/isq.h</code> might be expensive to compile in every translation unit. There are some smaller, domain targeted files available for explicit inclusion in the <code>mp-units/systems/isq/...</code> subdirectory.</p>"},{"location":"getting_started/installation_and_usage/#systems-of-units","title":"Systems of units","text":"<ul> <li><code>mp-units/systems/si.h</code> provides International System of Units (SI) definitions and associated math functions,</li> <li><code>mp-units/systems/angular.h</code> provides strong angular units and associated math functions,</li> <li><code>mp-units/systems/international.h</code> provides international yard and pound units,</li> <li><code>mp-units/systems/imperial.h</code> includes <code>international.h</code> and extends it with imperial units,</li> <li><code>mp-units/systems/usc.h</code> includes <code>international.h</code> and extends it with United States customary system of units,</li> <li><code>mp-units/systems/cgs.h</code> provides centimetre-gram-second system of units,</li> <li><code>mp-units/systems/iau.h</code> provides astronomical system of units,</li> <li><code>mp-units/systems/hep.h</code> provides units used in high-energy physics,</li> <li><code>mp-units/systems/typographic.h</code> provides units used in typography or typesetting,</li> <li><code>mp-units/systems/natural.h</code> provides an example implementation of natural units.</li> </ul> Tip: Improving compile times <p><code>mp-units/systems/si.h</code> might be expensive to compile in every translation unit. There are some smaller files available for explicit inclusion in the <code>mp-units/systems/si/...</code> subdirectory.</p> <p><code>mp-units/systems/si/unit_symbols.h</code> is the most expensive to include.</p>"},{"location":"getting_started/installation_and_usage/#obtaining-dependencies","title":"Obtaining dependencies","text":"<p>This library assumes that most of the dependencies will be provided by the Conan Package Manager. If you want to obtain required dependencies by other means, some modifications to the library's CMake files might be needed. The rest of the dependencies responsible for documentation generation are provided by <code>python3-pip</code>.</p>"},{"location":"getting_started/installation_and_usage/#conan-quick-intro","title":"Conan quick intro","text":"<p>In case you are not familiar with Conan, to install it (or upgrade) just do:</p> <pre><code>pip install -U conan\n</code></pre> <p>After that, you might need to add a custom profile file for your development environment in ~/.conan2/profiles directory. An example profile can look as follows:</p> ~/.conan2/profiles/gcc12<pre><code>[settings]\narch=x86_64\nbuild_type=Release\ncompiler=gcc\ncompiler.cppstd=20\ncompiler.libcxx=libstdc++11\ncompiler.version=12\nos=Linux\n\n[conf]\ntools.build:compiler_executables={\"c\": \"gcc-12\", \"cpp\": \"g++-12\"}\n</code></pre> <p>Setting the language version</p> <p>Please note that the mp-units library requires at least C++20 to be set in a Conan profile or forced via the Conan command line. If we do the former, we will not need to provide <code>-s compiler.cppstd=20</code> every time we run a Conan command line (as provided in the command line instructions below).</p> <p>Using Ninja as a CMake generator for Conan</p> <p>It is highly recommended to set Ninja as a CMake generator for Conan. To do so, we should create a ~/.conan2/global.conf file that will set <code>tools.cmake.cmaketoolchain:generator</code> to one of the Ninja generators. For example:</p> ~/.conan2/global.conf<pre><code>tools.cmake.cmaketoolchain:generator=\"Ninja Multi-Config\"\n</code></pre> <p>Separate build folders for different configurations</p> <p>~/.conan2/global.conf file may also set <code>tools.cmake.cmake_layout:build_folder_vars</code> which makes working with several compilers or build configurations easier. For example, the below line will force Conan to generate separate CMake presets and folders for each compiler and C++ standard version:</p> ~/.conan2/global.conf<pre><code>tools.cmake.cmake_layout:build_folder_vars=[\"settings.compiler\", \"settings.compiler.version\", \"settings.compiler.cppstd\"]\n</code></pre> <p>In such a case, we will need to use a configuration-specific preset name in the Conan instructions provided below rather than just <code>conan-default</code> and <code>conan-release</code> (e.g. <code>conan-gcc-13-23</code> and <code>conan-gcc-13-23-release</code>)</p>"},{"location":"getting_started/installation_and_usage/#build-options","title":"Build options","text":"<p>Note</p> <p>Most of the below options are related to the C++ language features available in the compilers. Please refer to the C++ compiler support chapter to learn more about which C++ features are required and which compiler support them.</p>"},{"location":"getting_started/installation_and_usage/#conan-options","title":"Conan options","text":"<code>cxx_modules</code> <p> 2.2.0 \u00b7 <code>auto</code>/<code>True</code>/<code>False</code> (Default: <code>auto</code>)</p> <p>Configures CMake to add C++ modules to the list of default targets.</p> <code>std_format</code> <p> 2.2.0 \u00b7 <code>auto</code>/<code>True</code>/<code>False</code> (Default: <code>auto</code>)</p> <p>Enables the usage of <code>std::format</code> and associated facilities for text formatting. If it is not supported, then the {fmt} library is used instead.</p> <code>string_view_ret</code> <p> 2.2.0 \u00b7 <code>auto</code>/<code>True</code>/<code>False</code> (Default: <code>auto</code>)</p> <p>Enables returning <code>std::string_view</code> from the <code>unit_symbol()</code> and <code>dimension_symbol()</code> functions. If this feature is not available, those functions will return <code>mp_units::basic_fixed_string<CharT, N></code> instead.</p> <code>no_crtp</code> <p> 2.2.0 \u00b7 <code>auto</code>/<code>True</code>/<code>False</code> (Default: <code>auto</code>)</p> <p>Removes the need for the usage of the CRTP idiom in the <code>quantity_spec</code> definitions.</p> <code>contracts</code> <p> 2.2.0 \u00b7 <code>none</code>/<code>gsl-lite</code>/<code>ms-gsl</code> (Default: <code>gsl-lite</code>)</p> <p>Enables checking of preconditions and additional asserts in the code.</p> <code>freestanding</code> <p> 2.2.0 \u00b7 <code>True</code>/<code>False</code> (Default: <code>False</code>)</p> <p>Configures the library in the freestanding mode. When enabled, the library's source code should build with the compiler's <code>-ffreestanding</code> compilation option without any issues.</p>"},{"location":"getting_started/installation_and_usage/#conan-configuration-properties","title":"Conan configuration properties","text":"<code>user.mp-units.build:all</code> <p> 2.2.0 \u00b7 <code>True</code>/<code>False</code> (Default: <code>False</code>)</p> <p>Enables compilation of all the source code, including tests and examples. To support this, it requires some additional Conan build dependencies described in Repository directory tree and dependencies. It also runs unit tests during Conan build (unless <code>tools.build:skip_test</code> configuration property is set to <code>True</code>).</p> <code>user.mp-units.build:skip_la</code> <p> 2.2.0 \u00b7 <code>True</code>/<code>False</code> (Default: <code>False</code>)</p> <p>If <code>user.mp-units.build:all</code> is enabled, among others, Conan installs the external wg21-linear_algebra dependency and enables the compilation of linear algebra-based tests and usage examples. Such behavior can be disabled with this option.</p> <code>user.mp-units.analyze:clang-tidy</code> <p> 2.2.0 \u00b7 <code>True</code>/<code>False</code> (Default: <code>False</code>)</p> <p>Enables clang-tidy analysis.</p>"},{"location":"getting_started/installation_and_usage/#cmake-options","title":"CMake options","text":"<code>MP_UNITS_BUILD_AS_SYSTEM_HEADERS</code> <p> 2.2.0 \u00b7 <code>ON</code>/<code>OFF</code> (Default: <code>OFF</code>)</p> <p>Exports library as system headers.</p> <code>MP_UNITS_BUILD_CXX_MODULES</code> <p> 2.2.0 \u00b7 <code>ON</code>/<code>OFF</code> (Default: <code>OFF</code>)</p> <p>Adds C++ modules to the list of default targets.</p> <code>MP_UNITS_API_STD_FORMAT</code> <p> 2.2.0 \u00b7 <code>AUTO</code>/<code>TRUE</code>/<code>FALSE</code> (Default: <code>AUTO</code>)</p> <p>Enables the usage of <code>std::format</code> and associated facilities for text formatting. If it is not supported, then the {fmt} library is used instead.</p> <code>MP_UNITS_API_STRING_VIEW_RET</code> <p> 2.2.0 \u00b7 <code>AUTO</code>/<code>TRUE</code>/<code>FALSE</code> (Default: <code>AUTO</code>)</p> <p>Enables returning <code>std::string_view</code> from the <code>unit_symbol()</code> and <code>dimension_symbol()</code> functions. If this feature is not available, those functions will return <code>mp_units::basic_fixed_string<CharT, N></code> instead.</p> <code>MP_UNITS_API_NO_CRTP</code> <p> 2.2.0 \u00b7 <code>AUTO</code>/<code>TRUE</code>/<code>FALSE</code> (Default: <code>AUTO</code>)</p> <p>Removes the need for the usage of the CRTP idiom in the <code>quantity_spec</code> definitions.</p> <code>MP_UNITS_API_CONTRACTS</code> <p> 2.2.0 \u00b7 <code>NONE</code>/<code>GSL-LITE</code>/<code>MS-GSL</code> (Default: <code>GSL-LITE</code>)</p> <p>Enables checking of preconditions and additional asserts in the code.</p> <code>MP_UNITS_API_FREESTANDING</code> <p> 2.2.0 \u00b7 <code>ON</code>/<code>OFF</code> (Default: <code>OFF</code>)</p> <p>Configures the library in the freestanding mode. When enabled, the library's source code should build with the compiler's <code>-ffreestanding</code> compilation option without any issues.</p>"},{"location":"getting_started/installation_and_usage/#options-for-mp-units-project-developers","title":"Options for mp-units project developers","text":"<code>MP_UNITS_DEV_BUILD_LA</code> <p> 2.2.0 \u00b7 <code>ON</code>/<code>OFF</code> (Default: <code>ON</code>)</p> <p>Enables building code depending on the linear algebra library.</p> <code>MP_UNITS_DEV_IWYU</code> <p> 2.2.0 \u00b7 <code>ON</code>/<code>OFF</code> (Default: <code>OFF</code>)</p> <p>Enables include-what-you-use analysis.</p> <code>MP_UNITS_DEV_CLANG_TIDY</code> <p> 2.2.0 \u00b7 <code>ON</code>/<code>OFF</code> (Default: <code>OFF</code>)</p> <p>Enables clang-tidy analysis.</p>"},{"location":"getting_started/installation_and_usage/#cmake-with-presets-support","title":"CMake with presets support","text":"<p>It is recommended to use at least CMake 3.23 to build this project as this version introduced support for CMake Presets schema version 4, used now by Conan to generate presets files. All build instructions below assume that you have such support. If not, your CMake invocations have to be replaced with something like:</p> <pre><code>mkdir build && cd build\ncmake .. -G \"Ninja Multi-Config\" -DCMAKE_TOOLCHAIN_FILE=<path_to_generators_dir>/conan_toolchain.cmake\ncmake --build . --config Release\n</code></pre> <p>Tip</p> <p>In case you can't use CMake 3.23 but you have access to CMake 3.20 or later, you can append <code>-c tools.cmake.cmaketoolchain.presets:max_schema_version=2</code> to the <code>conan install</code> command which will force Conan to use an older version of the CMake Presets schema.</p>"},{"location":"getting_started/installation_and_usage/#installation-and-reuse","title":"Installation and reuse","text":"<p>There are many different ways of installing/reusing mp-units in your project. Below we mention only a few of many options possible.</p> <p>Important: Prefer using Conan if possible</p> <p>The easiest and most recommended way to obtain mp-units is with the Conan package manager. See Conan + CMake (release) for a detailed instruction.</p>"},{"location":"getting_started/installation_and_usage/#copy","title":"Copy","text":"<p>As mp-units is a C++ header-only library you can simply copy all needed src/*/include subdirectories to your source tree.</p> <p>Note</p> <p>In such a case, you are on your own to ensure all the dependencies are installed and their header files can be located during the build. Please also note that some compiler-specific flags are needed to make the code compile without issues.</p>"},{"location":"getting_started/installation_and_usage/#copy-cmake","title":"Copy + CMake","text":"<p>If you copy the whole mp-units repository to your project's file tree, you can reuse CMake targets defined by the library. To do so, you should use CMakeLists.txt file from the ./src directory:</p> <pre><code>add_subdirectory(<path_to_units_folder>/src)\n# ...\ntarget_link_libraries(<your_target> <PUBLIC|PRIVATE|INTERFACE> mp-units::mp-units)\n</code></pre> <p>Note</p> <p>You are still on your own to make sure all the dependencies are installed and their header and CMake configuration files can be located during the build.</p>"},{"location":"getting_started/installation_and_usage/#conan-cmake-release","title":"Conan + CMake (release)","text":"<p>Tip</p> <p>If you are new to the Conan package manager, it is highly recommended to read Obtaining Dependencies and refer to Consuming packages chapter of the official Conan documentation for more information.</p> <p>mp-units releases are hosted on Conan-Center. The following steps may be performed to obtain an official library release:</p> <ol> <li> <p>Create Conan configuration file (either conanfile.txt or conanfile.py) in your project's top-level directory and add mp-units as a dependency of your project. For example, the simplest file may look as follows:</p> conanfile.txt<pre><code>[requires]\nmp-units/2.2.0\n\n[options]\nmp-units:cxx_modules=True\n\n[layout]\ncmake_layout\n\n[generators]\nCMakeToolchain\nCMakeDeps\n</code></pre> </li> <li> <p>Import mp-units and its dependencies definitions to your project's build procedure with <code>find_package</code>:</p> <pre><code>find_package(mp-units REQUIRED)\n</code></pre> </li> <li> <p>Link your CMake targets with mp-units:</p> <pre><code>target_link_libraries(<your_target> <PUBLIC|PRIVATE|INTERFACE> mp-units::mp-units)\n</code></pre> </li> <li> <p>Download, build, and install Conan dependencies before running the CMake configuration step:</p> <pre><code>conan install . -pr <your_conan_profile> -s compiler.cppstd=20 -b=missing\ncmake --preset conan-default\ncmake --build --preset conan-release\n</code></pre> </li> </ol>"},{"location":"getting_started/installation_and_usage/#conan-cmake-live-at-head","title":"Conan + CMake (Live At Head)","text":"<p>This chapter describes the procedure to Live At Head, which means using the latest stable version of mp-units all the time.</p> <p>Note</p> <p>Please note that even though the Conan packages that you will be using are generated ONLY for builds that are considered stable (passed our CI tests), some minor regressions may happen (our CI and C++20 build environment is not perfect yet). Also, please expect that the library interface might, and probably will, change occasionally. Even though we do our best, such changes might not be reflected in the project's documentation right away.</p> <p>The procedure is similar to the one described in Conan + CMake (release) with the following differences:</p> <ol> <li> <p>Before starting the previous procedure, add mp-units remote to your Conan configuration:</p> <pre><code>conan remote add conan-mpusz https://mpusz.jfrog.io/artifactory/api/conan/conan-oss\n</code></pre> </li> <li> <p>In your Conan configuration file, provide the package identifier of the <code>mpusz/testing</code> stream:</p> conanfile.txt<pre><code>[requires]\nmp-units/2.3.0@mpusz/testing\n\n[options]\nmp-units:cxx_modules=True\n\n[layout]\ncmake_layout\n\n[generators]\nCMakeToolchain\nCMakeDeps\n</code></pre> <p>Tip</p> <p>The identifiers of the latest packages can always be found in the project's README file or on the project's Artifactory.</p> </li> <li> <p>Force Conan to check for updated recipes with <code>-u</code>:</p> <pre><code>conan install . -pr <your_conan_profile> -s compiler.cppstd=20 -b=missing -u\n</code></pre> </li> </ol>"},{"location":"getting_started/installation_and_usage/#install","title":"Install","text":"<p>In case you don't want to use Conan in your project and just want to install the mp-units library on your file system and use <code>find_package(mp-units)</code> from another repository to find it; it is enough to perform the following steps:</p> <pre><code>conan install . -pr <your_conan_profile> -s compiler.cppstd=20 -b=missing\nmv CMakeUserPresets.json src\ncd src\ncmake --preset conan-default -DCMAKE_INSTALL_PREFIX=<your_installation_path>\ncmake --build --preset conan-release --target install\n</code></pre>"},{"location":"getting_started/installation_and_usage/#contributing-or-just-building-all-the-tests-and-examples","title":"Contributing (or just building all the tests and examples)","text":"<p>In case you would like to build all the mp-units source code (with unit tests and examples), you should:</p> <ol> <li>Use the CMakeLists.txt from the top-level directory.</li> <li>Run Conan with <code>user.mp-units.build:all</code> = <code>True</code>.</li> </ol> <pre><code>git clone https://github.com/mpusz/mp-units.git && cd units\nconan build . -pr <your_conan_profile> -s compiler.cppstd=23 -o cxx_modules=True -c user.mp-units.build:all=True -b missing\n</code></pre> <p>The above will download and install all of the dependencies needed for the development of the library, build all of the source code, and run unit tests.</p> <p>If you prefer to build the project via CMake rather than Conan, then you should replace the <code>conan build</code> with <code>conan install</code> command and then follow with a regular CMake build:</p> <pre><code>cmake --preset conan-default\ncmake --build --preset conan-release\ncmake --build --preset conan-release --target all_verify_interface_header_sets\ncmake --build --preset conan-release --target test\n</code></pre>"},{"location":"getting_started/installation_and_usage/#building-documentation","title":"Building documentation","text":"<p>Starting from mp-units 2.0 we are using Material for MkDocs to build our documentation. The easiest way to install all the required dependencies is with <code>pip</code>:</p> <pre><code>pip install -U mkdocs-material mkdocs-rss-plugin\n</code></pre> <p>Additionally, a Cairo Graphics library is required by Material for MkDocs. Please follow the official MkDocs documentation to install it.</p> <p>After that, you can either:</p> <ul> <li> <p>easily start a live server to preview the documentation as you write</p> <pre><code>mkdocs serve\n</code></pre> </li> <li> <p>build the documentation</p> <pre><code>mkdocs build\n</code></pre> </li> </ul>"},{"location":"getting_started/installation_and_usage/#packaging","title":"Packaging","text":"<p>To test CMake installation and Conan packaging or create a Conan package run:</p> <pre><code>conan create . --user <username> --channel <channel> -pr <your_conan_profile> -s compiler.cppstd=20 -o cxx_modules=True -c user.mp-units.build:all=True -b missing\n</code></pre> <p>The above will create a Conan package and run tests provided in ./test_package directory.</p>"},{"location":"getting_started/installation_and_usage/#uploading-mp-units-package-to-the-conan-server","title":"Uploading mp-units package to the Conan server","text":"<pre><code>conan upload -r <remote-name> --all mp-units/2.2.0@<user>/<channel>\n</code></pre>"},{"location":"getting_started/introduction/","title":"Introduction","text":"<p>mp-units is a Modern C++ library that provides compile-time dimensional analysis and unit/quantity manipulation. The initial versions of the library were inspired by the <code>std::chrono::duration</code> but with each release, the interfaces diverged from the original to provide a better user experience.</p> <p>Info</p> <p>A brief introduction to the library's interfaces and the rationale for changes in version 2.0 of mp-units were provided in detail by Mateusz Pusz in the \"The Power of C++ Templates With mp-units: Lessons Learned & a New Library Design\" talk at the C++ on Sea 2023 conference.</p>"},{"location":"getting_started/introduction/#open-source","title":"Open Source","text":"<p>mp-units is Free and Open Source, with a permissive MIT license. Check out the source code and issue tracking (for questions and support, reporting bugs, suggesting feature requests and improvements) at https://github.com/mpusz/mp-units.</p>"},{"location":"getting_started/introduction/#with-the-users-experience-in-mind","title":"With the User's Experience in Mind","text":"<p>Most of the critical design decisions in the library are dictated by the requirement of providing the best user experience possible. Other C++ physical units libraries are \"famous\" for their enormous and hard-to-understand error messages (one line of the error log often does not fit on one slide). The ultimate goal of mp-units is to improve this and make compile-time errors and debugging as easy and user-friendly as possible.</p> <p>To achieve this goal, several techniques are applied:</p> <ul> <li>usage of C++20 concepts that improve compile-times and the readability of error messages when compared to the traditional template metaprogramming with SFINAE,</li> <li>usage of strong types for framework entities (instead of type aliases),</li> <li>usage of expression templates to improve the readability of generated types,</li> <li>limiting the number of template arguments to the bare minimum.</li> </ul> <p>Important: It is all about errors</p> <p>In many generic C++ libraries, compile-time errors do not happen often. It is hard to break <code>std::string</code> or <code>std::vector</code> in a way that won't compile with a huge error log. Physical quantities and units libraries are different. Generation of compile-time errors is the main reason to use such a library.</p>"},{"location":"getting_started/introduction/#key-features","title":"Key Features","text":"Feature Description Safety - The affine space strong types (<code>quantity</code> and <code>quantity_point</code>)- Compile-time checked conversions of quantities and units- Unique support for many quantities of the same kind- Type-safe equations on scalar, vector, and tensor quantities and their units- Value-preserving conversions Performance - All the compile-time logic implemented as immediate (<code>consteval</code>) functions- As fast or even faster than working with fundamental types- No space size overhead needed to implement high-level abstractions Great User Experience - Optimized for readable compilation errors and great debugging experience- Efficient and composable way to specify a unit of choice- Value-based dimension, unit, and quantity equations Feature Rich - Systems of Quantities- Systems of Units- Scalar, vector, and tensor quantities- The affine space- Different models of the universe (e.g. natural units systems)- Strong dimensionless quantities- Strong angular system- Supports any unit's magnitude (huge, small, floating-point)- Faster-than-lightspeed constants- Highly adjustable text-output formatting Easy to Extend - Each entity can be defined with a single line of code- User can easily extend the systems with custom dimensions, quantities, and units Low Standardization Cost - Small number of predefined entities thanks to their composability- No external dependencies (assuming full C++20 support)- No macros in the user interface (besides portability and standard-compliance issues)- Possibility to be standardized as a freestanding part of the C++ Standard Library"},{"location":"getting_started/look_and_feel/","title":"Look and Feel","text":"<p>Here is a small example of operations possible on scalar quantities:</p> C++ modulesHeader files <pre><code>import mp_units;\n\nusing namespace mp_units;\nusing namespace mp_units::si::unit_symbols;\n\n// simple numeric operations\nstatic_assert(10 * km / 2 == 5 * km);\n\n// conversions to common units\nstatic_assert(1 * h == 3600 * s);\nstatic_assert(1 * km + 1 * m == 1001 * m);\n\n// derived quantities\nstatic_assert(1 * km / (1 * s) == 1000 * m / s);\nstatic_assert(2 * km / h * (2 * h) == 4 * km);\nstatic_assert(2 * km / (2 * km / h) == 1 * h);\n\nstatic_assert(2 * m * (3 * m) == 6 * m2);\n\nstatic_assert(10 * km / (5 * km) == 2 * one);\n\nstatic_assert(1000 / (1 * s) == 1 * kHz);\n</code></pre> <pre><code>#include <mp-units/systems/si.h>\n\nusing namespace mp_units;\nusing namespace mp_units::si::unit_symbols;\n\n// simple numeric operations\nstatic_assert(10 * km / 2 == 5 * km);\n\n// conversions to common units\nstatic_assert(1 * h == 3600 * s);\nstatic_assert(1 * km + 1 * m == 1001 * m);\n\n// derived quantities\nstatic_assert(1 * km / (1 * s) == 1000 * m / s);\nstatic_assert(2 * km / h * (2 * h) == 4 * km);\nstatic_assert(2 * km / (2 * km / h) == 1 * h);\n\nstatic_assert(2 * m * (3 * m) == 6 * m2);\n\nstatic_assert(10 * km / (5 * km) == 2 * one);\n\nstatic_assert(1000 / (1 * s) == 1 * kHz);\n</code></pre> <p>Try it on Compiler Explorer</p> <p>This library requires some C++20 features (concepts and constraints, classes as NTTP, ...). Thanks to them, a user gets a powerful but still easy-to-use interface where all unit conversions and dimensional analysis can be performed without sacrificing accuracy. Please see the below example for a quick preview of basic library features:</p> C++ modulesHeader files <pre><code>#include <format>\n#include <iomanip>\n#include <iostream>\n#include <print>\nimport mp_units;\n\nusing namespace mp_units;\n\nconstexpr QuantityOf<isq::speed> auto avg_speed(QuantityOf<isq::length> auto d,\n QuantityOf<isq::time> auto t)\n{\n return d / t;\n}\n\nint main()\n{\n using namespace mp_units::si::unit_symbols;\n using namespace mp_units::international::unit_symbols;\n\n constexpr quantity v1 = 110 * km / h;\n constexpr quantity v2 = 70 * mph;\n constexpr quantity v3 = avg_speed(220. * isq::distance[km], 2 * h);\n constexpr quantity v4 = avg_speed(isq::distance(140. * mi), 2 * h);\n constexpr quantity v5 = v3.in(m / s);\n constexpr quantity v6 = value_cast<m / s>(v4);\n constexpr quantity v7 = value_cast<int>(v6);\n\n std::cout << v1 << '\\n'; // 110 km/h\n std::cout << std::setw(10) << std::setfill('*') << v2 << '\\n'; // ***70 mi/h\n std::cout << std::format(\"{:*^10}\\n\", v3); // *110 km/h*\n std::println(\"{:%N in %U of %D}\", v4); // 70 in mi/h of LT\u207b\u00b9\n std::println(\"{::N[.2f]}\", v5); // 30.56 m/s\n std::println(\"{::N[.2f]U[dn]}\", v6); // 31.29 m\u22c5s\u207b\u00b9\n std::println(\"{:%N}\", v7); // 31\n}\n</code></pre> <pre><code>#include <mp-units/format.h>\n#include <mp-units/ostream.h>\n#include <mp-units/systems/international.h>\n#include <mp-units/systems/isq.h>\n#include <mp-units/systems/si.h>\n#include <format>\n#include <iomanip>\n#include <iostream>\n#include <print>\n\nusing namespace mp_units;\n\nconstexpr QuantityOf<isq::speed> auto avg_speed(QuantityOf<isq::length> auto d,\n QuantityOf<isq::time> auto t)\n{\n return d / t;\n}\n\nint main()\n{\n using namespace mp_units::si::unit_symbols;\n using namespace mp_units::international::unit_symbols;\n\n constexpr quantity v1 = 110 * km / h;\n constexpr quantity v2 = 70 * mph;\n constexpr quantity v3 = avg_speed(220. * isq::distance[km], 2 * h);\n constexpr quantity v4 = avg_speed(isq::distance(140. * mi), 2 * h);\n constexpr quantity v5 = v3.in(m / s);\n constexpr quantity v6 = value_cast<m / s>(v4);\n constexpr quantity v7 = value_cast<int>(v6);\n\n std::cout << v1 << '\\n'; // 110 km/h\n std::cout << std::setw(10) << std::setfill('*') << v2 << '\\n'; // ***70 mi/h\n std::cout << std::format(\"{:*^10}\\n\", v3); // *110 km/h*\n std::println(\"{:%N in %U of %D}\", v4); // 70 in mi/h of LT\u207b\u00b9\n std::println(\"{::N[.2f]}\", v5); // 30.56 m/s\n std::println(\"{::N[.2f]U[dn]}\", v6); // 31.29 m\u22c5s\u207b\u00b9\n std::println(\"{:%N}\", v7); // 31\n}\n</code></pre> <p>Try it on Compiler Explorer</p> <p>Note</p> <p>More code examples can be found in the Examples chapter.</p>"},{"location":"getting_started/quick_start/","title":"Quick Start","text":"<p>This chapter provides a quick introduction to get you started with mp-units. Much more details can be found in our User's Guide.</p>"},{"location":"getting_started/quick_start/#quantities","title":"Quantities","text":"<p>A quantity is a concrete amount of a unit representing a quantity type of a specified dimension with a specific representation. It is represented in the library with a <code>quantity</code> class template.</p> <p>The SI Brochure says:</p> <p>SI Brochure</p> <p>The value of the quantity is the product of the number and the unit. The space between the number and the unit is regarded as a multiplication sign (just as a space between units implies multiplication).</p> <p>Following the above, the value of a quantity in the mp-units library is created by multiplying a number with a predefined unit:</p> C++ modulesHeader files <pre><code>import mp_units;\n\nusing namespace mp_units;\n\nquantity q = 42 * si::metre / si::second;\n</code></pre> <pre><code>#include <mp-units/systems/si.h>\n\nusing namespace mp_units;\n\nquantity q = 42 * si::metre / si::second;\n</code></pre> <p>Info</p> <p>In case someone doesn't like the multiply syntax or there is an ambiguity between <code>operator*</code> provided by this and other libraries, a quantity can also be created with a two-parameter constructor:</p> C++ modulesHeader files <pre><code>import mp_units;\n\nusing namespace mp_units;\n\nquantity q{42, si::metre / si::second};\n</code></pre> <pre><code>#include <mp-units/systems/si.h>\n\nusing namespace mp_units;\n\nquantity q{42, si::metre / si::second};\n</code></pre> <p>The above creates an instance of <code>quantity<derived_unit<si::metre, per<si::second>>{}, int></code>. The same can be obtained using optional unit symbols:</p> C++ modulesHeader files <pre><code>import mp_units;\n\nusing namespace mp_units;\nusing namespace mp_units::si::unit_symbols;\n\nquantity q = 42 * m / s;\n</code></pre> <pre><code>#include <mp-units/systems/si.h>\n\nusing namespace mp_units;\nusing namespace mp_units::si::unit_symbols;\n\nquantity q = 42 * m / s;\n</code></pre> <p>Important</p> <p>Unit symbols introduce a lot of short identifiers into the current scope, which may cause naming collisions with unrelated but already existing identifiers in the code base. This is why unit symbols are opt-in and typically should be imported only in the context where they are being used (e.g., function scope).</p> <p>A user has several options here to choose from depending on the required scenario and possible naming conflicts:</p> using-directiveusing-declarationcustom short identifierunit names <p>Explicitly \"import\" all of the symbols of a specific system of units from a dedicated <code>unit_symbols</code> namespace with a using-directive:</p> <pre><code>using namespace mp_units;\n\nvoid foo(double speed_m_s)\n{\n // imports all the SI symbols at once\n using namespace si::unit_symbols;\n quantity speed = speed_m_s * m / s;\n // ...\n}\n</code></pre> <p>Note</p> <p>This solution is perfect for small and isolated scopes but can cause surprising issues when used in larger scopes or when used for the entire program namespace.</p> <p>There are 29 named units in SI, and each of them has many prefixed variations (e.g., <code>ng</code>, <code>kcd</code>, ...). It is pretty easy to introduce a name collision with those.</p> <p>Selectively bring only the required and not-conflicting symbols with using-declarations:</p> <pre><code>using namespace mp_units;\n\nvoid foo(double N)\n{\n // 'N' function parameter would collide with the SI symbol for Newton, so we only bring what we need\n using si::unit_symbols::m;\n using si::unit_symbols::s;\n quantity speed = N * m / s;\n // ...\n}\n</code></pre> <p>Specify a custom not conflicting unit identifier for a unit:</p> <pre><code>using namespace mp_units;\n\nvoid foo(double speed_m_s)\n{\n // names of some local variables are conflicting with the symbols we want to use\n auto m = ...;\n auto s = ...;\n\n constexpr Unit auto mps = si::metre / si::second;\n quantity speed = speed_m_s * mps;\n}\n</code></pre> <p>Full unit names are straightforward to use and often provide the most readable code:</p> <pre><code>using namespace mp_units;\n\nvoid foo(double m, double s)\n{\n quantity speed = m * si::metre / (s * si::second);\n // ...\n}\n</code></pre> <p>Quantities of the same kind can be added, subtracted, and compared to each other:</p> C++ modulesHeader files <pre><code>import mp_units;\n\nusing namespace mp_units;\nusing namespace mp_units::si::unit_symbols;\n\nstatic_assert(1 * km + 50 * m == 1050 * m);\n</code></pre> <pre><code>#include <mp-units/systems/si.h>\n\nusing namespace mp_units;\nusing namespace mp_units::si::unit_symbols;\n\nstatic_assert(1 * km + 50 * m == 1050 * m);\n</code></pre> <p>Various quantities can be multiplied or divided by each other:</p> <pre><code>static_assert(140 * km / (2 * h) == 70 * km / h);\n</code></pre> <p>Note</p> <p>In case you wonder why this library does not use UDLs to create quantities, please check our FAQ.</p>"},{"location":"getting_started/quick_start/#quantity-points","title":"Quantity points","text":"<p>The quantity point specifies an absolute quantity with respect to an origin. If no origin is provided explicitly, an implicit one will be provided by the library.</p> <p>Together with quantities, they model The Affine Space.</p> <p>Quantity points should be used in all places where adding two values is meaningless (e.g., temperature points, timestamps, altitudes, readouts from the car's odometer, etc.).</p> <p>The set of operations that can be done on quantity points is limited compared to quantities. This introduces an additional type-safety.</p> C++ modulesHeader files <pre><code>#include <print>\nimport mp_units;\n\nint main()\n{\n using namespace mp_units;\n using namespace mp_units::si::unit_symbols;\n using namespace mp_units::usc::unit_symbols;\n\n quantity_point temp{20. * deg_C};\n std::println(\"Temperature: {} ({})\",\n temp.quantity_from_zero(),\n temp.in(deg_F).quantity_from_zero());\n}\n</code></pre> <pre><code>#include <mp-units/format.h>\n#include <mp-units/systems/si.h>\n#include <mp-units/systems/usc.h>\n#include <print>\n\nint main()\n{\n using namespace mp_units;\n using namespace mp_units::si::unit_symbols;\n using namespace mp_units::usc::unit_symbols;\n\n quantity_point temp{20. * deg_C};\n std::println(\"Temperature: {} ({})\",\n temp.quantity_from_zero(),\n temp.in(deg_F).quantity_from_zero());\n}\n</code></pre> <p>The above outputs:</p> <pre><code>Temperature: 20 \u00b0C (68 \u00b0F)\n</code></pre> <p>Info</p> <p>Check The Affine Space chapter to learn more about quantity points.</p>"},{"location":"users_guide/terms_and_definitions/","title":"Terms and Definitions","text":"<p>The mp-units project consistently uses the official metrology vocabulary defined by the ISO and BIPM. You can find essential project-related definitions in our documentation's \"Glossary\" chapter. Even more, terms are provided in the official metrology vocabulary of the ISO and BIPM.</p> <p>Tip</p> <p>Please familiarize yourself with terms from \"Glossary\" to better understand the documentation and improve domain-related communication and discussions.</p>"},{"location":"users_guide/examples/avg_speed/","title":"<code>avg_speed</code>","text":"<p>Try it on Compiler Explorer</p> <p>Let's continue the previous example. This time, our purpose will not be to showcase as many library features as possible, but we will scope on different interfaces one can provide with the mp-units. We will also describe some advantages and disadvantages of presented solutions.</p> <p>First, we either import a module or include all the necessary header files and import all the identifiers from the <code>mp_units</code> namespace:</p> avg_speed.cpp<pre><code>#include <exception>\n#include <iostream>\n#ifdef MP_UNITS_MODULES\nimport mp_units;\n#else\n#include <mp-units/ostream.h>\n#include <mp-units/systems/cgs.h>\n#include <mp-units/systems/international.h>\n#include <mp-units/systems/isq.h>\n#include <mp-units/systems/si.h>\n#endif\n\nnamespace {\n\nusing namespace mp_units;\n</code></pre> <p>Next, we define two functions calculating average speed based on quantities of fixed units and integral and floating-point representation types, respectively, and a third function that we introduced in the previous example:</p> avg_speed.cpp<pre><code>constexpr quantity<si::metre / si::second, int> fixed_int_si_avg_speed(quantity<si::metre, int> d,\n quantity<si::second, int> t)\n{\n return d / t;\n}\n\nconstexpr quantity<si::metre / si::second> fixed_double_si_avg_speed(quantity<si::metre> d, quantity<si::second> t)\n{\n return d / t;\n}\n\nconstexpr QuantityOf<isq::speed> auto avg_speed(QuantityOf<isq::length> auto d, QuantityOf<isq::time> auto t)\n{\n return d / t;\n}\n</code></pre> <p>We also added a simple utility to print our results:</p> avg_speed.cpp<pre><code>template<QuantityOf<isq::length> D, QuantityOf<isq::time> T, QuantityOf<isq::speed> V>\nvoid print_result(D distance, T duration, V speed)\n{\n const auto result_in_kmph = speed.force_in(si::kilo<si::metre> / non_si::hour);\n std::cout << \"Average speed of a car that makes \" << distance << \" in \" << duration << \" is \" << result_in_kmph\n << \".\\n\";\n}\n</code></pre> <p>Now, let's analyze how those three utility functions behave with different sets of arguments. First, we are going to use quantities of SI units and integral representation:</p> avg_speed.cpp<pre><code>void example()\n{\n using namespace mp_units::si::unit_symbols;\n\n // SI (int)\n {\n constexpr auto distance = 220 * km;\n constexpr auto duration = 2 * h;\n\n std::cout << \"SI units with 'int' as representation\\n\";\n\n print_result(distance, duration, fixed_int_si_avg_speed(distance, duration));\n print_result(distance, duration, fixed_double_si_avg_speed(distance, duration));\n print_result(distance, duration, avg_speed(distance, duration));\n }\n</code></pre> <p>The above provides the following output:</p> <pre><code>SI units with 'int' as representation\nAverage speed of a car that makes 220 km in 2 h is 108 km/h.\nAverage speed of a car that makes 220 km in 2 h is 110 km/h.\nAverage speed of a car that makes 220 km in 2 h is 110 km/h.\n</code></pre> <p>Please note that in the first two cases, we must convert length from <code>km</code> to <code>m</code> and time from <code>h</code> to <code>s</code>. The converted values are used to calculate speed in <code>m/s</code> which is then again converted to the one in <code>km/h</code>. Those conversions not only impact the application's runtime performance but may also affect the precision of the final result. Such truncation can be easily observed in the first case where we deal with integral representation types (the resulting speed is <code>108 km/h</code>).</p> <p>The second scenario is really similar to the previous one, but this time, function arguments have floating-point representation types:</p> avg_speed.cpp<pre><code> // SI (double)\n {\n constexpr auto distance = 220. * km;\n constexpr auto duration = 2. * h;\n\n std::cout << \"\\nSI units with 'double' as representation\\n\";\n\n // conversion from a floating-point to an integral type is a truncating one so an explicit cast is needed\n print_result(distance, duration, fixed_int_si_avg_speed(value_cast<int>(distance), value_cast<int>(duration)));\n print_result(distance, duration, fixed_double_si_avg_speed(distance, duration));\n print_result(distance, duration, avg_speed(distance, duration));\n }\n</code></pre> <p>Conversion from floating-point to integral representation types is considered value-truncating and that is why now, in the first case, we need an explicit call to <code>value_cast<int></code>.</p> <p>In the text output, we can observe that, again, the resulting value gets truncated during conversions in the first cast:</p> <pre><code>SI units with 'double' as representation\nAverage speed of a car that makes 220 km in 2 h is 108 km/h.\nAverage speed of a car that makes 220 km in 2 h is 110 km/h.\nAverage speed of a car that makes 220 km in 2 h is 110 km/h.\n</code></pre> <p>Next, let's do the same for integral and floating-point representations, but this time using international mile:</p> avg_speed.cpp<pre><code> // International mile (int)\n {\n using namespace mp_units::international::unit_symbols;\n\n constexpr auto distance = 140 * mi;\n constexpr auto duration = 2 * h;\n\n std::cout << \"\\nInternational mile with 'int' as representation\\n\";\n\n // it is not possible to make a lossless conversion of miles to meters on an integral type\n // (explicit cast needed)\n print_result(distance, duration, fixed_int_si_avg_speed(distance.force_in(m), duration));\n print_result(distance, duration, fixed_double_si_avg_speed(distance, duration));\n print_result(distance, duration, avg_speed(distance, duration));\n }\n\n // International mile (double)\n {\n using namespace mp_units::international::unit_symbols;\n\n constexpr auto distance = 140. * mi;\n constexpr auto duration = 2. * h;\n\n std::cout << \"\\nInternational mile with 'double' as representation\\n\";\n\n // conversion from a floating-point to an integral type is a truncating one so an explicit cast is needed\n // also it is not possible to make a lossless conversion of miles to meters on an integral type\n // (explicit cast needed)\n print_result(distance, duration, fixed_int_si_avg_speed(value_cast<m, int>(distance), value_cast<int>(duration)));\n print_result(distance, duration, fixed_double_si_avg_speed(distance, duration));\n print_result(distance, duration, avg_speed(distance, duration));\n }\n</code></pre> <p>One important difference here is the fact that as it is not possible to make a lossless conversion of miles to meters on a quantity using an integral representation type, so this time, we need a <code>value_cast<m, int></code> to force it.</p> <p>If we check the text output of the above, we will see the following:</p> <pre><code>International mile with 'int' as representation\nAverage speed of a car that makes 140 mi in 2 h is 111 km/h.\nAverage speed of a car that makes 140 mi in 2 h is 112.654 km/h.\nAverage speed of a car that makes 140 mi in 2 h is 112 km/h.\n\nInternational mile with 'double' as representation\nAverage speed of a car that makes 140 mi in 2 h is 111 km/h.\nAverage speed of a car that makes 140 mi in 2 h is 112.654 km/h.\nAverage speed of a car that makes 140 mi in 2 h is 112.654 km/h.\n</code></pre> <p>Please note how the first and third results get truncated using integral representation types.</p> <p>In the end, we repeat the scenario for CGS units:</p> avg_speed.cpp<pre><code> {\n constexpr auto distance = 22'000'000 * cgs::centimetre;\n constexpr auto duration = 7200 * cgs::second;\n\n std::cout << \"\\nCGS units with 'int' as representation\\n\";\n\n // it is not possible to make a lossless conversion of centimeters to meters on an integral type\n // (explicit cast needed)\n print_result(distance, duration, fixed_int_si_avg_speed(distance.force_in(m), duration));\n print_result(distance, duration, fixed_double_si_avg_speed(distance, duration));\n print_result(distance, duration, avg_speed(distance, duration));\n }\n\n // CGS (double)\n {\n constexpr auto distance = 22'000'000. * cgs::centimetre;\n constexpr auto duration = 7200. * cgs::second;\n\n std::cout << \"\\nCGS units with 'double' as representation\\n\";\n\n // conversion from a floating-point to an integral type is a truncating one so an explicit cast is needed\n // it is not possible to make a lossless conversion of centimeters to meters on an integral type\n // (explicit cast needed)\n print_result(distance, duration, fixed_int_si_avg_speed(value_cast<m, int>(distance), value_cast<int>(duration)));\n\n print_result(distance, duration, fixed_double_si_avg_speed(distance, duration));\n print_result(distance, duration, avg_speed(distance, duration));\n }\n}\n\n} // namespace\n</code></pre> <p>Again, we observe <code>value_cast</code> being used in the same places and consistent truncation errors in the text output:</p> <pre><code>CGS units with 'int' as representation\nAverage speed of a car that makes 22000000 cm in 7200 s is 108 km/h.\nAverage speed of a car that makes 22000000 cm in 7200 s is 110 km/h.\nAverage speed of a car that makes 22000000 cm in 7200 s is 109 km/h.\n\nCGS units with 'double' as representation\nAverage speed of a car that makes 2.2e+07 cm in 7200 s is 108 km/h.\nAverage speed of a car that makes 2.2e+07 cm in 7200 s is 110 km/h.\nAverage speed of a car that makes 2.2e+07 cm in 7200 s is 110 km/h.\n</code></pre> <p>The example file ends with a simple <code>main()</code> function:</p> avg_speed.cpp<pre><code>int main()\n{\n try {\n example();\n } catch (const std::exception& ex) {\n std::cerr << \"Unhandled std exception caught: \" << ex.what() << '\\n';\n } catch (...) {\n std::cerr << \"Unhandled unknown exception caught\\n\";\n }\n}\n</code></pre>","tags":["CGS System","International System","Text Formatting"]},{"location":"users_guide/examples/hello_units/","title":"<code>hello_units</code>","text":"<p>Try it on Compiler Explorer</p> <p>This is a really simple example showcasing the features of the mp-units library.</p> <p>First, we either import the <code>mp_units</code> module or include the headers for:</p> <ul> <li>an International System of Quantities (ISQ)</li> <li>an International System of units (SI)</li> <li>units derived from the International Yard and Pound</li> <li>text formatting and stream output support</li> </ul> hello_units.cpp<pre><code>#include <mp-units/compat_macros.h>\n#include <mp-units/ext/format.h>\n#include <iomanip>\n#include <iostream>\n#ifdef MP_UNITS_MODULES\nimport mp_units;\n#else\n#include <mp-units/format.h>\n#include <mp-units/ostream.h>\n#include <mp-units/systems/international.h>\n#include <mp-units/systems/isq.h>\n#include <mp-units/systems/si.h>\n#endif\n</code></pre> <p>Also, to shorten the definitions, we \"import\" all the symbols from the <code>mp_units</code> namespace.</p> hello_units.cpp<pre><code>using namespace mp_units;\n</code></pre> <p>Next, we define a simple function that calculates the average speed based on the provided arguments of length and time:</p> hello_units.cpp<pre><code>constexpr QuantityOf<isq::speed> auto avg_speed(QuantityOf<isq::length> auto d, QuantityOf<isq::time> auto t)\n{\n return d / t;\n}\n</code></pre> <p>The above function template takes any quantities implicitly convertible to <code>isq::length</code> and <code>isq::time</code>, respectively. Those quantities can use any compatible unit and a representation type. The function returns a result of a straightforward equation and ensures that its quantity type is implicitly convertible to <code>isq::speed</code>.</p> <p>Tip</p> <p>Besides verifying the type returned from the function, constraining a generic return type is beneficial for users of such a function as it provides more information of what to expect from a function than just using <code>auto</code>.</p> hello_units.cpp<pre><code>int main()\n{\n using namespace mp_units::si::unit_symbols;\n using namespace mp_units::international::unit_symbols;\n</code></pre> <p>The above lines explicitly opt into using unit symbols from two systems of units. As this introduces a lot of short identifiers into the current scope, it is not done implicitly while including a header file.</p> hello_units.cpp<pre><code> constexpr quantity v1 = 110 * km / h;\n constexpr quantity v2 = 70 * mph;\n constexpr quantity v3 = avg_speed(220. * km, 2 * h);\n constexpr quantity v4 = avg_speed(isq::distance(140. * mi), 2 * isq::duration[h]);\n constexpr quantity v5 = v3.in(m / s);\n constexpr quantity v6 = value_cast<m / s>(v4);\n constexpr quantity v7 = value_cast<int>(v6);\n</code></pre> <ul> <li>Lines <code>23</code> & <code>24</code> create a quantity of kind <code>isq::length / isq::time</code> with the numbers and units provided. Such quantities can be converted or assigned to any other quantity with a matching kind.</li> <li>Line <code>25</code> calls our function template with quantities of kind <code>isq::length</code> and <code>isq::time</code> and number and units provided.</li> <li>Line <code>26</code> explicitly provides quantity types of the quantities passed to a function template. This time, those will not be quantity kinds anymore and will have more restrictive conversion rules.</li> <li>Line <code>27</code> changes the unit of a quantity <code>v3</code> to <code>m / s</code> in a value-preserving way (floating-point representations are considered to be value-preserving).</li> <li>Line <code>28</code> does a similar operation, but this time, it would also succeed for value-truncating cases (if that was the case).</li> <li>Line <code>29</code> does a value-truncating conversion of changing the underlying representation type from <code>double</code> to <code>int</code>.</li> </ul> hello_units.cpp<pre><code> std::cout << v1 << '\\n'; // 110 km/h\n std::cout << std::setw(10) << std::setfill('*') << v2 << '\\n'; // ***70 mi/h\n std::cout << MP_UNITS_STD_FMT::format(\"{:*^10}\\n\", v3); // *110 km/h*\n std::cout << MP_UNITS_STD_FMT::format(\"{:%N in %U of %D}\\n\", v4); // 70 in mi/h of LT\u207b\u00b9\n std::cout << MP_UNITS_STD_FMT::format(\"{::N[.2f]}\\n\", v5); // 30.56 m/s\n std::cout << MP_UNITS_STD_FMT::format(\"{::N[.2f]U[dn]}\\n\", v6); // 31.29 m\u22c5s\u207b\u00b9\n std::cout << MP_UNITS_STD_FMT::format(\"{:%N}\\n\", v7); // 31\n}\n</code></pre> <p>The above presents various ways to print a quantity. Both stream insertion operations and <code>std::format</code> facilities are supported.</p> <p>Tip</p> <p><code>MP_UNITS_STD_FMT</code> is used for compatibility reasons. If a specific compiler does not support <code>std::format</code> or a user prefers to use the <code>{fmt}</code> library, this macro will resolve to <code>fmt</code> namespace. Otherwise, the <code>std</code> namespace will be used.</p>","tags":["International System","Text Formatting"]},{"location":"users_guide/examples/si_constants/","title":"<code>si_constants</code>","text":"<p>Try it on Compiler Explorer</p> <p>The next example presents all the seven defining constants of the SI system. We can observe how Faster-than-lightspeed Constants work in practice.</p> si_constants.cpp<pre><code>#include <mp-units/compat_macros.h>\n#include <mp-units/ext/format.h>\n#include <iostream>\n#ifdef MP_UNITS_MODULES\nimport mp_units;\n#else\n#include <mp-units/format.h>\n#include <mp-units/systems/si.h>\n#endif\n\ntemplate<class T>\n requires mp_units::is_scalar<T>\ninline constexpr bool mp_units::is_vector<T> = true;\n</code></pre> <p>As always, we start with the inclusion of all the needed header files. After that, for the simplicity of this example, we hack the character of quantities to be able to express vector quantities with simple scalar types.</p> si_constants.cpp<pre><code>int main()\n{\n using namespace mp_units;\n using namespace mp_units::si;\n using namespace mp_units::si::unit_symbols;\n\n std::cout << \"The seven defining constants of the SI and the seven corresponding units they define:\\n\";\n std::cout << MP_UNITS_STD_FMT::format(\"- hyperfine transition frequency of Cs: {} = {::N[.0]}\\n\",\n 1. * si2019::hyperfine_structure_transition_frequency_of_cs,\n (1. * si2019::hyperfine_structure_transition_frequency_of_cs).in(Hz));\n std::cout << MP_UNITS_STD_FMT::format(\"- speed of light in vacuum: {} = {::N[.0]}\\n\",\n 1. * si2019::speed_of_light_in_vacuum,\n (1. * si2019::speed_of_light_in_vacuum).in(m / s));\n std::cout << MP_UNITS_STD_FMT::format(\"- Planck constant: {} = {::N[.8e]}\\n\",\n 1. * si2019::planck_constant, (1. * si2019::planck_constant).in(J * s));\n std::cout << MP_UNITS_STD_FMT::format(\"- elementary charge: {} = {::N[.9e]}\\n\",\n 1. * si2019::elementary_charge, (1. * si2019::elementary_charge).in(C));\n std::cout << MP_UNITS_STD_FMT::format(\"- Boltzmann constant: {} = {::N[.6e]}\\n\",\n 1. * si2019::boltzmann_constant, (1. * si2019::boltzmann_constant).in(J / K));\n std::cout << MP_UNITS_STD_FMT::format(\"- Avogadro constant: {} = {::N[.8e]}\\n\",\n 1. * si2019::avogadro_constant, (1. * si2019::avogadro_constant).in(one / mol));\n std::cout << MP_UNITS_STD_FMT::format(\"- luminous efficacy: {} = {}\\n\",\n 1. * si2019::luminous_efficacy, (1. * si2019::luminous_efficacy).in(lm / W));\n}\n</code></pre> <p>The main part of the example prints all of the SI-defining constants. While analyzing the output of this program (provided below), we can easily notice that a direct printing of the quantity provides just a value <code>1</code> with a proper constant symbol. This is the main power of the Faster-than-lightspeed Constants feature. Only after we explicitly convert the unit of a quantity to proper SI units we get an actual numeric value of the constant.</p> <pre><code>The seven defining constants of the SI and the seven corresponding units they define:\n- hyperfine transition frequency of Cs: 1 \u0394\u03bd_Cs = 9192631770 Hz\n- speed of light in vacuum: 1 c = 299792458 m/s\n- Planck constant: 1 h = 6.62607015e-34 J s\n- elementary charge: 1 e = 1.602176634e-19 C\n- Boltzmann constant: 1 k = 1.380649e-23 J/K\n- Avogadro constant: 1 N_A = 6.02214076e+23 1/mol\n- luminous efficacy: 1 K_cd = 683 lm/W\n</code></pre>","tags":["Physical Constants","Text Formatting"]},{"location":"users_guide/framework_basics/character_of_a_quantity/","title":"Character of a Quantity","text":"<p>Warning</p> <p>This chapter's features are experimental and subject to change or removal. Please share your feedback if something seems wrong or could be improved.</p>"},{"location":"users_guide/framework_basics/character_of_a_quantity/#scalars-vectors-and-tensors","title":"Scalars, vectors, and tensors","text":"<p>ISO 80000-2</p> <p>Scalars, vectors and tensors are mathematical objects that can be used to denote certain physical quantities and their values. They are as such independent of the particular choice of a coordinate system, whereas each scalar component of a vector or a tensor and each component vector and component tensor depend on that choice.</p> <p>Such distinction is important because each quantity character represents different properties and allows different operations to be done on its quantities.</p> <p>For example, imagine a physical units library that allows the creation of a \\(speed\\) quantity from both \\(length / time\\) and \\(length * time\\). It wouldn't be too safe to use such a product, right?</p> <p>Now we have to realize that both of the above operations (multiplication and division) are not even mathematically defined for linear algebra types such as vectors or tensors. On the other hand, two vectors can be passed as arguments to dot and cross-product operations. The result of the first one is a scalar. The second one results in a vector that is perpendicular to both vectors passed as arguments. Again, it wouldn't be safe to allow replacing those two operations with each other or expect the same results from both cases. This simply can't work.</p>"},{"location":"users_guide/framework_basics/character_of_a_quantity/#isq-defines-quantities-of-all-characters","title":"ISQ defines quantities of all characters","text":"<p>While defining quantities ISO 80000 explicitly mentions when a specific quantity has a vector or tensor character. Here are some examples:</p> Quantity Character Quantity Equation \\(duration\\) scalar {base quantity} \\(mass\\) scalar {base quantity} \\(length\\) scalar {base quantity} \\(path\\; length\\) scalar {base quantity} \\(radius\\) scalar {base quantity} \\(position\\; vector\\) vector {base quantity} \\(velocity\\) vector \\(position\\; vector / duration\\) \\(acceleration\\) vector \\(velocity / duration\\) \\(force\\) vector \\(mass * acceleration\\) \\(power\\) scalar \\(force \\cdot velocity\\) \\(moment\\; of\\; force\\) vector \\(position\\; vector \\times force\\) \\(torque\\) scalar \\(moment\\; of\\; force \\cdot \\{unit\\; vector\\}\\) \\(surface\\; tension\\) scalar \\(\\lvert force \\rvert / length\\) \\(angular\\; displacement\\) scalar \\(path\\; length / radius\\) \\(angular\\; velocity\\) vector \\(angular\\; displacement / duration * \\{unit\\; vector\\}\\) \\(momentum\\) vector \\(mass * velocity\\) \\(angular\\; momentum\\) vector \\(position\\; vector \\times momentum\\) \\(moment\\; of\\; inertia\\) tensor \\(angular\\; momentum \\otimes angular\\; velocity\\) <p>In the above equations:</p> <ul> <li>\\(a * b\\) - regular multiplication where one of the arguments has to be scalar</li> <li>\\(a / b\\) - regular division where the divisor has to be scalar</li> <li>\\(a \\cdot b\\) - dot product of two vectors</li> <li>\\(a \\times b\\) - cross product of two vectors</li> <li>\\(\\lvert a \\rvert\\) - magnitude of a vector</li> <li>\\(\\{unit\\; vector\\}\\) - a special vector with the magnitude of \\(1\\)</li> <li>\\(a \\otimes b\\) - tensor product of two vectors or tensors</li> </ul> <p>Note</p> <p>As of now, all of the C++ physical units libraries on the market besides mp-units do not support the operations mentioned above. They expose only multiplication and division operators, which do not work for linear algebra-based representation types. If a user of those libraries would like to create the quantities provided in the above table properly, this would result in a compile-time error stating that multiplication and division of two linear algebra vectors is impossible.</p>"},{"location":"users_guide/framework_basics/character_of_a_quantity/#characters-dont-apply-to-dimensions-and-units","title":"Characters don't apply to dimensions and units","text":"<p>ISO 80000 explicitly states that dimensions are orthogonal to quantity characters:</p> <p>ISO 80000-1:2009</p> <p>In deriving the dimension of a quantity, no account is taken of its scalar, vector, or tensor character.</p> <p>Also, it explicitly states that:</p> <p>ISO 80000-2</p> <p>All units are scalars.</p>"},{"location":"users_guide/framework_basics/character_of_a_quantity/#defining-vector-and-tensor-quantities","title":"Defining vector and tensor quantities","text":"<p>To specify that a specific quantity has a vector or tensor character a value of <code>quantity_character</code> enumeration can be appended to the <code>quantity_spec</code> describing such a quantity type:</p> C++23C++20Portable <pre><code>inline constexpr struct position_vector final : quantity_spec<length, quantity_character::vector> {} position_vector;\ninline constexpr struct displacement final : quantity_spec<length, quantity_character::vector> {} displacement;\n</code></pre> <pre><code>inline constexpr struct position_vector final : quantity_spec<position_vector, length, quantity_character::vector> {} position_vector;\ninline constexpr struct displacement final : quantity_spec<displacement, length, quantity_character::vector> {} displacement;\n</code></pre> <pre><code>QUANTITY_SPEC(position_vector, length, quantity_character::vector);\nQUANTITY_SPEC(displacement, length, quantity_character::vector);\n</code></pre> <p>With the above, all the quantities derived from <code>position_vector</code> or <code>displacement</code> will have a correct character determined according to the kind of operations included in the quantity equation defining a derived quantity.</p> <p>For example, <code>velocity</code> in the below definition will be defined as a vector quantity (no explicit character override is needed):</p> C++23C++20Portable <pre><code>inline constexpr struct velocity final : quantity_spec<speed, position_vector / duration> {} velocity;\n</code></pre> <pre><code>inline constexpr struct velocity final : quantity_spec<velocity, speed, position_vector / duration> {} velocity;\n</code></pre> <pre><code>QUANTITY_SPEC(velocity, speed, position_vector / duration);\n</code></pre>"},{"location":"users_guide/framework_basics/character_of_a_quantity/#representation-types-for-vector-and-tensor-quantities","title":"Representation types for vector and tensor quantities","text":"<p>As we remember, the <code>quantity</code> class template is defined as follows:</p> <pre><code>template<Reference auto R,\n RepresentationOf<get_quantity_spec(R).character> Rep = double>\nclass quantity;\n</code></pre> <p>The second template parameter is constrained with a <code>RepresentationOf</code> concept that checks if the provided representation type satisfies the requirements for the character associated with this quantity type.</p> <p>Note</p> <p>The current version of the C++ Standard Library does not provide any types that could be used as a representation type for vector and tensor quantities. This is why users are on their own here .</p> <p>To provide examples and implement unit tests, our library uses the types proposed in the P1385 and available as a Conan package in the Conan Center. However, thanks to the provided customization points, any linear algebra library types can be used as a vector or tensor quantity representation type.</p> <p>To enable the usage of a user-defined type as a representation type for vector or tensor quantities, we need to provide a partial specialization of <code>is_vector</code> or <code>is_tensor</code> customization points.</p> <p>For example, here is how it can be done for the P1385 types:</p> <pre><code>#include <matrix>\n\nusing la_vector = STD_LA::fixed_size_column_vector<double, 3>;\n\ntemplate<>\ninline constexpr bool mp_units::is_vector<la_vector> = true;\n</code></pre> <p>With the above, we can use <code>la_vector</code> as a representation type for our quantity:</p> <pre><code>Quantity auto q = la_vector{1, 2, 3} * isq::velocity[m / s];\n</code></pre> <p>In case there is an ambiguity of <code>operator*</code> between mp-units and a linear algebra library, we can either:</p> <ul> <li> <p>use two-parameter constructor</p> <pre><code>Quantity auto q = quantity{la_vector{1, 2, 3}, isq::velocity[m / s]};\n</code></pre> </li> <li> <p>provide a dedicated overload of <code>operator*</code> that will resolve the ambiguity and wrap the above</p> <pre><code>template<Reference R>\nQuantity auto operator*(la_vector rep, R)\n{\n return quantity{rep, R{}};\n}\n</code></pre> </li> </ul> <p>Note</p> <p>The following does not work:</p> <pre><code>Quantity auto q1 = la_vector{1, 2, 3} * m / s;\nQuantity auto q2 = isq::velocity(la_vector{1, 2, 3} * m / s);\nquantity<isq::velocity[m/s]> q3{la_vector{1, 2, 3} * m / s};\n</code></pre> <p>In all the cases above, the SI unit <code>m / s</code> has an associated scalar quantity of <code>isq::length / isq::time</code>. <code>la_vector</code> is not a correct representation type for a scalar quantity so the construction fails.</p>"},{"location":"users_guide/framework_basics/character_of_a_quantity/#hacking-the-character","title":"Hacking the character","text":"<p>Sometimes we want to use a vector quantity, but we don't care about its direction. For example, the standard gravity acceleration constant always points down, so we might not care about this in a particular scenario. In such a case, we may want to \"hack\" the library to allow scalar types to be used as a representation type for scalar quantities.</p> <p>For example, we can do the following:</p> <pre><code>template<class T>\n requires mp_units::is_scalar<T>\ninline constexpr bool mp_units::is_vector<T> = true;\n</code></pre> <p>which says that every type that can be used as a scalar representation is also allowed for vector quantities.</p> <p>Doing the above is actually not such a big \"hack\" as the ISO 80000 explicitly allows it:</p> <p>ISO 80000-2</p> <p>A vector is a tensor of the first order and a scalar is a tensor of order zero.</p> <p>Despite it being allowed by ISO 80000, for type-safety reasons, we do not allow such a behavior by default, and a user has to opt into such scenarios explicitly.</p>"},{"location":"users_guide/framework_basics/concepts/","title":"Concepts","text":"<p>This chapter enumerates all the user-facing concepts in the mp-units library.</p>"},{"location":"users_guide/framework_basics/concepts/#Dimension","title":"<code>Dimension<T></code>","text":"<p><code>Dimension</code> concept matches a dimension of either a base or derived quantity:</p> <ul> <li>Base dimensions are explicitly defined by the user by inheriting from the instantiation of a <code>base_dimension</code> class template. It should be instantiated with a unique symbol identifier describing this dimension in a specific system of quantities.</li> <li>Derived dimensions are implicitly created by the library's framework based on the quantity equation provided in the quantity specification.</li> </ul> <p>All of the above dimensions have to be marked as <code>final</code>.</p>"},{"location":"users_guide/framework_basics/concepts/#DimensionOf","title":"<code>DimensionOf<T, V></code>","text":"<p><code>DimensionOf</code> concept is satisfied when both arguments satisfy a <code>Dimension</code> concept and when they compare equal.</p>"},{"location":"users_guide/framework_basics/concepts/#QuantitySpec","title":"<code>QuantitySpec<T></code>","text":"<p><code>QuantitySpec</code> concept matches all the quantity specifications including:</p> <ul> <li>Base quantities defined by a user by inheriting from the <code>quantity_spec</code> class template instantiated with a base dimension argument.</li> <li>Derived named quantities defined by a user by inheriting from the <code>quantity_spec</code> class template instantiated with a result of a quantity equation passed as an argument.</li> <li>Other named quantities forming a hierarchy of quantities of the same kind defined by a user by inheriting from the <code>quantity_spec</code> class template instantiated with another \"parent\" quantity specification passed as an argument.</li> <li>Quantity kinds describing a family of mutually comparable quantities.</li> <li>Intermediate derived quantity specifications being a result of a quantity equations on other specifications.</li> </ul> <p>All of the above quantity specifications have to be marked as <code>final</code>.</p>"},{"location":"users_guide/framework_basics/concepts/#QuantitySpecOf","title":"<code>QuantitySpecOf<T, V></code>","text":"<p><code>QuantitySpecOf</code> concept is satisfied when both arguments satisfy a <code>QuantitySpec</code> concept and when <code>T</code> is implicitly convertible to <code>V</code>.</p> More details <p>Additionally:</p> <ul> <li><code>T</code> should not be a nested quantity specification of <code>V</code></li> <li>either <code>T</code> is quantity kind or <code>V</code> should not be a nested quantity specification of <code>T</code></li> </ul> <p>Those additional conditions are required to make the following work:</p> <pre><code>static_assert(ReferenceOf<si::radian, isq::angular_measure>);\nstatic_assert(!ReferenceOf<si::radian, dimensionless>);\nstatic_assert(!ReferenceOf<isq::angular_measure[si::radian], dimensionless>);\nstatic_assert(ReferenceOf<one, isq::angular_measure>);\nstatic_assert(!ReferenceOf<dimensionless[one], isq::angular_measure>);\n</code></pre>"},{"location":"users_guide/framework_basics/concepts/#Unit","title":"<code>Unit<T></code>","text":"<p><code>Unit</code> concept matches all the units in the library including:</p> <ul> <li>Base units defined by a user by inheriting from the <code>named_unit</code> class template instantiated with a unique symbol identifier describing this unit in a specific system of units.</li> <li>Named scaled units defined by a user by inheriting from the <code>named_unit</code> class template instantiated with a unique symbol identifier and a product of multiplying another unit with some magnitude.</li> <li>Prefixed units defined by a user by inheriting from the <code>prefixed_unit</code> class template instantiated with a prefix symbol, a magnitude, and a unit to be prefixed.</li> <li>Derived named units defined by a user by inheriting from the <code>named_unit</code> class template instantiated with a unique symbol identifier and a result of unit equation passed as an argument.</li> <li>Derived unnamed units being a result of a unit equations on other units.</li> </ul> <p>All of the above units have to be marked as <code>final</code>.</p> <p>Note</p> <p>In the mp-units library, physical constants are also implemented as units.</p>"},{"location":"users_guide/framework_basics/concepts/#AssociatedUnit","title":"<code>AssociatedUnit<T></code>","text":"<p><code>AssociatedUnit</code> concept describes a unit with an associated quantity and is satisfied by:</p> <ul> <li>All units derived from a <code>named_unit</code> class template instantiated with a unique symbol identifier and a <code>QuantitySpec</code> of a quantity kind.</li> <li>All units being a result of unit equations on other associated units.</li> </ul> Examples <p>All units in the SI have associated quantities. For example, <code>si::second</code> is specified to measure <code>isq::time</code>.</p> <p>Natural units typically do not have an associated quantity. For example, if we assume <code>c = 1</code>, a <code>natural::second</code> unit can be used to measure both <code>time</code> and <code>length</code>. In such case, <code>speed</code> would have a unit of <code>one</code>.</p>"},{"location":"users_guide/framework_basics/concepts/#PrefixableUnit","title":"<code>PrefixableUnit<T></code>","text":"<p><code>PrefixableUnit</code> concept is satisfied by all units derived from a <code>named_unit</code> class template for which a customization point <code>unit_can_be_prefixed<T{}></code> was not explicitly set to <code>false</code>. Such units can be passed as an argument to a <code>prefixed_unit</code> class template.</p> Examples <p>All units in the SI can be prefixed with SI-defined prefixes.</p> <p>Some off-system units like <code>non_si::day</code> can't be prefixed. To enforce that, the following has to be provided:</p> <pre><code>template<> inline constexpr bool unit_can_be_prefixed<non_si::day> = false;\n</code></pre>"},{"location":"users_guide/framework_basics/concepts/#UnitOf","title":"<code>UnitOf<T, V></code>","text":"<p><code>UnitOf</code> concept is satisfied for all units <code>T</code> matching an <code>AssociatedUnit</code> concept with an associated quantity type implicitly convertible to <code>V</code>.</p> More details <p>Additionally, the kind of <code>V</code> and the kind of quantity type associated with <code>T</code> must be the same, or the quantity type associated with <code>T</code> may not be derived from the kind of <code>V</code>.</p> <p>This condition is required to make <code>dimensionless[si::radian]</code> invalid as <code>si::radian</code> should be only used for <code>isq::angular_measure</code>, which is a nested quantity kind within the dimensionless quantities tree.</p>"},{"location":"users_guide/framework_basics/concepts/#UnitCompatibleWith","title":"<code>UnitCompatibleWith<T, V1, V2></code>","text":"<p><code>UnitCompatibleWith</code> concept is satisfied for all units <code>T</code> when:</p> <ul> <li><code>V1</code> is a <code>Unit</code>,</li> <li><code>V2</code> is a <code>QuantitySpec</code>,</li> <li><code>T</code> and <code>V1</code> are defined in terms of the same reference unit,</li> <li>if <code>T</code> is an <code>AssociatedUnit</code> it should satisfy <code>UnitOf<V2></code>.</li> </ul>"},{"location":"users_guide/framework_basics/concepts/#Reference","title":"<code>Reference<T></code>","text":"<p><code>Reference</code> concept is satisfied by all quantity reference types. Such types provide all the meta-information required to create a <code>Quantity</code>. A <code>Reference</code> can either be:</p> <ul> <li>An <code>AssociatedUnit</code>.</li> <li>The instantiation of a <code>reference</code> class template with a <code>QuantitySpec</code> passed as the first template argument and a <code>Unit</code> passed as the second one.</li> </ul>"},{"location":"users_guide/framework_basics/concepts/#ReferenceOf","title":"<code>ReferenceOf<T, V></code>","text":"<p><code>ReferenceOf</code> concept is satisfied by references <code>T</code> which have a quantity specification that satisfies <code>QuantitySpecOf<V></code> concept. |</p>"},{"location":"users_guide/framework_basics/concepts/#Representation","title":"<code>Representation<T></code>","text":"<p><code>Representation</code> concept constraints a type of a number that stores the value of a quantity.</p>"},{"location":"users_guide/framework_basics/concepts/#RepresentationOf","title":"<code>RepresentationOf<T, Ch></code>","text":"<p><code>RepresentationOf</code> concept is satisfied by all <code>Representation</code> types that are of a specified quantity character <code>Ch</code>.</p> <p>A user can declare a custom representation type to be of a specific character by providing the specialization with <code>true</code> for one or more of the following variable templates:</p> <ul> <li><code>is_scalar<T></code></li> <li><code>is_vector<T></code></li> <li><code>is_tensor<T></code></li> </ul> Tip <p>If we want to use scalar types to also express vector quantities (e.g., ignoring the \"direction\" of the vector) the following definition can be provided to enable such a behavior:</p> <pre><code>template<class T>\n requires mp_units::is_scalar<T>\ninline constexpr bool mp_units::is_vector<T> = true;\n</code></pre>"},{"location":"users_guide/framework_basics/concepts/#Quantity","title":"<code>Quantity<T></code>","text":"<p><code>Quantity</code> concept matches every quantity in the library and is satisfied by all types being or deriving from an instantiation of a <code>quantity</code> class template.</p>"},{"location":"users_guide/framework_basics/concepts/#QuantityOf","title":"<code>QuantityOf<T, V></code>","text":"<p><code>QuantityOf</code> concept is satisfied by all the quantities for which a <code>QuantitySpecOf<V></code> is <code>true</code>.</p>"},{"location":"users_guide/framework_basics/concepts/#PointOrigin","title":"<code>PointOrigin<T></code>","text":"<p><code>PointOrigin</code> concept matches all quantity point origins in the library. It is satisfied by either:</p> <ul> <li>All types derived from an <code>absolute_point_origin</code> class template.</li> <li>All types derived from a <code>relative_point_origin</code> class template.</li> </ul>"},{"location":"users_guide/framework_basics/concepts/#PointOriginFor","title":"<code>PointOriginFor<T, V></code>","text":"<p><code>PointOriginFor</code> concept is satisfied by all <code>PointOrigin</code> types that have quantity type implicitly convertible from quantity specification <code>V</code>, which means that <code>V</code> must satisfy <code>QuantitySpecOf<T::quantity_spec></code>.</p> Examples <p><code>si::ice_point</code> can serve as a point origin for points of <code>isq::Celsius_temperature</code> because this quantity type implicitly converts to <code>isq::thermodynamic_temperature</code>.</p> <p>However, if we define <code>mean_sea_level</code> in the following way:</p> <pre><code>inline constexpr struct mean_sea_level final : absolute_point_origin<isq::altitude> {} mean_sea_level;\n</code></pre> <p>then it can't be used as a point origin for points of <code>isq::length</code> or <code>isq::width</code> as none of them is implicitly convertible to <code>isq::altitude</code>:</p> <ul> <li>not every length is an altitude,</li> <li>width is not compatible with altitude.</li> </ul>"},{"location":"users_guide/framework_basics/concepts/#QuantityPoint","title":"<code>QuantityPoint<T></code>","text":"<p><code>QuantityPoint</code> concept is satisfied by all types being either a specialization or derived from <code>quantity_point</code> class template.</p>"},{"location":"users_guide/framework_basics/concepts/#QuantityPointOf","title":"<code>QuantityPointOf<T, V></code>","text":"<p><code>QuantityPointOf</code> concept is satisfied by all the quantity points <code>T</code> that match the following value <code>V</code>:</p> <code>V</code> Condition <code>QuantitySpec</code> The quantity point quantity specification satisfies <code>QuantitySpecOf<V></code> concept. <code>PointOrigin</code> The point and <code>V</code> have the same absolute point origin."},{"location":"users_guide/framework_basics/concepts/#QuantityLike","title":"<code>QuantityLike<T></code>","text":"<p><code>QuantityLike</code> concept provides interoperability with other libraries and is satisfied by a type <code>T</code> for which an instantiation of <code>quantity_like_traits</code> type trait yields a valid type that provides:</p> <ul> <li>Static data member <code>reference</code> that matches the <code>Reference</code> concept,</li> <li><code>rep</code> type that matches <code>RepresentationOf</code> concept with the character provided in <code>reference</code>.</li> <li><code>to_numerical_value(T)</code> static member function returning a raw value of the quantity packed in either <code>convert_explicitly</code> or <code>convert_implicitly</code> wrapper that enables implicit conversion in the latter case.</li> <li><code>from_numerical_value(rep)</code> static member function returning <code>T</code> packed in either <code>convert_explicitly</code> or <code>convert_implicitly</code> wrapper that enables implicit conversion in the latter case.</li> </ul> Examples <p>This is how support for <code>std::chrono::seconds</code> can be provided:</p> <pre><code>template<>\nstruct mp_units::quantity_like_traits<std::chrono::seconds> {\n static constexpr auto reference = si::second;\n using rep = std::chrono::seconds::rep;\n\n [[nodiscard]] static constexpr convert_implicitly<rep> to_numerical_value(const std::chrono::seconds& q)\n {\n return q.count();\n }\n\n [[nodiscard]] static constexpr convert_implicitly<std::chrono::seconds> from_numerical_value(const rep& v)\n {\n return std::chrono::seconds(v);\n }\n};\n\nquantity q = 42s;\nstd::chrono::seconds dur = 42 * s;\n</code></pre>"},{"location":"users_guide/framework_basics/concepts/#QuantityPointLike","title":"<code>QuantityPointLike<T></code>","text":"<p><code>QuantityPointLike</code> concept provides interoperability with other libraries and is satisfied by a type <code>T</code> for which an instantiation of <code>quantity_point_like_traits</code> type trait yields a valid type that provides:</p> <ul> <li>Static data member <code>reference</code> that matches the <code>Reference</code> concept.</li> <li>Static data member <code>point_origin</code> that matches the <code>PointOrigin</code> concept.</li> <li><code>rep</code> type that matches <code>RepresentationOf</code> concept with the character provided in <code>reference</code>.</li> <li><code>to_quantity(T)</code> static member function returning the <code>quantity</code> being the offset of the point from the origin packed in either <code>convert_explicitly</code> or <code>convert_implicitly</code> wrapper that enables implicit conversion in the latter case.</li> <li><code>from_quantity(quantity<reference, rep>)</code> static member function returning <code>T</code> packed in either <code>convert_explicitly</code> or <code>convert_implicitly</code> wrapper that enables implicit conversion in the latter case.</li> </ul> Examples <p>This is how support for a <code>std::chrono::time_point</code> of <code>std::chrono::seconds</code> can be provided:</p> <pre><code>template<typename C>\nstruct mp_units::quantity_point_like_traits<std::chrono::time_point<C, std::chrono::seconds>> {\n using T = std::chrono::time_point<C, std::chrono::seconds>;\n static constexpr auto reference = si::second;\n static constexpr struct point_origin final : absolute_point_origin<isq::time> {} point_origin{};\n using rep = std::chrono::seconds::rep;\n\n [[nodiscard]] static constexpr convert_implicitly<quantity<reference, rep>> to_quantity(const T& qp)\n {\n return quantity{qp.time_since_epoch()};\n }\n\n [[nodiscard]] static constexpr convert_implicitly<T> from_quantity(const quantity<reference, rep>& q)\n {\n return T(q);\n }\n};\n\nquantity_point qp = time_point_cast<std::chrono::seconds>(std::chrono::system_clock::now());\nstd::chrono::sys_seconds q = qp + 42 * s;\n</code></pre>"},{"location":"users_guide/framework_basics/design_overview/","title":"Design Overview","text":"<p>The most important entities in the mp-units library are:</p> <ul> <li>quantity,</li> <li>quantity point,</li> <li>unit,</li> <li>dimension,</li> <li>quantity specification</li> <li>quantity reference,</li> <li>quantity representation.</li> </ul> <p>The graph provided below presents how those and a few other entities depend on each other:</p> <pre><code>flowchart TD\n Unit --- Reference\n Dimension --- QuantitySpec[\"Quantity specification\"]\n quantity_character[\"Quantity character\"] --- QuantitySpec\n QuantitySpec --- Reference[\"Quantity reference\"]\n Reference --- Quantity\n quantity_character -.- Representation\n Representation --- Quantity\n Quantity --- QuantityPoint[\"Quantity point\"]\n PointOrigin[\"Point origin\"] --- QuantityPoint\n\n click Dimension \"#dimension\"\n click quantity_character \"#quantity-character\"\n click QuantitySpec \"#quantity-specification\"\n click Unit \"#unit\"\n click Reference \"#quantity-reference\"\n click Representation \"#quantity-representation\"\n click Quantity \"#quantity\"\n click PointOrigin \"#point-origin\"\n click QuantityPoint \"#quantity-point\"</code></pre>"},{"location":"users_guide/framework_basics/design_overview/#dimension","title":"Dimension","text":"<p>Dimension specifies the dependence of a quantity on the base quantities of a particular system of quantities. It is represented as a product of powers of factors corresponding to the base quantities, omitting any numerical factor.</p> <p>In the mp-units library, we use the terms:</p> <ul> <li>base dimension to refer to the dimension of a base quantity,</li> <li>derived dimension to refer to the dimension of a derived quantity.</li> </ul> <p>For example:</p> <ul> <li>length (\\(\\mathsf{L}\\)), mass (\\(\\mathsf{M}\\)), time (\\(\\mathsf{T}\\)), electric current (\\(\\mathsf{I}\\)), thermodynamic temperature (\\(\\mathsf{\u0398}\\)), amount of substance (\\(\\mathsf{N}\\)), and luminous intensity (\\(\\mathsf{J}\\)) are the base dimensions of the ISQ.</li> <li>A derived dimension of force in the ISQ is denoted by \\(\\textsf{dim }F = \\mathsf{LMT}^{\u20132}\\).</li> <li>The implementation of IEC 80000 in this library provides <code>iec80000::dim_traffic_intensity</code> base dimension to extend ISQ with strong information technology quantities.</li> </ul> <p>Base dimensions can be defined by the user in the following way:</p> <pre><code>inline constexpr struct dim_length final : base_dimension<\"L\"> {} dim_length;\ninline constexpr struct dim_time final : base_dimension<\"T\"> {} dim_time;\n</code></pre> <p>Derived dimensions are implicitly created by the library's framework based on the quantity equation provided in the quantity specification:</p> C++23C++20Portable <pre><code>inline constexpr struct length final : quantity_spec<dim_length> {} length;\ninline constexpr struct time final : quantity_spec<dim_time> {} time;\ninline constexpr struct speed final : quantity_spec<length / time> {} speed;\n\nstatic_assert(speed.dimension == dim_length / dim_time);\n</code></pre> <pre><code>inline constexpr struct length final : quantity_spec<length, dim_length> {} length;\ninline constexpr struct time final : quantity_spec<time, dim_time> {} time;\ninline constexpr struct speed final : quantity_spec<speed, length / time> {} speed;\n\nstatic_assert(speed.dimension == dim_length / dim_time);\n</code></pre> <pre><code>QUANTITY_SPEC(length, dim_length);\nQUANTITY_SPEC(time, dim_time);\nQUANTITY_SPEC(speed, length / time);\n\nstatic_assert(speed.dimension == dim_length / dim_time);\n</code></pre> <p>Important</p> <p>Users should not explicitly define any derived dimensions. Those should always be implicitly created by the framework.</p> <p>The multiplication/division on quantity specifications also multiplies/divides their dimensions:</p> <pre><code>static_assert((length / time).dimension == dim_length / dim_time);\n</code></pre> <p>The dimension equation of <code>isq::dim_length / isq::dim_time</code> results in the <code>derived_dimension<isq::dim_length, per<isq::dim_time>></code> type.</p>"},{"location":"users_guide/framework_basics/design_overview/#quantity-character","title":"Quantity character","text":"<p>ISO 80000 explicitly states that quantities (even of the same kind) may have different characters:</p> <ul> <li>scalar,</li> <li>vector,</li> <li>tensor.</li> </ul> <p>The quantity character in the mp-units library is implemented with the <code>quantity_character</code> enumeration:</p> <pre><code>enum class quantity_character { scalar, vector, tensor };\n</code></pre> <p>Info</p> <p>You can read more on quantity characters in the \"Character of a Quantity\" chapter.</p>"},{"location":"users_guide/framework_basics/design_overview/#quantity-specification","title":"Quantity specification","text":"<p>Dimension is not enough to describe a quantity. This is why the ISO 80000 provides hundreds of named quantity types. It turns out that there are many more quantity types in the ISQ than the named units in the SI.</p> <p>This is why the mp-units library introduces a quantity specification entity that stores:</p> <ul> <li>dimension,</li> <li>quantity type/name,</li> <li>quantity character,</li> <li>the quantity equation being the recipe to create this quantity (only for derived quantities that specify such a recipe).</li> </ul> <p>Note</p> <p>We know that it might be sometimes confusing to talk about quantities, quantity types/names, and quantity specifications. However, it might be important to notice here that even the ISO 80000 admits that:</p> <p>It is customary to use the same term, \"quantity\", to refer to both general quantities, such as length, mass, etc., and their instances, such as given lengths, given masses, etc. Accordingly, we are used to saying both that length is a quantity and that a given length is a quantity by maintaining the specification \u2013 \"general quantity, \\(Q\\)\" or \"individual quantity, \\(Q_\\textsf{a}\\)\" \u2013 implicit and exploiting the linguistic context to remove the ambiguity.</p> <p>In the mp-units library, we have a:</p> <ul> <li>quantity - implemented as a <code>quantity</code> class template,</li> <li>quantity specification - implemented with a <code>quantity_spec</code> class template that among others identifies a specific quantity type/name.</li> </ul> <p>For example:</p> <ul> <li><code>isq::length</code>, <code>isq::mass</code>, <code>isq::time</code>, <code>isq::electric_current</code>, <code>isq::thermodynamic_temperature</code>, <code>isq::amount_of_substance</code>, and <code>isq::luminous_intensity</code> are the specifications of base quantities in the ISQ.</li> <li><code>isq::width</code>, <code>isq::height</code>, <code>isq::radius</code>, and <code>isq::position_vector</code> are only a few of many quantities of a kind length specified in the ISQ.</li> <li><code>isq::area</code>, <code>isq::speed</code>, <code>isq::moment_of_force</code> are only a few of many derived quantities provided in the ISQ.</li> </ul> <p>Quantity specification can be defined by the user in one of the following ways:</p> C++23C++20Portable <pre><code>inline constexpr struct length final : quantity_spec<dim_length> {} length;\ninline constexpr struct height final : quantity_spec<length> {} height;\ninline constexpr struct speed final : quantity_spec<length / time> {} speed;\n</code></pre> <pre><code>inline constexpr struct length final : quantity_spec<length, dim_length> {} length;\ninline constexpr struct height final : quantity_spec<height, length> {} height;\ninline constexpr struct speed final : quantity_spec<speed, length / time> {} speed;\n</code></pre> <pre><code>QUANTITY_SPEC(length, dim_length);\nQUANTITY_SPEC(height, length);\nQUANTITY_SPEC(speed, length / time);\n</code></pre> <p>The quantity equation of <code>isq::length / isq::time</code> results in the <code>derived_quantity_spec<isq::length, per<isq::time>></code> type.</p>"},{"location":"users_guide/framework_basics/design_overview/#unit","title":"Unit","text":"<p>A unit is a concrete amount of a quantity that allows us to measure the values of quantities of the same kind and represent the result as a number being the ratio of the two quantities.</p> <p>For example:</p> <ul> <li><code>si::second</code>, <code>si::metre</code>, <code>si::kilogram</code>, <code>si::ampere</code>, <code>si::kelvin</code>, <code>si::mole</code>, and <code>si::candela</code> are the base units of the SI.</li> <li><code>si::kilo<si::metre></code> is a prefixed unit of length.</li> <li><code>si::radian</code>, <code>si::newton</code>, and <code>si::watt</code> are examples of named derived units within the SI.</li> <li><code>non_si::minute</code> is an example of a scaled unit of time.</li> <li><code>si::si2019::speed_of_light_in_vacuum</code> is a physical constant standardized by the SI in 2019.</li> </ul> <p>Note</p> <p>In the mp-units library, physical constants are also implemented as units.</p> <p>A unit can be defined by the user in one of the following ways:</p> <pre><code>template<PrefixableUnit U> struct kilo_ : prefixed_unit<\"k\", mag_power<10, 3>, U{}> {};\ntemplate<PrefixableUnit auto U> inline constexpr kilo_<decltype(U)> kilo;\n\ninline constexpr struct second final : named_unit<\"s\", kind_of<isq::time>> {} second;\ninline constexpr struct minute final : named_unit<\"min\", mag<60> * second> {} minute;\ninline constexpr struct gram final : named_unit<\"g\", kind_of<isq::mass>> {} gram;\ninline constexpr auto kilogram = kilo<gram>;\ninline constexpr struct newton final : named_unit<\"N\", kilogram * metre / square(second)> {} newton;\n\ninline constexpr struct speed_of_light_in_vacuum final : named_unit<\"c\", mag<299'792'458> * metre / second> {} speed_of_light_in_vacuum;\n</code></pre> <p>The unit equation of <code>si::metre / si::second</code> results in the <code>derived_unit<si::metre, per<si::second>></code> type.</p>"},{"location":"users_guide/framework_basics/design_overview/#quantity-reference","title":"Quantity reference","text":"<p>ISO defines a quantity as:</p> <p>Quote</p> <p>property of a phenomenon, body, or substance, where the property has a magnitude that can be expressed as a number and a reference</p> <p>After that, it says:</p> <p>Quote</p> <p>A reference can be a measurement unit, a measurement procedure, a reference material, or a combination of such.</p> <p>In the mp-units library, a quantity reference provides all the domain-specific metadata for the quantity besides its numerical value:</p> <ul> <li>all the data stored in the quantity specification,</li> <li>unit.</li> </ul> <p>Together with the value of a representation type, it forms a quantity.</p> <p>In the library, we have two different ways to provide a reference:</p> <ul> <li>every unit with the associated quantity kind is a valid reference,</li> <li>providing a unit to an indexing operator of a quantity specification explicitly instantiates a <code>reference</code> class template with this quantity spec and a unit passed as arguments.</li> </ul> <p>Note</p> <p>All the units of the SI have associated quantity kinds and may serve as a reference.</p> <p>For example:</p> <ul> <li><code>si::metre</code> is defined in the SI as a unit of <code>isq::length</code> and thus can be used as a reference to instantiate a quantity of length (e.g., <code>42 * m</code>).</li> <li>The expression <code>isq::height[m]</code> results with <code>reference<isq::height, si::metre></code>, which can be used to instantiate a quantity of <code>isq::height</code> with a unit of <code>si::metre</code> (e.g., <code>42 * isq::height[m]</code>).</li> </ul>"},{"location":"users_guide/framework_basics/design_overview/#quantity-representation","title":"Quantity representation","text":"<p>Quantity representation defines the type used to store the numerical value of a quantity. Such a type should be of a specific quantity character provided in the quantity specification.</p> <p>Note</p> <p>By default, all floating-point and integral (besides <code>bool</code>) types are treated as scalars.</p>"},{"location":"users_guide/framework_basics/design_overview/#quantity","title":"Quantity","text":"<p>ISO defines a quantity as:</p> <p>Quote</p> <p>property of a phenomenon, body, or substance, where the property has a magnitude that can be expressed as a number and a reference</p> <p>This is why a <code>quantity</code> class template is defined in the library as:</p> <pre><code>template<Reference auto R,\n RepresentationOf<get_quantity_spec(R).character> Rep = double>\nclass quantity;\n</code></pre> <p>Its value can be easily created by multiplying/dividing the numerical value and a reference.</p> <p>For example:</p> <ul> <li>All of <code>42 * m</code>, <code>42 * si::metre</code>, <code>42 * isq::height[m]</code>, and <code>isq::height(42 * m)</code> create a quantity.</li> <li>A quantity type can also be specified explicitly (e.g., <code>quantity<si::metre, int></code>, <code>quantity<isq::height[m]></code>).</li> </ul>"},{"location":"users_guide/framework_basics/design_overview/#point-origin","title":"Point origin","text":"<p>In the affine space theory, the point origin specifies where the \"zero\" of our measurement's scale is.</p> <p>In the mp-units library, we have two types of point origins:</p> <ul> <li>absolute - defines an absolute \"zero\" for our point,</li> <li>relative - defines an origin that has some \"offset\" relative to an absolute point.</li> </ul> <p>For example:</p> <ul> <li>the absolute point origin can be defined in the following way:</li> </ul> <pre><code>inline constexpr struct absolute_zero final : absolute_point_origin<isq::thermodynamic_temperature> {} absolute_zero;\n</code></pre> <ul> <li>the relative point origin can be defined in the following way:</li> </ul> <pre><code>inline constexpr struct ice_point final : relative_point_origin<absolute_zero + 273'150 * milli<kelvin>> {} ice_point;\n</code></pre>"},{"location":"users_guide/framework_basics/design_overview/#quantity-point","title":"Quantity point","text":"<p>Quantity point implements a point in the affine space theory.</p> <p>In the mp-units library, the quantity point is implemented as:</p> <pre><code>template<Reference auto R,\n PointOriginFor<get_quantity_spec(R)> auto PO,\n RepresentationOf<get_quantity_spec(R).character> Rep = double>\nclass quantity_point;\n</code></pre> <p>Its value can be easily created by adding/subtracting the quantity with a point origin.</p> <p>For example:</p> <ul> <li>The following specifies a quantity point defined in terms of an <code>ice_point</code> provided in the previous example:</li> </ul> <pre><code>constexpr auto room_reference_temperature = ice_point + isq::Celsius_temperature(21 * deg_C);\n</code></pre>"},{"location":"users_guide/framework_basics/dimensionless_quantities/","title":"Dimensionless Quantities","text":"<p>The quantities we discussed so far always had some specific type and physical dimension. However, this is not always the case. While performing various computations, we sometimes end up with so-called \"dimensionless\" quantities, which ISO defines as quantities of dimension one:</p> <p>ISO/IEC Guide 99</p> <ul> <li>Quantity for which all the exponents of the factors corresponding to the base quantities in its quantity dimension are zero.</li> <li>The measurement units and values of quantities of dimension one are numbers, but such quantities convey more information than a number.</li> <li>Some quantities of dimension one are defined as the ratios of two quantities of the same kind.</li> <li>Numbers of entities are quantities of dimension one.</li> </ul>"},{"location":"users_guide/framework_basics/dimensionless_quantities/#dividing-two-quantities-of-the-same-kind","title":"Dividing two quantities of the same kind","text":"<p>Dividing two quantities of the same kind always results in a quantity of dimension one. However, depending on what type of quantities we divide or what their units are, we may end up with slightly different results.</p> <p>Note</p> <p>In mp-units, dividing two quantities of the same dimension always results in a quantity with the dimension being <code>dimension_one</code>. This is often different for other physical units libraries, which may return a raw representation type for such cases. A raw value is also always returned from the division of two <code>std::chrono::duration</code> objects.</p> <p>To read more about the reasoning for this design decision, please check our FAQ.</p>"},{"location":"users_guide/framework_basics/dimensionless_quantities/#dividing-quantities-of-the-same-type","title":"Dividing quantities of the same type","text":"<p>First, let's analyze what happens if we divide two quantities of the same type:</p> <pre><code>constexpr QuantityOf<dimensionless> auto q = isq::height(200 * m) / isq::height(50 * m);\n</code></pre> <p>In such a case, we end up with a dimensionless quantity that has the following properties:</p> <pre><code>static_assert(q.quantity_spec == dimensionless);\nstatic_assert(q.dimension == dimension_one);\nstatic_assert(q.unit == one);\n</code></pre> <p>In case we would like to print its value, we would see a raw value of <code>4</code> in the output with no unit being printed.</p>"},{"location":"users_guide/framework_basics/dimensionless_quantities/#dividing-quantities-of-different-types","title":"Dividing quantities of different types","text":"<p>Now let's see what happens if we divide quantities of the same dimension and unit but which have different quantity types:</p> <pre><code>constexpr QuantityOf<dimensionless> auto q = isq::work(200 * J) / isq::heat(50 * J);\n</code></pre> <p>Again we end up with <code>dimension_one</code> and <code>one</code>, but this time:</p> <pre><code>static_assert(q.quantity_spec == isq::work / isq::heat);\n</code></pre> <p>As shown above, the result is not of a <code>dimensionless</code> type anymore. Instead, we get a quantity type derived from the performed quantity equation. According to the ISQ, work divided by heat is the recipe for the thermodynamic efficiency quantity, thus:</p> <pre><code>static_assert(implicitly_convertible(q.quantity_spec, isq::efficiency_thermodynamics));\n</code></pre> <p>Note</p> <p>The quantity of <code>isq::efficiency_thermodynamics</code> is of a kind <code>dimensionless</code>, so it is implicitly convertible to <code>dimensionless</code> and satisfies the <code>QuantityOf<dimensionless></code> concept.</p>"},{"location":"users_guide/framework_basics/dimensionless_quantities/#dividing-quantities-of-different-units","title":"Dividing quantities of different units","text":"<p>Now, let's see what happens when we divide two quantities of the same type but different units:</p> <pre><code>constexpr QuantityOf<dimensionless> auto q = isq::height(4 * km) / isq::height(2 * m);\n</code></pre> <p>This time, we still get a quantity of the <code>dimensionless</code> type with a <code>dimension_one</code> as its dimension. However, the resulting unit is not <code>one</code> anymore:</p> <pre><code>static_assert(q.unit == mag_power<10, 3> * one);\n</code></pre> <p>In case we would print the text output of this quantity, we would not see a raw value of <code>2000</code>, but <code>2 km/m</code>.</p> <p>First, it may look surprising, but this is consistent with dividing quantities of different dimensions. For example, if we divide <code>4 * km / 2 * s</code>, we do not expect <code>km</code> to be \"expanded\" to <code>m</code> before the division, right? We would expect the result of <code>2 km/s</code>, which is exactly what we get when we divide quantities of the same kind.</p> <p>This is a compelling feature that allows us to express huge or tiny ratios without the need for big and expensive representation types. With this, we can easily define things like a Hubble's constant that uses a unit that is proportional to the ratio of kilometers per megaparsecs, which are both units of length:</p> <pre><code>inline constexpr struct hubble_constant final :\n named_unit<{u8\"H\u2080\", \"H_0\"}, mag_ratio<701, 10> * si::kilo<si::metre> / si::second / si::mega<parsec>> {} hubble_constant;\n</code></pre>"},{"location":"users_guide/framework_basics/dimensionless_quantities/#counts-of-things","title":"Counts of things","text":"<p>Another important use case for dimensionless quantities is to provide strong types for counts of things. For example:</p> <ul> <li>ISO-80000-3 provides a rotation quantity defined as the number of revolutions,</li> <li>IEC-80000-6 provides a number of turns in a winding quantity,</li> <li>IEC-80000-13 provides a Hamming distance quantity defined as the number of digit positions in which the corresponding digits of two words of the same length are different.</li> </ul> <p>Thanks to assigning strong names to such quantities, later on, they can be explicitly used as arguments in the quantity equations of other quantities deriving from them.</p>"},{"location":"users_guide/framework_basics/dimensionless_quantities/#predefined-units-of-the-dimensionless-quantity","title":"Predefined units of the dimensionless quantity","text":"<p>As we observed above, the most common unit for dimensionless quantities is <code>one</code>. It has the ratio of <code>1</code> and does not output any textual symbol.</p> <p>Important: <code>one</code> is an identity</p> <p>A unit <code>one</code> is special in the entire type system of units as it is considered to be an identity operand in the unit expression templates. This means that, for example:</p> <pre><code>static_assert(one * one == one);\nstatic_assert(one * si::metre == si::metre);\nstatic_assert(si::metre / si::metre == one);\n</code></pre> <p>The same is also true for <code>dimension_one</code> and <code>dimensionless</code> in the domains of dimensions and quantity specifications.</p> <p>Besides the unit <code>one</code>, there are a few other scaled units predefined in the library for usage with dimensionless quantities:</p> <pre><code>inline constexpr struct percent final : named_unit<\"%\", mag_ratio<1, 100> * one> {} percent;\ninline constexpr struct per_mille final : named_unit<{u8\"\u2030\", \"%o\"}, mag_ratio<1, 1000> * one> {} per_mille;\ninline constexpr struct parts_per_million final : named_unit<\"ppm\", mag_ratio<1, 1'000'000> * one> {} parts_per_million;\ninline constexpr auto ppm = parts_per_million;\n</code></pre>"},{"location":"users_guide/framework_basics/dimensionless_quantities/#angular-quantities","title":"Angular quantities","text":"<p>Special, often controversial, examples of dimensionless quantities are an angular measure and solid angular measure quantities that are defined in the ISQ to be the result of a division of \\(arc\\; length / radius\\) and \\(area / radius^2\\) respectively. Moreover, ISQ also explicitly states that both can be expressed in the unit <code>one</code>. This means that both angular measure and solid angular measure should be of a kind dimensionless.</p> <p>On the other hand, ISQ also specifies that a unit radian can be used for angular measure, and a unit steradian can be used for solid angular measure. Those should not be mixed or used to express other types of dimensionless quantities. This means that both angular measure and solid angular measure should also be quantity kinds by themselves.</p> <p>Note</p> <p>Many people claim that angle being a dimensionless quantity is a bad idea. There are proposals submitted to make an angle a base quantity and <code>rad</code> to become a base unit. More on this topic can be found in the \"Strong Angular System\" chapter.</p>"},{"location":"users_guide/framework_basics/dimensionless_quantities/#nested-quantity-kinds","title":"Nested quantity kinds","text":"<p>Angular quantities are not the only ones with such a \"strange\" behavior. Another but a similar case is a storage capacity quantity specified in IEC-80000-13 that again allows expressing it in both <code>one</code> and <code>bit</code> units.</p> <p>Those cases make dimensionless quantities an exceptional tree in the library. This is the only quantity hierarchy that contains more than one quantity kind in its tree:</p> <pre><code>flowchart TD\n dimensionless[\"dimensionless\\n[one]\"]\n dimensionless --- rotation\n dimensionless --- efficiency\n dimensionless --- angular_measure[\"angular_measure\\n[rad]\"]\n angular_measure --- rotational_displacement\n angular_measure --- phase_angle\n dimensionless --- solid_angular_measure[\"solid_angular_measure\\n[sr]\"]\n dimensionless --- drag_factor\n dimensionless --- storage_capacity[\"storage_capacity\\n[bit]\"] --- equivalent_binary_storage_capacity\n dimensionless --- ...</code></pre> <p>To provide such support in the library, we provided an <code>is_kind</code> specifier that can be appended to the quantity specification:</p> C++23C++20Portable <pre><code>inline constexpr struct angular_measure final : quantity_spec<dimensionless, arc_length / radius, is_kind> {} angular_measure;\ninline constexpr struct solid_angular_measure final : quantity_spec<dimensionless, area / pow<2>(radius), is_kind> {} solid_angular_measure;\ninline constexpr struct storage_capacity final : quantity_spec<dimensionless, is_kind> {} storage_capacity;\n</code></pre> <pre><code>inline constexpr struct angular_measure final : quantity_spec<angular_measure, dimensionless, arc_length / radius, is_kind> {} angular_measure;\ninline constexpr struct solid_angular_measure final : quantity_spec<solid_angular_measure, dimensionless, area / pow<2>(radius), is_kind> {} solid_angular_measure;\ninline constexpr struct storage_capacity final : quantity_spec<storage_capacity, dimensionless, is_kind> {} storage_capacity;\n</code></pre> <pre><code>QUANTITY_SPEC(angular_measure, dimensionless, arc_length / radius, is_kind);\nQUANTITY_SPEC(solid_angular_measure, dimensionless, area / pow<2>(radius), is_kind);\nQUANTITY_SPEC(storage_capacity, dimensionless, is_kind);\n</code></pre> <p>With the above, we can constrain <code>radian</code>, <code>steradian</code>, and <code>bit</code> to be allowed for usage with specific quantity kinds only:</p> <pre><code>inline constexpr struct radian final : named_unit<\"rad\", metre / metre, kind_of<isq::angular_measure>> {} radian;\ninline constexpr struct steradian final : named_unit<\"sr\", square(metre) / square(metre), kind_of<isq::solid_angular_measure>> {} steradian;\ninline constexpr struct bit final : named_unit<\"bit\", one, kind_of<storage_capacity>> {} bit;\n</code></pre> <p>but still allow the usage of <code>one</code> and its scaled versions for such quantities.</p>"},{"location":"users_guide/framework_basics/faster_than_lightspeed_constants/","title":"Faster-than-lightspeed Constants","text":"<p>In most libraries, physical constants are implemented as constant (possibly <code>constexpr</code>) quantity values. Such an approach has some disadvantages, often affecting the run time performance and causing a loss of precision.</p>"},{"location":"users_guide/framework_basics/faster_than_lightspeed_constants/#simplifying-constants-in-an-equation","title":"Simplifying constants in an equation","text":"<p>When dealing with equations involving physical constants, they often occur more than once in an expression. Such a constant may appear both in a numerator and denominator of a quantity equation. As we know from fundamental physics, we can simplify such an expression by striking a constant out of the equation. Supporting such behavior allows a faster runtime performance and often a better precision of the resulting value.</p>"},{"location":"users_guide/framework_basics/faster_than_lightspeed_constants/#physical-constants-as-units","title":"Physical constants as units","text":"<p>The mp-units library allows and encourages the implementation of physical constants as regular units. With that, the constant's value is handled at compile-time, and under favorable circumstances, it can be simplified in the same way as all other repeated units do. If it is not simplified, the value is stored in a type, and the expensive multiplication or division operations can be delayed in time until a user selects a specific unit to represent/print the data.</p> <p>Such a feature often also allows using simpler or faster representation types in the equation. For example, instead of always having to multiply a small integral value with a big floating-point constant number, we can just use the integral type all the way. Only in case a constant will not simplify in the equation, and the user will require a specific unit, such a multiplication will be lazily invoked, and the representation type will need to be expanded to facilitate that. With that, addition, subtractions, multiplications, and divisions will always be the fastest - compiled away or done in out-of-order execution.</p> <p>To benefit from all of the above, in the mp-units library, SI defining and other constants are implemented as units in the following way:</p> <pre><code>namespace si {\n\nnamespace si2019 {\n\ninline constexpr struct speed_of_light_in_vacuum final :\n named_unit<\"c\", mag<299'792'458> * metre / second> {} speed_of_light_in_vacuum;\n\n} // namespace si2019\n\ninline constexpr struct magnetic_constant final :\n named_unit<{u8\"\u03bc\u2080\", \"u_0\"}, mag<4> * mag_pi * mag_power<10, -7> * henry / metre> {} magnetic_constant;\n\n} // namespace mp_units::si\n</code></pre>"},{"location":"users_guide/framework_basics/faster_than_lightspeed_constants/#usage-examples","title":"Usage examples","text":"<p>With the above definitions, we can calculate vacuum permittivity as:</p> <pre><code>constexpr auto permeability_of_vacuum = 1. * si::magnetic_constant;\nconstexpr auto speed_of_light_in_vacuum = 1 * si::si2019::speed_of_light_in_vacuum;\n\nQuantityOf<isq::permittivity_of_vacuum> auto q = 1 / (permeability_of_vacuum * pow<2>(speed_of_light_in_vacuum));\n\nstd::println(\"permittivity of vacuum = {} = {::N[.3e]}\", q, q.in(F / m));\n</code></pre> <p>The above first prints the following:</p> <pre><code>permittivity of vacuum = 1 \u03bc\u2080\u207b\u00b9 c\u207b\u00b2 = 8.854e-12 F/m\n</code></pre> <p>As we can clearly see, all the calculations above were just about multiplying and dividing the number <code>1</code> with the rest of the information provided as a compile-time type. Only when a user wants a specific SI unit as a result, the unit ratios are lazily resolved.</p> <p>Another similar example can be an equation for total energy:</p> <pre><code>QuantityOf<isq::mechanical_energy> auto total_energy(QuantityOf<isq::momentum> auto p,\n QuantityOf<isq::mass> auto m,\n QuantityOf<isq::speed> auto c)\n{\n return isq::mechanical_energy(sqrt(pow<2>(p * c) + pow<2>(m * pow<2>(c))));\n}\n</code></pre> <pre><code>constexpr auto GeV = si::giga<si::electronvolt>;\nconstexpr QuantityOf<isq::speed> auto c = 1. * si::si2019::speed_of_light_in_vacuum;\nconstexpr auto c2 = pow<2>(c);\n\nconst auto p1 = isq::momentum(4. * GeV / c);\nconst QuantityOf<isq::mass> auto m1 = 3. * GeV / c2;\nconst auto E = total_energy(p1, m1, c);\n\nstd::cout << \"in `GeV` and `c`:\\n\"\n << \"p = \" << p1 << \"\\n\"\n << \"m = \" << m1 << \"\\n\"\n << \"E = \" << E << \"\\n\";\n\nconst auto p2 = p1.in(GeV / (m / s));\nconst auto m2 = m1.in(GeV / pow<2>(m / s));\nconst auto E2 = total_energy(p2, m2, c).in(GeV);\n\nstd::cout << \"\\nin `GeV`:\\n\"\n << \"p = \" << p2 << \"\\n\"\n << \"m = \" << m2 << \"\\n\"\n << \"E = \" << E2 << \"\\n\";\n\nconst auto p3 = p1.in(kg * m / s);\nconst auto m3 = m1.in(kg);\nconst auto E3 = total_energy(p3, m3, c).in(J);\n\nstd::cout << \"\\nin SI base units:\\n\"\n << \"p = \" << p3 << \"\\n\"\n << \"m = \" << m3 << \"\\n\"\n << \"E = \" << E3 << \"\\n\";\n</code></pre> <p>The above prints the following:</p> <pre><code>in `GeV` and `c`:\np = 4 GeV/c\nm = 3 GeV/c\u00b2\nE = 5 GeV\n\nin `GeV`:\np = 1.33426e-08 GeV s/m\nm = 3.33795e-17 GeV s\u00b2/m\u00b2\nE = 5 GeV\n\nin SI base units:\np = 2.13771e-18 kg m/s\nm = 5.34799e-27 kg\nE = 8.01088e-10 J\n</code></pre>"},{"location":"users_guide/framework_basics/generic_interfaces/","title":"Generic Interfaces","text":"<p>Using a concrete unit in the interface often makes a lot of sense. It is especially useful if we store the data internally in the object. In such a case, we have to select a specific unit anyway.</p> <p>For example, let's consider a simple storage tank:</p> <pre><code>class StorageTank {\n quantity<horizontal_area[m2]> base_;\n quantity<isq::height[m]> height_;\n quantity<isq::mass_density[kg / m3]> density_ = air_density;\npublic:\n constexpr StorageTank(const quantity<horizontal_area[m2]>& base, const quantity<isq::height[m]>& height) :\n base_(base), height_(height)\n {\n }\n\n // ...\n};\n</code></pre> <p>As the quantities provided in the function's interface are then stored in the class, there is probably no sense in using generic interfaces here.</p>"},{"location":"users_guide/framework_basics/generic_interfaces/#the-issues-with-unit-specific-interfaces","title":"The issues with unit-specific interfaces","text":"<p>However, in many cases, using a specific unit in the interface is counterproductive. Let's consider the following function:</p> <pre><code>quantity<km / h> avg_speed(quantity<km> distance, quantity<h> duration)\n{\n return distance / duration;\n}\n</code></pre> <p>Everything seems fine for now. It also works great if we call it with:</p> <pre><code>quantity<km / h> s1 = avg_speed(220 * km, 2 * h);\n</code></pre> <p>However, if the user starts doing the following:</p> <pre><code>quantity<mi / h> s2 = avg_speed(140 * mi, 2 * h);\nquantity<m / s> s3 = avg_speed(20 * m, 2 * s);\n</code></pre> <p>some issues start to be clearly visible:</p> <ol> <li>The arguments must be converted to units mandated by the function's parameters at each call. This involves potentially expensive multiplication/division operations at runtime.</li> <li>After the function returns the speed in a unit of <code>km/h</code>, another potentially expensive multiplication/division operations must be performed to convert the resulting quantity into a unit being the derived unit of the initial function's arguments.</li> <li>Besides the obvious runtime cost, some unit conversions may result in a value truncation, which means that the result will not be exactly equal to a direct division of the function's arguments.</li> <li> <p>We have to use a floating-point representation type (the <code>quantity</code> class template by default uses <code>double</code> as a representation type) which is considered value-preserving. Trying to use an integral type in this scenario will work only for <code>s1</code>, while <code>s2</code> and <code>s3</code> will fail to compile. Failing to compile is a good thing here as the library tries to prevent the user from doing a clearly wrong thing. To make the code compile, the user needs to use dedicated <code>value_cast</code> or <code>force_in</code> like this:</p> <pre><code>quantity<isq::speed[mi / h]> s2 = avg_speed(value_cast<km>(140 * mi), 2 * h);\nquantity<isq::speed[m / s]> s3 = avg_speed((20 * m).force_in(km), (2 * s).force_in(h));\n</code></pre> <p>but the above will obviously provide an incorrect behavior (e.g., division by <code>0</code> in the evaluation of <code>s3</code>).</p> </li> </ol>"},{"location":"users_guide/framework_basics/generic_interfaces/#a-naive-solution","title":"A naive solution","text":"<p>A naive solution here would be to implement the function as an unconstrained function template:</p> <pre><code>auto avg_speed(auto distance, auto duration)\n{\n return distance / duration;\n}\n</code></pre> <p>Beware, this is not a good solution. The above code is too generic. Such a function template accepts everything:</p> <ul> <li>quantities of other types<ul> <li>the compiler will not prevent accidental reordering of the function's arguments,</li> <li>quantities of different types can be passed as well,</li> </ul> </li> <li>plain <code>double</code> arguments,</li> <li><code>std::vector</code> and <code>std::lock_guard</code> will be accepted as well (of course, this will fail in the instantiation of a function's body later in the compilation process).</li> </ul> <p>Note</p> <p>The usage of <code>auto</code> instead of a function parameter type is a C++20 feature. It makes such a code a function template where the type of such a parameter will be deduced during the template instantiation process from the argument type passed by the user.</p>"},{"location":"users_guide/framework_basics/generic_interfaces/#constraining-function-template-arguments-with-concepts","title":"Constraining function template arguments with concepts","text":"<p>Much better generic code can be implemented using basic concepts provided with the library:</p> Original template notationThe shorthand notationTerse notation <pre><code>template<typename Distance, typename Duration>\n requires QuantityOf<Distance, isq::length> && QuantityOf<Duration, isq::time>\nauto avg_speed(Distance distance, Duration duration)\n{\n return isq::speed(distance / duration);\n}\n</code></pre> <pre><code>template<QuantityOf<isq::length> Distance, QuantityOf<isq::time> Duration>\nauto avg_speed(Distance distance, Duration duration)\n{\n return isq::speed(distance / duration);\n}\n</code></pre> <pre><code>auto avg_speed(QuantityOf<isq::length> auto distance,\n QuantityOf<isq::time> auto duration)\n{\n return isq::speed(distance / duration);\n}\n</code></pre> <p>This explicitly states that the arguments passed by the user must not only satisfy a <code>Quantity</code> concept, but also their quantity specification must be implicitly convertible to <code>isq::length</code> and <code>isq::time</code> accordingly. This no longer leaves room for error while still allowing the compiler to generate the most efficient code.</p> <p>Tip</p> <p>Please note that now it is safe just to use integral types all the way which again improves the runtime performance as the multiplication/division operations are often faster on the integral rather than floating-point types.</p>"},{"location":"users_guide/framework_basics/generic_interfaces/#constraining-function-template-return-type","title":"Constraining function template return type","text":"<p>The above function template resolves all of the issues described before. However, we can do even better here by additionally constraining the return type:</p> <pre><code>QuantityOf<isq::speed> auto avg_speed(QuantityOf<isq::length> auto distance,\n QuantityOf<isq::time> auto duration)\n{\n return isq::speed(distance / duration);\n}\n</code></pre> <p>Doing so has two important benefits:</p> <ol> <li>It informs the users of our interface about what to expect to be the result of a function invocation. It is superior to just returning <code>auto</code>, which does not provide any hint about the thing being returned there.</li> <li>Such a concept constrains the type returned from the function. This means that it works as a unit test to verify if our function actually performs what it is supposed to do. If there is an error in quantity equations, we will learn about it right away.</li> </ol>"},{"location":"users_guide/framework_basics/generic_interfaces/#constraining-a-variable-on-the-stack","title":"Constraining a variable on the stack","text":"<p>If we know precisely what the function does in its internals and if we know the exact argument types passed to such a function, we often know the exact type that will be returned from its invocation.</p> <p>However, if we care about performance, we should often use the generic interfaces described in this chapter. A side effect is that we sometimes are unsure about the return type. Even if we know it today, it might change a week from now due to some code refactoring.</p> <p>In such cases, we can again use <code>auto</code> to denote the type:</p> <pre><code>auto s1 = avg_speed(220 * km, 2 * h);\nauto s2 = avg_speed(140 * mi, 2 * h);\nauto s3 = avg_speed(20 * m, 2 * s);\n</code></pre> <p>or benefit from CTAD:</p> <pre><code>quantity s1 = avg_speed(220 * km, 2 * h);\nquantity s2 = avg_speed(140 * mi, 2 * h);\nquantity s3 = avg_speed(20 * m, 2 * s);\n</code></pre> <p>In both cases, it is probably OK to do so as the <code>avg_speed</code> function name explicitly provides the information on what to expect as a result.</p> <p>In other scenarios where the returned quantity type is not so obvious, it is again helpful to constrain the type with a concept like so:</p> <pre><code>QuantityOf<isq::speed> auto s1 = avg_speed(220 * km, 2 * h);\nQuantityOf<isq::speed> auto s2 = avg_speed(140 * mi, 2 * h);\nQuantityOf<isq::speed> auto s3 = avg_speed(20 * m, 2 * s);\n</code></pre> <p>The above explicitly provides additional information about the quantity we are dealing with in the code, and it serves as a unit test checking if the \"thing\" returned from a function is actually what we expected here.</p> <p>Note</p> <p>The <code>QuantityOf</code> and <code>QuantityPointOf</code> concepts are probably the most useful, but there are a few more to play with. A list of all the concepts can be found in the Basic Concepts chapter.</p>"},{"location":"users_guide/framework_basics/interface_introduction/","title":"Interface Introduction","text":""},{"location":"users_guide/framework_basics/interface_introduction/#new-style-of-definitions","title":"New style of definitions","text":"<p>The mp-units library decided to use a rather unusual pattern to define entities. Here is how we define <code>metre</code> and <code>second</code> SI base units:</p> <pre><code>inline constexpr struct metre final : named_unit<\"m\", kind_of<isq::length>> {} metre;\ninline constexpr struct second final : named_unit<\"s\", kind_of<isq::time>> {} second;\n</code></pre> <p>Please note that the above reuses the same identifier for a type and its value. The rationale behind this is that:</p> <ul> <li>Users always work with values and never have to spell such a type name.</li> <li>The types appear in the compilation errors and during debugging.</li> </ul> <p>Important</p> <p>To improve compiler errors' readability and make it easier to correlate them with a user's written code, a new idiom in the library is to use the same identifier for a type and its instance.</p>"},{"location":"users_guide/framework_basics/interface_introduction/#strong-types-instead-of-aliases","title":"Strong types instead of aliases","text":"<p>Let's look again at the above units definitions. Another important point to notice is that all the types describing entities in the library are short, nicely named identifiers that derive from longer, more verbose class template instantiations. This is really important to improve the user experience while debugging the program or analyzing the compilation error.</p> <p>Note</p> <p>Such a practice is rare in the industry. Some popular C++ physical units libraries generate enormously long error messages where even only the first line failed to fit on a slide with a tiny font.</p>"},{"location":"users_guide/framework_basics/interface_introduction/#entities-composability","title":"Entities composability","text":"<p>Many physical units libraries (in C++ or any other programming language) assign strong types to library entities (e.g., derived units). While <code>metre_per_second</code> as a type may not look too scary, consider, for example, units of angular momentum. If we followed this path, its coherent unit would look like <code>kilogram_metre_sq_per_second</code>. Now, consider how many scaled versions of this unit you would predefine in the library to ensure that all users are happy with your choice? How expensive would it be from the implementation point of view? What about potential future standardization efforts?</p> <p>This is why in mp-units, we put a strong requirement to make everything as composable as possible. For example, to create a quantity with a unit of speed, one may write:</p> <pre><code>quantity<si::metre / si::second> q;\n</code></pre> <p>In case we use such a unit often and would prefer to have a handy helper for it, we can always do something like this:</p> <pre><code>constexpr auto metre_per_second = si::metre / si::second;\nquantity<metre_per_second> q;\n</code></pre> <p>or choose any shorter identifier of our choice.</p> <p>Coming back to the angular momentum case, thanks to the composability of units, a user can create such a quantity in the following way:</p> <pre><code>using namespace mp_units::si::unit_symbols;\nauto q = la_vector{1, 2, 3} * isq::angular_momentum[kg * m2 / s];\n</code></pre> <p>It is a much better solution. It is terse and easy to understand. Please also notice how easy it is to obtain any scaled version of such a unit (e.g., <code>mg * square(mm) / min</code>) without having to introduce hundreds of types to predefine them.</p>"},{"location":"users_guide/framework_basics/interface_introduction/#value-based-equations","title":"Value-based equations","text":"<p>The mp-units library is based on C++20, significantly improving user experience. One of such improvements is the usage of value-based equations.</p> <p>As we have learned above, the entities are being used as values in the code, and they compose. Moreover, derived entities can be defined in the library using such value-based equations. This is a huge improvement compared to what we can find in other physical units libraries or what we have to deal with when we want to write some equations for <code>std::ratio</code>.</p> <p>For example, below are a few definitions of the SI derived units showing the power of C++20 extensions to Non-Type Template Parameters, which allow us to directly pass a result of the value-based unit equation to a class template definition:</p> <pre><code>inline constexpr struct newton final : named_unit<\"N\", kilogram * metre / square(second)> {} newton;\ninline constexpr struct pascal final : named_unit<\"Pa\", newton / square(metre)> {} pascal;\ninline constexpr struct joule final : named_unit<\"J\", newton * metre> {} joule;\n</code></pre>"},{"location":"users_guide/framework_basics/interface_introduction/#expression-templates","title":"Expression templates","text":"<p>The previous chapter provided a rationale for not having predefined types for derived entities. In many libraries, such an approach results in long and unreadable compilation errors, as framework-generated types are typically far from being easy to read and understand.</p> <p>The mp-units library greatly improves the user experience by extensively using expression templates. Such expressions are used consistently throughout the entire library to describe the results of:</p> <ul> <li>dimension equation - the result is put into the <code>derived_dimension<></code> class template</li> <li>quantity equation - the result is put into the <code>derived_quantity_spec<></code> class template</li> <li>unit equation - the result is put into the <code>derived_unit<></code> class template</li> </ul> <p>For example, if we take the above-defined base units and put the results of their division into the quantity class template like this:</p> <pre><code>quantity<metre / second> q;\n</code></pre> <p>we will observe the following type in the debugger</p> <pre><code>(gdb) ptype q\ntype = class mp_units::quantity<mp_units::derived_unit<metre, mp_units::per<second>>(), double> [with Rep = double] {\n</code></pre> <p>The same type identifier will be visible in the compilation error (in case it happens).</p> <p>Important</p> <p>Expressions templates are extensively used throughout the library to improve the readability of the resulting types.</p>"},{"location":"users_guide/framework_basics/interface_introduction/#identities","title":"Identities","text":"<p>As mentioned above, equations can be performed on dimensions, quantities, and units. Each such domain must introduce an identity object that can be used in the resulting expressions. Here is the list of identities used in the library:</p> Domain Concept Identity <code>Dimension</code> <code>dimension_one</code> <code>QuantitySpec</code> <code>dimensionless</code> <code>Unit</code> <code>one</code> <p>In the equations, a user can explicitly refer to an identity object. For example:</p> <pre><code>constexpr auto my_unit = one / second;\n</code></pre> <p>Note</p> <p>Another way to achieve the same result is to call an <code>inverse()</code> function:</p> <pre><code>constexpr auto my_unit = inverse(second);\n</code></pre> <p>Both cases will result in the same expression template being generated and put into the wrapper class template.</p>"},{"location":"users_guide/framework_basics/interface_introduction/#supported-operations-and-their-results","title":"Supported operations and their results","text":"<p>There are only a few operations that one can do on such entities, and the result of each of them has its unique representation in the library:</p> Operation Resulting template expression arguments <code>A * B</code> <code>A, B</code> <code>B * A</code> <code>A, B</code> <code>A * A</code> <code>power<A, 2></code> <code>{identity} * A</code> <code>A</code> <code>A * {identity}</code> <code>A</code> <code>A / B</code> <code>A, per<B></code> <code>A / A</code> <code>{identity}</code> <code>A / {identity}</code> <code>A</code> <code>{identity} / A</code> <code>{identity}, per<A></code> <code>pow<2>(A)</code> <code>power<A, 2></code> <code>pow<2>({identity})</code> <code>{identity}</code> <code>sqrt(A)</code> or <code>pow<1, 2>(A)</code> <code>power<A, 1, 2></code> <code>sqrt({identity})</code> or <code>pow<1, 2>({identity})</code> <code>{identity}</code>"},{"location":"users_guide/framework_basics/interface_introduction/#simplifying-the-resulting-expression-templates","title":"Simplifying the resulting expression templates","text":"<p>To limit the length and improve the readability of generated types, there are many rules to simplify the resulting expression template.</p> <ol> <li> <p>Ordering</p> <p>The resulting comma-separated arguments of multiplication are always sorted according to a specific predicate. This is why:</p> <pre><code>static_assert(A * B == B * A);\nstatic_assert(std::is_same_v<decltype(A * B), decltype(B * A)>);\n</code></pre> <p>This is probably the most important of all the steps, as it allows comparing types and enables the rest of the simplification rules.</p> </li> <li> <p>Aggregation</p> <p>In case two of the same identifiers are found next to each other on the argument list they will be aggregated in one entry:</p> Before After <code>A, A</code> <code>power<A, 2></code> <code>A, power<A, 2></code> <code>power<A, 3></code> <code>power<A, 1, 2>, power<A, 2></code> <code>power<A, 5, 2></code> <code>power<A, 1, 2>, power<A, 1, 2></code> <code>A</code> </li> <li> <p>Simplification</p> <p>In case two of the same identifiers are found in the numerator and denominator argument lists; they are being simplified into one entry:</p> Before After <code>A, per<A></code> <code>{identity}</code> <code>power<A, 2>, per<A></code> <code>A</code> <code>power<A, 3>, per<A></code> <code>power<A, 2></code> <code>A, per<power<A, 2>></code> <code>{identity}, per<A></code> </li> <li> <p>Repacking</p> <p>In case an expression uses two results of other operations, the components of its arguments are repacked into one resulting type and simplified there.</p> <p>For example, assuming:</p> <pre><code>constexpr auto X = A / B;\n</code></pre> <p>then:</p> Operation Resulting template expression arguments <code>X * B</code> <code>A</code> <code>X * A</code> <code>power<A, 2>, per<B></code> <code>X * X</code> <code>power<A, 2>, per<power<B, 2>></code> <code>X / X</code> <code>{identity}</code> <code>X / A</code> <code>{identity}, per<B></code> <code>X / B</code> <code>A, per<power<B, 2>></code> </li> </ol>"},{"location":"users_guide/framework_basics/interface_introduction/#example","title":"Example","text":"<p>Thanks to all of the features described above, a user may write the code like this one:</p> <pre><code>using namespace mp_units::si::unit_symbols;\nquantity speed = 60. * isq::speed[km / h];\nquantity duration = 8 * s;\nquantity acceleration = speed / duration;\nstd::cout << \"acceleration: \" << acceleration << \" (\" << acceleration.in(m / s2) << \")\\n\";\n</code></pre> <p>The <code>acceleration</code> quantity, being the result of the above code, has the following type (after stripping the <code>mp_units</code> namespace for brevity):</p> <pre><code>quantity<reference<derived_quantity_spec<isq::speed, per<isq::time>>{}, derived_unit<si::kilo_<si::metre{}>, per<non_si::hour, si::second>>{}>{}, int>\n</code></pre> <p>and the text output presents:</p> <pre><code>acceleration: 7.5 km h\u207b\u00b9 s\u207b\u00b9 (2.08333 m/s\u00b2)\n</code></pre>"},{"location":"users_guide/framework_basics/obtaining_metadata/","title":"Obtaining Metadata","text":""},{"location":"users_guide/framework_basics/obtaining_metadata/#quantity-spec","title":"quantity spec","text":""},{"location":"users_guide/framework_basics/obtaining_metadata/#unit","title":"unit","text":""},{"location":"users_guide/framework_basics/obtaining_metadata/#reference","title":"reference","text":""},{"location":"users_guide/framework_basics/obtaining_metadata/#quantity","title":"quantity","text":""},{"location":"users_guide/framework_basics/quantity_arithmetics/","title":"Quantity Arithmetics","text":""},{"location":"users_guide/framework_basics/quantity_arithmetics/#quantity-is-a-numeric-wrapper","title":"<code>quantity</code> is a numeric wrapper","text":"<p>If we think about it, the <code>quantity</code> class template is just a \"smart\" numeric wrapper. It exposes properly constrained set of arithmetic operations on one or two operands.</p> <p>Important: <code>quantity</code> propagates the underlying interface</p> <p>Every single arithmetic operator is exposed by the <code>quantity</code> class template only if the underlying representation type provides it as well, and when its implementation has proper semantics (e.g., returns a reasonable type).</p> <p>For example, in the following code, <code>-a</code> will compile only if <code>MyInt</code> exposes such an operation as well:</p> <pre><code>quantity a = MyInt{42} * m;\nquantity b = -a;\n</code></pre> <p>Assuming that:</p> <ul> <li><code>q</code> is our quantity,</li> <li><code>qi</code> is a quantity implicitly convertible to <code>q</code>,</li> <li><code>qk</code> is a quantity of the same kind as <code>q</code>,</li> <li><code>q1</code> is a quantity of <code>dimension_one</code> with the unit <code>one</code>,</li> <li><code>qq</code> is any other quantity,</li> <li><code>number</code> is a value of a type \"compatible\" with <code>q</code>'s representation type,</li> </ul> <p>here is the list of all the supported operators:</p> <ul> <li>unary:<ul> <li><code>+q</code></li> <li><code>-q</code></li> <li><code>++q</code></li> <li><code>q++</code></li> <li><code>--q</code></li> <li><code>q--</code></li> </ul> </li> <li>compound assignment:<ul> <li><code>q += qi</code></li> <li><code>q -= qi</code></li> <li><code>q %= qi</code></li> <li><code>q *= number</code></li> <li><code>q *= q1</code></li> <li><code>q /= number</code></li> <li><code>q /= q1</code></li> </ul> </li> <li>binary:<ul> <li><code>q + qk</code></li> <li><code>q - qk</code></li> <li><code>q % qk</code></li> <li><code>q * qq</code></li> <li><code>q * number</code></li> <li><code>number * q</code></li> <li><code>q / qq</code></li> <li><code>q / number</code></li> <li><code>number / q</code></li> </ul> </li> <li>ordering and comparison:<ul> <li><code>q == qk</code></li> <li><code>q <=> qk</code></li> </ul> </li> </ul> <p>As we can see, there are plenty of operations one can do on a value of a <code>quantity</code> type. As most of them are obvious, in the following chapters, we will discuss only the most important or non-trivial aspects of quantity arithmetics.</p>"},{"location":"users_guide/framework_basics/quantity_arithmetics/#addition-and-subtraction","title":"Addition and subtraction","text":"<p>Quantities can easily be added or subtracted from each other:</p> <pre><code>static_assert(1 * m + 1 * m == 2 * m);\nstatic_assert(2 * m - 1 * m == 1 * m);\nstatic_assert(isq::height(1 * m) + isq::height(1 * m) == isq::height(2 * m));\nstatic_assert(isq::height(2 * m) - isq::height(1 * m) == isq::height(1 * m));\n</code></pre> <p>The above uses the same types for LHS, RHS, and the result, but in general, we can add, subtract, or compare the values of any quantity type as long as both quantities are of the same kind. The result of such an operation will be the common type of the arguments:</p> <pre><code>static_assert(1 * km + 1.5 * m == 1001.5 * m);\nstatic_assert(isq::height(1 * m) + isq::width(1 * m) == isq::length(2 * m));\nstatic_assert(isq::height(2 * m) - isq::distance(0.5 * m) == 1.5 * m);\nstatic_assert(isq::radius(1 * m) - 0.5 * m == isq::radius(0.5 * m));\n</code></pre> <p>Note</p> <p>Please note that for the compound assignment operators, both arguments have to either be of the same type or the RHS has to be implicitly convertible to the LHS, as the type of LHS is always the result of such an operation:</p> <pre><code>static_assert((1 * m += 1 * km) == 1001 * m);\nstatic_assert((isq::height(1.5 * m) -= 1 * m) == isq::height(0.5 * m));\n</code></pre> <p>If we break those rules, the following code will not compile:</p> <pre><code>static_assert((1 * m -= 0.5 * m) == 0.5 * m); // Compile-time error(1)\nstatic_assert((1 * km += 1 * m) == 1001 * m); // Compile-time error(2)\nstatic_assert((isq::height(1 * m) += isq::length(1 * m)) == 2 * m); // Compile-time error(3)\n</code></pre> <ol> <li>The floating-point to integral representation type is considered narrowing.</li> <li>Conversion of quantity with integral representation type from a unit of a higher resolution to the one with a lower resolution is considered narrowing.</li> <li>Conversion from a more generic quantity type to a more specific one is considered unsafe.</li> </ol>"},{"location":"users_guide/framework_basics/quantity_arithmetics/#multiplication-and-division","title":"Multiplication and division","text":"<p>Multiplying or dividing a quantity by a number does not change its quantity type or unit. However, its representation type may change. For example:</p> <pre><code>static_assert(isq::height(3 * m) * 0.5 == isq::height(1.5 * m));\n</code></pre> <p>Note</p> <p>Unless we use a compound assignment operator, in which case truncating operations are again not allowed:</p> <pre><code>static_assert((isq::height(3 * m) *= 0.5) == isq::height(1.5 * m)); // Compile-time error(1)\n</code></pre> <ol> <li>The floating-point to integral representation type is considered narrowing.</li> </ol> <p>However, suppose we multiply or divide quantities of the same or different types or we divide a raw number by a quantity. In that case, we most probably will end up in a quantity of yet another type:</p> <pre><code>static_assert(120 * km / (2 * h) == 60 * km / h);\nstatic_assert(isq::width(2 * m) * isq::length(2 * m) == isq::area(4 * m2));\nstatic_assert(50 / isq::time(1 * s) == isq::frequency(50 * Hz));\n</code></pre> <p>Note</p> <p>An exception from the above rule happens when one of the arguments is a dimensionless quantity. If we multiply or divide by such a quantity, the quantity type will not change. If such a quantity has a unit <code>one</code>, also the unit of a quantity will not change:</p> <pre><code>static_assert(120 * m / (2 * one) == 60 * m);\n</code></pre> <p>An interesting special case happens when we divide the same quantity kinds or multiply a quantity by its inverted type. In such a case, we end up with a dimensionless quantity.</p> <pre><code>static_assert(isq::height(4 * m) / isq::width(2 * m) == 2 * one); // (1)!\nstatic_assert(5 * h / (120 * min) == 0 * one); // (2)!\nstatic_assert(5. * h / (120 * min) == 2.5 * one);\n</code></pre> <ol> <li>The resulting quantity type of the LHS is <code>isq::height / isq::width</code>, which is a quantity of the dimensionless kind.</li> <li>The resulting quantity of the LHS is <code>0 * dimensionless[h / min]</code>. To be consistent with the division of different quantity types, we do not convert quantity values to a common unit before the division.</li> </ol> <p>Important: Beware of integral division</p> <p>The physical units library can't do any runtime branching logic for the division operator. All logic must be done at compile-time when the actual values are unknown, and the quantity types can't change at runtime.</p> <p>If we expect <code>120 * km / (2 * h)</code> to return <code>60 km / h</code>, we have to agree with the fact that <code>5 * km / (24 * h)</code> returns <code>0 km/h</code>. We can't do a range check at runtime to dynamically adjust scales and types based on the values of provided function arguments.</p> <p>This is why we often prefer floating-point representation types when dealing with units. Some popular physical units libraries even forbid integer division at all.</p>"},{"location":"users_guide/framework_basics/quantity_arithmetics/#modulo","title":"Modulo","text":"<p>Now that we know how addition, subtraction, multiplication, and division work, it is time to discuss modulo. What would we expect to be returned from the following quantity equation?</p> <pre><code>auto q = 5 * h % (120 * min);\n</code></pre> <p>Most of us would probably expect to see <code>1 h</code> or <code>60 min</code> as a result. And this is where the problems start.</p> <p>C++ language defines its <code>/</code> and <code>%</code> operators with the quotient-remainder theorem:</p> <pre><code>q = a / b;\nr = a % b;\nq * b + r == a;\n</code></pre> <p>The important property of the modulo operation is that it only works for integral representation types (it is undefined what modulo for floating-point types means). However, as we saw in the previous chapter, integral types are tricky because they often truncate the value.</p> <p>From the quotient-remainder theorem, the result of modulo operation is <code>r = a - q * b</code>. Let's see what we get from such a quantity equation on integral representation types:</p> <pre><code>const quantity a = 5 * h;\nconst quantity b = 120 * min;\nconst quantity q = a / b;\nconst quantity r = a - q * b;\n\nstd::cout << \"reminder: \" << r << \"\\n\";\n</code></pre> <p>The above code outputs:</p> <pre><code>reminder: 5 h\n</code></pre> <p>And now, a tough question needs an answer. Do we really want modulo operation on physical units to be consistent with the quotient-remainder theorem and return <code>5 h</code> for <code>5 * h % (120 * min)</code>?</p> <p>This is exactly why we decided not to follow this hugely surprising path in the mp-units library. The selected approach was also consistent with the feedback from the C++ experts. For example, this is what Richard Smith said about this issue:</p> <p>Richard Smith</p> <p>I think the quotient-remainder property is a less important motivation here than other factors -- the constraints on <code>%</code> and <code>/</code> are quite different, so they lack the inherent connection they have for integers. In particular, I would expect that <code>A / B</code> works for all quantities <code>A</code> and <code>B</code>, whereas <code>A % B</code> is only meaningful when <code>A</code> and <code>B</code> have the same dimension. It seems like a nice-to-have for the property to apply in the case where both <code>/</code> and <code>%</code> are defined, but internal consistency of <code>/</code> across all cases seems much more important to me.</p> <p>I would expect <code>61 min % 1 h</code> to be <code>1 min</code>, and <code>1 h % 59 min</code> to also be <code>1 min</code>, so my intuition tells me that the result type of <code>A % B</code>, where <code>A</code> and <code>B</code> have the same dimension, should have the smaller unit of <code>A</code> and <code>B</code> (and if the smaller one doesn't divide the larger one, we should either use the <code>gcd / std::common_type</code> of the units of <code>A</code> and <code>B</code> or perhaps just produce an error). I think any other behavior for <code>%</code> is hard to defend.</p> <p>On the other hand, for division it seems to me that the choice of unit should probably not affect the result, and so if we want that <code>5 mm / 120 min = 0 mm/min</code>, then <code>5 h / 120 min == 0 hc</code> (where <code>hc</code> is a dimensionless \"hexaconta\", or <code>60x</code>, unit). I don't like the idea of taking SI base units into account; that seems arbitrary and like it would do the wrong thing as often as it does the right thing, especially when the units have a multiplier that is very large or small. We could special-case the situation of a dimensionless quantity, but that could lead to problematic overflow pretty easily: a calculation such as <code>10 s * 5 GHz * 2 uW</code> would overflow an <code>int</code> if it produces a dimensionless quantity for <code>10 s * 5 GHz</code>, but it could equally produce <code>50 G * 2 uW = 100 kW</code> without any overflow, and presumably would if the terms were merely reordered.</p> <p>If people want to use integer-valued quantities, I think it's fundamental that you need to know what the units of the result of an operation will be, and take that into account in how you express computations; the simplest rule for heterogeneous operators like <code>*</code> or <code>/</code> seems to be that the units of the result are determined by applying the operator to the units of the operands -- and for homogeneous operators like <code>+</code> or <code>%</code>, it seems like the only reasonable option is that you get the <code>std::common_type</code> of the units of the operands.</p> <p>To summarize, the modulo operation on physical units has more in common with addition and division operators than with the quotient-remainder theorem. To avoid surprising results, the operation uses a common unit to do the calculation and provide its result:</p> <pre><code>static_assert(5 * h / (120 * min) == 0 * one);\nstatic_assert(5 * h % (120 * min) == 60 * min);\nstatic_assert(61 * min % (1 * h) == 1 * min);\nstatic_assert(1 * h % (59 * min) == 1 * min);\n</code></pre>"},{"location":"users_guide/framework_basics/quantity_arithmetics/#comparison-against-zero","title":"Comparison against zero","text":"<p>In our code, we often want to compare the value of a quantity against zero. For example, we do it every time we want to ensure that we deal with a non-zero or positive value.</p> <p>We could implement such checks in the following way:</p> <pre><code>if (q1 / q2 != 0 * m / s)\n // ...\n</code></pre> <p>The above would work (assuming we are dealing with the quantity of speed) but could be suboptimal if the result of <code>q1 / q2</code> is not expressed in <code>m / s</code>. To eliminate the need for conversion, we need to write:</p> <pre><code>if (auto q = q1 / q2; q != q.zero())\n // ...\n</code></pre> <p>but that is a bit inconvenient, and inexperienced users could be unaware of this technique and its reasons.</p> <p>For the above reasons, the library provides dedicated interfaces to compare against zero that follow the naming convention of named comparison functions in the C++ Standard Library. The mp-units/compare.h header file exposes the following functions:</p> <ul> <li><code>is_eq_zero</code></li> <li><code>is_neq_zero</code></li> <li><code>is_lt_zero</code></li> <li><code>is_gt_zero</code></li> <li><code>is_lteq_zero</code></li> <li><code>is_gteq_zero</code></li> </ul> <p>Thanks to them, to save typing and not pay for unneeded conversions, our check could be implemented as follows:</p> <pre><code>if (is_neq_zero(q1 / q2))\n // ...\n</code></pre> <p>Tip</p> <p>Those functions will work with any type <code>T</code> that exposes <code>zero()</code> member function returning something comparable to <code>T</code>. Thanks to that, we can use them not only with quantities but also with <code>std::chrono::duration</code> or any other type that exposes such an interface.</p>"},{"location":"users_guide/framework_basics/quantity_arithmetics/#other-maths","title":"Other maths","text":"<p>This chapter scopes only on the <code>quantity</code> type's operators. However, there are many named math functions taking quantities as arguments. Those can be found in the mp-units/math.h header file. Among others, we can find there the following:</p> <ul> <li><code>pow()</code>, <code>sqrt()</code>, <code>cbrt()</code>,</li> <li><code>exp()</code>,</li> <li><code>abs()</code>,</li> <li><code>epsilon()</code>,</li> <li><code>fma()</code>, <code>fmod()</code>, <code>remainder()</code>,</li> <li><code>isfinite()</code>, <code>isinf()</code>, <code>isnan()</code>,</li> <li><code>floor()</code>, <code>ceil()</code>, <code>round()</code>,</li> <li><code>inverse()</code>,</li> <li><code>hypot()</code>,</li> <li><code>sin()</code>, <code>cos()</code>, <code>tan()</code>,</li> <li><code>asin()</code>, <code>acos()</code>, <code>atan()</code>, <code>atan2()</code>.</li> </ul> <p>In the library, we can also find mp-units/random.h header file with all the pseudo-random number generators working on quantity types.</p>"},{"location":"users_guide/framework_basics/simple_and_typed_quantities/","title":"Simple and Typed Quantities","text":"<p>ISO defines a quantity as:</p> <p>Quote</p> <p>property of a phenomenon, body, or substance, where the property has a magnitude that can be expressed as a number and a reference</p> <p>After that, it says:</p> <p>Quote</p> <p>A reference can be a measurement unit, a measurement procedure, a reference material, or a combination of such.</p>"},{"location":"users_guide/framework_basics/simple_and_typed_quantities/#quantity-class-template","title":"<code>quantity</code> class template","text":"<p>In the mp-units library, a quantity is represented with the following class template:</p> <pre><code>template<Reference auto R,\n RepresentationOf<get_quantity_spec(R).character> Rep = double>\nclass quantity;\n</code></pre> <p>The concept <code>Reference</code> is satisfied by a type that provides all the domain-specific metadata describing a quantity (besides the representation type and its value). Such a type can be either:</p> <ul> <li>a unit with an associated quantity type (e.g., <code>si::metre</code>, <code>m / s</code>),</li> <li>a reference type explicitly specifying the quantity type and its unit.</li> </ul> <p>Important</p> <p>All units in the SI system have an associated quantity type.</p> <p>A reference type is implicitly created as a result of the following expression:</p> <pre><code>constexpr auto ref = isq::length[m];\n</code></pre> <p>The above example results in the following type <code>reference<isq::length(), si::metre()></code> being instantiated.</p> <p>As we have two alternative options that satisfy the <code>Reference</code> concept in the mp-units library, we also have two modes of dealing with quantities.</p>"},{"location":"users_guide/framework_basics/simple_and_typed_quantities/#simple-quantities","title":"Simple quantities","text":"<p>The simple mode might be preferred by many developers. It is all about units. Quantities using this mode have shorter type identifiers, resulting in easier-to-understand error messages and better debugging experience.</p> <p>Here is a simple example showing how to deal with such quantities:</p> C++ modulesHeader files <pre><code>#include <print>\nimport mp_units;\n\nusing namespace mp_units;\n\nconstexpr quantity<si::metre / si::second> avg_speed(quantity<si::metre> dist,\n quantity<si::second> time)\n{\n return dist / time;\n}\n\nint main()\n{\n using namespace mp_units::si::unit_symbols;\n\n const quantity distance = 110 * km;\n const quantity duration = 2 * h;\n const quantity speed = avg_speed(distance, duration);\n\n std::println(\"A car driving {} in {} has an average speed of {::N[.4]} ({::N[.4]})\",\n distance, duration, speed, speed.in(km / h));\n}\n</code></pre> <pre><code>#include <mp-units/format.h>\n#include <mp-units/systems/si.h>\n#include <print>\n\nusing namespace mp_units;\n\nconstexpr quantity<si::metre / si::second> avg_speed(quantity<si::metre> dist,\n quantity<si::second> time)\n{\n return dist / time;\n}\n\nint main()\n{\n using namespace mp_units::si::unit_symbols;\n\n const quantity distance = 110 * km;\n const quantity duration = 2 * h;\n const quantity speed = avg_speed(distance, duration);\n\n std::println(\"A car driving {} in {} has an average speed of {::N[.4]} ({::N[.4]})\",\n distance, duration, speed, speed.in(km / h));\n}\n</code></pre> <p>The code above prints:</p> <pre><code>A car driving 110 km in 2 h has an average speed of 15.28 m/s (55 km/h)\n</code></pre> <p>Try it on Compiler Explorer</p>"},{"location":"users_guide/framework_basics/simple_and_typed_quantities/#user-provided-unit-wrappers","title":"User-provided unit wrappers","text":"<p>Sometimes it might be awkward to type some derived units:</p> <pre><code>quantity speed = 60 * km / h;\n</code></pre> <p>In case such a unit is used a lot in the project, a user can easily provide a nicely named wrapper for it with:</p> <pre><code>constexpr auto kmph = km / h;\nquantity speed = 60 * kmph;\n</code></pre>"},{"location":"users_guide/framework_basics/simple_and_typed_quantities/#easy-to-understand-compilation-error-messages","title":"Easy-to-understand compilation error messages","text":"<p>In case a user makes an error in a quantity equation and the result of the calculation will not match the function return type, the compiler will detect such an issue at compile-time.</p> <p>For example, in case we will make the following error:</p> <pre><code>constexpr quantity<si::metre / si::second> avg_speed(quantity<si::metre> dist,\n quantity<si::second> time)\n{\n return dist * time; // (1)!\n}\n</code></pre> <ol> <li>Quantities multiplied (instead of divided) by accident.</li> </ol> <p>the following compilation error message will be provided:</p> <pre><code>error: no viable conversion from returned value of type\n 'quantity<mp_units::derived_unit<mp_units::si::metre, mp_units::si::second>{{{}}}, [...]>'\n to function return type\n 'quantity<mp_units::derived_unit<mp_units::si::metre, mp_units::per<mp_units::si::second>>{{{}}}, [...]>'\n 10 | return dist * time;\n | ^~~~~~~~~~~\n</code></pre>"},{"location":"users_guide/framework_basics/simple_and_typed_quantities/#typed-quantities","title":"Typed quantities","text":"<p>Simple mode is all about and just about units. In case we care about a specific quantity type, typed quantities should be preferred. With this mode, for example, we can specify if we deal with width, height, or radius and ensure we will not assign one to another by accident.</p> <p>The previous example can be re-typed using typed quantities in the following way:</p> C++ modulesHeader files <pre><code>#include <print>\nimport mp_units;\n\nusing namespace mp_units;\n\nconstexpr quantity<isq::speed[si::metre / si::second]> avg_speed(quantity<isq::length[si::metre]> dist,\n quantity<isq::time[si::second]> time)\n{\n return dist / time;\n}\n\nint main()\n{\n using namespace mp_units::si::unit_symbols;\n\n const quantity distance = isq::distance(110 * km);\n const quantity duration = isq::time(2 * h);\n const quantity speed = avg_speed(distance, duration);\n\n std::println(\"A car driving {} in {} has an average speed of {::N[.4]} ({::N[.4]})\",\n distance, duration, speed, speed.in(km / h));\n}\n</code></pre> <pre><code>#include <mp-units/format.h>\n#include <mp-units/systems/isq.h>\n#include <mp-units/systems/si.h>\n#include <print>\n\nusing namespace mp_units;\n\nconstexpr quantity<isq::speed[si::metre / si::second]> avg_speed(quantity<isq::length[si::metre]> dist,\n quantity<isq::time[si::second]> time)\n{\n return dist / time;\n}\n\nint main()\n{\n using namespace mp_units::si::unit_symbols;\n\n const quantity distance = isq::distance(110 * km);\n const quantity duration = isq::time(2 * h);\n const quantity speed = avg_speed(distance, duration);\n\n std::println(\"A car driving {} in {} has an average speed of {::N[.4]} ({::N[.4]})\",\n distance, duration, speed, speed.in(km / h));\n}\n</code></pre> <pre><code>A car driving 110 km in 2 h has an average speed of 15.28 m/s (55 km/h)\n</code></pre> <p>Try it on Compiler Explorer</p> <p>In case we will accidentally make the same calculation error as before, this time, we will get a bit longer error message, this time also containing information about the quantity type:</p> <pre><code>error: no viable conversion from returned value of type\n 'quantity<reference<get_quantity_spec(metre{}) * struct time{{{}}}, metre{} * second{{}}>{}, [...]>'\n to function return type\n 'quantity<reference<speed{}, derived_unit<metre, per<second>>{}>{}, [...]>'\n 12 | return dist * time;\n | ^~~~~~~~~~~\n</code></pre> <p>As we can see above, the compilation error is longer but still relatively easy to understand.</p>"},{"location":"users_guide/framework_basics/simple_and_typed_quantities/#additional-type-safety-with-typed-quantities","title":"Additional type safety with typed quantities","text":"<p>Based on the previous example, it might seem that typed quantities are not that useful, more to type and provide harder-to-understand error messages. It might be true in some cases, but there are scenarios where they offer additional level of safety.</p> <p>Let's see another example:</p> C++ modulesHeader files SimpleTyped <pre><code>#include <numbers>\nimport mp_units;\n\nusing namespace mp_units;\n\nclass StorageTank {\n quantity<square(si::metre)> base_;\n quantity<si::metre> height_;\npublic:\n constexpr StorageTank(const quantity<square(si::metre)>& base,\n const quantity<si::metre>& height) :\n base_(base), height_(height)\n {\n }\n\n // ...\n};\n\nclass CylindricalStorageTank : public StorageTank {\npublic:\n constexpr CylindricalStorageTank(const quantity<si::metre>& radius,\n const quantity<si::metre>& height) :\n StorageTank(std::numbers::pi * pow<2>(radius), height)\n {\n }\n};\n\nclass RectangularStorageTank : public StorageTank {\npublic:\n constexpr RectangularStorageTank(const quantity<si::metre>& length,\n const quantity<si::metre>& width,\n const quantity<si::metre>& height) :\n StorageTank(length * width, height)\n {\n }\n};\n\nint main()\n{\n using namespace mp_units::si::unit_symbols;\n auto tank = RectangularStorageTank(1'000 * mm, 500 * mm, 200 * mm);\n // ...\n}\n</code></pre> <pre><code>#include <numbers>\nimport mp_units;\n\nusing namespace mp_units;\n\n// add a custom quantity type of kind isq::length\ninline constexpr struct horizontal_length final :\n quantity_spec<isq::length> {} horizontal_length;\n\n// add a custom derived quantity type of kind isq::area\n// with a constrained quantity equation\ninline constexpr struct horizontal_area final :\n quantity_spec<isq::area, horizontal_length * isq::width> {} horizontal_area;\n\nclass StorageTank {\n quantity<horizontal_area[square(si::metre)]> base_;\n quantity<isq::height[si::metre]> height_;\npublic:\n constexpr StorageTank(const quantity<horizontal_area[square(si::metre)]>& base,\n const quantity<isq::height[si::metre]>& height) :\n base_(base), height_(height)\n {\n }\n\n // ...\n};\n\nclass CylindricalStorageTank : public StorageTank {\npublic:\n constexpr CylindricalStorageTank(const quantity<isq::radius[si::metre]>& radius,\n const quantity<isq::height[si::metre]>& height) :\n StorageTank(quantity_cast<horizontal_area>(std::numbers::pi * pow<2>(radius)),\n height)\n {\n }\n};\n\nclass RectangularStorageTank : public StorageTank {\npublic:\n constexpr RectangularStorageTank(const quantity<horizontal_length[si::metre]>& length,\n const quantity<isq::width[si::metre]>& width,\n const quantity<isq::height[si::metre]>& height) :\n StorageTank(length * width, height)\n {\n }\n};\n\nint main()\n{\n using namespace mp_units::si::unit_symbols;\n auto tank = RectangularStorageTank(horizontal_length(1'000 * mm),\n isq::width(500 * mm),\n isq::height(200 * mm));\n // ...\n}\n</code></pre> SimpleTyped <pre><code>#include <mp-units/math.h>\n#include <mp-units/systems/si.h>\n#include <numbers>\n\nusing namespace mp_units;\n\nclass StorageTank {\n quantity<square(si::metre)> base_;\n quantity<si::metre> height_;\npublic:\n constexpr StorageTank(const quantity<square(si::metre)>& base,\n const quantity<si::metre>& height) :\n base_(base), height_(height)\n {\n }\n\n // ...\n};\n\nclass CylindricalStorageTank : public StorageTank {\npublic:\n constexpr CylindricalStorageTank(const quantity<si::metre>& radius,\n const quantity<si::metre>& height) :\n StorageTank(std::numbers::pi * pow<2>(radius), height)\n {\n }\n};\n\nclass RectangularStorageTank : public StorageTank {\npublic:\n constexpr RectangularStorageTank(const quantity<si::metre>& length,\n const quantity<si::metre>& width,\n const quantity<si::metre>& height) :\n StorageTank(length * width, height)\n {\n }\n};\n\nint main()\n{\n using namespace mp_units::si::unit_symbols;\n auto tank = RectangularStorageTank(1'000 * mm, 500 * mm, 200 * mm);\n // ...\n}\n</code></pre> <pre><code>#include <mp-units/math.h>\n#include <mp-units/systems/isq.h>\n#include <mp-units/systems/si.h>\n#include <numbers>\n\nusing namespace mp_units;\n\n// add a custom quantity type of kind isq::length\ninline constexpr struct horizontal_length final :\n quantity_spec<isq::length> {} horizontal_length;\n\n// add a custom derived quantity type of kind isq::area\n// with a constrained quantity equation\ninline constexpr struct horizontal_area final :\n quantity_spec<isq::area, horizontal_length * isq::width> {} horizontal_area;\n\nclass StorageTank {\n quantity<horizontal_area[square(si::metre)]> base_;\n quantity<isq::height[si::metre]> height_;\npublic:\n constexpr StorageTank(const quantity<horizontal_area[square(si::metre)]>& base,\n const quantity<isq::height[si::metre]>& height) :\n base_(base), height_(height)\n {\n }\n\n // ...\n};\n\nclass CylindricalStorageTank : public StorageTank {\npublic:\n constexpr CylindricalStorageTank(const quantity<isq::radius[si::metre]>& radius,\n const quantity<isq::height[si::metre]>& height) :\n StorageTank(quantity_cast<horizontal_area>(std::numbers::pi * pow<2>(radius)),\n height)\n {\n }\n};\n\nclass RectangularStorageTank : public StorageTank {\npublic:\n constexpr RectangularStorageTank(const quantity<horizontal_length[si::metre]>& length,\n const quantity<isq::width[si::metre]>& width,\n const quantity<isq::height[si::metre]>& height) :\n StorageTank(length * width, height)\n {\n }\n};\n\nint main()\n{\n using namespace mp_units::si::unit_symbols;\n auto tank = RectangularStorageTank(horizontal_length(1'000 * mm),\n isq::width(500 * mm),\n isq::height(200 * mm));\n // ...\n}\n</code></pre> <p>In the above example, the highlighted call doesn't look that safe anymore in the case of simple quantities, right? Suppose someone, either by mistake or due to some refactoring, will call the function with an invalid order of arguments. In that case, the program will compile fine but not work as expected.</p> <p>Let's see what will happen if we reorder the arguments in the case of typed quantities:</p> <pre><code>auto tank = RectangularStorageTank(horizontal_length(1'000 * mm),\n isq::height(200 * mm),\n isq::width(500 * mm));\n</code></pre> <p>This time, a compiler provides the following compilation error:</p> <pre><code><source>:53:15: error: no matching constructor for initialization of 'RectangularStorageTank'\n 53 | auto tank = RectangularStorageTank(horizontal_length(1'000 * mm),\n | ^ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n 54 | isq::height(200 * mm),\n | ~~~~~~~~~~~~~~~~~~~~~~\n 55 | isq::width(500 * mm));\n | ~~~~~~~~~~~~~~~~~~~~\n<source>:43:13: note: candidate constructor not viable: no known conversion from\n 'quantity<mp_units::reference<mp_units::isq::height{{{{{}}}}},\n mp_units::si::milli_<mp_units::si::metre{{}}>{{{{}}}}>{}, int>' to\n 'const quantity<reference<width{}, metre{}>{}, (default) double>' for 2nd argument\n 43 | constexpr RectangularStorageTank(const quantity<horizontal_length[m]>& length,\n | ^\n 44 | const quantity<isq::width[m]>& width,\n | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n</code></pre> <p>What about derived quantities? In the above example, you probably noticed that we also defined a custom <code>horizontal_area</code> quantity of kind <code>isq::area</code>. This quantity has the unique property of being implicitly constructible only from the result of the multiplication of quantities of <code>horizontal_area</code> and <code>isq::width</code> or the ones that implicitly convert to them.</p> <p>Based on the above error message, we already know that a quantity of <code>isq::height</code> is not implicitly constructible to the quantity of <code>isq::width</code>. This property is transitively passed to derived quantities using them. If by accident, we will try to create a <code>StorageTank</code> base class in the following way:</p> <pre><code>class RectangularStorageTank : public StorageTank {\npublic:\n constexpr RectangularStorageTank(const quantity<horizontal_length[m]>& length,\n const quantity<isq::width[m]>& width,\n const quantity<isq::height[m]>& height) :\n StorageTank(length * height, height)\n {\n }\n};\n</code></pre> <p>we will again get a compilation error message like this one:</p> <pre><code>error: no matching constructor for initialization of 'StorageTank'\n 46 | StorageTank(length * height, height)\n | ^ ~~~~~~~~~~~~~~~~~~~~~~~\n<source>:22:13: note: candidate constructor not viable: no known conversion from\n 'quantity<mp_units::reference<mp_units::derived_quantity_spec<horizontal_length, mp_units::isq::height>{{}, {{}}},\n mp_units::derived_unit<mp_units::power<mp_units::si::metre, 2>>{{{}}}>{}, [...]>' to\n 'const quantity<reference<horizontal_area{}, derived_unit<power<metre, 2>>{}>{}, [...]>' for 1st argument\n 22 | constexpr StorageTank(const quantity<horizontal_area[m2]>& base,\n | ^ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n</code></pre> <p>Tip</p> <p>If you need to use various quantities of the same kind, consider using typed quantities to bring an additional level of safety to your project.</p>"},{"location":"users_guide/framework_basics/simple_and_typed_quantities/#quantity_cast-to-force-unsafe-conversions","title":"<code>quantity_cast()</code> to force unsafe conversions","text":"<p>Did you notice the <code>quantity_cast()</code> usage in the other child class?</p> <pre><code>class CylindricalStorageTank : public StorageTank {\npublic:\n constexpr CylindricalStorageTank(const quantity<isq::radius[m]>& radius,\n const quantity<isq::height[m]>& height) :\n StorageTank(quantity_cast<horizontal_area>(std::numbers::pi * pow<2>(radius)),\n height)\n {\n }\n};\n</code></pre> <p>As <code>isq::radius</code> is not convertible to <code>horizontal_length</code>, the derived quantity of <code>pow<2>(radius)</code> can't be converted to <code>horizontal_area</code> as well. It would be unsafe to allow such a conversion as not all of the circles lie flat on the ground, right?</p> <p>In such a case, the user has to explicitly force such an unsafe conversion with the help of a <code>quantity_cast()</code>. This function name is easy to spot in code reviews or while searching the project for problems if something goes sideways. In case of unexpected quantities-related issues, this should be the first function to look for.</p> <p>Tip</p> <p>Do not overuse <code>quantity_cast()</code>. Use it only when necessary and ensure that the requested conversion is exactly what you need in this case.</p>"},{"location":"users_guide/framework_basics/simple_and_typed_quantities/#which-mode-should-i-use-in-my-project","title":"Which mode should I use in my project?","text":"<p>We have good news for you if you wonder which mode you should choose for your project. Simple and typed quantity modes can be freely mixed with each other. When you use different quantities of the same kind (e.g., radius, wavelength, altitude, ...), you should probably reach for typed quantities to bring additional safety for those cases. Otherwise, just use simple mode for the remaining quantities. The mp-units library will do its best to protect your project based on the information provided.</p> <p>Tip</p> <p>You can easily mix simple and typed quantities in your project.</p>"},{"location":"users_guide/framework_basics/systems_of_quantities/","title":"Systems of Quantities","text":"<p>The physical units libraries on the market typically only scope on modeling one or more systems of units. However, this is not the only system kind to model. Another, and maybe even more important, system kind is a system of quantities.</p> <p>Info</p> <p>Please note that the mp-units is probably the first library on the Open Source market (in any programming language) that models the ISQ with all its definitions provided in ISO 80000. Please provide feedback if something looks odd or could be improved.</p>"},{"location":"users_guide/framework_basics/systems_of_quantities/#dimension-is-not-enough-to-describe-a-quantity","title":"Dimension is not enough to describe a quantity","text":"<p>Most of the products on the market are aware of physical dimensions. However, a dimension is not enough to describe a quantity. For example, let's see the following implementation:</p> <pre><code>class Box {\n area base_;\n length height_;\npublic:\n Box(length l, length w, length h) : base_(l * w), height_(h) {}\n // ...\n};\n\nBox my_box(2 * m, 3 * m, 1 * m);\n</code></pre> <p>How do you like such an interface? It turns out that in most existing strongly-typed libraries this is often the best we can do </p> <p>Another typical question many users ask is how to deal with work and torque. Both of those have the same dimension but are different quantities.</p> <p>A similar issue is related to figuring out what should be the result of:</p> <pre><code>auto res = 1 * Hz + 1 * Bq + 1 * Bd;\n</code></pre> <p>where:</p> <ul> <li><code>Hz</code> (hertz) - unit of frequency</li> <li><code>Bq</code> (becquerel) - unit of activity</li> <li><code>Bd</code> (baud) - unit of modulation rate</li> </ul> <p>All of those quantities have the same dimension, namely \\(\\mathsf{T}^{-1}\\), but probably it is not wise to allow adding, subtracting, or comparing them, as they describe vastly different physical properties.</p> <p>If the above example seems too abstract, let's consider a fuel consumption (fuel volume divided by distance, e.g., <code>6.7 l/km</code>) and an area. Again, both have the same dimension \\(\\mathsf{L}^{2}\\), but probably it wouldn't be wise to allow adding, subtracting, or comparing a fuel consumption of a car and the area of a football field. Such an operation does not have any physical sense and should fail to compile.</p> <p>Important</p> <p>More than one quantity may be defined for the same dimension:</p> <ul> <li>quantities of different kinds (e.g. frequency, modulation rate, activity, ...)</li> <li>quantities of the same kind (e.g. length, width, altitude, distance, radius, wavelength, position vector, ...)</li> </ul> <p>It turns out that the above issues can't be solved correctly without proper modeling of a system of quantities.</p>"},{"location":"users_guide/framework_basics/systems_of_quantities/#quantities-of-the-same-kind","title":"Quantities of the same kind","text":"<p>ISO 80000-1</p> <ul> <li>Quantities may be grouped together into categories of quantities that are mutually comparable</li> <li>Mutually comparable quantities are called quantities of the same kind</li> <li>Two or more quantities cannot be added or subtracted unless they belong to the same category of mutually comparable quantities</li> <li>Quantities of the same kind within a given system of quantities have the same quantity dimension</li> <li>Quantities of the same dimension are not necessarily of the same kind</li> </ul> <p>The above quotes from ISO 80000 provide answers to all the issues above. Two quantities can't be added, subtracted, or compared unless they belong to the same kind. As frequency, activity, and modulation rate are different kinds, the expression provided above should not compile.</p>"},{"location":"users_guide/framework_basics/systems_of_quantities/#system-of-quantities-is-not-only-about-kinds","title":"System of quantities is not only about kinds","text":"<p>ISO 80000 specify hundreds of different quantities. There are plenty of different kinds provided and often each kind contains more than one quantity. In fact, it turns out that such quantities form a hierarchy of quantities of the same kind.</p> <p>For example, here are all quantities of the kind length provided in the ISO 80000:</p> <pre><code>flowchart TD\n length --- width[width, breadth]\n length --- height[height, depth, altitude]\n width --- thickness\n width --- diameter\n width --- radius\n length --- path_length\n path_length --- distance\n distance --- radial_distance\n length --- wavelength\n length --- position_vector[\"position_vector\\n{vector}\"]\n length --- displacement[\"displacement\\n{vector}\"]\n radius --- radius_of_curvature</code></pre> <p>Each of the above quantities expresses some kind of length, and each can be measured with <code>si::metre</code>. However, each of them has different properties, usage, and sometimes even requires a different representation type (notice that <code>position_vector</code> and <code>displacement</code> are vector quantities).</p> <p>Such a hierarchy helps us in defining arithmetics and conversion rules for various quantities of the same kind.</p>"},{"location":"users_guide/framework_basics/systems_of_quantities/#defining-quantities","title":"Defining quantities","text":"<p>In the mp-units library all the information about the quantity is provided with the <code>quantity_spec</code> class template. In order to define a specific quantity a user should inherit a strong type from such an instantiation.</p> <p>Tip</p> <p>Quantity specification definitions benefit from an explicit object parameter added in C++23 to remove the need for CRTP idiom, which significantly simplifies the code. However, as C++23 is far from being mainstream today, a portability macro <code>QUANTITY_SPEC()</code> is provided and used consistently through the library to allow the code to compile with C++20 compilers, thanks to the CRTP usage under the hood.</p> <p>See more in the C++ compiler support chapter.</p> <p>For example, here is how the above quantity kind tree can be modeled in the library:</p> C++23C++20Portable <pre><code>inline constexpr struct length final : quantity_spec<dim_length> {} length;\ninline constexpr struct width final : quantity_spec<length> {} width;\ninline constexpr auto breadth = width;\ninline constexpr struct height final : quantity_spec<length> {} height;\ninline constexpr auto depth = height;\ninline constexpr auto altitude = height;\ninline constexpr struct thickness final : quantity_spec<width> {} thickness;\ninline constexpr struct diameter final : quantity_spec<width> {} diameter;\ninline constexpr struct radius final : quantity_spec<width> {} radius;\ninline constexpr struct radius_of_curvature final : quantity_spec<radius> {} radius_of_curvature;\ninline constexpr struct path_length final : quantity_spec<length> {} path_length;\ninline constexpr auto arc_length = path_length;\ninline constexpr struct distance final : quantity_spec<path_length> {} distance;\ninline constexpr struct radial_distance final : quantity_spec<distance> {} radial_distance;\ninline constexpr struct wavelength final : quantity_spec<length> {} wavelength;\ninline constexpr struct position_vector final : quantity_spec<length, quantity_character::vector> {} position_vector;\ninline constexpr struct displacement final : quantity_spec<length, quantity_character::vector> {} displacement;\n</code></pre> <pre><code>inline constexpr struct length final : quantity_spec<length, dim_length> {} length;\ninline constexpr struct width final : quantity_spec<width, length> {} width;\ninline constexpr auto breadth = width;\ninline constexpr struct height final : quantity_spec<height, length> {} height;\ninline constexpr auto depth = height;\ninline constexpr auto altitude = height;\ninline constexpr struct thickness final : quantity_spec<thickness, width> {} thickness;\ninline constexpr struct diameter final : quantity_spec<diameter, width> {} diameter;\ninline constexpr struct radius final : quantity_spec<radius, width> {} radius;\ninline constexpr struct radius_of_curvature final : quantity_spec<radius_of_curvature, radius> {} radius_of_curvature;\ninline constexpr struct path_length final : quantity_spec<path_length, length> {} path_length;\ninline constexpr auto arc_length = path_length;\ninline constexpr struct distance final : quantity_spec<distance, path_length> {} distance;\ninline constexpr struct radial_distance final : quantity_spec<radial_distance, distance> {} radial_distance;\ninline constexpr struct wavelength final : quantity_spec<wavelength, length> {} wavelength;\ninline constexpr struct position_vector final : quantity_spec<position_vector, length, quantity_character::vector> {} position_vector;\ninline constexpr struct displacement final : quantity_spec<displacement, length, quantity_character::vector> {} displacement;\n</code></pre> <pre><code>QUANTITY_SPEC(length, dim_length);\nQUANTITY_SPEC(width, length);\ninline constexpr auto breadth = width;\nQUANTITY_SPEC(height, length);\ninline constexpr auto depth = height;\ninline constexpr auto altitude = height;\nQUANTITY_SPEC(thickness, width);\nQUANTITY_SPEC(diameter, width);\nQUANTITY_SPEC(radius, width);\nQUANTITY_SPEC(radius_of_curvature, radius);\nQUANTITY_SPEC(path_length, length);\ninline constexpr auto arc_length = path_length;\nQUANTITY_SPEC(distance, path_length);\nQUANTITY_SPEC(radial_distance, distance);\nQUANTITY_SPEC(wavelength, length);\nQUANTITY_SPEC(position_vector, length, quantity_character::vector);\nQUANTITY_SPEC(displacement, length, quantity_character::vector);\n</code></pre> <p>Note</p> <p>More information on how to define a system of quantities can be found in the \"International System of Quantities (ISQ)\" chapter.</p>"},{"location":"users_guide/framework_basics/systems_of_quantities/#comparing-adding-and-subtracting-quantities","title":"Comparing, adding, and subtracting quantities","text":"<p>ISO 80000 explicitly states that width and height are quantities of the same kind, and as such they:</p> <ul> <li>are mutually comparable,</li> <li>can be added and subtracted.</li> </ul> <p>If we take the above for granted, the only reasonable result of <code>1 * width + 1 * height</code> is <code>2 * length</code>, where the result of <code>length</code> is known as a common quantity type. A result of such an equation is always the first common node in a hierarchy tree of the same kind. For example:</p> <pre><code>static_assert(common_quantity_spec(isq::width, isq::height) == isq::length);\nstatic_assert(common_quantity_spec(isq::thickness, isq::radius) == isq::width);\nstatic_assert(common_quantity_spec(isq::distance, isq::path_length) == isq::path_length);\n</code></pre>"},{"location":"users_guide/framework_basics/systems_of_quantities/#converting-between-quantities","title":"Converting between quantities","text":"<p>Based on the same hierarchy of quantities of kind length, we can define quantity conversion rules.</p> <ol> <li> <p>Implicit conversions</p> <ul> <li>every width is a length</li> <li>every radius is a width</li> </ul> <pre><code>static_assert(implicitly_convertible(isq::width, isq::length));\nstatic_assert(implicitly_convertible(isq::radius, isq::width));\nstatic_assert(implicitly_convertible(isq::radius, isq::length));\n</code></pre> </li> <li> <p>Explicit conversions</p> <ul> <li>not every length is a width</li> <li>not every width is a radius</li> </ul> <pre><code>static_assert(!implicitly_convertible(isq::length, isq::width));\nstatic_assert(!implicitly_convertible(isq::width, isq::radius));\nstatic_assert(!implicitly_convertible(isq::length, isq::radius));\nstatic_assert(explicitly_convertible(isq::length, isq::width));\nstatic_assert(explicitly_convertible(isq::width, isq::radius));\nstatic_assert(explicitly_convertible(isq::length, isq::radius));\n</code></pre> </li> <li> <p>Explicit casts</p> <ul> <li>height is not a width</li> <li>both height and width are quantities of kind length</li> </ul> <pre><code>static_assert(!implicitly_convertible(isq::height, isq::width));\nstatic_assert(!explicitly_convertible(isq::height, isq::width));\nstatic_assert(castable(isq::height, isq::width));\n</code></pre> </li> <li> <p>No conversion</p> <ul> <li>time has nothing in common with length</li> </ul> <pre><code>static_assert(!implicitly_convertible(isq::time, isq::length));\nstatic_assert(!explicitly_convertible(isq::time, isq::length));\nstatic_assert(!castable(isq::time, isq::length));\n</code></pre> </li> </ol>"},{"location":"users_guide/framework_basics/systems_of_quantities/#hierarchies-of-derived-quantities","title":"Hierarchies of derived quantities","text":"<p>Derived quantity equations often do not automatically form a hierarchy tree. This is why it is sometimes not obvious what such a tree should look like. Also, ISO explicitly states:</p> <p>ISO/IEC Guide 99</p> <p>The division of \u2018quantity\u2019 according to \u2018kind of quantity\u2019 is, to some extent, arbitrary.</p> <p>The below presents some arbitrary hierarchy of derived quantities of kind energy:</p> <pre><code>flowchart TD\n energy[\"energy\\n(mass * length<sup>2</sup> / time<sup>2</sup>)\"]\n energy --- mechanical_energy\n mechanical_energy --- potential_energy\n potential_energy --- gravitational_potential_energy[\"gravitational_potential_energy\\n(mass * acceleration_of_free_fall * height)\"]\n potential_energy --- elastic_potential_energy[\"elastic_potential_energy\\n(spring_constant * amount_of_compression<sup>2</sup>)\"]\n mechanical_energy --- kinetic_energy[\"kinetic_energy\\n(mass * speed<sup>2</sup>)\"]\n energy --- enthalpy\n enthalpy --- internal_energy[internal_energy, thermodynamic_energy]\n internal_energy --- Helmholtz_energy[Helmholtz_energy, Helmholtz_function]\n enthalpy --- Gibbs_energy[Gibbs_energy, Gibbs_function]\n energy --- active_energy</code></pre> <p>Notice, that even though all of those quantities have the same dimension and can be expressed in the same units, they have different quantity equations that can be used to create them implicitly:</p> <ul> <li> <p>energy is the most generic one and thus can be created from base quantities of mass, length, and time. As those are also the roots of quantities of their kinds and all other quantities from their trees are implicitly convertible to them (we agreed on that \"every width is a length\" already), it means that an energy can be implicitly constructed from any quantity of mass, length, and time:</p> <pre><code>static_assert(implicitly_convertible(isq::mass * pow<2>(isq::length) / pow<2>(isq::time), isq::energy));\nstatic_assert(implicitly_convertible(isq::mass * pow<2>(isq::height) / pow<2>(isq::time), isq::energy));\n</code></pre> </li> <li> <p>mechanical energy is a more \"specialized\" quantity than energy (not every energy is a mechanical energy). It is why an explicit cast is needed to convert from either energy or the results of its quantity equation:</p> <pre><code>static_assert(!implicitly_convertible(isq::energy, isq::mechanical_energy));\nstatic_assert(explicitly_convertible(isq::energy, isq::mechanical_energy));\nstatic_assert(!implicitly_convertible(isq::mass * pow<2>(isq::length) / pow<2>(isq::time),\n isq::mechanical_energy));\nstatic_assert(explicitly_convertible(isq::mass * pow<2>(isq::length) / pow<2>(isq::time),\n isq::mechanical_energy));\n</code></pre> </li> <li> <p>gravitational potential energy is not only even more specialized one but additionally, it is special in a way that it provides its own \"constrained\" quantity equation. Maybe not every <code>mass * pow<2>(length) / pow<2>(time)</code> is a gravitational potential energy, but every <code>mass * acceleration_of_free_fall * height</code> is.</p> <pre><code>static_assert(!implicitly_convertible(isq::energy, gravitational_potential_energy));\nstatic_assert(explicitly_convertible(isq::energy, gravitational_potential_energy));\nstatic_assert(!implicitly_convertible(isq::mass * pow<2>(isq::length) / pow<2>(isq::time),\n gravitational_potential_energy));\nstatic_assert(explicitly_convertible(isq::mass * pow<2>(isq::length) / pow<2>(isq::time),\n gravitational_potential_energy));\nstatic_assert(implicitly_convertible(isq::mass * isq::acceleration_of_free_fall * isq::height,\n gravitational_potential_energy));\n</code></pre> </li> </ul>"},{"location":"users_guide/framework_basics/systems_of_quantities/#modeling-a-quantity-kind","title":"Modeling a quantity kind","text":"<p>In the physical units library, we also need an abstraction describing an entire family of quantities of the same kind. Such quantities have not only the same dimension but also can be expressed in the same units.</p> <p>To annotate a quantity to represent its kind (and not just a hierarchy tree's root quantity) we introduced a <code>kind_of<></code> specifier. For example, to express any quantity of length, we need to type <code>kind_of<isq::length></code>.</p> <p>Important</p> <p><code>isq::length</code> and <code>kind_of<isq::length></code> are two different things.</p> <p>Such an entity behaves as any quantity of its kind. This means that it is implicitly convertible to any quantity in a tree.</p> <pre><code>static_assert(!implicitly_convertible(isq::length, isq::height));\nstatic_assert(implicitly_convertible(kind_of<isq::length>, isq::height));\n</code></pre> <p>Additionally, the result of operations on quantity kinds is also a quantity kind:</p> <pre><code>static_assert(same_type<kind_of<isq::length> / kind_of<isq::time>, kind_of<isq::length / isq::time>>);\n</code></pre> <p>However, if at least one equation's operand is not a quantity kind, the result becomes a \"strong\" quantity where all the kinds are converted to the hierarchy tree's root quantities:</p> <pre><code>static_assert(!same_type<kind_of<isq::length> / isq::time, kind_of<isq::length / isq::time>>);\nstatic_assert(same_type<kind_of<isq::length> / isq::time, isq::length / isq::time>);\n</code></pre> <p>Info</p> <p>Only a root quantity from the hierarchy tree or the one marked with <code>is_kind</code> specifier in the <code>quantity_spec</code> definition can be put as a template parameter to the <code>kind_of</code> specifier. For example, <code>kind_of<isq::width></code> will fail to compile. However, we can call <code>get_kind(q)</code> to obtain a kind of any quantity:</p> <pre><code>static_assert(get_kind(isq::width) == kind_of<isq::length>);\n</code></pre>"},{"location":"users_guide/framework_basics/systems_of_units/","title":"Systems of Units","text":"<p>Modeling a system of units is probably the most important feature and a selling point of every physical units library. Thanks to that, the library can protect users from performing invalid operations on quantities and provide automated conversion factors between various compatible units.</p> <p>Probably all the libraries in the wild model the SI and many of them provide support for additional units belonging to various other systems (e.g., imperial, cgs, etc).</p>"},{"location":"users_guide/framework_basics/systems_of_units/#systems-of-units-are-based-on-systems-of-quantities","title":"Systems of Units are based on Systems of Quantities","text":"<p>Systems of quantities specify a set of quantities and equations relating to those quantities. Those equations do not take any unit or a numerical representation into account at all. To create a quantity, we need to add those missing pieces of information. This is where a system of units kicks in.</p> <p>The SI is explicitly stated to be based on the ISQ. Among others, it defines <code>7</code> base units, one for each base quantity. In the mp-units this is expressed by associating a quantity kind (that we discussed in detail in the previous chapter) with a unit that is used to express it:</p> <pre><code>inline constexpr struct metre final : named_unit<\"m\", kind_of<isq::length>> {} metre;\n</code></pre> <p>Important</p> <p>The <code>kind_of<isq::length></code> above states explicitly that this unit has an associated quantity kind. In other words, <code>si::metre</code> (and scaled units based on it) can be used to express the amount of any quantity of kind length.</p>"},{"location":"users_guide/framework_basics/systems_of_units/#units-compose","title":"Units compose","text":"<p>One of the most vital points of the SI system is that its units compose. This allows providing thousands of different units for hundreds of various quantities with a tiny set of predefined units and prefixes.</p> <p>The same is modeled in the mp-units library, which also allows composing predefined units to create a nearly infinite number of different derived units. For example, one can write:</p> <pre><code>quantity<si::metre / si::second> q;\n</code></pre> <p>to express a quantity of speed. The resulting quantity type is implicitly inferred from the unit equation by repeating the same operations on the associated quantity kinds.</p>"},{"location":"users_guide/framework_basics/systems_of_units/#many-shades-of-the-same-unit","title":"Many shades of the same unit","text":"<p>The SI provides the names for 22 common coherent units of 22 derived quantities.</p> <p>Each such named derived unit is a result of a specific predefined unit equation. For example, a unit of power quantity is defined in the library as:</p> <pre><code>inline constexpr struct watt final : named_unit<\"W\", joule / second> {} watt;\n</code></pre> <p>However, a power quantity can be expressed in other units as well. For example, the following:</p> <pre><code>auto q1 = 42 * W;\nstd::cout << q1 << \"\\n\";\nstd::cout << q1.in(J / s) << \"\\n\";\nstd::cout << q1.in(N * m / s) << \"\\n\";\nstd::cout << q1.in(kg * m2 / s3) << \"\\n\";\n</code></pre> <p>prints:</p> <pre><code>42 W\n42 J/s\n42 N m/s\n42 kg m\u00b2/s\u00b3\n</code></pre> <p>All of the above quantities are equivalent and mean exactly the same.</p>"},{"location":"users_guide/framework_basics/systems_of_units/#constraining-a-derived-unit-to-work-only-with-a-specific-derived-quantity","title":"Constraining a derived unit to work only with a specific derived quantity","text":"<p>Some derived units are valid only for specific derived quantities. For example, SI specifies both <code>hertz</code> and <code>becquerel</code> derived units with the same unit equation <code>1 / s</code>. However, it also explicitly states:</p> <p>SI Brochure</p> <p>The hertz shall only be used for periodic phenomena and the becquerel shall only be used for stochastic processes in activity referred to a radionuclide.</p> <p>The above means that the usage of <code>becquerel</code> as a unit of a frequency quantity is an error.</p> <p>The library allows constraining such units to work only with quantities of a specific kind in the following way:</p> <pre><code>inline constexpr struct hertz final : named_unit<\"Hz\", one / second, kind_of<isq::frequency>> {} hertz;\ninline constexpr struct becquerel final : named_unit<\"Bq\", one / second, kind_of<isq::activity>> {} becquerel;\n</code></pre> <p>With the above, <code>hertz</code> can only be used with frequencies, while <code>becquerel</code> should only be used with quantities of activity. This means that the following equation will not compile:</p> <pre><code>auto q = 1 * Hz + 1 * Bq; // Fails to compile\n</code></pre> <p>This is exactly what we wanted to achieve to improve the type-safety of the library.</p>"},{"location":"users_guide/framework_basics/systems_of_units/#prefixed-units","title":"Prefixed units","text":"<p>Besides named units, the SI specifies also 24 prefixes (all being a power of <code>10</code>) that can be prepended to all named units to obtain various scaled versions of them.</p> <p>Implementation of <code>std::ratio</code> provided by all major compilers is able to express only 16 of them. This is why, in the mp-units, we had to find an alternative way to represent unit magnitude in a more flexible way.</p> <p>Each prefix is implemented similarly to the following:</p> <pre><code>template<PrefixableUnit U> struct quecto_ : prefixed_unit<\"q\", mag_power<10, -30>, U{}> {};\ntemplate<PrefixableUnit auto U> inline constexpr quecto_<decltype(U)> quecto;\n</code></pre> <p>and then a PrefixableUnit can be prefixed in the following way:</p> <pre><code>inline constexpr auto qm = quecto<metre>;\n</code></pre> <p>The usage of <code>mag_power</code> not only enables providing support for SI prefixes, but it can also efficiently represent any rational magnitude. For example, IEC 80000 prefixes used in the IT industry can be implemented as:</p> <pre><code>template<PrefixableUnit U> struct yobi_ : prefixed_unit<\"Yi\", mag_power<2, 80>, U{}> {};\ntemplate<PrefixableUnit auto U> inline constexpr yobi_<decltype(U)> yobi;\n</code></pre>"},{"location":"users_guide/framework_basics/systems_of_units/#scaled-units","title":"Scaled units","text":"<p>In the SI, all units are either base or derived units or prefixed versions of those. However, those are only some of the options possible.</p> <p>For example, there is a list of off-system units accepted for use with SI. Those are scaled versions of the SI units with ratios that can't be explicitly expressed with predefined SI prefixes. Those include units like minute, hour, or electronvolt:</p> <pre><code>inline constexpr struct minute final : named_unit<\"min\", mag<60> * si::second> {} minute;\ninline constexpr struct hour final : named_unit<\"h\", mag<60> * minute> {} hour;\ninline constexpr struct electronvolt final : named_unit<\"eV\", mag_ratio<1'602'176'634, 1'000'000'000> * mag_power<10, -19> * si::joule> {} electronvolt;\n</code></pre> <p>Also, units of other systems of units are often defined in terms of scaled versions of the SI units. For example, the international yard is defined as:</p> <pre><code>inline constexpr struct yard final : named_unit<\"yd\", mag_ratio<9'144, 10'000> * si::metre> {} yard;\n</code></pre> <p>For some units, a magnitude might also be irrational. The best example here is a <code>degree</code> which is defined using a floating-point magnitude having a factor of the number \u03c0 (Pi):</p> <pre><code>inline constexpr struct mag_pi final : magnitude<std::numbers::pi_v<long double>> {} mag_pi;\n</code></pre> <pre><code>inline constexpr struct degree final : named_unit<{u8\"\u00b0\", \"deg\"}, mag_pi / mag<180> * si::radian> {} degree;\n</code></pre>"},{"location":"users_guide/framework_basics/text_output/","title":"Text Output","text":"<p>Besides providing dimensional analysis and unit conversions, the library also tries hard to print any quantity in the most user-friendly way. We can print the entire quantity or its selected parts (numerical value, unit, or dimension).</p> <p>Note</p> <p>The library does not provide a text output for quantity points. The quantity stored inside is just an implementation detail of this type. It is a vector from a specific origin. Without the knowledge of the origin, the vector by itself is useless as we can't determine which point it describes.</p> <p>In the current library design, point origin does not provide any text in its definition. Even if we could add such information to the point's definition, we would not know how to output it in the text. There may be many ways to do it. For example, should we prepend or append the origin part to the quantity text?</p> <p>For example, the text output of <code>42 m</code> for a quantity point may mean many things. It may be an offset from the mountain top, sea level, or maybe the center of Mars. Printing <code>42 m AMSL</code> for altitudes above mean sea level is a much better solution, but the library does not have enough information to print it that way by itself.</p> <p>Please let us know if you have a good idea of how to solve this issue.</p>"},{"location":"users_guide/framework_basics/text_output/#predefined-symbols","title":"Predefined symbols","text":"<p>The definitions of dimensions, units, prefixes, and constants require assigning text symbols for each entity. Those symbols will be composed by the library's framework to express dimensions and units of derived quantities.</p> DimensionsUnitsPrefixesConstants <pre><code>inline constexpr struct dim_length final : base_dimension<\"L\"> {} dim_length;\ninline constexpr struct dim_mass final : base_dimension<\"M\"> {} dim_mass;\ninline constexpr struct dim_time final : base_dimension<\"T\"> {} dim_time;\ninline constexpr struct dim_electric_current final : base_dimension<\"I\"> {} dim_electric_current;\ninline constexpr struct dim_thermodynamic_temperature final : base_dimension<{u8\"\u0398\", \"O\"}> {} dim_thermodynamic_temperature;\ninline constexpr struct dim_amount_of_substance final : base_dimension<\"N\"> {} dim_amount_of_substance;\ninline constexpr struct dim_luminous_intensity final : base_dimension<\"J\"> {} dim_luminous_intensity;\n</code></pre> <pre><code>inline constexpr struct second final : named_unit<\"s\", kind_of<isq::time>> {} second;\ninline constexpr struct metre final : named_unit<\"m\", kind_of<isq::length>> {} metre;\ninline constexpr struct gram final : named_unit<\"g\", kind_of<isq::mass>> {} gram;\ninline constexpr auto kilogram = kilo<gram>;\n\ninline constexpr struct newton final : named_unit<\"N\", kilogram * metre / square(second)> {} newton;\ninline constexpr struct joule final : named_unit<\"J\", newton * metre> {} joule;\ninline constexpr struct watt final : named_unit<\"W\", joule / second> {} watt;\ninline constexpr struct coulomb final : named_unit<\"C\", ampere * second> {} coulomb;\ninline constexpr struct volt final : named_unit<\"V\", watt / ampere> {} volt;\ninline constexpr struct farad final : named_unit<\"F\", coulomb / volt> {} farad;\ninline constexpr struct ohm final : named_unit<{u8\"\u03a9\", \"ohm\"}, volt / ampere> {} ohm;\n</code></pre> <pre><code>template<PrefixableUnit U> struct micro_ : prefixed_unit<{u8\"\u00b5\", \"u\"}, mag_power<10, -6>, U{}> {};\ntemplate<PrefixableUnit U> struct milli_ : prefixed_unit<\"m\", mag_power<10, -3>, U{}> {};\ntemplate<PrefixableUnit U> struct centi_ : prefixed_unit<\"c\", mag_power<10, -2>, U{}> {};\ntemplate<PrefixableUnit U> struct deci_ : prefixed_unit<\"d\", mag_power<10, -1>, U{}> {};\ntemplate<PrefixableUnit U> struct deca_ : prefixed_unit<\"da\", mag_power<10, 1>, U{}> {};\ntemplate<PrefixableUnit U> struct hecto_ : prefixed_unit<\"h\", mag_power<10, 2>, U{}> {};\ntemplate<PrefixableUnit U> struct kilo_ : prefixed_unit<\"k\", mag_power<10, 3>, U{}> {};\ntemplate<PrefixableUnit U> struct mega_ : prefixed_unit<\"M\", mag_power<10, 6>, U{}> {};\n</code></pre> <pre><code>inline constexpr struct hyperfine_structure_transition_frequency_of_cs final : named_unit<{u8\"\u0394\u03bd_Cs\", \"dv_Cs\"}, mag<9'192'631'770> * hertz> {} hyperfine_structure_transition_frequency_of_cs;\ninline constexpr struct speed_of_light_in_vacuum final : named_unit<\"c\", mag<299'792'458> * metre / second> {} speed_of_light_in_vacuum;\ninline constexpr struct planck_constant final : named_unit<\"h\", mag_ratio<662'607'015, 100'000'000> * mag_power<10, -34> * joule * second> {} planck_constant;\ninline constexpr struct elementary_charge final : named_unit<\"e\", mag_ratio<1'602'176'634, 1'000'000'000> * mag_power<10, -19> * coulomb> {} elementary_charge;\ninline constexpr struct boltzmann_constant final : named_unit<\"k\", mag_ratio<1'380'649, 1'000'000> * mag_power<10, -23> * joule / kelvin> {} boltzmann_constant;\ninline constexpr struct avogadro_constant final : named_unit<\"N_A\", mag_ratio<602'214'076, 100'000'000> * mag_power<10, 23> / mole> {} avogadro_constant;\ninline constexpr struct luminous_efficacy final : named_unit<\"K_cd\", mag<683> * lumen / watt> {} luminous_efficacy;\n</code></pre> <p>Important</p> <p>Two symbols always have to be provided if the primary symbol contains characters outside of the basic literal character set. The first must be provided as a UTF-8 literal and may contain any Unicode characters. The second one must provide an alternative spelling and only use characters from within of basic literal character set.</p> <p>Note</p> <p>Unicode provides only a minimal set of characters available as subscripts, which are often used to differentiate various constants and quantities of the same kind. To workaround this issue, mp-units uses the '_' character to specify that the following characters should be considered a subscript of the symbol.</p> <p>Tip</p> <p>For older compilers, it might be required to specify a <code>symbol_text</code> class explicitly template name to initialize it with two symbols:</p> <pre><code>inline constexpr struct ohm final : named_unit<symbol_text{u8\"\u03a9\", \"ohm\"}, volt / ampere> {} ohm;\n</code></pre>"},{"location":"users_guide/framework_basics/text_output/#symbols-for-derived-entities","title":"Symbols for derived entities","text":""},{"location":"users_guide/framework_basics/text_output/#text_encoding","title":"<code>text_encoding</code>","text":"<p>ISQ and SI standards always specify symbols using Unicode encoding. This is why it is a default and primary target for text output. However, in some applications or environments, a standard ASCII-like text output using only the characters from the basic literal character set can be preferred by users.</p> <p>This is why the library provides an option to change the default encoding to the ASCII one with:</p> <pre><code>enum class text_encoding : std::int8_t {\n unicode, // \u00b5s; m\u00b3; L\u00b2MT\u207b\u00b3\n ascii, // us; m^3; L^2MT^-3\n default_encoding = unicode\n};\n</code></pre>"},{"location":"users_guide/framework_basics/text_output/#symbols-of-derived-dimensions","title":"Symbols of derived dimensions","text":""},{"location":"users_guide/framework_basics/text_output/#dimension_symbol_formatting","title":"<code>dimension_symbol_formatting</code>","text":"<p><code>dimension_symbol_formatting</code> is a data type describing the configuration of the symbol generation algorithm.</p> <pre><code>struct dimension_symbol_formatting {\n text_encoding encoding = text_encoding::default_encoding;\n};\n</code></pre>"},{"location":"users_guide/framework_basics/text_output/#dimension_symbol","title":"<code>dimension_symbol()</code>","text":"<p>Returns a <code>std::string_view</code> with the symbol of a dimension for the provided configuration:</p> <pre><code>template<dimension_symbol_formatting fmt = dimension_symbol_formatting{}, typename CharT = char, Dimension D>\n[[nodiscard]] consteval std::string_view dimension_symbol(D);\n</code></pre> <p>For example:</p> <pre><code>static_assert(dimension_symbol<{.encoding = text_encoding::ascii}>(isq::power.dimension) == \"L^2MT^-3\");\n</code></pre> <p>Note</p> <p><code>std::string_view</code> is returned only when C++23 is available. Otherwise, an instance of a <code>basic_fixed_string</code> is being returned.</p>"},{"location":"users_guide/framework_basics/text_output/#dimension_symbol_to","title":"<code>dimension_symbol_to()</code>","text":"<p>Inserts the generated dimension symbol into the output text iterator at runtime.</p> <pre><code>template<typename CharT = char, std::output_iterator<CharT> Out, Dimension D>\nconstexpr Out dimension_symbol_to(Out out, D d, dimension_symbol_formatting fmt = dimension_symbol_formatting{});\n</code></pre> <p>For example:</p> <pre><code>std::string txt;\ndimension_symbol_to(std::back_inserter(txt), isq::power.dimension, {.encoding = text_encoding::ascii});\nstd::cout << txt << \"\\n\";\n</code></pre> <p>The above prints:</p> <pre><code>L^2MT^-3\n</code></pre>"},{"location":"users_guide/framework_basics/text_output/#symbols-of-derived-units","title":"Symbols of derived units","text":""},{"location":"users_guide/framework_basics/text_output/#unit_symbol_formatting","title":"<code>unit_symbol_formatting</code>","text":"<p><code>unit_symbol_formatting</code> is a data type describing the configuration of the symbol generation algorithm. It contains three orthogonal fields, each with a default value.</p> <pre><code>enum class unit_symbol_solidus : std::int8_t {\n one_denominator, // m/s; kg m\u207b\u00b9 s\u207b\u00b9\n always, // m/s; kg/(m s)\n never, // m s\u207b\u00b9; kg m\u207b\u00b9 s\u207b\u00b9\n default_denominator = one_denominator\n};\n\nenum class unit_symbol_separator : std::int8_t {\n space, // kg m\u00b2/s\u00b2\n half_high_dot, // kg\u22c5m\u00b2/s\u00b2 (valid only for unicode encoding)\n default_separator = space\n};\n\nstruct unit_symbol_formatting {\n text_encoding encoding = text_encoding::default_encoding;\n unit_symbol_solidus solidus = unit_symbol_solidus::default_denominator;\n unit_symbol_separator separator = unit_symbol_separator::default_separator;\n};\n</code></pre> <p><code>unit_symbol_solidus</code> impacts how the division of unit symbols is being presented in the text output. By default, the '/' will be printed if only one unit component is in the denominator. Otherwise, the exponent syntax will be used.</p> <p><code>unit_symbol_separator</code> specifies how multiple multiplied units should be separated from each other. By default, the space (' ') will be used as a separator.</p>"},{"location":"users_guide/framework_basics/text_output/#unit_symbol","title":"<code>unit_symbol()</code>","text":"<p>Returns a <code>std::string_view</code> with the symbol of a unit for the provided configuration:</p> <pre><code>template<unit_symbol_formatting fmt = unit_symbol_formatting{}, typename CharT = char, Unit U>\n[[nodiscard]] consteval std::string_view unit_symbol(U);\n</code></pre> <p>For example:</p> <pre><code>static_assert(unit_symbol<{.solidus = unit_symbol_solidus::never,\n .separator = unit_symbol_separator::half_high_dot}>(kg * m / s2) == \"kg\u22c5m\u22c5s\u207b\u00b2\");\n</code></pre> <p>Note</p> <p><code>std::string_view</code> is returned only when C++23 is available. Otherwise, an instance of a <code>basic_fixed_string</code> is being returned. See more in the C++ compiler support chapter.</p>"},{"location":"users_guide/framework_basics/text_output/#unit_symbol_to","title":"<code>unit_symbol_to()</code>","text":"<p>Inserts the generated unit symbol into the output text iterator at runtime.</p> <pre><code>template<typename CharT = char, std::output_iterator<CharT> Out, Unit U>\nconstexpr Out unit_symbol_to(Out out, U u, unit_symbol_formatting fmt = unit_symbol_formatting{});\n</code></pre> <p>For example:</p> <pre><code>std::string txt;\nunit_symbol_to(std::back_inserter(txt), kg * m / s2,\n {.solidus = unit_symbol_solidus::never, .separator = unit_symbol_separator::half_high_dot});\nstd::cout << txt << \"\\n\";\n</code></pre> <p>The above prints:</p> <pre><code>kg\u22c5m\u22c5s\u207b\u00b2\n</code></pre>"},{"location":"users_guide/framework_basics/text_output/#space_before_unit_symbol-customization-point","title":"<code>space_before_unit_symbol</code> customization point","text":"<p>The SI Brochure says:</p> <p>SI Brochure</p> <p>The numerical value always precedes the unit and a space is always used to separate the unit from the number. ... The only exceptions to this rule are for the unit symbols for degree, minute and second for plane angle, <code>\u00b0</code>, <code>\u2032</code> and <code>\u2033</code>, respectively, for which no space is left between the numerical value and the unit symbol.</p> <p>There are more units with such properties. For example, percent (<code>%</code>) and per mille(<code>\u2030</code>).</p> <p>To support the above and other similar cases, the library exposes <code>space_before_unit_symbol</code> customization point. By default, its value is <code>true</code> for all the units, so the space between a number and a unit will be inserted in the output text. To change this behavior, we have to provide a partial specialization for a specific unit:</p> <pre><code>template<>\ninline constexpr bool space_before_unit_symbol<non_si::degree> = false;\n</code></pre> <p>Note</p> <p>The above works only for the default formatting or for the format strings that use <code>%?</code> placement field (<code>std::format(\"{}\", q)</code> is equivalent to <code>std::format(\"{:%N%?%U}\", q)</code>).</p> <p>In case a user provides custom format specification (e.g., <code>std::format(\"{:%N %U}\", q)</code>), the library will always obey this specification for all the units (no matter what the actual value of the <code>space_before_unit_symbol</code> customization point is) and the separating space will always be used in this case.</p>"},{"location":"users_guide/framework_basics/text_output/#output-streams","title":"Output streams","text":"<p>Tip</p> <p>The output streaming support is opt-in and can be enabled by including the <code><mp-units/ostream.h></code> header file.</p> <p>The easiest way to print a dimension, unit, or quantity is to provide its object to the output stream:</p> <pre><code>const QuantityOf<isq::speed> auto v1 = avg_speed(220. * km, 2 * h);\nconst QuantityOf<isq::speed> auto v2 = avg_speed(140. * mi, 2 * h);\nstd::cout << v1 << '\\n'; // 110 km/h\nstd::cout << v2 << '\\n'; // 70 mi/h\nstd::cout << v2.unit << '\\n'; // mi/h\nstd::cout << v2.dimension << '\\n'; // LT\u207b\u00b9\n</code></pre> <p>The text output will always print the value using the default formatting for this entity.</p> <p>Important: Don't assume a unit</p> <p>Remember that when we deal with a quantity of an \"unknown\" (e.g., <code>auto</code>) type, it is a good practice to always convert the unit to the expected one before passing it to the text output:</p> <pre><code>std::cout << v1.in(km / h) << '\\n'; // 110 km/h\nstd::cout << v1.force_in(m / s) << '\\n'; // 30.5556 m/s\n</code></pre>"},{"location":"users_guide/framework_basics/text_output/#output-stream-formatting","title":"Output stream formatting","text":"<p>Only basic formatting can be applied to output streams. It includes control over width, fill, and alignment.</p> <p>The numerical value of the quantity will be printed according to the current stream state and standard manipulators may be used to customize that (assuming that the underlying representation type respects them).</p> <pre><code>std::cout << \"|\" << std::setw(10) << 123 * m << \"|\\n\"; // | 123 m|\nstd::cout << \"|\" << std::setw(10) << std::left << 123 * m << \"|\\n\"; // |123 m |\nstd::cout << \"|\" << std::setw(10) << std::setfill('*') << 123 * m << \"|\\n\"; // |123 m*****|\n</code></pre> <p>Note</p> <p>To have more control over the formatting of the quantity that is printed with the output stream just use <code>std::cout << std::format(...)</code>.</p>"},{"location":"users_guide/framework_basics/text_output/#text-formatting","title":"Text formatting","text":"<p>The library provides custom formatters for <code>std::format</code> facility, which allows fine-grained control over what and how it is being printed in the text output.</p> <p>Tip</p> <p>The text formatting facility support is opt-in and can be enabled by including the <code><mp-units/format.h></code> header file.</p>"},{"location":"users_guide/framework_basics/text_output/#controlling-width-fill-and-alignment","title":"Controlling width, fill, and alignment","text":"<p>Formatting grammar for all the entities provides control over width, fill, and alignment. The C++ standard grammar tokens <code>fill-and-align</code> and <code>width</code> are being used. They treat the entity as a contiguous text to be aligned. For example, here are a few examples of the quantity numerical value and symbol formatting:</p> <pre><code>std::println(\"|{:0}|\", 123 * m); // |123 m|\nstd::println(\"|{:10}|\", 123 * m); // | 123 m|\nstd::println(\"|{:<10}|\", 123 * m); // |123 m |\nstd::println(\"|{:>10}|\", 123 * m); // | 123 m|\nstd::println(\"|{:^10}|\", 123 * m); // | 123 m |\nstd::println(\"|{:*<10}|\", 123 * m); // |123 m*****|\nstd::println(\"|{:*>10}|\", 123 * m); // |*****123 m|\nstd::println(\"|{:*^10}|\", 123 * m); // |**123 m***|\n</code></pre> <p>It is important to note that in the second line above, the quantity text is aligned to the right by default, which is consistent with the formatting of numeric types. Units and dimensions behave as text and, thus, are aligned to the left by default.</p> <p>Note</p> <p><code>std::println</code> is a C++23 facility. In case we do not have access to C++23, we can obtain the same output with:</p> <pre><code>std::cout << std::format(\"<format-string>\\n\", <format-args>);\n</code></pre>"},{"location":"users_guide/framework_basics/text_output/#dimension-formatting","title":"Dimension formatting","text":"<pre><code>dimension-format-spec = [fill-and-align], [width], [dimension-spec];\ndimension-spec = [text-encoding];\ntext-encoding = 'U' | 'A';\n</code></pre> <p>In the above grammar:</p> <ul> <li><code>fill-and-align</code> and <code>width</code> tokens are defined in the format.string.std chapter of the C++ standard specification,</li> <li><code>text-encoding</code> token specifies the symbol text encoding:<ul> <li><code>U</code> (default) uses the Unicode symbols defined by [@ISO80000] (e.g., <code>LT\u207b\u00b2</code>),</li> <li><code>A</code> forces non-standard ASCII-only output (e.g., <code>LT^-2</code>).</li> </ul> </li> </ul> <p>Dimension symbols of some quantities are specified to use Unicode signs by the ISQ (e.g., <code>\u0398</code> symbol for the thermodynamic temperature dimension). The library follows this by default. From the engineering point of view, sometimes Unicode text might not be the best solution, as terminals of many (especially embedded) devices can output only letters from the basic literal character set. In such a case, the dimension symbol can be forced to be printed using such characters thanks to <code>text-encoding</code> token:</p> <pre><code>std::println(\"{}\", isq::dim_thermodynamic_temperature); // \u0398\nstd::println(\"{:A}\", isq::dim_thermodynamic_temperature); // O\nstd::println(\"{}\", isq::power.dimension); // L\u00b2MT\u207b\u00b3\nstd::println(\"{:A}\", isq::power.dimension); // L^2MT^-3\n</code></pre>"},{"location":"users_guide/framework_basics/text_output/#unit-formatting","title":"Unit formatting","text":"<pre><code>unit-format-spec = [fill-and-align], [width], [unit-spec];\nunit-spec = [text-encoding], [unit-symbol-solidus], [unit-symbol-separator], [L]\n | [text-encoding], [unit-symbol-separator], [unit-symbol-solidus], [L]\n | [unit-symbol-solidus], [text-encoding], [unit-symbol-separator], [L]\n | [unit-symbol-solidus], [unit-symbol-separator], [text-encoding], [L]\n | [unit-symbol-separator], [text-encoding], [unit-symbol-solidus], [L]\n | [unit-symbol-separator], [unit-symbol-solidus], [text-encoding], [L];\nunit-symbol-solidus = '1' | 'a' | 'n';\nunit-symbol-separator = 's' | 'd';\n</code></pre> <p>In the above grammar:</p> <ul> <li><code>fill-and-align</code> and <code>width</code> tokens are defined in the format.string.std chapter of the C++ standard specification,</li> <li><code>unit-symbol-solidus</code> token specifies how the division of units should look like:<ul> <li>'1' (default) outputs <code>/</code> only when there is only one unit in the denominator, otherwise negative exponents are printed (e.g., <code>m/s</code>, <code>kg m\u207b\u00b9 s\u207b\u00b9</code>)</li> <li>'a' always uses solidus (e.g., <code>m/s</code>, <code>kg/(m s)</code>)</li> <li>'n' never prints solidus, which means that negative exponents are always used (e.g., <code>m s\u207b\u00b9</code>, <code>kg m\u207b\u00b9 s\u207b\u00b9</code>)</li> </ul> </li> <li><code>unit-symbol-separator</code> token specifies how multiplied unit symbols should be separated:<ul> <li>'s' (default) uses space as a separator (e.g., <code>kg m\u00b2/s\u00b2</code>)</li> <li>'d' uses half-high dot (<code>\u22c5</code>) as a separator (e.g., <code>kg\u22c5m\u00b2/s\u00b2</code>) (requires the Unicode encoding)</li> </ul> </li> <li>'L' is reserved for possible future localization use in case the C++ standard library gets access to the ICU-like database.</li> </ul> <p>Note</p> <p>The above grammar intended that the elements of <code>unit-spec</code> can appear in any order as they have unique characters. Users shouldn't have to remember the order of those tokens to control the formatting of a unit symbol.</p> <p>Unit symbols of some quantities are specified to use Unicode signs by the SI (e.g., <code>\u03a9</code> symbol for the resistance quantity). The library follows this by default. From the engineering point of view, Unicode text might not be the best solution sometimes, as terminals of many (especially embedded) devices can output only letters from the basic literal character set. In such a case, the unit symbol can be forced to be printed using such characters thanks to <code>text-encoding</code> token:</p> <pre><code>std::println(\"{}\", si::ohm); // \u03a9\nstd::println(\"{:A}\", si::ohm); // ohm\nstd::println(\"{}\", us); // \u00b5s\nstd::println(\"{:A}\", us); // us\nstd::println(\"{}\", m / s2); // m/s\u00b2\nstd::println(\"{:A}\", m / s2); // m/s^2\n</code></pre> <p>Additionally, both ISO 80000 and SI leave some freedom on how to print unit symbols. This is why two additional tokens were introduced.</p> <p><code>unit-symbol-solidus</code> specifies how the division of units should look like. By default, <code>/</code> will be used only when the denominator contains only one unit. However, with the 'a' or 'n' options, we can force the facility to print the <code>/</code> character always (even when there are more units in the denominator), or never, in which case a parenthesis will be added to enclose all denominator units.</p> <pre><code>std::println(\"{}\", m / s); // m/s\nstd::println(\"{}\", kg / m / s2); // kg m\u207b\u00b9 s\u207b\u00b2\nstd::println(\"{:a}\", m / s); // m/s\nstd::println(\"{:a}\", kg / m / s2); // kg/(m s\u00b2)\nstd::println(\"{:n}\", m / s); // m s\u207b\u00b9\nstd::println(\"{:n}\", kg / m / s2); // kg m\u207b\u00b9 s\u207b\u00b2\n</code></pre> <p>Also, there are a few options to separate the units being multiplied. ISO 80000 (part 1) says:</p> <p>ISO 80000-1</p> <p>When symbols for quantities are combined in a product of two or more quantities, this combination is indicated in one of the following ways: <code>ab</code>, <code>a b</code>, <code>a \u00b7 b</code>, <code>a \u00d7 b</code></p> <p>NOTE 1 In some fields, e.g., vector algebra, distinction is made between <code>a \u2219 b</code> and <code>a \u00d7 b</code>.</p> <p>The library supports <code>a b</code> and <code>a \u00b7 b</code> only. Additionally, we decided that the extraneous space in the latter case makes the result too verbose, so we decided just to use the <code>\u00b7</code> symbol as a separator.</p> <p>Note</p> <p>Please let us know if you require more formatting options here.</p> <p>The <code>unit-symbol-separator</code> token allows us to obtain the following outputs:</p> <pre><code>std::println(\"{}\", kg * m2 / s2); // kg m\u00b2/s\u00b2\nstd::println(\"{:d}\", kg * m2 / s2); // kg\u22c5m\u00b2/s\u00b2\n</code></pre> <p>Note</p> <p>'d' requires the Unicode encoding to be set.</p>"},{"location":"users_guide/framework_basics/text_output/#quantity-formatting","title":"Quantity formatting","text":"<pre><code>quantity-format-spec = [fill-and-align], [width], [quantity-specs], [defaults-specs];\nquantity-specs = conversion-spec;\n | quantity-specs, conversion-spec;\n | quantity-specs, literal-char;\nliteral-char = ? any character other than '{', '}', or '%' ?;\nconversion-spec = '%', placement-type;\nplacement-type = subentity-id | '?' | '%';\ndefaults-specs = ':', default-spec-list;\ndefault-spec-list = default-spec;\n | default-spec-list, default-spec;\ndefault-spec = subentity-id, '[' format-spec ']';\nsubentity-id = 'N' | 'U' | 'D';\nformat-spec = ? as specified by the formatter for the argument type ?;\n</code></pre> <p>In the above grammar:</p> <ul> <li><code>fill-and-align</code> and <code>width</code> tokens are defined in the format.string.std chapter of the C++ standard specification,</li> <li><code>placement-type</code> token specifies which entity should be put and where:<ul> <li>'N' inserts a default-formatted numerical value of the quantity,</li> <li>'U' inserts a default-formatted unit of the quantity,</li> <li>'D' inserts a default-formatted dimension of the quantity,</li> <li>'?' inserts an optional separator between the number and a unit based on the value of <code>space_before_unit_symbol</code> for this unit,</li> <li>'%' just inserts '%' character.</li> </ul> </li> <li><code>defaults-specs</code> token allows overwriting defaults for the underlying formatters with the custom format string. Each override starts with a subentity identifier ('N', 'U', or 'D') followed by the format string enclosed in square brackets.</li> </ul>"},{"location":"users_guide/framework_basics/text_output/#default-formatting","title":"Default formatting","text":"<p>To format <code>quantity</code> values, the formatting facility uses <code>quantity-format-spec</code>. If left empty, the default formatting is applied. The same default formatting is also applied to the output streams. This is why the following code lines produce the same output:</p> <pre><code>std::cout << \"Distance: \" << 123 * km << \"\\n\";\nstd::cout << std::format(\"Distance: {}\\n\", 123 * km);\nstd::cout << std::format(\"Distance: {:%N%?%U}\\n\", 123 * km);\n</code></pre> <p>Note</p> <p>For some quantities, the <code>{:%N %U}</code> format may provide a different output than the default one, as some units have <code>space_before_unit_symbol</code> customization point explicitly set to <code>false</code> (e.g., <code>%</code> and <code>\u00b0</code>).</p>"},{"location":"users_guide/framework_basics/text_output/#quantity-numerical-value-unit-symbol-or-both","title":"Quantity numerical value, unit symbol, or both?","text":"<p>Thanks to the grammar provided above, the user can easily decide to either:</p> <ul> <li> <p>print a whole quantity:</p> <pre><code>std::println(\"Speed: {}\", 120 * km / h);\n</code></pre> <pre><code>Speed: 120 km/h\n</code></pre> </li> <li> <p>provide custom quantity formatting:</p> <pre><code>std::println(\"Speed: {:%N in %U}\", 120 * km / h);\n</code></pre> <pre><code>Speed: 120 in km/h\n</code></pre> </li> <li> <p>provide custom formatting for components:</p> <pre><code>std::println(\"Speed: {::N[.2f]U[n]}\", 100. * km / (3 * h));\n</code></pre> <pre><code>Speed: 33.33 km h\u207b\u00b9\n</code></pre> </li> <li> <p>print only specific components (numerical value, unit, or dimension):</p> <pre><code>std::println(\"Speed:\\n- number: {0:%N}\\n- unit: {0:%U}\\n- dimension: {0:%D}\", 120 * km / h);\n</code></pre> <pre><code>Speed:\n- number: 120\n- unit: km/h\n- dimension: LT\u207b\u00b9\n</code></pre> </li> </ul>"},{"location":"users_guide/framework_basics/text_output/#formatting-of-the-quantity-numerical-value","title":"Formatting of the quantity numerical value","text":"<p>The representation type used as a numerical value of a quantity must provide its own formatter specialization. It will be called by the quantity formatter with the format-spec provided by the user in the <code>N</code> defaults specification.</p> <p>In case we use C++ fundamental arithmetic types with our quantities the standard formatter specified in format.string.std will be used. The rest of this chapter assumes that it is the case and provides some usage examples.</p> <p><code>sign</code> token allows us to specify how the value's sign is being printed:</p> <pre><code>std::println(\"{0},{0::N[+]},{0::N[-]},{0::N[ ]}\", 1 * m); // 1 m,+1 m,1 m, 1 m\nstd::println(\"{0},{0::N[+]},{0::N[-]},{0::N[ ]}\", -1 * m); // -1 m,-1 m,-1 m,-1 m\n</code></pre> <p>where:</p> <ul> <li><code>+</code> indicates that a sign should be used for both non-negative and negative numbers,</li> <li><code>-</code> indicates that a sign should be used for negative numbers and negative zero only (this is the default behavior),</li> <li><code><space></code> indicates that a leading space should be used for non-negative numbers other than negative zero, and a minus sign for negative numbers and negative zero.</li> </ul> <p><code>precision</code> token is allowed only for floating-point representation types:</p> <pre><code>std::println(\"{::N[.0]}\", 1.2345 * m); // 1 m\nstd::println(\"{::N[.1]}\", 1.2345 * m); // 1 m\nstd::println(\"{::N[.2]}\", 1.2345 * m); // 1.2 m\nstd::println(\"{::N[.3]}\", 1.2345 * m); // 1.23 m\nstd::println(\"{::N[.0f]}\", 1.2345 * m); // 1 m\nstd::println(\"{::N[.1f]}\", 1.2345 * m); // 1.2 m\nstd::println(\"{::N[.2f]}\", 1.2345 * m); // 1.23 m\n</code></pre> <p><code>type</code> specifies how a value of the representation type is being printed. For integral types:</p> <pre><code>std::println(\"{::N[b]}\", 42 * m); // 101010 m\nstd::println(\"{::N[B]}\", 42 * m); // 101010 m\nstd::println(\"{::N[d]}\", 42 * m); // 42 m\nstd::println(\"{::N[o]}\", 42 * m); // 52 m\nstd::println(\"{::N[x]}\", 42 * m); // 2a m\nstd::println(\"{::N[X]}\", 42 * m); // 2A m\n</code></pre> <p>The above can be printed in an alternate version thanks to the <code>#</code> token:</p> <pre><code>std::println(\"{::N[#b]}\", 42 * m); // 0b101010 m\nstd::println(\"{::N[#B]}\", 42 * m); // 0B101010 m\nstd::println(\"{::N[#o]}\", 42 * m); // 052 m\nstd::println(\"{::N[#x]}\", 42 * m); // 0x2a m\nstd::println(\"{::N[#X]}\", 42 * m); // 0X2A m\n</code></pre> <p>For floating-point values, the <code>type</code> token works as follows:</p> <pre><code>std::println(\"{::N[a]}\", 1.2345678 * m); // 1.3c0ca2a5b1d5dp+0 m\nstd::println(\"{::N[.3a]}\", 1.2345678 * m); // 1.3c1p+0 m\nstd::println(\"{::N[A]}\", 1.2345678 * m); // 1.3C0CA2A5B1D5DP+0 m\nstd::println(\"{::N[.3A]}\", 1.2345678 * m); // 1.3C1P+0 m\nstd::println(\"{::N[e]}\", 1.2345678 * m); // 1.234568e+00 m\nstd::println(\"{::N[.3e]}\", 1.2345678 * m); // 1.235e+00 m\nstd::println(\"{::N[E]}\", 1.2345678 * m); // 1.234568E+00 m\nstd::println(\"{::N[.3E]}\", 1.2345678 * m); // 1.235E+00 m\nstd::println(\"{::N[g]}\", 1.2345678 * m); // 1.23457 m\nstd::println(\"{::N[g]}\", 1.2345678e8 * m); // 1.23457e+08 m\nstd::println(\"{::N[.3g]}\", 1.2345678 * m); // 1.23 m\nstd::println(\"{::N[.3g]}\", 1.2345678e8 * m); // 1.23e+08 m\nstd::println(\"{::N[G]}\", 1.2345678 * m); // 1.23457 m\nstd::println(\"{::N[G]}\", 1.2345678e8 * m); // 1.23457E+08 m\nstd::println(\"{::N[.3G]}\", 1.2345678 * m); // 1.23 m\nstd::println(\"{::N[.3G]}\", 1.2345678e8 * m); // 1.23E+08 m\n</code></pre>"},{"location":"users_guide/framework_basics/the_affine_space/","title":"The Affine Space","text":"<p>The affine space has two types of entities:</p> <ul> <li>Point - a position specified with coordinate values (e.g., location, address, etc.)</li> <li>Displacement vectors - the difference between two points (e.g., shift, offset, displacement, duration, etc.)</li> </ul> <p>In the following subchapters, we will often refer to displacement vectors simply as vectors for brevity.</p> <p>Note</p> <p>The displacement vector described here is specific to the affine space theory and is not the same thing as the quantity of a vector character that we discussed in the \"Scalars, vectors, and tensors\" chapter (although, in some cases, those terms may overlap).</p>"},{"location":"users_guide/framework_basics/the_affine_space/#operations-in-the-affine-space","title":"Operations in the affine space","text":"<p>Here are the primary operations one can do in the affine space:</p> <ul> <li>vector + vector -> vector</li> <li>vector - vector -> vector</li> <li>-vector -> vector</li> <li>vector * scalar -> vector</li> <li>scalar * vector -> vector</li> <li>vector / scalar -> vector</li> <li>point - point -> vector</li> <li>point + vector -> point</li> <li>vector + point -> point</li> <li>point - vector -> point</li> </ul> <p>Important</p> <p>It is not possible to:</p> <ul> <li>add two points,</li> <li>subtract a point from a vector,</li> <li>multiply nor divide points with anything else.</li> </ul>"},{"location":"users_guide/framework_basics/the_affine_space/#points-are-more-common-than-most-of-us-imagine","title":"Points are more common than most of us imagine","text":"<p>Point abstractions should be used more often in the C++ software. They are not only about temperature or time. Points are everywhere around us and should become more popular in the products we implement. They can be used to implement:</p> <ul> <li>temperature points,</li> <li>timestamps,</li> <li>daily mass readouts from the scale,</li> <li>altitudes of mountain peaks on a map,</li> <li>current path length measured by the car's odometer,</li> <li>today's price of instruments on the market,</li> <li>and many more.</li> </ul> <p>Improving the affine space's Points intuition will allow us to write better and safer software.</p>"},{"location":"users_guide/framework_basics/the_affine_space/#displacement-vector-is-modeled-by-quantity","title":"Displacement vector is modeled by <code>quantity</code>","text":"<p>Up until now, each time we used a <code>quantity</code> in our code, we were modeling some kind of a difference between two things:</p> <ul> <li>the distance between two points,</li> <li>duration between two time points,</li> <li>the difference in speed (even if relative to zero).</li> </ul> <p>As we already know, a <code>quantity</code> type provides all operations required for a displacement vector abstraction in an affine space.</p>"},{"location":"users_guide/framework_basics/the_affine_space/#point-is-modeled-by-quantity_point-and-pointorigin","title":"Point is modeled by <code>quantity_point</code> and <code>PointOrigin</code>","text":"<p>In the mp-units library, the Point abstraction is modelled by:</p> <ul> <li><code>PointOrigin</code> concept that specifies measurement origin, and</li> <li><code>quantity_point</code> class template that specifies a Point relative to a specific predefined origin.</li> </ul>"},{"location":"users_guide/framework_basics/the_affine_space/#quantity_point","title":"<code>quantity_point</code>","text":"<p>The <code>quantity_point</code> class template specifies an absolute quantity measured from a predefined origin:</p> <pre><code>template<Reference auto R,\n PointOriginFor<get_quantity_spec(R)> auto PO = default_point_origin(R),\n RepresentationOf<get_quantity_spec(R).character> Rep = double>\nclass quantity_point;\n</code></pre> <p>As we can see above, the <code>quantity_point</code> class template exposes one additional parameter compared to <code>quantity</code>. The <code>PO</code> parameter satisfies a <code>PointOriginFor</code> concept and specifies the origin of our measurement scale.</p> <p>Each <code>quantity_point</code> internally stores a <code>quantity</code> object, which represents a displacement vector from the predefined origin. Thanks to this, an instantiation of a <code>quantity_point</code> can be considered as a model of a vector space from such an origin.</p> <p>Forcing the user to manually predefine an origin for every domain may be cumbersome and discourage users from using such abstractions at all. This is why, by default, the <code>PO</code> template parameter is initialized with the <code>default_point_origin(R)</code> that provides the quantity points' scale zeroth point using the following rules:</p> <ul> <li>if the measurement unit of a quantity specifies its point origin in its definition (e.g., degree Celsius), then this origin is being used,</li> <li>otherwise, an instantiation of <code>zeroth_point_origin<QuantitySpec></code> is being used which provides a well-established zeroth point for a specific quantity type.</li> </ul> <p>Tip</p> <p>The <code>quantity_point</code> definition can be found in the <code>mp-units/quantity_point.h</code> header file.</p>"},{"location":"users_guide/framework_basics/the_affine_space/#zeroth_point_originquantityspec","title":"<code>zeroth_point_origin<QuantitySpec></code>","text":"<p><code>zeroth_point_origin<QuantitySpec></code> is meant to be used in cases where the specific domain has a well-established, non-controversial, and unique zeroth point on the measurement scale. This saves the user from the need to write a boilerplate code that would predefine such a type for this domain.</p> <p></p> <pre><code>quantity_point<isq::distance[si::metre]> qp1{100 * m};\nquantity_point<isq::distance[si::metre]> qp2{120 * m};\n\nassert(qp1.quantity_from_zero() == 100 * m);\nassert(qp2.quantity_from_zero() == 120 * m);\nassert(qp2.quantity_from(qp1) == 20 * m);\nassert(qp1.quantity_from(qp2) == -20 * m);\n\nassert(qp2 - qp1 == 20 * m);\nassert(qp1 - qp2 == -20 * m);\n\n// auto res = qp1 + qp2; // Compile-time error\n</code></pre> <p>In the above code <code>100 * m</code> and <code>120 * m</code> still create two quantities that serve as displacement vectors here. Quantity point objects can be explicitly constructed from such quantities only when their origin is an instantiation of the <code>zeroth_point_origin<QuantitySpec></code>.</p> <p>It is really important to understand that even though we can use <code>.quantity_from_zero()</code> to obtain the displacement vector of a point from the origin, the point by itself does not represent or have any associated physical value. It is just a point in some space. The same point can be expressed with different displacement vectors from different origins.</p> <p>It is also worth mentioning that simplicity comes with a safety cost here. For some users, it might be surprising that the usage of <code>zeroth_point_origin<QuantitySpec></code> makes various quantity point objects compatible as long as quantity types used in the origin and reference are compatible:</p> <pre><code>quantity_point<si::metre> qp1{isq::distance(100 * m)};\nquantity_point<si::metre> qp2{isq::height(120 * m)};\n\nassert(qp2.quantity_from(qp1) == 20 * m);\nassert(qp1.quantity_from(qp2) == -20 * m);\nassert(qp2 - qp1 == 20 * m);\nassert(qp1 - qp2 == -20 * m);\n</code></pre>"},{"location":"users_guide/framework_basics/the_affine_space/#absolute-point-origin","title":"Absolute point origin","text":"<p>In cases where we want to implement an isolated independent space in which points are not compatible with other spaces, even of the same quantity type, we should manually predefine an absolute point origin.</p> <p></p> <pre><code>inline constexpr struct origin final : absolute_point_origin<isq::distance> {} origin;\n\n// quantity_point<si::metre, origin> qp1{100 * m}; // Compile-time error\n// quantity_point<si::metre, origin> qp2{120 * m}; // Compile-time error\nquantity_point<si::metre, origin> qp1 = origin + 100 * m;\nquantity_point<si::metre, origin> qp2 = 120 * m + origin;\n\n// assert(qp1.quantity_from_zero() == 100 * m); // Compile-time error\n// assert(qp2.quantity_from_zero() == 120 * m); // Compile-time error\nassert(qp1.quantity_from(origin) == 100 * m);\nassert(qp2.quantity_from(origin) == 120 * m);\nassert(qp2.quantity_from(qp1) == 20 * m);\nassert(qp1.quantity_from(qp2) == -20 * m);\n\nassert(qp1 - origin == 100 * m);\nassert(qp2 - origin == 120 * m);\nassert(qp2 - qp1 == 20 * m);\nassert(qp1 - qp2 == -20 * m);\n\nassert(origin - qp1 == -100 * m);\nassert(origin - qp2 == -120 * m);\n\n// assert(origin - origin == 0 * m); // Compile-time error\n</code></pre> <p>We can't construct a quantity point directly from the quantity anymore when a custom, named origin is used. To prevent potential safety and maintenance issues, we always need to explicitly provide both a compatible origin and a quantity measured from it to construct a quantity point.</p> <p>Said otherwise, a quantity point defined in terms of a specific origin is the result of adding the origin and the displacement vector measured from it to the point we create.</p> <p>Info</p> <p>A rationale for this longer construction syntax can be found in the Why can't I create a quantity by passing a number to a constructor? chapter.</p> <p>Similarly to creation of a quantity, if someone does not like the operator-based syntax to create a <code>quantity_point</code>, the same results can be achieved with a two-parameter constructor:</p> <pre><code>quantity_point qp1{100 * m, origin};\n</code></pre> <p>Again, CTAD always helps to use precisely the type we need in a current case.</p> <p>Additionally, if a quantity point is defined in terms of a custom, named origin, then we can't use a <code>quantity_from_zero()</code> member function anymore. This is to prevent surprises, as our origin may not necessarily be perceived as an absolute zero in the domain we model. Also, as we will learn soon, we can define several related origins in one space, and then it gets harder to understand which one is the \"zero\" one. This is why, to be specific and always correct about the points we use, a <code>quantity_from(QP)</code> member function can be used (where <code>QP</code> can either be an origin or another quantity point).</p> <p>Finally, please note that it is not allowed to subtract two point origins defined in terms of <code>absolute_point_origin</code> (e.g., <code>origin - origin</code>) as those do not contain information about the unit, so we cannot determine a resulting <code>quantity</code> type.</p>"},{"location":"users_guide/framework_basics/the_affine_space/#modeling-independent-spaces-in-one-domain","title":"Modeling independent spaces in one domain","text":"<p>Absolute point origins are also perfect for establishing independent spaces even if the same quantity type and unit is being used:</p> <p></p> <pre><code>inline constexpr struct origin1 final : absolute_point_origin<isq::distance> {} origin1;\ninline constexpr struct origin2 final : absolute_point_origin<isq::distance> {} origin2;\n\nquantity_point qp1 = origin1 + 100 * m;\nquantity_point qp2 = origin2 + 120 * m;\n\nassert(qp1.quantity_from(origin1) == 100 * m);\nassert(qp2.quantity_from(origin2) == 120 * m);\n\nassert(qp1 - origin1 == 100 * m);\nassert(qp2 - origin2 == 120 * m);\nassert(origin1 - qp1 == -100 * m);\nassert(origin2 - qp2 == -120 * m);\n\n// assert(qp2 - qp1 == 20 * m); // Compile-time error\n// assert(qp1 - origin2 == 100 * m); // Compile-time error\n// assert(qp2 - origin1 == 120 * m); // Compile-time error\n// assert(qp2.quantity_from(qp1) == 20 * m); // Compile-time error\n// assert(qp1.quantity_from(origin2) == 100 * m); // Compile-time error\n// assert(qp2.quantity_from(origin1) == 120 * m); // Compile-time error\n</code></pre>"},{"location":"users_guide/framework_basics/the_affine_space/#relative-point-origin","title":"Relative Point origin","text":"<p>We often do not have only one ultimate \"zero\" point when we measure things. Often, we have one common scale, but we measure various quantities relative to different points and expect those points to be compatible. There are many examples here, but probably the most common are temperatures, timestamps, and altitudes.</p> <p>For such cases, relative point origins should be used:</p> <p></p> <pre><code>inline constexpr struct A final : absolute_point_origin<isq::distance> {} A;\ninline constexpr struct B final : relative_point_origin<A + 10 * m> {} B;\ninline constexpr struct C final : relative_point_origin<B + 10 * m> {} C;\ninline constexpr struct D final : relative_point_origin<A + 30 * m> {} D;\n\nquantity_point qp1 = C + 100 * m;\nquantity_point qp2 = D + 120 * m;\n\nassert(qp1.quantity_ref_from(qp1.point_origin) == 100 * m);\nassert(qp2.quantity_ref_from(qp2.point_origin) == 120 * m);\n\nassert(qp2.quantity_from(qp1) == 30 * m);\nassert(qp1.quantity_from(qp2) == -30 * m);\nassert(qp2 - qp1 == 30 * m);\nassert(qp1 - qp2 == -30 * m);\n\nassert(qp1.quantity_from(A) == 120 * m);\nassert(qp1.quantity_from(B) == 110 * m);\nassert(qp1.quantity_from(C) == 100 * m);\nassert(qp1.quantity_from(D) == 90 * m);\nassert(qp1 - A == 120 * m);\nassert(qp1 - B == 110 * m);\nassert(qp1 - C == 100 * m);\nassert(qp1 - D == 90 * m);\n\nassert(qp2.quantity_from(A) == 150 * m);\nassert(qp2.quantity_from(B) == 140 * m);\nassert(qp2.quantity_from(C) == 130 * m);\nassert(qp2.quantity_from(D) == 120 * m);\nassert(qp2 - A == 150 * m);\nassert(qp2 - B == 140 * m);\nassert(qp2 - C == 130 * m);\nassert(qp2 - D == 120 * m);\n\nassert(B - A == 10 * m);\nassert(C - A == 20 * m);\nassert(D - A == 30 * m);\nassert(D - C == 10 * m);\n\nassert(B - B == 0 * m);\n// assert(A - A == 0 * m); // Compile-time error\n</code></pre> <p>Note</p> <p>Even though we can't subtract two absolute point origins from each other, it is possible to subtract relative ones or relative and absolute ones.</p>"},{"location":"users_guide/framework_basics/the_affine_space/#converting-between-different-representations-of-the-same-point","title":"Converting between different representations of the same point","text":"<p>As we might represent the same point with displacement vectors from various origins, the library provides facilities to convert the same point to the <code>quantity_point</code> class templates expressed in terms of different origins.</p> <p></p> <p>For this purpose, we can use either:</p> <ul> <li> <p>A converting constructor:</p> <pre><code>quantity_point<si::metre, C> qp2C = qp2;\nassert(qp2C.quantity_ref_from(qp2C.point_origin) == 130 * m);\n</code></pre> </li> <li> <p>A dedicated conversion interface:</p> <pre><code>quantity_point qp2B = qp2.point_for(B);\nquantity_point qp2A = qp2.point_for(A);\n\nassert(qp2B.quantity_ref_from(qp2B.point_origin) == 140 * m);\nassert(qp2A.quantity_ref_from(qp2A.point_origin) == 150 * m);\n</code></pre> </li> </ul> <p>It is important to understand that all such translations still describe exactly the same point (e.g., all of them compare equal):</p> <pre><code>assert(qp2 == qp2C);\nassert(qp2 == qp2B);\nassert(qp2 == qp2A);\n</code></pre> <p>Important</p> <p>It is only allowed to convert between various origins defined in terms of the same <code>absolute_point_origin</code>. Even if it is possible to express the same point as a displacement vector from another <code>absolute_point_origin</code>, the library will not provide such a conversion. A custom user-defined conversion function will be needed to add such a functionality.</p> <p>Said another way, in the library, there is no way to spell how two distinct <code>absolute_point_origin</code> types relate to each other.</p>"},{"location":"users_guide/framework_basics/the_affine_space/#temperature-support","title":"Temperature support","text":"<p>Support for temperature quantity points is probably one of the most common examples of relative point origins in action that we use in daily life.</p> <p>The SI definition in the library provides a few predefined point origins for this purpose:</p> <pre><code>namespace si {\n\ninline constexpr struct absolute_zero final : absolute_point_origin<isq::thermodynamic_temperature> {} absolute_zero;\ninline constexpr auto zeroth_kelvin = absolute_zero;\n\ninline constexpr struct ice_point final : relative_point_origin<quantity_point{273'150 * milli<kelvin>}> {} ice_point;\ninline constexpr auto zeroth_degree_Celsius = ice_point;\n\n}\n\nnamespace usc {\n\ninline constexpr struct zeroth_degree_Fahrenheit final :\n relative_point_origin<quantity_point{-32 * (mag_ratio<5, 9> * si::degree_Celsius)}> {} zeroth_degree_Fahrenheit;\n\n}\n</code></pre> <p>The above is a great example of how point origins can be stacked on top of each other:</p> <ul> <li><code>usc::zeroth_degree_Fahrenheit</code> is defined relative to <code>si::zeroth_degree_Celsius</code></li> <li><code>si::zeroth_degree_Celsius</code> is defined relative to <code>si::zeroth_kelvin</code>.</li> </ul> <p>Note</p> <p>Notice that while stacking point origins, we can use different representation types and units for origins and a point. In the above example, the relative point origin for degree Celsius is defined in terms of <code>si::kelvin</code>, while the quantity point for it will use <code>si::degree_Celsius</code> as a unit.</p> <p>The temperature point origins defined above are provided explicitly in the respective units' definitions:</p> <pre><code>namespace si {\n\ninline constexpr struct kelvin final :\n named_unit<\"K\", kind_of<isq::thermodynamic_temperature>, zeroth_kelvin> {} kelvin;\ninline constexpr struct degree_Celsius final :\n named_unit<{u8\"\u00b0C\", \"`C\"}, kelvin, zeroth_degree_Celsius> {} degree_Celsius;\n\n}\n\nnamespace usc {\n\ninline constexpr struct degree_Fahrenheit final :\n named_unit<{u8\"\u00b0F\", \"`F\"}, mag_ratio<5, 9> * si::degree_Celsius,\n zeroth_degree_Fahrenheit> {} degree_Fahrenheit;\n\n}\n</code></pre> <p>As it was described above, <code>default_point_origin(R)</code> returns a <code>zeroth_point_origin<QuantitySpec></code> when a unit does not provide any origin in its definition. As of today, the units of temperature are the only ones in the entire mp-units library that provide such origins.</p> <p>Now, let's see how we can benefit from the above definitions. We have quite a few alternatives to choose from here. Depending on our needs or tastes, we can:</p> <ul> <li> <p>be explicit about the unit and origin:</p> <pre><code>quantity_point<si::degree_Celsius, si::zeroth_degree_Celsius> q1 = si::zeroth_degree_Celsius + 20.5 * deg_C;\nquantity_point<si::degree_Celsius, si::zeroth_degree_Celsius> q2 = {20.5 * deg_C, si::zeroth_degree_Celsius};\nquantity_point<si::degree_Celsius, si::zeroth_degree_Celsius> q3{20.5 * deg_C};\n</code></pre> </li> <li> <p>specify a unit and use its zeroth point origin implicitly:</p> <pre><code>quantity_point<si::degree_Celsius> q4 = si::zeroth_degree_Celsius + 20.5 * deg_C;\nquantity_point<si::degree_Celsius> q5 = {20.5 * deg_C, si::zeroth_degree_Celsius};\nquantity_point<si::degree_Celsius> q6{20.5 * deg_C};\n</code></pre> </li> <li> <p>benefit from CTAD:</p> <pre><code>quantity_point q7 = si::zeroth_degree_Celsius + 20.5 * deg_C;\nquantity_point q8 = {20.5 * deg_C, si::zeroth_degree_Celsius};\nquantity_point q9{20.5 * deg_C};\n</code></pre> </li> </ul> <p>In all of the above cases, we end up with the <code>quantity_point</code> of the same type and value.</p> <p>To play a bit more with temperatures, we can implement a simple room AC temperature controller in the following way:</p> <p></p> <pre><code>constexpr struct room_reference_temp final : relative_point_origin<quantity_point{21 * deg_C}> {} room_reference_temp;\nusing room_temp = quantity_point<isq::Celsius_temperature[deg_C], room_reference_temp>;\n\nconstexpr auto step_delta = isq::Celsius_temperature(0.5 * deg_C);\nconstexpr int number_of_steps = 6;\n\nroom_temp room_ref{};\nroom_temp room_low = room_ref - number_of_steps * step_delta;\nroom_temp room_high = room_ref + number_of_steps * step_delta;\n\nstd::println(\"Room reference temperature: {} ({}, {::N[.2f]})\\n\",\n room_ref.quantity_from_zero(),\n room_ref.in(usc::degree_Fahrenheit).quantity_from_zero(),\n room_ref.in(si::kelvin).quantity_from_zero());\n\nstd::println(\"| {:<18} | {:^18} | {:^18} | {:^18} |\",\n \"Temperature delta\", \"Room reference\", \"Ice point\", \"Absolute zero\");\nstd::println(\"|{0:=^20}|{0:=^20}|{0:=^20}|{0:=^20}|\", \"\");\n\nauto print_temp = [&](std::string_view label, auto v) {\n std::println(\"| {:<14} | {:^18} | {:^18} | {:^18:N[.2f]} |\", label,\n v - room_reference_temp, (v - si::ice_point).in(deg_C), (v - si::absolute_zero).in(deg_C));\n};\n\nprint_temp(\"Lowest\", room_low);\nprint_temp(\"Default\", room_ref);\nprint_temp(\"Highest\", room_high);\n</code></pre> <p>The above prints:</p> <pre><code>Room reference temperature: 21 \u00b0C (69.8 \u00b0F, 294.15 K)\n\n| Temperature delta | Room reference | Ice point | Absolute zero |\n|====================|====================|====================|====================|\n| Lowest | -3 \u00b0C | 18 \u00b0C | 291.15 \u00b0C |\n| Default | 0 \u00b0C | 21 \u00b0C | 294.15 \u00b0C |\n| Highest | 3 \u00b0C | 24 \u00b0C | 297.15 \u00b0C |\n</code></pre>"},{"location":"users_guide/framework_basics/the_affine_space/#no-text-output-for-points","title":"No text output for Points","text":"<p>The library does not provide a text output for quantity points. The quantity stored inside is just an implementation detail of this type. It is a vector from a specific origin. Without the knowledge of the origin, the vector by itself is useless as we can't determine which point it describes.</p> <p>In the current library design, point origin does not provide any text in its definition. Even if we could add such information to the point's definition, we would not know how to output it in the text. There may be many ways to do it. For example, should we prepend or append the origin part to the quantity text?</p> <p>For example, the text output of <code>42 m</code> for a quantity point may mean many things. It may be an offset from the mountain top, sea level, or maybe the center of Mars. Printing <code>42 m AMSL</code> for altitudes above mean sea level is a much better solution, but the library does not have enough information to print it that way by itself.</p>"},{"location":"users_guide/framework_basics/the_affine_space/#the-affine-space-is-about-type-safety","title":"The affine space is about type-safety","text":"<p>The following operations are not allowed in the affine space:</p> <ul> <li>adding two <code>quantity_point</code> objects<ul> <li>It is physically impossible to add positions of home and Denver airports.</li> </ul> </li> <li>subtracting a <code>quantity_point</code> from a <code>quantity</code><ul> <li>What would it mean to subtract the DEN airport location from the distance to it?</li> </ul> </li> <li>multiplying/dividing a <code>quantity_point</code> with a scalar<ul> <li>What is the position of <code>2 *</code> DEN airport location?</li> </ul> </li> <li>multiplying/dividing a <code>quantity_point</code> with a quantity<ul> <li>What would multiplying the distance with the DEN airport location mean?</li> </ul> </li> <li>multiplying/dividing two <code>quantity_point</code> objects<ul> <li>What would multiplying home and DEN airport location mean?</li> </ul> </li> <li>mixing <code>quantity_points</code> of different quantity kinds<ul> <li>It is physically impossible to subtract time from length.</li> </ul> </li> <li>mixing <code>quantity_points</code> of inconvertible quantities<ul> <li>What does subtracting a distance point to DEN airport from the Mount Everest base camp altitude mean?</li> </ul> </li> <li>mixing <code>quantity_points</code> of convertible quantities but with unrelated origins<ul> <li>How do we subtract a point on our trip to CppCon measured relatively to our home location from a point measured relative to the center of the Solar System?</li> </ul> </li> </ul> <p>Important: The affine space improves safety</p> <p>The usage of <code>quantity_point</code> and affine space types, in general, improves expressiveness and type-safety of the code we write.</p>"},{"location":"users_guide/framework_basics/value_conversions/","title":"Value Conversions","text":""},{"location":"users_guide/framework_basics/value_conversions/#value-preserving-conversions","title":"Value-preserving conversions","text":"<pre><code>auto q1 = 5 * km;\nstd::cout << q1.in(m) << '\\n';\nquantity<si::metre, int> q2 = q1;\n</code></pre> <p>The second line above converts the current quantity to the one expressed in meters and prints its contents. The third line converts the quantity expressed in kilometers into the one measured in meters.</p> <p>In case a user would like to perform an opposite transformation:</p> <pre><code>auto q1 = 5 * m;\nstd::cout << q1.in(km) << '\\n';\nquantity<si::kilo<si::metre>, int> q2 = q1;\n</code></pre> <p>Both conversions will fail to compile.</p> <p>There are two ways to make the above work. The first solution is to use a floating-point representation type:</p> <pre><code>auto q1 = 5. * m;\nstd::cout << q1.in(km) << '\\n';\nquantity<si::kilo<si::metre>> q2 = q1;\n</code></pre> <p>or</p> <pre><code>auto q1 = 5 * m;\nstd::cout << value_cast<double>(q1).in(km) << '\\n';\nquantity<si::kilo<si::metre>> q2 = q1; // double by default\n</code></pre> <p>Important</p> <p>The mp-units library follows <code>std::chrono::duration</code> logic and treats floating-point types as value-preserving.</p>"},{"location":"users_guide/framework_basics/value_conversions/#value-truncating-conversions","title":"Value-truncating conversions","text":"<p>The second solution is to force a truncating conversion:</p> <pre><code>auto q1 = 5 * m;\nstd::cout << value_cast<km>(q1) << '\\n';\nquantity<si::kilo<si::metre>, int> q2 = q1.force_in(km);\n</code></pre> <p>This explicit cast makes it clear that something unsafe is going on. It is easy to spot in code reviews or while chasing a bug in the source code.</p> <p>Note</p> <p><code>q.force_in(U)</code> is just a shortcut to run <code>value_cast<U>(q)</code>. There is no difference in behavior between those two interfaces. <code>q.force_in(U)</code> was added for consistency with <code>q.in(U)</code> and <code>q.force_numerical_value_in(U)</code>.</p> <p>Another place where this cast is useful is when a user wants to convert a quantity with a floating-point representation to the one using an integral one. Again, this is a truncating conversion, so an explicit cast is needed:</p> <pre><code>quantity<si::metre, int> q3 = value_cast<int>(3.14 * m);\n</code></pre> <p>Info</p> <p>It is often OK to use an integral as a representation type, but in general, floating-point types provide better precision and are privileged in the library as they are considered to be value-preserving.</p> <p>In some cases, a unit and a representation type should be changed simultaneously. Moreover, sometimes, the order of doing those operations matters. In such cases, the library provides the <code>value_cast<U, Rep>(q)</code> which always returns the most precise result:</p> C++23C++20Portable <pre><code>inline constexpr struct dim_currency final : base_dimension<\"$\"> {} dim_currency;\ninline constexpr struct currency final : quantity_spec<dim_currency> {} currency;\n\ninline constexpr struct us_dollar final : named_unit<\"USD\", kind_of<currency>> {} us_dollar;\ninline constexpr struct scaled_us_dollar final : named_unit<\"USD_s\", mag_power<10, -8> * us_dollar> {} scaled_us_dollar;\n\nnamespace unit_symbols {\n\ninline constexpr auto USD = us_dollar;\ninline constexpr auto USD_s = scaled_us_dollar;\n\n} // namespace unit_symbols\n\nusing Price = quantity_point<currency[us_dollar]>;\nusing Scaled = quantity_point<currency[scaled_us_dollar], zeroth_point_origin<currency>, std::int64_t>;\n</code></pre> <pre><code>inline constexpr struct dim_currency final : base_dimension<\"$\"> {} dim_currency;\ninline constexpr struct currency final : quantity_spec<currency, dim_currency> {} currency;\n\ninline constexpr struct us_dollar final : named_unit<\"USD\", kind_of<currency>> {} us_dollar;\ninline constexpr struct scaled_us_dollar final : named_unit<\"USD_s\", mag_power<10, -8> * us_dollar> {} scaled_us_dollar;\n\nnamespace unit_symbols {\n\ninline constexpr auto USD = us_dollar;\ninline constexpr auto USD_s = scaled_us_dollar;\n\n} // namespace unit_symbols\n\nusing Price = quantity_point<currency[us_dollar]>;\nusing Scaled = quantity_point<currency[scaled_us_dollar], zeroth_point_origin<currency>, std::int64_t>;\n</code></pre> <pre><code>inline constexpr struct dim_currency final : base_dimension<\"$\"> {} dim_currency;\nQUANTITY_SPEC(currency, dim_currency);\n\ninline constexpr struct us_dollar final : named_unit<\"USD\", kind_of<currency>> {} us_dollar;\ninline constexpr struct scaled_us_dollar final : named_unit<\"USD_s\", mag_power<10, -8> * us_dollar> {} scaled_us_dollar;\n\nnamespace unit_symbols {\n\ninline constexpr auto USD = us_dollar;\ninline constexpr auto USD_s = scaled_us_dollar;\n\n} // namespace unit_symbols\n\nusing Price = quantity_point<currency[us_dollar]>;\nusing Scaled = quantity_point<currency[scaled_us_dollar], zeroth_point_origin<currency>, std::int64_t>;\n</code></pre> <pre><code>using namespace unit_symbols;\nPrice price{12.95 * USD};\nScaled spx = value_cast<USD_s, std::int64_t>(price);\n</code></pre> <p>As a shortcut, instead of providing a unit and a representation type to <code>value_cast</code>, you may also provide a <code>Quantity</code> type directly, from which unit and representation type are taken. However, <code>value_cast<Quantity></code>, still only allows for changes in unit and representation type, but not changing the type of the quantity. For that, you will have to use a <code>quantity_cast</code> instead.</p> <p>Overloads are also provided for instances of <code>quantity_point</code>. All variants of <code>value_cast<...>(q)</code> that apply to instances of <code>quantity</code> have a corresponding version applicable to <code>quantity_point</code>, where the <code>point_origin</code> remains untouched, and the cast changes how the \"offset\" from the origin is represented. Specifically, for any <code>quantity_point</code> instance <code>qp</code>, all of the following equivalences hold: <pre><code>static_assert( value_cast<Rep>(qp) == quantity_point{value_cast<Rep>(qp.quantity_from(qp.point_origin)), qp.point_origin} );\nstatic_assert( value_cast<U>(qp) == quantity_point{value_cast<U>(qp.quantity_from(qp.point_origin)), qp.point_origin} );\nstatic_assert( value_cast<U, Rep>(qp) == quantity_point{value_cast<U, Rep>(qp.quantity_from(qp.point_origin)), qp.point_origin} );\nstatic_assert( value_cast<Q>(qp) == quantity_point{value_cast<Q>(qp.quantity_from(qp.point_origin)), qp.point_origin} );\n</code></pre></p> <p>Furthermore, there is one additional overload <code>value_cast<ToQP>(qp)</code>. This overload permits to additionally replace the <code>point_origin</code> with another compatible one, while still representing the same point in the affine space. Thus, it is roughly equivalent to <code>value_cast<ToQP::unit, ToQP::rep>(qp).point_for(ToQP::point_origin)</code>. In contrast to a separate <code>value_cast</code> followed by <code>point_for</code> (or vice-versa), the combined <code>value_cast</code> tries to choose the order of the individual conversion steps in a way to avoid both overflow and unnecessary loss of precision. Overflow is a risk because the change of origin point may require an addition of a potentially large offset (the difference between the origin points), which may well be outside the range of one or both quantity types.</p>"},{"location":"users_guide/use_cases/interoperability_with_other_libraries/","title":"Interoperability with Other Libraries","text":"<p>mp-units makes it easy to cooperate with similar entities of other libraries. No matter if we want to provide interoperability with a simple home-grown strongly typed wrapper type (e.g., <code>Meter</code>, <code>Timestamp</code>, ...) or with a feature-rich quantities and units library, we have to provide specializations of:</p> <ul> <li>a <code>quantity_like_traits</code> for external <code>quantity</code>-like type,</li> <li>a <code>quantity_point_like_traits</code> for external <code>quantity_point</code>-like type.</li> </ul>"},{"location":"users_guide/use_cases/interoperability_with_other_libraries/#specifying-a-conversion-kind","title":"Specifying a conversion kind","text":"<p>Before we delve into the template specialization details, let's first decide if we want the conversions to happen implicitly or if explicit ones would be a better choice. Or maybe the conversion should be implicit in one direction only (e.g., into mp-units abstractions) while the explicit conversions in the other direction should be preferred?</p> <p>There is no one unified answer to the above questions. Everything depends on the use case.</p> <p>Typically, the implicit conversions are allowed in cases where:</p> <ul> <li>both abstractions mean exactly the same, and interchanging them in the code should not change its logic,</li> <li>there is no significant runtime overhead introduced by such a conversion (e.g., no need for dynamic allocation or copying of huge internal buffers),</li> <li>the target type of the conversion provides the same or better safety to the users,</li> <li>we prefer the simplicity of implicit conversions over safety during the (hopefully short) transition period of refactoring our code base from the usage of one library to the other.</li> </ul> <p>In all other scenarios, we should probably enforce explicit conversions.</p> <p>The kinds of inter-library conversions can be easily configured in partial specializations of conversion traits in the mp-units library. To require an explicit conversion, the return type of the conversion function should be wrapped in <code>convert_explicitly<T></code>. Otherwise, <code>convert_implicitly<T></code> should be used.</p>"},{"location":"users_guide/use_cases/interoperability_with_other_libraries/#quantities-conversions","title":"Quantities conversions","text":"<p>For example, let's assume that some company has its own <code>Meter</code> strong-type wrapper:</p> <pre><code>struct Meter {\n int value;\n};\n</code></pre> <p>As every usage of <code>Meter</code> is at least as good and safe as the usage of <code>quantity<si::metre, int></code>, and as there is no significant runtime performance penalty, we would like to allow the conversion to <code>mp_units::quantity</code> to happen implicitly.</p> <p>On the other hand, the <code>quantity</code> type is much safer than the <code>Meter</code>, and that is why we would prefer to see the opposite conversions stated explicitly in our code.</p> <p>To enable such interoperability, we must define a partial specialization of the <code>quantity_like_traits<T></code> type trait. Such specialization should provide:</p> <ul> <li>static data member <code>reference</code> that provides the quantity reference (e.g., unit),</li> <li><code>rep</code> type that specifies the underlying storage type,</li> <li><code>to_numerical_value(T)</code> static member function returning a quantity's raw value of <code>rep</code> type packed in either <code>convert_explicitly</code> or <code>convert_implicitly</code> wrapper.</li> <li><code>from_numerical_value(rep)</code> static member function returning <code>T</code> packed in either <code>convert_explicitly</code> or <code>convert_implicitly</code> wrapper.</li> </ul> <p>For example, for our <code>Meter</code> type, we could provide the following:</p> <pre><code>template<>\nstruct mp_units::quantity_like_traits<Meter> {\n static constexpr auto reference = si::metre;\n using rep = decltype(Meter::value);\n static constexpr convert_implicitly<rep> to_numerical_value(Meter m) { return m.value; }\n static constexpr convert_explicitly<Meter> from_numerical_value(rep v) { return Meter{v}; }\n};\n</code></pre> <p>After that, we can check that the <code>QuantityLike</code> concept is satisfied:</p> <pre><code>static_assert(mp_units::QuantityLike<Meter>);\n</code></pre> <p>and we can write the following:</p> <pre><code>void print(Meter m) { std::cout << m.value << \" m\\n\"; }\n\nint main()\n{\n using namespace mp_units;\n using namespace mp_units::si::unit_symbols;\n\n Meter height{42};\n\n // implicit conversions\n quantity h1 = height;\n quantity<isq::height[m], int> h2 = height;\n\n std::cout << h1 << \"\\n\";\n std::cout << h2 << \"\\n\";\n\n // explicit conversions\n print(Meter(h1));\n print(Meter(h2));\n}\n</code></pre> <p>Note</p> <p>No matter if we decide to use implicit or explicit conversions, the mp-units will not allow unsafe operations to happen.</p> <p>If we extend the above example with unsafe conversions, the code will not compile, and we will have to fix the issues first before the conversion may be performed:</p> UnsafeFixed <pre><code>quantity<isq::height[m]> h3 = height;\nquantity<isq::height[mm], int> h4 = height;\nquantity<isq::height[km], int> h5 = height; // Compile-time error (1)\n\nstd::cout << h3 << \"\\n\";\nstd::cout << h4 << \"\\n\";\nstd::cout << h5 << \"\\n\";\n\nprint(Meter(h3)); // Compile-time error (2)\nprint(Meter(h4)); // Compile-time error (3)\nprint(Meter(h5));\n</code></pre> <ol> <li>Truncation of value while converting from meters to kilometers.</li> <li>Conversion of <code>double</code> to <code>int</code> is not value-preserving.</li> <li>Truncation of value while converting from millimeters to meters.</li> </ol> <pre><code>quantity<isq::height[m]> h3 = height;\nquantity<isq::height[mm], int> h4 = height;\nquantity<isq::height[km], int> h5 = quantity{height}.force_in(km);\n\nstd::cout << h3 << \"\\n\";\nstd::cout << h4 << \"\\n\";\nstd::cout << h5 << \"\\n\";\n\nprint(Meter(value_cast<int>(h3)));\nprint(Meter(h4.force_in(m)));\nprint(Meter(h5));\n</code></pre>"},{"location":"users_guide/use_cases/interoperability_with_other_libraries/#quantity-points-conversions","title":"Quantity points conversions","text":"<p>To play with quantity point conversions, let's assume that we have a <code>Timestamp</code> strong type in our codebase, and we would like to start using mp-units to work with this abstraction.</p> <pre><code>struct Timestamp {\n int seconds;\n};\n</code></pre> <p>As we described in The Affine Space chapter, timestamps should be modeled as quantity points rather than regular quantities.</p> <p>To allow the conversion between our custom <code>Timestamp</code> type and the <code>quantity_point</code> class template we need to provide the following in the partial specialization of the <code>quantity_point_like_traits<T></code> type trait:</p> <ul> <li>static data member <code>reference</code> that provides the quantity point reference (e.g., unit),</li> <li>static data member <code>point_origin</code> that specifies the absolute point, which is the beginning of our measurement scale for our points,</li> <li><code>rep</code> type that specifies the underlying storage type,</li> <li><code>to_quantity(T)</code> static member function returning the <code>quantity</code> being the offset of the point from the origin packed in either <code>convert_explicitly</code> or <code>convert_implicitly</code> wrapper,</li> <li><code>from_quantity(quantity<reference, rep>)</code> static member function returning <code>T</code> packed in either <code>convert_explicitly</code> or <code>convert_implicitly</code> wrapper.</li> </ul> <p>For example, for our <code>Timestamp</code> type, we could provide the following:</p> <pre><code>template<>\nstruct mp_units::quantity_point_like_traits<Timestamp> {\n static constexpr auto reference = si::second;\n static constexpr auto point_origin = default_point_origin(reference);\n using rep = decltype(Timestamp::seconds);\n\n static constexpr convert_implicitly<quantity<reference, rep>> to_quantity(Timestamp ts)\n {\n return ts.seconds * si::second;\n }\n\n static constexpr convert_explicitly<Timestamp> from_quantity(quantity<reference, rep> q)\n {\n return Timestamp(q.numerical_value_ref_in(si::second));\n }\n};\n</code></pre> <p>After that, we can check that the <code>QuantityPointLike</code> concept is satisfied:</p> <pre><code>static_assert(mp_units::QuantityPointLike<Timestamp>);\n</code></pre> <p>and we can write the following:</p> <pre><code>void print(Timestamp ts) { std::cout << ts.seconds << \" s\\n\"; }\n\nint main()\n{\n using namespace mp_units;\n using namespace mp_units::si::unit_symbols;\n\n Timestamp ts{42};\n\n // implicit conversion\n quantity_point qp = ts;\n\n std::cout << qp.quantity_from_zero() << \"\\n\";\n\n // explicit conversion\n print(Timestamp(qp));\n}\n</code></pre>"},{"location":"users_guide/use_cases/interoperability_with_other_libraries/#interoperability-with-the-c-standard-library","title":"Interoperability with the C++ Standard Library","text":"<p>In the C++ standard library, we have two types that handle quantities and model the affine space. Those are:</p> <ul> <li><code>std::chrono::duration</code> - specifies quantities of time,</li> <li><code>std::chrono::time_point</code> - specifies quantity points of time.</li> </ul> <p>The mp-units library comes with built-in interoperability with those types. It is enough to include the mp-units/systems/si/chrono.h file to benefit from it. This file provides:</p> <ul> <li>partial specializations of <code>quantity_like_traits</code> and <code>quantity_point_like_traits</code> that provide support for implicit conversions between <code>std</code> and <code>mp_units</code> types in both directions,</li> <li><code>chrono_point_origin<Clock></code> point origin for <code>std</code> clocks,</li> <li><code>to_chrono_duration</code> and <code>to_chrono_time_point</code> dedicated conversion functions that result in types exactly representing mp-units abstractions.</li> </ul> <p>Important</p> <p>Only a <code>quantity_point</code> that uses <code>chrono_point_origin<Clock></code> as its origin can be converted to the <code>std::chrono</code> abstractions:</p> <pre><code>inline constexpr struct ts_origin final : relative_point_origin<chrono_point_origin<system_clock> + 1 * h> {} ts_origin;\ninline constexpr struct my_origin final : absolute_point_origin<isq::time> {} my_origin;\n\nquantity_point qp1 = sys_seconds{1s};\nauto tp1 = to_chrono_time_point(qp1); // OK\n\nquantity_point qp2 = chrono_point_origin<system_clock> + 1 * s;\nauto tp2 = to_chrono_time_point(qp2); // OK\n\nquantity_point qp3 = ts_origin + 1 * s;\nauto tp3 = to_chrono_time_point(qp3); // OK\n\nquantity_point qp4 = my_origin + 1 * s;\nauto tp4 = to_chrono_time_point(qp4); // Compile-time Error (1)\n\nquantity_point qp5{1 * s};\nauto tp5 = to_chrono_time_point(qp5); // Compile-time Error (2)\n</code></pre> <ol> <li><code>my_origin</code> is not defined in terms of <code>chrono_point_origin<Clock></code>.</li> <li><code>zeroth_point_origin</code> is not defined in terms of <code>chrono_point_origin<Clock></code>.</li> </ol> <p>Here is an example of how interoperability described in this chapter can be used in practice:</p> <pre><code>using namespace std::chrono;\n\nsys_seconds ts_now = floor<seconds>(system_clock::now());\n\nquantity_point start_time = ts_now;\nquantity speed = 925. * km / h;\nquantity distance = 8111. * km;\nquantity flight_time = distance / speed;\nquantity_point exp_end_time = start_time + flight_time;\n\nsys_seconds ts_end = value_cast<int>(exp_end_time.in(s));\n\nauto curr_time = zoned_time(current_zone(), ts_now);\nauto mst_time = zoned_time(\"America/Denver\", ts_end);\n\nstd::cout << \"Takeoff: \" << curr_time << \"\\n\";\nstd::cout << \"Landing: \" << mst_time << \"\\n\";\n</code></pre> <p>The above may print the following output:</p> <pre><code>Takeoff: 2023-11-18 13:20:54 UTC\nLanding: 2023-11-18 15:07:01 MST\n</code></pre>"},{"location":"users_guide/use_cases/wide_compatibility/","title":"Wide Compatibility","text":"<p>The mp-units allows us to implement nice and terse code targeting a specific C++ version and configuration. Such code is easy to write and understand but might not be portable to some older environments.</p> <p>However, sometimes, we want to develop code that can be compiled on a wide range of various compilers and configurations. This is why the library also exposes and uses special preprocessor macros that can be used to ensure the wide compatibility of our code.</p> <p>Note</p> <p>Those macros are used in our short example applications as those are meant to be built on all of the supported compilers. Some still do not support <code>std::format</code>, C++ modules, or C++ versions newer than C++20.</p>"},{"location":"users_guide/use_cases/wide_compatibility/#various-compatibility-options","title":"Various compatibility options","text":"<p>Depending on your compiler's conformance, you can choose to use any of the below styles to write your code using mp-units:</p> C++23C++20C++20 with header filesC++20 with header files + libfmtWide Compatibility <pre><code>#include <format>\n#include <iostream>\nimport mp_units;\n\n// ...\n\ninline constexpr struct horizontal_length final : quantity_spec<isq::length> {} horizontal_length;\n\n// ...\n\nstd::cout << std::format(...) << \"\\n\";\n</code></pre> <pre><code>#include <format>\n#include <iostream>\nimport mp_units;\n\n// ...\n\ninline constexpr struct horizontal_length final : quantity_spec<horizontal_length, isq::length> {} horizontal_length;\n\n// ...\n\nstd::cout << std::format(...) << \"\\n\";\n</code></pre> <pre><code>#include <mp-units/format.h>\n#include <mp-units/ostream.h>\n#include <mp-units/systems/international.h>\n#include <mp-units/systems/isq.h>\n#include <mp-units/systems/si.h>\n#include <format>\n#include <iostream>\n\n// ...\n\ninline constexpr struct horizontal_length final : quantity_spec<horizontal_length, isq::length> {} horizontal_length;\n\n// ...\n\nstd::cout << std::format(...) << \"\\n\";\n</code></pre> <pre><code>#include <mp-units/format.h>\n#include <mp-units/ostream.h>\n#include <mp-units/systems/international.h>\n#include <mp-units/systems/isq.h>\n#include <mp-units/systems/si.h>\n#include <fmt/format.h>\n#include <iostream>\n\n// ...\n\ninline constexpr struct horizontal_length final : quantity_spec<horizontal_length, isq::length> {} horizontal_length;\n\n// ...\n\nstd::cout << fmt::format(...) << \"\\n\";\n</code></pre> <pre><code>#include <iostream>\n#include <mp-units/ext/format.h>\n#ifdef MP_UNITS_MODULES\n#include <mp-units/compat_macros.h>\nimport mp_units;\n#else\n#include <mp-units/format.h>\n#include <mp-units/ostream.h>\n#include <mp-units/systems/international.h>\n#include <mp-units/systems/isq.h>\n#include <mp-units/systems/si.h>\n#endif\n\n// ...\n\nQUANTITY_SPEC(horizontal_length, isq::length);\n\n// ...\n\nstd::cout << MP_UNITS_STD_FMT::format(...) << \"\\n\";\n</code></pre> <p>Tip</p> <p>Depending on your preferences, you can either write:</p> <ul> <li>terse code directly targeting your specific compiler's abilities,</li> <li>verbose code using preprocessor branches and macros that provide the widest compatibility across various compilers.</li> </ul>"},{"location":"users_guide/use_cases/wide_compatibility/#compatibility-macros","title":"Compatibility macros","text":"<p>This chapter describes only the most essential tools the mp-units users need. All the compatibility macros can be found in the mp-units/compat_macros.h header file.</p> <p>Tip</p> <p>The mp-units/compat_macros.h header file is implicitly included when we use \"legacy\" headers in our translation units. However, it has to be explicitly included when we use C++20 modules, as those do not propagate preprocessor macros.</p>"},{"location":"users_guide/use_cases/wide_compatibility/#QUANTITY_SPEC","title":"<code>QUANTITY_SPEC(name, ...)</code>","text":"<p>Quantity specification definitions benefit from an explicit object parameter added in C++23 to remove the need for CRTP idiom, which significantly simplifies the code.</p> <p>This macro benefits from the new C++23 feature if available. Otherwise, it uses the CRTP idiom under the hood.</p>"},{"location":"users_guide/use_cases/wide_compatibility/#mp_units_std_fmt","title":"<code>MP_UNITS_STD_FMT</code>","text":"<p>Some of the supported compilers do not support std::format and related tools. Also, despite using a conformant compiler, some projects still choose to use fmtlib as their primary formatting facility (e.g., to benefit from additional features provided with the library).</p> <p>This macro resolves to either the <code>std</code> or <code>fmt</code> namespace, depending on the value of MP_UNITS_API_STD_FORMAT CMake option.</p> <p>To include the header files of the underlying text formatting framework, the following include should be used:</p> <pre><code>#include <mp-units/ext/format.h>\n</code></pre>"},{"location":"users_guide/use_cases/wide_compatibility/#contracts","title":"Contracts","text":"<p>The mp-units library internally does contract checking by default. It can be disabled with a Conan or CMake option. However, when enabled, it can use either gsl-lite or ms-gsl. To write a code that is independent from the underlying framework, the following preprocessor macros are exposed:</p> <ul> <li><code>MP_UNITS_EXPECTS(expr)</code></li> <li><code>MP_UNITS_EXPECTS_DEBUG(expr)</code></li> <li><code>MP_UNITS_ASSERT(expr)</code></li> <li><code>MP_UNITS_ASSERT_DEBUG(expr)</code></li> </ul> <p>Their meaning is consistent with respective gsl-lite.</p> <p>Also, to include the header files of the underlying framework, the following include should be used:</p> <pre><code>#include <mp-units/ext/contracts.h>\n</code></pre>"},{"location":"users_guide/use_cases/working_with_legacy_interfaces/","title":"Working with Legacy interfaces","text":"<p>In case we are working with a legacy/unsafe interface, we may need to extract the numerical value of a quantity and pass it to some third-party legacy unsafe interfaces.</p> <p>In such situations we can use <code>.numerical_value_in(Unit)</code> member function:</p> <pre><code>void legacy_check_speed_limit(int speed_in_km_per_h);\n</code></pre> <pre><code>legacy_check_speed_limit((180 * km / (2 * h)).numerical_value_in(km / h));\n</code></pre> <p>Such a getter will explicitly enforce the usage of a correct unit required by the underlying interface, which reduces a significant number of safety-related issues.</p> <p>The above code will not compile in case value truncation may happen. To solve the issue, we need to either use a value-preserving representation type or force the truncating conversion with <code>.force_numerical_value_in(Unit)</code>:</p> <pre><code>legacy_check_speed_limit((140 * mi / (2 * h)).force_numerical_value_in(km / h));\n</code></pre> <p>The getters mentioned above always return by value as a quantity value conversion may be required to adjust it to the target unit. In case a user needs a reference to the underlying storage <code>.numerical_value_ref_in(Unit)</code> should be used:</p> <pre><code>void legacy_set_speed_limit(int* speed_in_km_per_h) { *speed_in_km_per_h = 100; }\n</code></pre> <pre><code>quantity<km / h, int> speed_limit;\nlegacy_set_speed_limit(&speed_limit.numerical_value_ref_in(km / h));\n</code></pre> <p>This member function again requires a target unit to enforce safety. This overload does not participate in overload resolution if the provided unit has a different scaling factor than the current one.</p>"},{"location":"blog/archive/2024/","title":"2024","text":""},{"location":"blog/archive/2023/","title":"2023","text":""},{"location":"blog/category/wg21/","title":"WG21","text":""},{"location":"blog/category/releases/","title":"Releases","text":""},{"location":"users_guide/examples/tags_index/","title":"Tags Index","text":"<p>Note</p> <p>mp-units usage example applications are meant to be built on all of the supported compilers. This is why they benefit from the Wide Compatibility mode.</p> <p>Tip</p> <p>All usage examples in this chapter are categorized with appropriate tags to simplify navigation and search of relevant code. You can either read all the examples one-by-one in the order provided by the documentation authors or, thanks to the tagging system, jump straight to the example that is the most interesting for you.</p>"},{"location":"users_guide/examples/tags_index/#cgs-system","title":"CGS System","text":"<ul> <li>avg_speed</li> </ul>"},{"location":"users_guide/examples/tags_index/#international-system","title":"International System","text":"<ul> <li>avg_speed</li> <li>hello_units</li> </ul>"},{"location":"users_guide/examples/tags_index/#physical-constants","title":"Physical Constants","text":"<ul> <li>si_constants</li> </ul>"},{"location":"users_guide/examples/tags_index/#text-formatting","title":"Text Formatting","text":"<ul> <li>avg_speed</li> <li>hello_units</li> <li>si_constants</li> </ul>"}]} |