mp-units/docs/reference/core/concepts.rst

.. namespace:: units

Concepts
========

.. note::

    All names defined in this chapter reside in the :any:`units` namespace unless
    specified otherwise.

.. concept:: template<typename T> PrefixFamily

    A concept matching a prefix family. Satisfied by all types derived from :class:`prefix_family`.

.. concept:: template<typename T> Prefix

    A concept matching a symbol prefix. Satisfied by all instantiations of :struct:`prefix`.

.. concept:: template<ratio R> UnitRatio

    Satisfied by all ratio values for which :expr:`R.num > 0` and :expr:`R.den > 0`.

.. concept:: template<typename T> BaseDimension

    A concept matching all base dimensions in the library. Satisfied by all dimension types
    derived from the instantiation of :class:`base_dimension`.

.. concept:: template<typename T> Exponent

    A concept matching dimension's exponents. Satisfied by all instantiations of :class:`exponent`.

.. concept:: template<typename T> DerivedDimension

    A concept matching all derived dimensions in the library. Satisfied by all dimension
    types derived from the instantiation of ``detail::derived_dimension_base``.

.. concept:: template<typename T> Dimension

    A concept matching all dimensions in the library. Satisfied by all dimension types for
    which either :expr:`BaseDimension<T>` or :expr:`DerivedDimension<T>` is ``true``.

.. concept:: template<typename T> Unit

    A concept matching all unit types in the library. Satisfied by all unit types derived
    from the instantiation of :class:`scaled_unit`.

.. concept:: template<typename U, typename D> UnitOf

    A concept matching only units of a specified dimension. Satisfied by all unit types that
    satisfy :expr:`Unit<U>`, :expr:`Dimension<D>`, and for which :expr:`U::reference` and
    ``dimension_unit<D>::reference`` denote the same unit type.

    :tparam U: Type to verify against concept constraints.
    :tparam D: Dimension type to use for verification.

.. concept:: template<typename T> Quantity

    A concept matching all quantities in the library. Satisfied by all instantiations of :class:`quantity`.

.. concept:: template<typename T> QuantityLike

    A concept matching all quantity-like types other than specialization of :class:`quantity`. Satisfied by
    all types for which a correct specialization of :class:`quantity_like_traits` type trait is provided.

.. concept:: template<typename T> WrappedQuantity

    A concept matching types that wrap quantity objects. Satisfied by all wrapper types that
    satisfy :expr:`Quantity<typename T::value_type> || QuantityLike<typename T::value_type>` recursively
    (i.e. ``std::optional<si::length<si::metre>>``).

.. concept:: template<typename T> QuantityValue

    A concept matching types that can be used as a `Quantity` representation type. Satisfied
    by types that match ``(!Quantity<T>) && (!QuantityLike<T>) && (!WrappedQuantity<T>) && std::regular<T>``
    and satisfy one of the following:

    - if ``common_type_with<T, std::intmax_t>`` is ``true``, then ``std::common_type_t<T, std::intmax_t>``
      must at least provide binary multiplication and division operators,
    - otherwise, ``T::value_type`` must be valid, ``common_type_with<T::value_type, std::intmax_t>`` be
      ``true``, and ``std::common_type_t<T::value_type, std::intmax_t>`` must at least provide binary
      multiplication and division operators with itself and ``T``.

.. concept:: template<typename T> QuantityPoint

    A concept matching all quantity points in the library. Satisfied by all instantiations of
    :class:`quantity_point`.

.. concept:: template<typename T> Kind

    A concept matching all kind types. Satisfied by all kind types derived from an specialization of
    :class:`kind`.

.. concept:: template<typename T> PointKind

    A concept matching all point kind types. Satisfied by all point kind types derived from an specialization of
    :class:`point_kind`.

.. concept:: template<typename T> QuantityKind

    A concept matching all quantity kinds in the library. Satisfied by all specializations of
    :class:`quantity_kind`.

.. concept:: template<typename T> QuantityPointKind

    A concept matching all quantity point kinds in the library. Satisfied by all specializations of
    :class:`quantity_point_kind`.

.. concept:: template<typename Dim, template<typename...> typename DimTemplate> DimensionOfT

    A concept matching all dimensions being the instantiations derived from the provided dimension
    class template.

.. concept:: template<typename Q, template<typename...> typename DimTemplate> QuantityOfT

    A concept matching all quantities with a dimension being the instantiation derived from
    the provided dimension class template.

.. concept:: template<typename Q, typename Dim> QuantityOf

    A concept matching all quantities with a dimension being the instantiation derived from
    the provided dimension type.

.. concept:: template<typename Q1, typename Q2> QuantityEquivalentTo

    A concept matching two equivalent quantities. Satisfied by quantities having equivalent dimensions.

.. concept:: template<typename QP, typename Dim> QuantityPointOf

    A concept matching all quantity points with a dimension being the instantiation derived from
    the provided dimension type.

.. concept:: template<typename QP1, typename QP2> QuantityPointEquivalentTo

    A concept matching two equivalent quantity points. Satisfied by quantity points having equivalent
    dimensions.

.. concept:: template<typename QK, typename K> QuantityKindOf

    A concept matching only quantity kinds of a specific kind.

    :tparam QK: Quantity kind to verify.
    :tparam K: Kind type to use for verification.

.. concept:: template<typename QK1, typename QK2> QuantityKindEquivalentTo

    A concept matching two equivalent quantity kinds. Satisfied by quantity kinds having equivalent kinds.
 
.. concept:: template<typename QPK, typename PK> QuantityPointKindOf
 
    A concept matching only quantity point kinds of a specific point kind.
 
    :tparam QPK: Quantity point kind to verify.
    :tparam PK: Point kind type to use for verification.

.. concept:: template<typename QPK1, typename QPK2> QuantityPointKindEquivalentTo

    A concept matching two equivalent quantity point kinds. Satisfied by quantity point kinds having
    equivalent kinds.