// The MIT License (MIT) // // Copyright (c) 2018 Mateusz Pusz // // Permission is hereby granted, free of charge, to any person obtaining a copy // of this software and associated documentation files (the "Software"), to deal // in the Software without restriction, including without limitation the rights // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell // copies of the Software, and to permit persons to whom the Software is // furnished to do so, subject to the following conditions: // // The above copyright notice and this permission notice shall be included in all // copies or substantial portions of the Software. // // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE // SOFTWARE. #pragma once #include #include #include #include #include #include #include #include #include #include #include // the below is not used in this header but should be exposed with it #include #include namespace mp_units { namespace detail { template using quantity_like_type = quantity::reference, typename quantity_like_traits::rep>; template concept RepSafeConstructibleFrom = // exposition only std::constructible_from && (treat_as_floating_point || !treat_as_floating_point); // UFrom ratio is an exact multiple of UTo template concept Harmonic = // exposition only Unit && Unit && is_integral(get_canonical_unit(UFrom).mag / get_canonical_unit(UTo).mag); template concept QuantityConvertibleTo = // exposition only Quantity && Quantity && implicitly_convertible(QFrom::quantity_spec, QTo::quantity_spec) && convertible(QFrom::unit, QTo::unit) && requires(QFrom q) { detail::sudo_cast(q); } && (treat_as_floating_point || (!treat_as_floating_point && Harmonic)); template concept InvokeResultOf = std::regular_invocable && RepresentationOf, Ch>; template concept InvocableQuantities = Quantity && Quantity && InvokeResultOf && requires { common_reference(Q1::reference, Q2::reference); } && std::constructible_from>, Q1> && std::constructible_from>, Q2>; template requires detail::InvocableQuantities using common_quantity_for = quantity>; } // namespace detail /** * @brief A quantity * * 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. * * @tparam R a reference of the quantity providing all information about quantity properties * @tparam Rep a type to be used to represent values of a quantity */ template Rep = double> class quantity { public: Rep number_; // needs to be public for a structural type // member types and values static constexpr Reference auto reference = R; static constexpr QuantitySpec auto quantity_spec = get_quantity_spec(reference); static constexpr Dimension auto dimension = quantity_spec.dimension; static constexpr Unit auto unit = get_unit(reference); using rep = Rep; // static member functions [[nodiscard]] static constexpr quantity zero() noexcept requires requires { quantity_values::zero(); } { return quantity(quantity_values::zero()); } [[nodiscard]] static constexpr quantity one() noexcept requires requires { quantity_values::one(); } { return quantity(quantity_values::one()); } [[nodiscard]] static constexpr quantity min() noexcept requires requires { quantity_values::min(); } { return quantity(quantity_values::min()); } [[nodiscard]] static constexpr quantity max() noexcept requires requires { quantity_values::max(); } { return quantity(quantity_values::max()); } // construction, assignment, destruction quantity() = default; quantity(const quantity&) = default; quantity(quantity&&) = default; template Q> constexpr explicit(false) quantity(const Q& q) : number_(detail::sudo_cast(q).number()) { } template requires detail::QuantityConvertibleTo, quantity> constexpr explicit quantity(const Q& q) : quantity(detail::quantity_like_type(quantity_like_traits::number(q))) { } template requires(dimension == dimension_one) && (unit == ::mp_units::one) && detail::RepSafeConstructibleFrom> constexpr explicit(!std::convertible_to) quantity(Value&& v) : number_(std::forward(v)) { } quantity& operator=(const quantity&) = default; quantity& operator=(quantity&&) = default; // data access [[nodiscard]] constexpr const rep& number() const& noexcept { return number_; } [[nodiscard]] constexpr rep&& number() && noexcept { return std::move(number_); } [[nodiscard]] constexpr const rep&& number() const&& noexcept { return std::move(number_); } template requires requires(quantity q) { q[U{}]; } [[nodiscard]] constexpr rep number_in(U) const noexcept { return (*this)[U{}].number(); } template requires detail::QuantityConvertibleTo{}, Rep>> [[nodiscard]] constexpr quantity<::mp_units::reference{}, Rep> operator[](U) const { return quantity{*this}; } // member unary operators [[nodiscard]] constexpr Quantity auto operator+() const requires requires(rep v) { { +v } -> std::common_with; } { return make_quantity(+number()); } [[nodiscard]] constexpr Quantity auto operator-() const requires requires(rep v) { { -v } -> std::common_with; } { return make_quantity(-number()); } constexpr quantity& operator++() requires requires(rep v) { { ++v } -> std::same_as; } { ++number_; return *this; } [[nodiscard]] constexpr Quantity auto operator++(int) requires requires(rep v) { { v++ } -> std::common_with; } { return make_quantity(number_++); } constexpr quantity& operator--() requires requires(rep v) { { --v } -> std::same_as; } { --number_; return *this; } [[nodiscard]] constexpr Quantity auto operator--(int) requires requires(rep v) { { v-- } -> std::common_with; } { return make_quantity(number_--); } constexpr quantity& operator+=(const quantity& q) requires requires(rep a, rep b) { { a += b } -> std::same_as; } { number_ += q.number(); return *this; } constexpr quantity& operator-=(const quantity& q) requires requires(rep a, rep b) { { a -= b } -> std::same_as; } { number_ -= q.number(); return *this; } template requires(!Quantity) && requires(rep a, const Value b) { { a *= b } -> std::same_as; } constexpr quantity& operator*=(const Value& v) { number_ *= v; return *this; } template Q> requires(Q::unit == ::mp_units::one) && requires(rep a, const typename Q::rep b) { { a *= b } -> std::same_as; } constexpr quantity& operator*=(const Q& rhs) { number_ *= rhs.number(); return *this; } template requires(!Quantity) && requires(rep a, const Value b) { { a /= b } -> std::same_as; } constexpr quantity& operator/=(const Value& v) { gsl_ExpectsAudit(v != quantity_values::zero()); number_ /= v; return *this; } template Q> requires(Q::unit == ::mp_units::one) && requires(rep a, const typename Q::rep b) { { a /= b } -> std::same_as; } constexpr quantity& operator/=(const Q& rhs) { gsl_ExpectsAudit(rhs.number() != quantity_values::zero()); number_ /= rhs.number(); return *this; } constexpr quantity& operator%=(const quantity& q) requires(!treat_as_floating_point) && requires(rep a, rep b) { { a %= b } -> std::same_as; } { gsl_ExpectsAudit(q.number() != quantity_values::zero()); number_ %= q.number(); return *this; } private: template requires RepresentationOf, get_quantity_spec(R2).character> friend constexpr quantity> make_quantity(Rep2&& v); template requires detail::RepSafeConstructibleFrom> constexpr explicit quantity(Value&& v) : number_(std::forward(v)) { } }; // CTAD template explicit quantity(Q) -> quantity::reference, typename quantity_like_traits::rep>; template requires detail::InvocableQuantities, quantity, quantity> [[nodiscard]] constexpr Quantity auto operator+(const quantity& lhs, const quantity& rhs) { using ret = detail::common_quantity_for, quantity, quantity>; return make_quantity(ret(lhs).number() + ret(rhs).number()); } template requires detail::InvocableQuantities, quantity, quantity> [[nodiscard]] constexpr Quantity auto operator-(const quantity& lhs, const quantity& rhs) { using ret = detail::common_quantity_for, quantity, quantity>; return make_quantity(ret(lhs).number() - ret(rhs).number()); } template requires detail::InvokeResultOf<(get_quantity_spec(R1) * get_quantity_spec(R2)).character, std::multiplies<>, Rep1, Rep2> [[nodiscard]] constexpr Quantity auto operator*(const quantity& lhs, const quantity& rhs) { return make_quantity(lhs.number() * rhs.number()); } template requires(!Quantity) && detail::InvokeResultOf, Rep, const Value&> [[nodiscard]] constexpr Quantity auto operator*(const quantity& q, const Value& v) { return make_quantity(q.number() * v); } template requires(!Quantity) && detail::InvokeResultOf, const Value&, Rep> [[nodiscard]] constexpr Quantity auto operator*(const Value& v, const quantity& q) { return make_quantity(v * q.number()); } template requires detail::InvokeResultOf<(get_quantity_spec(R1) / get_quantity_spec(R2)).character, std::divides<>, Rep1, Rep2> [[nodiscard]] constexpr Quantity auto operator/(const quantity& lhs, const quantity& rhs) { gsl_ExpectsAudit(rhs.number() != quantity_values::zero()); return make_quantity(lhs.number() / rhs.number()); } template requires(!Quantity) && detail::InvokeResultOf, Rep, const Value&> [[nodiscard]] constexpr Quantity auto operator/(const quantity& q, const Value& v) { gsl_ExpectsAudit(v != quantity_values::zero()); return make_quantity(q.number() / v); } template requires(!Quantity) && detail::InvokeResultOf, const Value&, Rep> [[nodiscard]] constexpr Quantity auto operator/(const Value& v, const quantity& q) { return make_quantity<::mp_units::one / R>(v / q.number()); } template requires(!treat_as_floating_point) && (!treat_as_floating_point) && detail::InvocableQuantities, quantity, quantity> [[nodiscard]] constexpr Quantity auto operator%(const quantity& lhs, const quantity& rhs) { gsl_ExpectsAudit(rhs.number() != quantity_values::zero()); using ret = detail::common_quantity_for, quantity, quantity>; return make_quantity(ret(lhs).number() % ret(rhs).number()); } template requires requires { typename std::common_type_t, quantity>; } && std::equality_comparable, quantity>::rep> [[nodiscard]] constexpr bool operator==(const quantity& lhs, const quantity& rhs) { using ct = std::common_type_t, quantity>; return ct(lhs).number() == ct(rhs).number(); } template requires requires { typename std::common_type_t, quantity>; } && std::three_way_comparable, quantity>::rep> [[nodiscard]] constexpr auto operator<=>(const quantity& lhs, const quantity& rhs) { using ct = std::common_type_t, quantity>; return ct(lhs).number() <=> ct(rhs).number(); } template requires(!Quantity) && (quantity::dimension == dimension_one) && detail::InvokeResultOf, Rep, Value> [[nodiscard]] constexpr Quantity auto operator+(const quantity& q, const Value& v) { return q + make_quantity<::mp_units::one>(v); } template requires(!Quantity) && (quantity::dimension == dimension_one) && detail::InvokeResultOf, Value, Rep> [[nodiscard]] constexpr Quantity auto operator+(const Value& v, const quantity& q) { return make_quantity<::mp_units::one>(v) + q; } template requires(!Quantity) && (quantity::dimension == dimension_one) && detail::InvokeResultOf, Rep, Value> [[nodiscard]] constexpr Quantity auto operator-(const quantity& q, const Value& v) { return q - make_quantity<::mp_units::one>(v); } template requires(!Quantity) && (quantity::dimension == dimension_one) && detail::InvokeResultOf, Value, Rep> [[nodiscard]] constexpr Quantity auto operator-(const Value& v, const quantity& q) { return make_quantity<::mp_units::one>(v) - q; } template requires(!Quantity) && (quantity::dimension == dimension_one) && (get_unit(R) == ::mp_units::one) && (!treat_as_floating_point) && (!treat_as_floating_point) && detail::InvokeResultOf, Value, Rep> [[nodiscard]] constexpr Quantity auto operator%(const Value& v, const quantity& q) { gsl_ExpectsAudit(q.number() != quantity_values::zero()); return make_quantity(v % q.number()); } template requires(!Quantity) && (quantity::dimension == dimension_one) && std::equality_comparable_with [[nodiscard]] constexpr bool operator==(const quantity& q, const Value& v) { return q == make_quantity<::mp_units::one>(v); } template requires(!Quantity) && (quantity::dimension == dimension_one) && std::three_way_comparable_with [[nodiscard]] constexpr auto operator<=>(const quantity& q, const Value& v) { return q <=> make_quantity<::mp_units::one>(v); } template requires RepresentationOf, get_quantity_spec(R).character> [[nodiscard]] constexpr quantity> make_quantity(Rep&& v) { return quantity>(std::forward(v)); } } // namespace mp_units namespace std { template requires requires { { mp_units::common_reference(Q1::reference, Q2::reference) } -> mp_units::Reference; typename common_type_t; } struct common_type { public: using type = mp_units::quantity>; }; // dimensionless quantities support for interacting with raw values template requires(!mp_units::Quantity) && (Q::dimension == mp_units::dimension_one) && (Q::unit == mp_units::one) && requires { typename common_type_t; } struct common_type { public: using type = mp_units::quantity>; }; template requires(!mp_units::Quantity) && (Q::dimension == mp_units::dimension_one) && (Q::unit == mp_units::one) && requires { typename common_type_t; } struct common_type : common_type {}; } // namespace std