mpusz/mp-units
1
0
Fork 1
mirror of https://github.com/mpusz/mp-units.git synced 2025-08-01 03:14:29 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs: SI Brochure quote added with the rationale for the multiplication syntax usage to create quantities

Browse Source
This commit is contained in:
Mateusz Pusz
2023-09-04 10:53:47 +02:00
parent bbc2255a6e
commit 75482733d1
1 changed files with 11 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/getting_started/quick_start.md
View File

@@ -6,7 +6,17 @@ specific representation, and is represented in the library with a `quantity` cla
## Creating a quantity
The quantity is created by multiplying a number with a predefined unit:
The [SI Brochure](../appendix/references.md#SIBrochure) says:
!!! quote "SI Brochure"
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).
Following the above, the value of a quantity in the **mp-units** library is created by multiplying
a number with a predefined unit:
```cpp
#include <mp-units/systems/si/si.h>