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

xo-unit: refactor bu_store ns + expand docs

Browse source
This commit is contained in:
Roland Conybeare 2024-05-08 23:51:49 -04:00
commit 8844390090
3 changed files with 247 additions and 215 deletions
Download patch file Download diff file Expand all files Collapse all files

25
docs/bu-store-class.rst
View file

@ -7,7 +7,7 @@ Basis Unit Store
#include <xo/unit/bu_store.hpp>
namespace bu = xo::qty::bu;
namespace bu = xo::qty::detail::bu;
A :code:`xo::qty::bu_store` is a small, constexpr, key-value store associating
abbreviations with basis units. To satisfy the constexpr requirement,
@ -54,7 +54,28 @@ This class supports the implementation of ``natural_unit::abbrev()``.
Application code is not expected to interact directly with it.
.. doxygenclass:: xo::qty::bu_store
.. doxygenclass:: xo::qty::detail::bu_store
For example, this would be possible:
.. code-block:: cpp
#include <xo/unit/bu_store.hpp>
namespace bu = using xo::qty::detail::bu;
using xo::qty::detail::bu_store;
using xo::qty::dim;
using xo::flatstring;
constexpr bu_store store;
static_assert(store.bu_abbrev(bu::minute) == flatstring("min"));
static_assert(store.bu_abbrev(bu::microgram) == flatstring("ug"));
.. doxygenclass:: xo::qty::detail::bu_dim_store
.. doxygengroup:: bu-dim-store-type-traits
.. doxygengroup:: bu-dim-store-instance-vars
Constants
---------