Namespaces
Name |
Description |
The Measurement Library |
mp_units namespace
The Measurement Library
Namespaces
Name |
Description |
Public authoring vocabulary shared by the library's own customization points and by higher‐level tools. |
Types
Name |
Description |
A point origin located at the zero point of a quantity specification |
|
A dimension of a base quantity |
|
A compile‐time fixed string |
|
Policy that checks the value is within [min, max]and reports violations. |
|
Policy that checks the value is ≥ 0 and reports violations. |
|
Policy that clamps the value to [0, ∞).] |
|
Policy that clamps the value to [min, max]. |
|
Measurement unit for an accumulation of two quantities of different units |
|
Customization point for handling domain constraint violations. |
|
A dimension of a derived quantity |
|
A specification of a derived quantity |
|
Measurement unit for a derived quantity |
|
Dimension one |
|
Formatting options for |
|
Quantity of dimension one |
|
Tag property marking a |
|
The type of a quantity kind for the quantity specification |
|
A named Magnitude constant identified by its symbol and, where supported, its value |
|
A constant defined in terms of a unit |
|
A named unit |
|
Implementation type of |
|
Tag property marking a |
|
Unit one |
|
The "ppm" (parts per million) unit, equal to 1/1,000,000 |
|
Type list type storing the list of components with negative exponents |
|
The "‰" (per mille) unit, equal to 1/1000 |
|
The "%" (percent) unit, equal to 1/100 |
|
The mathematical constant π, exposed as a dimensionless named constant |
|
A convenient Magnitude constant for pi, which we can manipulate like a regular number. |
|
Tag property canceling an inherited |
|
Type container for exponents with ratio different than |
|
A prefixed unit |
|
A quantity |
|
Quantity character |
|
Provides support for external quantity‐like types |
|
A quantity point |
|
Provides support for external quantity point‐like types |
|
A specification of a quantity used to define its kind, dimension, and character |
|
Quantity reference type |
|
Policy that reflects (folds) the value at both boundaries. |
|
A point origin defined relative to another quantity point |
|
Relative standard uncertainty of a measured constant |
|
Maps a representation value type to the concrete type a quantity should store. |
|
Describes the underlying arithmetic/element type of a representation type. |
|
A type trait that defines zero, one, min, and max for a representation type |
|
Tag type for the |
|
Tag type for the |
|
Tag type for the |
|
Unit being a scaled version of another unit |
|
Absolute standard uncertainty of a measured constant |
|
A symbol text representation |
|
Tag type for the |
|
Specifies the options used to format a unit symbol |
|
Ordered list of the 1D‐vector component axes a vector quantity decomposes into |
|
Opts a vector quantity into decomposition into named 1D‐vector components |
|
Policy that wraps the value into the half‐open range [min, max).] |
Type Aliases
Name |
Description |
Alias for |
|
The underlying symbolic expression factor type, unwrapping |
|
|
|
|
|
|
|
|
|
|
|
|
Deprecated alias for |
Public alias that yields the representation type of a quantity‐like type. |
|
Convenience alias for |
|
Convenience alias for |
|
|
Deprecated alias for |
|
Deprecated alias for |
Enums
Name |
Description |
Character set used to render a |
|
|
The pre‐2.6.0 flat quantity character enumeration |
The numeric field axis of a quantity's character |
|
The tensor order axis of a quantity's character |
|
Specifies the separator placed between the symbols of a unit symbol's factors |
|
Specifies how the solidus ( |
Functions
Name |
Description |
Computes the absolute value of a quantity |
|
Constructs a |
|
Checks whether a quantity of quantity spec |
|
|
|
|
|
|
|
Returns the default point origin for a reference |
|
Constructs a |
|
Returns the textual symbol of a dimension as a |
|
Writes the textual symbol of a dimension to an output iterator. |
|
|
Returns the epsilon of the quantity |
Computes Euler's raised to the given power |
|
Checks whether a quantity of quantity spec |
|
|
|
|
|
Computes the floating‐point remainder of the division operation x / y. |
|
|
|
Computes the canonical form of a unit |
|
|
|
Returns the common unit of two or more units usable as a reference |
|
|
|
Returns the kind of a quantity specification |
|
|
|
Returns the relative standard uncertainty of a measured constant |
|
Returns the standard uncertainty of a measured constant |
|
Returns the unit of a reference |
|
|
|
Checks whether a quantity of quantity spec |
|
Checks whether two quantity specifications are convertible to each other in both directions |
|
|
|
|
Checks whether |
|
Checks whether |
|
Checks whether |
Returns |
|
|
Checks whether |
|
Checks whether |
|
Checks whether |
Checks whether a quantity specification is tagged as non‐negative |
|
|
|
|
|
|
|
Linear interpolation or extrapolation |
|
Computes the midpoint of two points |
|
Multiplication operators |
|
Division operators |
|
Constructs a |
|
|
|
|
|
Computes the IEEE remainder of the floating point division operation x / y. |
|
|
|
|
|
|
|
Returns the textual symbol of a unit |
|
Writes the textual symbol of a unit to an output iterator |
|
|
|
Streams the textual symbol of a dimension to a |
|
Equality operators |
|
Compares two quantity characters lexicographically on (order, field) |
Variables
Name |
Description |
The unique instance of the dimension one. |
|
Quantity of dimension one |
|
A specializable opt‐out: when |
|
Opts |
|
Opts stateless symbolic‐constant tag types out of being a valid quantity representation. |
|
User‐specializable variable template for runtime coordinate frame transformations. |
|
Customization point object returning the imaginary part of a complex‐like value. |
|
Controls whether conversion from |
|
|
Deprecated, no longer necessary; kept only for backward compatibility. |
Whether |
|
Whether |
|
The unique instance of the |
|
|
Deprecated, no longer necessary; kept only for backward compatibility. |
Whether |
|
Whether |
|
Specialization confirming that |
|
Whether |
|
Specialization confirming that |
|
|
Deprecated, no longer necessary; kept only for backward compatibility. |
|
Specifies if a specific conversion between two types is representable without data loss |
|
Deprecated, no longer necessary; kept only for backward compatibility. |
The quantity kind of the hierarchy tree rooted at the quantity specification |
|
|
Deprecated placeholder retained for source compatibility |
A Magnitude constant equal to the value |
|
A Magnitude constant equal to the value |
|
|
Deprecated alias for the pi Magnitude constant |
Create a Magnitude which is some rational number raised to a rational power. |
|
A Magnitude constant equal to the rational number |
|
Customization point object computing the magnitude of a representation value |
|
Customization point object returning the modulus (absolute value) of a complex‐like value. |
|
The point origin located at the zero point of a quantity specification |
|
The unique instance of the |
|
The numeric field of a representation type: real or complex. |
|
Detects |
|
The unique instance of the unit one. |
|
The unique instance of the parts‐per‐million unit. |
|
The unique instance of the per mille unit. |
|
The unique instance of the percent unit. |
|
The unique instance of the π constant. |
|
The unique instance of the pi magnitude constant. |
|
The unique instance of the |
|
Alias for |
|
Customization point object returning the real part of a complex‐like value. |
|
Public helper that yields the reference (unit + quantity spec) associated with a quantity‐like type. |
|
Rounding policy that rounds to the nearest representable value, to even in halfway cases |
|
Rounding policy that rounds towards negative infinity |
|
Rounding policy that rounds towards positive infinity |
|
Puts a space ' ' sign before a unit symbol |
|
The intrinsic tensor order of a representation type: 0 for scalar, 1 for vector, 2 for tensor. |
|
Structural detection of |
|
Specifies if a value of a type should be treated as a floating‐point value |
|
Rounding policy that rounds towards zero for an integral destination |
|
Public helper that yields the unit associated with a quantity‐like type. |
|
|
Deprecated alias for |
Alias for |
Concepts
Name |
Description |
A concept matching all dimensions in the library. |
|
A concept checking if the argument is of the same dimension. |
|
A concept matching constants that are measured rather than exact by definition |
|
A concept matching all quantity point origins in the library |
|
A concept matching all quantity point origins for a specified quantity type in the library |
|
A concept to be used to define prefixes for a unit |
|
A concept matching all quantities in the library |
|
A concept matching all external quantities like types |
|
A concept matching all quantities of the provided quantity spec |
|
A concept matching all quantity points in the library |
|
A concept matching all external quantity point like types |
|
A concept matching all quantity points of the provided property |
|
A concept matching all quantity specifications in the library |
|
A concept matching all quantity specifications of a provided quantity spec value |
|
A concept matching all references in the library. |
|
A concept matching all references of the provided quantity spec |
|
Concept matching a representation type suitable for a quantity specification or character |
|
A concept matching all rounding policies |
|
A concept matching all unit types in the library |
|
Concept to detect whether T is a valid UnitMagnitude. |
|
A concept matching all units associated with the provided quantity spec |
mp_units::utility namespace
Public authoring vocabulary shared by the library's own customization points and by higher‐level tools.
Types
Name |
Description |
A transparent wrapper that carries an error policy for domain constraint enforcement. |
|
The fill/align/width part of a |
|
The fill character(s) of a |
|
A reference to a format argument, by index or (when using fmtlib) by name. |
|
Wraps an integral type with overflow detection. |
|
Error policy that terminates the program on overflow (always available, freestanding‐safe). |
|
Error policy that throws std::overflow_error on overflow (hosted only). |
|
Error policy that terminates the program on constraint violation (freestanding‐safe). |
|
Error policy that throws std::domain_error on constraint violation (hosted only). |
|
Sentinel type for a specializable variable‐template customization point with no usable default. |
|
A |
Type Aliases
Name |
Description |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Enums
Name |
Description |
The alignment option of a |
|
Which alternative of |
Functions
Name |
Description |
Finds the single modifier from |
|
Resolves a dynamic ( |
|
Modulus operators |
|
Multiplication operators |
|
Unary plus operators |
|
Unary minus operators |
|
Division operators |
|
Parses the fill and alignment part of a |
|
Parses a spec value that may be a literal integer or a |
|
Parses the fill/align/width part of a |
|
Parses the range [begin, end) as an unsigned integer.] |
|
Writes a string to an output iterator with fill/align/width padding. |
|
Streams a safe_int's wrapped value to an output stream |
|
Equality operators |
|
Three‐way comparison operators |
Variables
Name |
Description |
The default value of a customization point that has not yet been specialized. |
Concepts
Name |
Description |
A complex‐field representation type. |
|
A complex scalar: complex field with |
|
Concept satisfied by error policy types usable with |
|
Concept satisfied by overflow error policies usable with |
|
A real‐field representation type. |
|
A real scalar (tensor order 0): real field, totally ordered, self‐scalable. |
|
A scalar (real or complex, tensor order 0) ‐ the element type a vector/tensor is built from. |
|
A second‐order tensor (or a lower‐order type filling its slot). |
|
A vector (a scalar, or a magnitude‐bearing tensor‐order‐1 type). |
|
Satisfied when a customization point has been given a value (i.e. is not |
Created with MrDocs