From 1f372d64adde03d162a630010f1649d0b16c4388 Mon Sep 17 00:00:00 2001 From: Roland Conybeare Date: Sat, 27 Apr 2024 08:19:26 -0400 Subject: [PATCH] xo-unit: doc: + glossary entries for abbreviations {nu, su} --- docs/glossary.rst | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/docs/glossary.rst b/docs/glossary.rst index 5d594f81..b7a4f864 100644 --- a/docs/glossary.rst +++ b/docs/glossary.rst @@ -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.