// 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 // IWYU pragma: begin_exports #include // #include #include #include #include #include #include #include // IWYU pragma: end_exports #include namespace units { namespace detail { // TODO: Replace with `v * R` pending https://github.com/BobSteagall/wg21/issues/58. template inline constexpr auto make_quantity = [](Representation auto&& v) { using Rep = std::remove_cvref_t; return quantity(std::forward(v)); }; template concept quantity_one = Quantity && (T::dimension == dimension_one) && (T::unit == one); } // namespace detail template concept floating_point_ = // exposition only (Quantity && treat_as_floating_point) || (!Quantity && treat_as_floating_point); template concept safe_convertible_to_ = // exposition only (!Quantity) && (!Quantity) && std::convertible_to && (floating_point_ || (!floating_point_)); // QFrom ratio is an exact multiple of QTo template concept harmonic_ = // exposition only Quantity && Quantity && is_integral(detail::get_canonical_unit(QFrom::unit).mag / detail::get_canonical_unit(QTo::unit).mag); template concept quantity_convertible_to_ = // exposition only Quantity && Quantity && interconvertible(QFrom::reference, QTo::reference) && scalable_with_ && (floating_point_ || (!floating_point_ && harmonic_)); template concept quantity_value_for_ = std::regular_invocable && Representation>; template concept invoke_result_convertible_to_ = Representation && quantity_value_for_ && safe_convertible_to_>; template concept have_quantity_for_ = Quantity && (!Quantity) && quantity_value_for_; template concept QuantityLike = requires(T q) { quantity_like_traits::dimension; quantity_like_traits::unit; typename quantity_like_traits::rep; requires Dimension::dimension)>>; requires Unit::unit)>>; requires Representation::rep>; { quantity_like_traits::number(q) } -> std::convertible_to::rep>; }; template using quantity_like_type = quantity::dimension, quantity_like_traits::unit>{}, typename quantity_like_traits::rep>; /** * @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 measurement unit. * * @tparam D a dimension of the quantity (can be either a BaseDimension or a DerivedDimension) * @tparam U a measurement unit of the quantity * @tparam Rep a type to be used to represent values of a quantity */ template class quantity { Rep number_; public: // member types and values using rep = Rep; static constexpr auto reference = R; static constexpr auto dimension = R.dimension; static constexpr auto unit = R.unit; // 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 requires safe_convertible_to_, rep> constexpr explicit(!detail::quantity_one) quantity(Value&& v) : number_(std::forward(v)) { } template Q> constexpr explicit(false) quantity(const Q& q) : number_(quantity_cast(q).number()) { } template requires quantity_convertible_to_, quantity> constexpr explicit quantity(const Q& q) : quantity(quantity_like_type(quantity_like_traits::number(q))) { } quantity& operator=(const quantity&) = default; quantity& operator=(quantity&&) = default; // data access [[nodiscard]] constexpr rep& number() & noexcept { return number_; } [[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 quantity_convertible_to_{}, Rep>> [[nodiscard]] constexpr quantity<::units::reference{}, Rep> operator[](U) const { return quantity<::units::reference{}, Rep>{*this}; } // member unary operators [[nodiscard]] constexpr Quantity auto operator+() const requires requires(rep v) { { +v } -> std::common_with; } { using ret = quantity; return ret(+number()); } [[nodiscard]] constexpr Quantity auto operator-() const requires std::regular_invocable, rep> { using ret = quantity; return ret(-number()); } constexpr quantity& operator++() requires requires(rep v) { { ++v } -> std::same_as; } { ++number_; return *this; } [[nodiscard]] constexpr quantity operator++(int) requires requires(rep v) { { v++ } -> std::same_as; } { return quantity(number_++); } constexpr quantity& operator--() requires requires(rep v) { { --v } -> std::same_as; } { --number_; return *this; } [[nodiscard]] constexpr quantity operator--(int) requires requires(rep v) { { v-- } -> std::same_as; } { return 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 constexpr quantity& operator*=(const Rep2& rhs) requires requires(rep a, const Rep2 b) { { a *= b } -> std::same_as; } { number_ *= rhs; return *this; } template constexpr quantity& operator*=(const Q& rhs) requires requires(rep a, const typename Q::rep b) { { a *= b } -> std::same_as; } { number_ *= rhs.number(); return *this; } template constexpr quantity& operator/=(const Rep2& rhs) requires requires(rep a, const Rep2 b) { { a /= b } -> std::same_as; } { gsl_ExpectsAudit(rhs != quantity_values::zero()); number_ /= rhs; return *this; } template constexpr quantity& operator/=(const Q& rhs) requires requires(rep a, const typename Q::rep b) { { a /= b } -> std::same_as; } { gsl_ExpectsAudit(rhs.number() != quantity_values::zero()); number_ /= rhs.number(); return *this; } template constexpr quantity& operator%=(const Rep2& rhs) requires(!floating_point_) && (!floating_point_) && requires(rep a, const Rep2 b) { { a %= b } -> std::same_as; } { gsl_ExpectsAudit(rhs != quantity_values::zero()); number_ %= rhs; return *this; } template constexpr quantity& operator%=(const Q& rhs) requires(!floating_point_) && (!floating_point_) && requires(rep a, const typename Q::rep b) { { a %= b } -> std::same_as; } { gsl_ExpectsAudit(rhs.number() != quantity_values::zero()); number_ %= rhs.number(); return *this; } constexpr quantity& operator%=(const quantity& q) requires(!floating_point_) && requires(rep a, rep b) { { a %= b } -> std::same_as; } { gsl_ExpectsAudit(q.number() != quantity_values::zero()); number_ %= q.number(); return *this; } // Hidden Friends // Below friend functions are to be found via argument-dependent lookup only template [[nodiscard]] friend constexpr Quantity auto operator+(const quantity& lhs, const Value& rhs) requires requires { // TODO: Simplify when Clang catches up. requires !Quantity; requires unit == ::units::one; requires invoke_result_convertible_to_, rep, Value>; } { return ::units::quantity(lhs.number() + rhs); } template [[nodiscard]] friend constexpr Quantity auto operator+(const Value& lhs, const quantity& rhs) requires requires { // TODO: Simplify when Clang catches up. requires !Quantity; requires unit == ::units::one; requires invoke_result_convertible_to_, Value, rep>; } { return ::units::quantity(lhs + rhs.number()); } template [[nodiscard]] friend constexpr Quantity auto operator-(const quantity& lhs, const Value& rhs) requires requires { // TODO: Simplify when Clang catches up. requires !Quantity; requires unit == ::units::one; requires invoke_result_convertible_to_, rep, Value>; } { return ::units::quantity(lhs.number() - rhs); } template [[nodiscard]] friend constexpr Quantity auto operator-(const Value& lhs, const quantity& rhs) requires requires { // TODO: Simplify when Clang catches up. requires !Quantity; requires unit == ::units::one; requires invoke_result_convertible_to_, Value, rep>; } { return ::units::quantity(lhs - rhs.number()); } template requires invoke_result_convertible_to_, rep, const Value&> [[nodiscard]] friend constexpr Quantity auto operator*(const quantity& q, const Value& v) { using ret = quantity, rep, Value>>; return ret(q.number() * v); } template requires invoke_result_convertible_to_, const Value&, rep> [[nodiscard]] friend constexpr Quantity auto operator*(const Value& v, const quantity& q) { using ret = quantity, Value, rep>>; return ret(v * q.number()); } template requires(!Quantity) && invoke_result_convertible_to_, rep, const Value&> [[nodiscard]] friend constexpr Quantity auto operator/(const quantity& q, const Value& v) { gsl_ExpectsAudit(v != quantity_values::zero()); using ret = quantity, rep, Value>>; return ret(q.number() / v); } template requires(!Quantity) && invoke_result_convertible_to_, const Value&, rep> [[nodiscard]] friend constexpr Quantity auto operator/(const Value& v, const quantity& q) { return detail::make_quantity(v / q.number()); } template requires(!Quantity) && (!floating_point_) && (!floating_point_) && invoke_result_convertible_to_, rep, const Value&> [[nodiscard]] friend constexpr Quantity auto operator%(const quantity& q, const Value& v) { gsl_ExpectsAudit(v != quantity_values::zero()); using ret = quantity, rep, Value>>; return ret(q.number() % v); } [[nodiscard]] friend constexpr Quantity auto operator%(const quantity& lhs, const quantity& rhs) requires(!floating_point_) && invoke_result_convertible_to_, rep, rep> { gsl_ExpectsAudit(rhs.number() != quantity_values::zero()); using ret = quantity, rep, rep>>; return ret(lhs.number() % rhs.number()); } [[nodiscard]] friend constexpr auto operator<=>(const quantity& lhs, const quantity& rhs) requires std::three_way_comparable #if UNITS_COMP_GCC == 10 && UNITS_COMP_GCC_MINOR >= 2 = default; #else { return lhs.number() <=> rhs.number(); } #endif [[nodiscard]] friend constexpr bool operator==(const quantity& lhs, const quantity& rhs) = default; }; // CTAD #if !UNITS_COMP_CLANG || UNITS_COMP_CLANG > 16 template explicit(false) quantity(Rep&&) -> quantity; #endif template explicit(false) quantity(quantity) -> quantity; template explicit(false) quantity(Rep)->quantity; template explicit quantity(Q) -> quantity::dimension, quantity_like_traits::unit>{}, typename quantity_like_traits::rep>; // non-member binary operators template requires(interconvertible(Q1::reference, Q2::reference)) && quantity_value_for_, typename Q1::rep, typename Q2::rep> [[nodiscard]] constexpr Quantity auto operator+(const Q1& lhs, const Q2& rhs) { constexpr auto ref = common_reference(Q1::reference, Q2::reference); using ret = quantity; return ret(ret(lhs).number() + ret(rhs).number()); } template requires(interconvertible(Q1::reference, Q2::reference)) && quantity_value_for_, typename Q1::rep, typename Q2::rep> [[nodiscard]] constexpr Quantity auto operator-(const Q1& lhs, const Q2& rhs) { constexpr auto ref = common_reference(Q1::reference, Q2::reference); using ret = quantity; return ret(ret(lhs).number() - ret(rhs).number()); } template requires quantity_value_for_, typename Q1::rep, typename Q2::rep> [[nodiscard]] constexpr Quantity auto operator*(const Q1& lhs, const Q2& rhs) { return detail::make_quantity(lhs.number() * rhs.number()); } template requires quantity_value_for_, typename Q1::rep, typename Q2::rep> [[nodiscard]] constexpr Quantity auto operator/(const Q1& lhs, const Q2& rhs) { gsl_ExpectsAudit(rhs.number() != quantity_values::zero()); return detail::make_quantity(lhs.number() / rhs.number()); } template requires(!floating_point_) && (!floating_point_) && (interconvertible(Q1::reference, Q2::reference) || quantity_of) && quantity_value_for_, typename Q1::rep, typename Q2::rep> [[nodiscard]] constexpr Quantity auto operator%(const Q1& lhs, const Q2& rhs) { gsl_ExpectsAudit(rhs.number() != quantity_values::zero()); using ret = quantity{}, std::invoke_result_t, typename Q1::rep, typename Q2::rep>>; return ret(lhs.number() % rhs.number()); } template requires(interconvertible(Q1::reference, Q2::reference)) && std::three_way_comparable_with [[nodiscard]] constexpr auto operator<=>(const Q1& lhs, const Q2& rhs) { constexpr auto ref = common_reference(Q1::reference, Q2::reference); return quantity_cast(lhs).number() <=> quantity_cast(rhs).number(); } template requires(interconvertible(Q1::reference, Q2::reference)) && std::equality_comparable_with [[nodiscard]] constexpr bool operator==(const Q1& lhs, const Q2& rhs) { constexpr auto ref = common_reference(Q1::reference, Q2::reference); return quantity_cast(lhs).number() == quantity_cast(rhs).number(); } } // namespace units namespace std { template requires requires { { units::common_reference(Q1::reference, Q2::reference) } -> units::Reference; typename common_type_t; } struct common_type { public: using type = units::quantity>; }; } // namespace std