[#index]
= Global namespace
:relfileprefix: 
:mrdocs:

== Namespaces

[cols=1]
|===
| Name
| xref:mp_units.adoc[`mp_units`] 
|===

== xref:mp_units.adoc[mp_units] namespace

=== Types

[cols=2]
|===
| Name
| Description
| xref:mp_units/absolute_point_origin.adoc[`absolute_point_origin`] 
| 
| xref:mp_units/base_dimension.adoc[`base_dimension`] 
| A dimension of a base quantity
| xref:mp_units/basic_fixed_string-08.adoc[`basic_fixed_string`] 
| A compile‐time fixed string
| xref:mp_units/binomial_distribution.adoc[`binomial_distribution`] 
| 
| xref:mp_units/cartesian_vector-08.adoc[`cartesian_vector`] 
| 
| xref:mp_units/cauchy_distribution.adoc[`cauchy_distribution`] 
| 
| xref:mp_units/chi_squared_distribution.adoc[`chi_squared_distribution`] 
| 
| xref:mp_units/common_unit.adoc[`common_unit`] 
| Measurement unit for an accumulation of two quantities of different units
| xref:mp_units/delta_.adoc[`delta_`] 
| 
| xref:mp_units/derived_dimension.adoc[`derived_dimension`] 
| A dimension of a derived quantity
| xref:mp_units/derived_quantity_spec.adoc[`derived_quantity_spec`] 
| A specification of a derived quantity
| xref:mp_units/derived_unit.adoc[`derived_unit`] 
| Measurement unit for a derived quantity
| xref:mp_units/dimension_one-063.adoc[`dimension_one`] 
| Dimension one
| xref:mp_units/dimension_symbol_formatting.adoc[`dimension_symbol_formatting`] 
| 
| xref:mp_units/dimensionless-0f.adoc[`dimensionless`] 
| Quantity of dimension one
| xref:mp_units/discrete_distribution.adoc[`discrete_distribution`] 
| 
| xref:mp_units/exponential_distribution.adoc[`exponential_distribution`] 
| 
| xref:mp_units/extreme_value_distribution.adoc[`extreme_value_distribution`] 
| 
| xref:mp_units/fisher_f_distribution.adoc[`fisher_f_distribution`] 
| 
| xref:mp_units/gamma_distribution.adoc[`gamma_distribution`] 
| 
| xref:mp_units/geometric_distribution.adoc[`geometric_distribution`] 
| 
| xref:mp_units/is_kind-06.adoc[`is_kind`] 
| 
| xref:mp_units/kind_of_-00.adoc[`kind_of_`] 
| 
| xref:mp_units/kind_of_-0d.adoc[`kind_of_<Q>`] 
| 
| xref:mp_units/lognormal_distribution.adoc[`lognormal_distribution`] 
| 
| xref:mp_units/mag_constant.adoc[`mag_constant`] 
| 
| xref:mp_units/named_unit-0ec.adoc[`named_unit`] 
| A named unit
| xref:mp_units/named_unit-06.adoc[`named_unit<Symbol>`] 
| Specialization for a unit that can be reused by several base quantities
| xref:mp_units/named_unit-07.adoc[`named_unit<Symbol, U>`] 
| Specialization for unit of a specified base quantity
| xref:mp_units/named_unit-05.adoc[`named_unit<Symbol, U, QS>`] 
| Specialization for a unit with special name valid only for a specific quantity
| xref:mp_units/named_unit-0e4.adoc[`named_unit<Symbol, U, QS, PO>`] 
| 
| xref:mp_units/negative_binomial_distribution.adoc[`negative_binomial_distribution`] 
| 
| xref:mp_units/normal_distribution.adoc[`normal_distribution`] 
| 
| xref:mp_units/one-0f.adoc[`one`] 
| Unit one
| xref:mp_units/parts_per_million-0f.adoc[`parts_per_million`] 
| 
| xref:mp_units/per.adoc[`per`] 
| Type list type storing the list of components with negative exponents
| xref:mp_units/per_mille-01.adoc[`per_mille`] 
| 
| xref:mp_units/percent-02.adoc[`percent`] 
| 
| xref:mp_units/pi-0c.adoc[`pi`] 
| 
| xref:mp_units/piecewise_constant_distribution.adoc[`piecewise_constant_distribution`] 
| 
| xref:mp_units/piecewise_linear_distribution.adoc[`piecewise_linear_distribution`] 
| 
| xref:mp_units/point_.adoc[`point_`] 
| 
| xref:mp_units/poisson_distribution.adoc[`poisson_distribution`] 
| 
| xref:mp_units/power.adoc[`power`] 
| Type container for exponents with ratio different than `1`
| xref:mp_units/prefixed_unit.adoc[`prefixed_unit`] 
| A prefixed unit
| xref:mp_units/quantity-01.adoc[`quantity`] 
| A quantity
| xref:mp_units/quantity_like_traits.adoc[`quantity_like_traits`] 
| Provides support for external quantity‐like types
| xref:mp_units/quantity_point-08.adoc[`quantity_point`] 
| A quantity point
| xref:mp_units/quantity_point_like_traits.adoc[`quantity_point_like_traits`] 
| Provides support for external quantity point‐like types
| xref:mp_units/quantity_spec-09.adoc[`quantity_spec`] 
| 
| xref:mp_units/quantity_spec-0a6.adoc[`quantity_spec<QS, Args...>`] 
| 
| xref:mp_units/quantity_spec-0a0.adoc[`quantity_spec<QS, Eq, Args...>`] 
| 
| xref:mp_units/reference.adoc[`reference`] 
| Quantity reference type
| xref:mp_units/relative_point_origin.adoc[`relative_point_origin`] 
| 
| xref:mp_units/representation_values.adoc[`representation_values`] 
| A type trait that defines zero, one, min, and max for a representation type
| xref:mp_units/scaled_unit.adoc[`scaled_unit`] 
| Unit being a scaled version of another unit
| xref:mp_units/student_t_distribution.adoc[`student_t_distribution`] 
| 
| xref:mp_units/symbol_text-032.adoc[`symbol_text`] 
| A symbol text representation
| xref:mp_units/system_reference.adoc[`system_reference`] 
| System‐specific reference
| xref:mp_units/uniform_int_distribution.adoc[`uniform_int_distribution`] 
| 
| xref:mp_units/uniform_real_distribution.adoc[`uniform_real_distribution`] 
| 
| xref:mp_units/unit_symbol_formatting.adoc[`unit_symbol_formatting`] 
| 
| xref:mp_units/weibull_distribution.adoc[`weibull_distribution`] 
| 
| xref:mp_units/zeroth_point_origin_.adoc[`zeroth_point_origin_`] 
| 
| xref:mp_units/conditional.adoc[`conditional`] 
| 
| xref:mp_units/expr_type.adoc[`expr_type`] 
| 
| xref:mp_units/fixed_string.adoc[`fixed_string`] 
| 
| xref:mp_units/fixed_u16string.adoc[`fixed_u16string`] 
| 
| xref:mp_units/fixed_u32string.adoc[`fixed_u32string`] 
| 
| xref:mp_units/fixed_u8string.adoc[`fixed_u8string`] 
| 
| xref:mp_units/fixed_wstring.adoc[`fixed_wstring`] 
| 
| xref:mp_units/is_same.adoc[`is_same`] 
| 
| xref:mp_units/quantity_values.adoc[`quantity_values`] 
| 
| xref:mp_units/text_encoding.adoc[`text_encoding`] 
| 
| xref:mp_units/value_type_t.adoc[`value_type_t`] 
| 
| xref:mp_units/wrapped_type_t.adoc[`wrapped_type_t`] 
| 
|===

=== Enums

[cols=2]
|===
| Name
| Description
| xref:mp_units/character_set.adoc[`character_set`] 
| 
| xref:mp_units/quantity_character.adoc[`quantity_character`] 
| Quantity character
| xref:mp_units/unit_symbol_separator.adoc[`unit_symbol_separator`] 
| 
| xref:mp_units/unit_symbol_solidus.adoc[`unit_symbol_solidus`] 
| 
|===

=== Functions

[cols=2]
|===
| Name
| Description
| xref:mp_units/abs.adoc[`abs`] 
| Computes the absolute value of a quantity
| xref:mp_units/castable.adoc[`castable`] 
| 
| xref:mp_units/cbrt-0a.adoc[`cbrt`] 
| `cbrt` overloads
| xref:mp_units/ceil.adoc[`ceil`] 
| Computes the smallest quantity with integer representation and unit type To with its number not less than q
| xref:mp_units/contains-01b.adoc[`contains`] 
| 
| xref:mp_units/cubic.adoc[`cubic`] 
| Computes the cubic power of a unit
| xref:mp_units/default_point_origin.adoc[`default_point_origin`] 
| 
| xref:mp_units/dimension_symbol.adoc[`dimension_symbol`] 
| 
| xref:mp_units/dimension_symbol_to.adoc[`dimension_symbol_to`] 
| 
| xref:mp_units/epsilon.adoc[`epsilon`] 
| Returns the epsilon of the quantity
| xref:mp_units/exp.adoc[`exp`] 
| Computes Euler's raised to the given power
| xref:mp_units/explicitly_convertible.adoc[`explicitly_convertible`] 
| 
| xref:mp_units/floor.adoc[`floor`] 
| Computes the largest quantity with integer representation and unit type To with its number not greater than q
| xref:mp_units/fma-0c.adoc[`fma`] 
| `fma` overloads
| xref:mp_units/fmod.adoc[`fmod`] 
| Computes the floating‐point remainder of the division operation x / y.
| xref:mp_units/get-0a.adoc[`get`] 
| 
| xref:mp_units/get_canonical_unit.adoc[`get_canonical_unit`] 
| 
| xref:mp_units/get_common_quantity_spec-08.adoc[`get_common_quantity_spec`] 
| 
| xref:mp_units/get_common_reference.adoc[`get_common_reference`] 
| 
| xref:mp_units/get_common_unit-08f.adoc[`get_common_unit`] 
| 
| xref:mp_units/get_kind.adoc[`get_kind`] 
| 
| xref:mp_units/get_quantity_spec-021.adoc[`get_quantity_spec`] 
| 
| xref:mp_units/get_unit-02.adoc[`get_unit`] 
| 
| xref:mp_units/hypot-00.adoc[`hypot`] 
| `hypot` overloads
| xref:mp_units/implicitly_convertible.adoc[`implicitly_convertible`] 
| 
| xref:mp_units/interconvertible.adoc[`interconvertible`] 
| 
| xref:mp_units/inverse-0a.adoc[`inverse`] 
| Computes the inverse of a quantity in a provided unit
| xref:mp_units/is_eq_zero.adoc[`is_eq_zero`] 
| 
| xref:mp_units/is_gt_zero.adoc[`is_gt_zero`] 
| 
| xref:mp_units/is_gteq_zero.adoc[`is_gteq_zero`] 
| 
| xref:mp_units/is_lt_zero.adoc[`is_lt_zero`] 
| 
| xref:mp_units/is_lteq_zero.adoc[`is_lteq_zero`] 
| 
| xref:mp_units/is_neq_zero.adoc[`is_neq_zero`] 
| 
| xref:mp_units/isfinite-01.adoc[`isfinite`] 
| `isfinite` overloads
| xref:mp_units/isinf-0c.adoc[`isinf`] 
| `isinf` overloads
| xref:mp_units/isnan-08c.adoc[`isnan`] 
| `isnan` overloads
| xref:mp_units/lerp.adoc[`lerp`] 
| Linear interpolation or extrapolation
| xref:mp_units/magnitude-0c.adoc[`magnitude`] 
| 
| xref:mp_units/midpoint.adoc[`midpoint`] 
| Computes the midpoint of two points
| xref:mp_units/operator_mod-01.adoc[`operator%`] 
| Modulus operators
| xref:mp_units/operator_star-000.adoc[`operator*`] 
| Multiplication operators
| xref:mp_units/operator_plus-0ad.adoc[`operator+`] 
| Addition operators
| xref:mp_units/operator_minus-0c.adoc[`operator‐`] 
| Subtraction operators
| xref:mp_units/operator_slash-0a.adoc[`operator/`] 
| Division operators
| xref:mp_units/pow-05e.adoc[`pow`] 
| `pow` overloads
| xref:mp_units/quantity_cast-0f.adoc[`quantity_cast`] 
| `quantity_cast` overloads
| xref:mp_units/remainder.adoc[`remainder`] 
| Computes the IEEE remainder of the floating point division operation x / y.
| xref:mp_units/round.adoc[`round`] 
| Computes the nearest quantity with integer representation and unit type `To` to `q`
| xref:mp_units/sqrt-07.adoc[`sqrt`] 
| `sqrt` overloads
| xref:mp_units/square.adoc[`square`] 
| Computes the square power of a unit
| xref:mp_units/swap.adoc[`swap`] 
| 
| xref:mp_units/unit_symbol.adoc[`unit_symbol`] 
| 
| xref:mp_units/unit_symbol_to.adoc[`unit_symbol_to`] 
| 
| xref:mp_units/unit_vector.adoc[`unit_vector`] 
| 
| xref:mp_units/value_cast-03d.adoc[`value_cast`] 
| `value_cast` overloads
| xref:mp_units/operator_lshift-0e9.adoc[`operator<<`] 
| Stream insertion operators
| xref:mp_units/operator_eq-0cb.adoc[`operator==`] 
| Equality operators
| xref:mp_units/operator_3way-06.adoc[`operator<=>`] 
| Three‐way comparison operators
|===

=== Variables

[cols=2]
|===
| Name
| Description
| xref:mp_units/absolute.adoc[`absolute`] 
| 
| xref:mp_units/delta.adoc[`delta`] 
| 
| xref:mp_units/dimension_one-060.adoc[`dimension_one`] 
| 
| xref:mp_units/dimensionless-03.adoc[`dimensionless`] 
| Quantity of dimension one
| xref:mp_units/disable_real-00.adoc[`disable_real`] 
| //////////// REAL SCALAR ///////////////
| xref:mp_units/disable_real-0b.adoc[`disable_real<bool>`] 
| 
| xref:mp_units/imag.adoc[`imag`] 
| 
| xref:mp_units/is_complex.adoc[`is_complex`] 
| 
| xref:mp_units/is_derived_from_specialization_of.adoc[`is_derived_from_specialization_of`] 
| 
| xref:mp_units/is_derived_from_specialization_of_v.adoc[`is_derived_from_specialization_of_v`] 
| 
| xref:mp_units/is_kind-0b.adoc[`is_kind`] 
| 
| xref:mp_units/is_same_v-0d.adoc[`is_same_v`] 
| 
| xref:mp_units/is_same_v-0e.adoc[`is_same_v<T, T>`] 
| 
| xref:mp_units/is_scalar.adoc[`is_scalar`] 
| 
| xref:mp_units/is_specialization_of-06.adoc[`is_specialization_of`] 
| 
| xref:mp_units/is_specialization_of-0b.adoc[`is_specialization_of<Type<Params...>, Type>`] 
| 
| xref:mp_units/is_specialization_of_v-01.adoc[`is_specialization_of_v`] 
| 
| xref:mp_units/is_specialization_of_v-08.adoc[`is_specialization_of_v<Type<Params...>, Type>`] 
| 
| xref:mp_units/is_tensor.adoc[`is_tensor`] 
| 
| xref:mp_units/is_value_preserving.adoc[`is_value_preserving`] 
| Specifies if a specific conversion between two types preserves the value
| xref:mp_units/is_vector.adoc[`is_vector`] 
| 
| xref:mp_units/kind_of.adoc[`kind_of`] 
| 
| xref:mp_units/known_first_factor.adoc[`known_first_factor`] 
| /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
| xref:mp_units/mag.adoc[`mag`] 
| 
| xref:mp_units/mag_pi.adoc[`mag_pi`] 
| 
| xref:mp_units/mag_power.adoc[`mag_power`] 
| Create a Magnitude which is some rational number raised to a rational power.
| xref:mp_units/mag_ratio.adoc[`mag_ratio`] 
| 
| xref:mp_units/magnitude-04.adoc[`magnitude`] 
| 
| xref:mp_units/modulus.adoc[`modulus`] 
| 
| xref:mp_units/one-07.adoc[`one`] 
| 
| xref:mp_units/parts_per_million-0a.adoc[`parts_per_million`] 
| 
| xref:mp_units/per_mille-08.adoc[`per_mille`] 
| 
| xref:mp_units/percent-0a.adoc[`percent`] 
| 
| xref:mp_units/pi-0f.adoc[`pi`] 
| 
| xref:mp_units/point.adoc[`point`] 
| 
| xref:mp_units/ppm.adoc[`ppm`] 
| 
| xref:mp_units/real.adoc[`real`] 
| 
| xref:mp_units/space_before_unit_symbol.adoc[`space_before_unit_symbol`] 
| Puts a space ' ' sign before a unit symbol
| xref:mp_units/treat_as_floating_point.adoc[`treat_as_floating_point`] 
| Specifies if a value of a type should be treated as a floating‐point value
| xref:mp_units/zeroth_point_origin.adoc[`zeroth_point_origin`] 
| 
| xref:mp_units/π.adoc[`π`] 
| 
|===

=== Concepts

[cols=2]
|===
| Name
| Description
| xref:mp_units/AssociatedUnit.adoc[`AssociatedUnit`] 
| A concept matching all units that can be used as quantity references
| xref:mp_units/Dimension.adoc[`Dimension`] 
| A concept matching all dimensions in the library.
| xref:mp_units/DimensionOf.adoc[`DimensionOf`] 
| A concept checking if the argument is of the same dimension.
| xref:mp_units/PointOrigin.adoc[`PointOrigin`] 
| A concept matching all quantity point origins in the library
| xref:mp_units/PointOriginFor.adoc[`PointOriginFor`] 
| A concept matching all quantity point origins for a specified quantity type in the library
| xref:mp_units/PrefixableUnit.adoc[`PrefixableUnit`] 
| A concept to be used to define prefixes for a unit
| xref:mp_units/Quantity.adoc[`Quantity`] 
| A concept matching all quantities in the library
| xref:mp_units/QuantityLike.adoc[`QuantityLike`] 
| A concept matching all external quantities like types
| xref:mp_units/QuantityOf.adoc[`QuantityOf`] 
| A concept matching all quantities of the provided quantity spec
| xref:mp_units/QuantityPoint.adoc[`QuantityPoint`] 
| A concept matching all quantity points in the library
| xref:mp_units/QuantityPointLike.adoc[`QuantityPointLike`] 
| A concept matching all external quantity point like types
| xref:mp_units/QuantityPointOf.adoc[`QuantityPointOf`] 
| A concept matching all quantity points of the provided property
| xref:mp_units/QuantitySpec.adoc[`QuantitySpec`] 
| 
| xref:mp_units/QuantitySpecOf.adoc[`QuantitySpecOf`] 
| A concept matching all quantity specifications of a provided quantity spec value
| xref:mp_units/Reference.adoc[`Reference`] 
| A concept matching all references in the library.
| xref:mp_units/ReferenceOf.adoc[`ReferenceOf`] 
| A concept matching all references of the provided quantity spec
| xref:mp_units/RepresentationOf.adoc[`RepresentationOf`] 
| 
| xref:mp_units/Unit.adoc[`Unit`] 
| A concept matching all unit types in the library
| xref:mp_units/UnitMagnitude.adoc[`UnitMagnitude`] 
| Concept to detect whether T is a valid UnitMagnitude.
| xref:mp_units/UnitOf.adoc[`UnitOf`] 
| A concept matching all units associated with the provided quantity spec
|===

=== Deduction Guides

[cols=1]
|===
| Name
| xref:mp_units/basic_fixed_string-0d.adoc[`basic_fixed_string<CharT, N ‐ 1>`] 
| xref:mp_units/basic_fixed_string-0f.adoc[`basic_fixed_string<CharT, 1 + sizeof...(Rest)>`] 
| xref:mp_units/basic_fixed_string-0a.adoc[`basic_fixed_string<CharT, N>`] 
| xref:mp_units/cartesian_vector-06.adoc[`cartesian_vector<std::common_type_t<Arg, Args...>>`] 
| xref:mp_units/quantity-05.adoc[`quantity<quantity_like_traits<Q>::reference, quantity_like_traits<Q>::rep>`] 
| xref:mp_units/quantity-02.adoc[`quantity<R{}, Value>`] 
| xref:mp_units/quantity_point-04.adoc[`quantity_point<Q::reference, default_point_origin(Q::reference), Q::rep>`] 
| xref:mp_units/quantity_point-0cb.adoc[`quantity_point<quantity_point_like_traits<QP>::reference, quantity_point_like_traits<QP>::point_origin, quantity_point_like_traits<QP>::rep>`] 
| xref:mp_units/quantity_point-0c5.adoc[`quantity_point<Q::reference, PO{}, Q::rep>`] 
| xref:mp_units/symbol_text-06.adoc[`symbol_text<1, 1>`] 
| xref:mp_units/symbol_text-07.adoc[`symbol_text<N, N>`] 
| xref:mp_units/symbol_text-03f.adoc[`symbol_text<N ‐ 1, N ‐ 1>`] 
| xref:mp_units/symbol_text-0f.adoc[`symbol_text<N, M>`] 
| xref:mp_units/symbol_text-01.adoc[`symbol_text<N ‐ 1, M ‐ 1>`] 
|===


[.small]#Created with https://www.mrdocs.com[MrDocs]#