From 65e383a506d6d6adbb0e2676f336ba52f99c41b5 Mon Sep 17 00:00:00 2001 From: Mateusz Pusz Date: Fri, 5 Mar 2021 11:31:46 +0100 Subject: [PATCH] docs: Basic concepts embraced with examples --- docs/framework/basic_concepts.rst | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/docs/framework/basic_concepts.rst b/docs/framework/basic_concepts.rst index 6c11c7ae..ddff3461 100644 --- a/docs/framework/basic_concepts.rst +++ b/docs/framework/basic_concepts.rst @@ -49,18 +49,25 @@ The most important concepts in the library are `Unit`, `Dimension`, `Unit` is a basic building block of the library. Every dimension works with a concrete hierarchy of units. Such hierarchy defines a reference unit and -often a few scaled versions of it. +often a few scaled versions of it. Examples: ``second``, ``metre``, ``kilometre_per_hour``. `Dimension` concept matches a dimension of either a base or derived quantity. `base_dimension` is instantiated with a unique symbol identifier and a base unit. `derived_dimension` is a list of exponents of either base or other -derived dimensions. +derived dimensions. Examples: ``si::dim_time``, ``si::dim_length``, ``si::dim_speed``. `Quantity` is a concrete amount of a unit for a specified dimension with a -specific representation. +specific representation. Examples: ``quantity``, +``si::length``, ``si::speed``. `QuantityPoint` is an absolute `Quantity` with respect to some origin. +Examples: timestamp (as opposed to duration), absolute temperature +(as opposed to temperature difference). -`QuantityKind` is a `Quantity` with more specific usage. +`QuantityKind` is a `Quantity` with more specific usage. Examples: +distance (``horizonal_kind``) and height (``vertical_kind``) are different kinds +of a length quantity. `QuantityPointKind` is an absolute `QuantityKind` with respect to some origin. +Examples: altitude is a quantity point of ``vertical_kind`` (as opposed to +height).