feedc0de/mp-units
1
0
Fork 0
forked from mpusz/mp-units
Code Pull Requests Activity

docs: "Common units" chapter cleanup

Browse Source
This commit is contained in:
Mateusz Pusz
2024-10-15 20:52:51 +02:00
parent 6591a65d06
commit 5742ca8162
1 changed files with 8 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
docs/users_guide/framework_basics/systems_of_units.md
View File

@@ -262,9 +262,9 @@ This is why we provide both versions of identifiers for such units.
## Common units ## Common units
Adding or subtracting two quantities of different units will force the library to find a common Adding, subtracting, or comparing two quantities of different units will force the library to find
unit for those. This is to prevent data truncation. For the cases when one of the units is an a common unit for those. This is to prevent data truncation. For the cases when one of the units is
integral multiple of the another, the resulting quantity will use a "smaller" one in its result. an integral multiple of the another, the resulting quantity will use a "smaller" one in its result.
For example: For example:
```cpp ```cpp
@@ -273,14 +273,14 @@ static_assert((1 * km + 1 * mm).unit == mm);
static_assert((1 * yd + 1 * mi).unit == yd); static_assert((1 * yd + 1 * mi).unit == yd);
``` ```
However, in many cases an arithmetic on quantities of different units will result in a yet another However, in many cases an arithmetic operation on quantities of different units will result in
unit. This happens when none of the source units is an integral multiple of another. In such cases, a yet another unit. This happens when none of the source units is an integral multiple of another.
the library returns a special type that denotes that we are dealing with a common unit of such In such cases, the library returns a special type that denotes that we are dealing with a common
an equation: unit of such an equation:
```cpp ```cpp
quantity q1 = 1 * km + 1 * mi; // quantity<common_unit<international::mile, si::kilo_<si::metre>>{}, int> quantity q1 = 1 * km + 1 * mi; // quantity<common_unit<international::mile, si::kilo_<si::metre>>{}, int>
quantity q2 = 1. * rad + 1. * deg; // quantity<common_unit<si::degree, si::radian>, double>{}> quantity q2 = 1. * rad + 1. * deg; // quantity<common_unit<si::degree, si::radian>{}, double>
``` ```
!!! note !!! note