roland/xo-alloc
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

xo-unit: doc: + glossary entries for abbreviations {nu, su}

Browse source
This commit is contained in:
Roland Conybeare 2024-04-27 08:19:26 -04:00
commit 1f372d64ad
1 changed files with 12 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

16
docs/glossary.rst
View file

@ -6,16 +6,24 @@ Glossary
.. glossary::
basis dimension
Orthogonal directions associated with basis units, for example *mass*, *length*, *time*.
In xo-unit these are represented by the enum ``xo::unit::dim``.
In xo-unit these are represented by the enum ``xo::qty::dim``.
basis unit
An implementation type representing a quantity (with associated scale) in the direction of a single :term:`basis dimension`.
For example *milliseconds*, *seconds*, and *hours* stand for different basis units with the *time* dimension.
In xo-unit these are represented by the template type ``xo::unit::basis_unit``.
In xo-unit these are represented by the template type ``xo::qty::basis_unit``.
bpu
A rational power of a (single) basis unit. For example *kg.m.s\ :sup:-2* or *hr\ :sup:-(1/2)*.
In xo-unit these are represented by the template type ``xo::unit::bpu``.
A rational power of a (single) basis unit. For example *s\ :sup:-2* or *hr\ :sup:-(1/2)*.
In xo-unit these are represented by the template type ``xo::qty::bpu``.
nu
A cartesian product of basis power units (bpus). For example *kg.m.s\ :sup:-2* or *hr\ :sup:-(1/2)*.
In xo-unit these are represented by template type ``xo::qty::natural_unit``.
su
A dimensionless multiple of a natural unit. Used as intermediate value when coalescing quantities involving different units.
In xo-unit these are represented by template type ``xo::qty::scaled_unit``.
XO
A set of integrated c++ libraries for complex event processing, with browser and python integration.