From a114b9b9a3838b3b62f072de680ee2819e7e25a6 Mon Sep 17 00:00:00 2001 From: Mateusz Pusz Date: Thu, 21 Dec 2023 12:23:52 +0100 Subject: [PATCH] docs: "Quantity points" chapter extended --- docs/getting_started/quick_start.md | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/docs/getting_started/quick_start.md b/docs/getting_started/quick_start.md index 5da05a18..c220b968 100644 --- a/docs/getting_started/quick_start.md +++ b/docs/getting_started/quick_start.md @@ -85,8 +85,14 @@ static_assert(140 * km / (2 * h) == 70 * km / h); ## Quantity points -The `quantity_point` class template specifies an absolute quantity with respect to an origin. -Together with quantities they model [The Affine Space](../users_guide/framework_basics/the_affine_space.md). +The quantity point specifies an absolute quantity with respect to an origin. +Together with quantities, they model [The Affine Space](../users_guide/framework_basics/the_affine_space.md). + +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.). + +The set of operations that can be done on quantity points is limited compared to quantities. +This introduces an additional type-safety. ```cpp #include @@ -112,3 +118,8 @@ The above outputs: ```text Temperature: 20 °C (68 °F) ``` + +!!! info + + Check [The Affine Space](../users_guide/framework_basics/the_affine_space.md) chapter to learn + more about quantity points.