mp_units::quantity

A quantity

Synopsis

Declared in <mp-units/framework/quantity.h>
template<
    Reference auto R,
    RepresentationOf<get_quantity_spec(R)> Rep>
class quantity;


Types

Name
rep

Member Functions

Name Description
quantity [constructor]Constructors
~quantity [destructor]Destructor
operator= Assignment operators
force_in
force_numerical_value_in
in
numerical_value_in
numerical_value_ref_in [deleted]
operator%= Modulus assignment operator
operator*= Multiplication assignment operators
operator+
operator++ Increment operators
operator+= Addition assignment operator
operator-
operator-- Decrement operators
operator-= Subtraction assignment operator
operator/= Division assignment operators
operator Conversion operators

Static Member Functions

Name
max
min
zero

Data Members

Name Description
numerical_value_is_an_implementation_detail_ needs to be public for a structural type

Static Data Members

Name
dimension
quantity_spec
reference
unit

Friends

|===
Name Description
operator<=> Three-way comparison operator
operator<=> Three-way comparison operator
operator== Equality operator
operator== Equality operator
operator/
operator/
operator/
operator*
operator*
operator*
operator%
operator%
operator%
operator-
operator-
operator-
operator+
operator+
operator+

Non-Member Functions

Name Description
absComputes the absolute value of a quantity
cbrtComputes the cubic root of a quantity
ceilComputes the smallest quantity with integer representation and unit type To with its number not less than q
epsilonReturns the epsilon of the quantity
expComputes Euler's raised to the given power
floorComputes the largest quantity with integer representation and unit type To with its number not greater than q
fmaComputes the fma of 3 quantities
fmaComputes the fma of 2 quantities and a quantity point
fmodComputes the floating-point remainder of the division operation x / y.
hypotComputes the square root of the sum of the squares of x, y, and z, without undue overflow or underflow at intermediate stages of the computation
hypotComputes the square root of the sum of the squares of x and y, without undue overflow or underflow at intermediate stages of the computation
inverseComputes the inverse of a quantity in a provided unit
isfiniteDetermines if a quantity is finite.
isinfDetermines if a quantity is infinite.
isnanDetermines if a quantity is a nan.
powComputes the value of a quantity raised to the Num/Den power
remainderComputes the IEEE remainder of the floating point division operation x / y.
roundComputes the nearest quantity with integer representation and unit type To to q
sqrtComputes the square root of a quantity
value_castExplicit cast of a quantity's representation type

Description

Property of a phenomenon, body, or substance, where the property has a magnitude that can be expressed by means of a number and a reference.

Template Parameters

Name Description
R a reference of the quantity providing all information about quantity properties
Rep a type to be used to represent values of a quantity

Created with MrDocs