A quantity of a spatial unit with a representation and precision. More...
#include <quanta/spatial.hpp>
Public Types | |
| using | unit = Unit |
| The unit tag type. | |
| using | rep = Rep |
| The representation type. | |
| using | precision = typename Precision::type |
| The precision as a std::ratio. | |
Public Member Functions | |
| constexpr | quantity ()=default |
| Constructs a zero quantity. | |
| quantity (const quantity &)=default | |
| template<typename Rep2 > requires std::convertible_to<const Rep2&, rep> && (treat_as_inexact_v<rep> || !treat_as_inexact_v<Rep2>) | |
| constexpr | quantity (const Rep2 &r) |
| Constructs from a tick count. | |
| template<typename Rep2 , typename Precision2 > requires std::convertible_to<const Rep2&, rep> && detail::_lossless_conversion<Rep2, Precision2, rep, precision> && detail::_quantity_castable<quantity<Unit, Rep2, Precision2>, quantity> | |
| constexpr | quantity (const quantity< Unit, Rep2, Precision2 > &q) |
| Constructs from another quantity of the same unit with different representation or precision. | |
| template<typename Rep2 , typename Precision2 > requires (!detail::_lossless_conversion<Rep2, Precision2, rep, precision> || !std::convertible_to<const Rep2&, rep>) && detail::_quantity_castable<quantity<Unit, Rep2, Precision2>, quantity> | |
| constexpr | quantity (const quantity< Unit, Rep2, Precision2 > &q) |
| Explicit constructor for lossy conversions. | |
| ~quantity ()=default | |
| quantity & | operator= (const quantity &)=default |
| constexpr rep | count () const |
| Returns the tick count. | |
| constexpr quantity< Unit, typename std::common_type< rep >::type, precision > | operator+ () const |
| Returns a copy of this quantity. | |
| constexpr quantity< Unit, typename std::common_type< rep >::type, precision > | operator- () const |
| Returns the negation of this quantity. | |
| constexpr quantity & | operator++ () |
| constexpr quantity | operator++ (int) |
| constexpr quantity & | operator-- () |
| constexpr quantity | operator-- (int) |
| constexpr quantity & | operator+= (const quantity &q) |
| constexpr quantity & | operator-= (const quantity &q) |
| constexpr quantity & | operator*= (const rep &r) |
| constexpr quantity & | operator/= (const rep &r) |
| constexpr quantity & | operator%= (const rep &r) |
| constexpr quantity & | operator%= (const quantity &q) |
Static Public Member Functions | |
| static constexpr quantity | zero () noexcept |
| Returns a zero quantity. | |
| static constexpr quantity | min () noexcept |
| Returns the minimum representable quantity. | |
| static constexpr quantity | max () noexcept |
| Returns the maximum representable quantity. | |
Detailed Description
class quanta::spatial::quantity< Unit, Rep, Precision >
A quantity of a spatial unit with a representation and precision.
Similar to std::chrono::duration, quantity represents an amount of some spatial unit (meters, square meters or cubic meters). The precision is expressed as a std::ratio of one base unit, so millimeters have precision std::milli, inches have precision std::ratio<127, 5000> (exactly 0.0254 m) and milliliters have precision std::micro (of one cubic meter).
Examples
Lengths (and only lengths) have a nested period alias, equal to precision, matching std::chrono::duration::period. It gives a length the same shape as a duration, so it can be passed to generic code that expects a duration-like or distance-like type, such as quanta::frequency::frequency::wavelength<quanta::spatial::millimeters>(). Areas and volumes deliberately lack it, so such code rejects them.
- Template Parameters
-
Unit The unit tag type (meter_unit, square_meter_unit or cubic_meter_unit). Rep Arithmetic type for the tick count. Precision A std::ratio representing the precision (default: 1).
Definition at line 231 of file spatial.hpp.
Member Typedef Documentation
◆ precision
| using quanta::spatial::quantity< Unit, Rep, Precision >::precision = typename Precision::type |
The precision as a std::ratio.
Definition at line 242 of file spatial.hpp.
◆ rep
| using quanta::spatial::quantity< Unit, Rep, Precision >::rep = Rep |
The representation type.
Definition at line 240 of file spatial.hpp.
◆ unit
| using quanta::spatial::quantity< Unit, Rep, Precision >::unit = Unit |
The unit tag type.
Definition at line 238 of file spatial.hpp.
Constructor & Destructor Documentation
◆ quantity() [1/5]
|
constexprdefault |
Constructs a zero quantity.
Referenced by quanta::spatial::quantity< Unit, Rep, Precision >::max(), quanta::spatial::quantity< Unit, Rep, Precision >::min(), quanta::spatial::quantity< Unit, Rep, Precision >::operator++(), quanta::spatial::quantity< Unit, Rep, Precision >::operator--(), and quanta::spatial::quantity< Unit, Rep, Precision >::zero().
◆ quantity() [2/5]
|
default |
◆ quantity() [3/5]
requires std::convertible_to<const Rep2&, rep> && (treat_as_inexact_v<rep> || !treat_as_inexact_v<Rep2>)
|
inlineexplicitconstexpr |
Constructs from a tick count.
Implicit for inexact types, explicit otherwise to prevent accidental precision loss.
- Template Parameters
-
Rep2 The source representation type.
- Parameters
-
r The tick count.
Definition at line 259 of file spatial.hpp.
◆ quantity() [4/5]
requires std::convertible_to<const Rep2&, rep> && detail::_lossless_conversion<Rep2, Precision2, rep, precision> && detail::_quantity_castable<quantity<Unit, Rep2, Precision2>, quantity>
|
inlineconstexpr |
Constructs from another quantity of the same unit with different representation or precision.
Implicit when the conversion is lossless (the target rep is floating-point, or the target precision evenly divides the source precision and the source rep is not floating-point) and the source rep converts implicitly to the target rep. Any other conversion that the cast can perform is explicit (see below).
- Template Parameters
-
Rep2 Source representation type. Precision2 Source precision.
- Parameters
-
q The source quantity.
Definition at line 280 of file spatial.hpp.
◆ quantity() [5/5]
requires (!detail::_lossless_conversion<Rep2, Precision2, rep, precision> || !std::convertible_to<const Rep2&, rep>) && detail::_quantity_castable<quantity<Unit, Rep2, Precision2>, quantity>
|
inlineexplicitconstexpr |
Explicit constructor for lossy conversions.
Every conversion that the cast can perform and that is not implicit (see above) is explicit: a lossy one (to a coarser precision, or from a floating-point rep to an integral one), or one to a rep that the source rep converts to only explicitly. The value is that of the domain's cast, truncated toward zero. The cast can perform the conversion when the conversion factor between the precisions fits in a std::ratio and the reps are integral or have a common type with intmax_t through which the count converts.
- Template Parameters
-
Rep2 Source representation type. Precision2 Source precision.
- Parameters
-
q The source quantity.
Definition at line 303 of file spatial.hpp.
◆ ~quantity()
|
default |
Member Function Documentation
◆ count()
|
inlineconstexpr |
Returns the tick count.
Definition at line 310 of file spatial.hpp.
Referenced by quanta::spatial::quantity< Unit, Rep, Precision >::operator%=(), quanta::spatial::quantity< Unit, Rep, Precision >::operator+=(), quanta::spatial::quantity< Unit, Rep, Precision >::operator-=(), quanta::spatial::operator/(), quanta::spatial::operator<=>(), quanta::spatial::operator==(), quanta::spatial::to_string(), and quanta::spatial::to_string().
◆ max()
|
inlinestaticconstexprnoexcept |
Returns the maximum representable quantity.
Definition at line 377 of file spatial.hpp.
References quanta::spatial::quantity< Unit, Rep, Precision >::quantity().
◆ min()
|
inlinestaticconstexprnoexcept |
Returns the minimum representable quantity.
Definition at line 374 of file spatial.hpp.
References quanta::spatial::quantity< Unit, Rep, Precision >::quantity().
◆ operator%=() [1/2]
|
inlineconstexpr |
Definition at line 363 of file spatial.hpp.
References quanta::spatial::quantity< Unit, Rep, Precision >::count().
◆ operator%=() [2/2]
|
inlineconstexpr |
Definition at line 356 of file spatial.hpp.
◆ operator*=()
|
inlineconstexpr |
Definition at line 346 of file spatial.hpp.
◆ operator+()
|
inlineconstexpr |
Returns a copy of this quantity.
Definition at line 313 of file spatial.hpp.
◆ operator++() [1/2]
|
inlineconstexpr |
Definition at line 322 of file spatial.hpp.
◆ operator++() [2/2]
|
inlineconstexpr |
Definition at line 327 of file spatial.hpp.
References quanta::spatial::quantity< Unit, Rep, Precision >::quantity().
◆ operator+=()
|
inlineconstexpr |
Definition at line 336 of file spatial.hpp.
References quanta::spatial::quantity< Unit, Rep, Precision >::count().
◆ operator-()
|
inlineconstexpr |
Returns the negation of this quantity.
Definition at line 318 of file spatial.hpp.
◆ operator--() [1/2]
|
inlineconstexpr |
Definition at line 329 of file spatial.hpp.
◆ operator--() [2/2]
|
inlineconstexpr |
Definition at line 334 of file spatial.hpp.
References quanta::spatial::quantity< Unit, Rep, Precision >::quantity().
◆ operator-=()
|
inlineconstexpr |
Definition at line 341 of file spatial.hpp.
References quanta::spatial::quantity< Unit, Rep, Precision >::count().
◆ operator/=()
|
inlineconstexpr |
Definition at line 351 of file spatial.hpp.
◆ operator=()
|
default |
◆ zero()
|
inlinestaticconstexprnoexcept |
Returns a zero quantity.
Definition at line 371 of file spatial.hpp.
References quanta::spatial::quantity< Unit, Rep, Precision >::quantity().
The documentation for this class was generated from the following file:
- quanta/spatial.hpp
