forked from mpusz/mp-units
304 lines
8.1 KiB
C++
304 lines
8.1 KiB
C++
// 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 <units/bits/external/downcasting.h>
|
|
#include <units/bits/external/fixed_string.h>
|
|
#include <units/bits/external/hacks.h>
|
|
#include <units/bits/external/type_traits.h>
|
|
|
|
namespace units {
|
|
|
|
// PrefixFamily
|
|
struct prefix_family;
|
|
|
|
/**
|
|
* @brief A concept matching a prefix family
|
|
*
|
|
* Satisfied by all types derived from `prefix_family`
|
|
*/
|
|
template<typename T>
|
|
concept PrefixFamily = std::derived_from<T, prefix_family>;
|
|
|
|
// Prefix
|
|
// TODO gcc:92150
|
|
// https://gcc.gnu.org/bugzilla/show_bug.cgi?id=92150
|
|
// namespace detail {
|
|
|
|
// template<typename T>
|
|
// inline constexpr bool is_prefix = false;
|
|
|
|
// template<typename PrefixFamily, Ratio R, basic_fixed_string Symbol>
|
|
// inline constexpr bool is_prefix<prefix<PrefixFamily, R, Symbol>> = true;
|
|
|
|
// } // namespace detail
|
|
|
|
/**
|
|
* @brief A concept matching a symbol prefix
|
|
*
|
|
* Satisfied by all instantiations of `prefix`.
|
|
*/
|
|
template<typename T>
|
|
// concept Prefix = detail::is_prefix<T>;
|
|
concept Prefix = true;
|
|
|
|
|
|
namespace detail {
|
|
|
|
template<typename T>
|
|
inline constexpr bool is_ratio = false;
|
|
|
|
} // namespace detail
|
|
|
|
/**
|
|
* @brief A concept matching a ratio
|
|
*
|
|
* Satisfied by all instantiations of `ratio`.
|
|
*/
|
|
template<typename T>
|
|
concept Ratio = detail::is_ratio<T>;
|
|
|
|
/**
|
|
* @brief A concept matching unit's ratio
|
|
*
|
|
* Satisfied by all types that satisfy `Ratio<R>` and for which `R::num > 0` and `R::den > 0`
|
|
*/
|
|
template<typename R>
|
|
concept UnitRatio = Ratio<R> && R::num > 0 && R::den > 0; // double negatives not allowed
|
|
|
|
// Unit
|
|
template<UnitRatio R, typename U>
|
|
struct scaled_unit;
|
|
|
|
/**
|
|
* @brief A concept matching all unit types in the library
|
|
*
|
|
* Satisfied by all unit types derived from the instantiation of :class:`scaled_unit`.
|
|
*/
|
|
template<typename T>
|
|
concept Unit = is_derived_from_instantiation<T, scaled_unit>;
|
|
|
|
template<basic_fixed_string Symbol, Unit U>
|
|
requires U::is_named
|
|
struct base_dimension;
|
|
|
|
namespace detail {
|
|
|
|
#if __GNUC__ == 9 && __GNUC_MINOR__ < 2
|
|
|
|
template<typename T>
|
|
inline constexpr bool is_base_dimension = true;
|
|
|
|
#else
|
|
|
|
template<typename T>
|
|
inline constexpr bool is_base_dimension = false;
|
|
|
|
template<basic_fixed_string Name, typename... Params>
|
|
inline constexpr bool is_base_dimension<base_dimension<Name, Params...>> = true;
|
|
|
|
#endif
|
|
|
|
} // namespace detail
|
|
|
|
/**
|
|
* @brief A concept matching all base dimensions in the library.
|
|
*
|
|
* Satisfied by all dimension types derived from the instantiation of `base_dimension`.
|
|
*/
|
|
template<typename T>
|
|
concept BaseDimension = detail::is_base_dimension<typename T::base_type_workaround>;
|
|
|
|
// Exponent
|
|
namespace detail {
|
|
|
|
template<typename T>
|
|
inline constexpr bool is_exp = false;
|
|
|
|
} // namespace detail
|
|
|
|
/**
|
|
* @brief A concept matching dimension's exponents.
|
|
*
|
|
* Satisfied by all instantiations of :class:`exp`.
|
|
*/
|
|
template<typename T>
|
|
concept Exponent = detail::is_exp<T>;
|
|
|
|
// DerivedDimension
|
|
namespace detail {
|
|
|
|
template<Exponent E, Exponent... ERest>
|
|
requires (BaseDimension<typename E::dimension> && ... && BaseDimension<typename ERest::dimension>)
|
|
struct derived_dimension_base;
|
|
|
|
} // namespace detail
|
|
|
|
/**
|
|
* @brief A concept matching all derived dimensions in the library.
|
|
*
|
|
* Satisfied by all dimension types derived from the instantiation of `detail::derived_dimension_base`.
|
|
*/
|
|
template<typename T>
|
|
concept DerivedDimension = is_instantiation<downcast_base_t<T>, detail::derived_dimension_base>;
|
|
|
|
// Dimension
|
|
/**
|
|
* @brief A concept matching all dimensions in the library.
|
|
*
|
|
* Satisfied by all dimension types for which either `BaseDimension<T>` or `DerivedDimension<T>` is `true`.
|
|
*/
|
|
template<typename T>
|
|
concept Dimension = BaseDimension<T> || DerivedDimension<T>;
|
|
|
|
// UnitOf
|
|
namespace detail {
|
|
|
|
template<Dimension D>
|
|
struct dimension_unit_impl;
|
|
|
|
template<BaseDimension D>
|
|
struct dimension_unit_impl<D> {
|
|
using type = D::base_unit;
|
|
};
|
|
|
|
template<DerivedDimension D>
|
|
struct dimension_unit_impl<D> {
|
|
using type = D::coherent_unit;
|
|
};
|
|
|
|
} // namespace detail
|
|
|
|
/**
|
|
* @brief Returns a 'default' unit of the dimension
|
|
*
|
|
* Depending on the dimension type it returns a base unit (for base dimensions)
|
|
* or a coherent unit (in case of derived dimensions).
|
|
*
|
|
* @tparam D Dimension type to get the unit from.
|
|
*/
|
|
template<Dimension D>
|
|
using dimension_unit = detail::dimension_unit_impl<D>::type;
|
|
|
|
/**
|
|
* @brief A concept matching only units of a specified dimension.
|
|
*
|
|
* Satisfied by all unit types that satisfy `Unit<U>`, `Dimension<D>`, and for which
|
|
* `U::reference` and @c dimension_unit<D>::reference denote the same unit type.
|
|
*
|
|
* @tparam U Type to verify.
|
|
* @tparam D Dimension type to use for verification.
|
|
*/
|
|
template<typename U, typename D>
|
|
concept UnitOf =
|
|
Unit<U> &&
|
|
Dimension<D> &&
|
|
std::same_as<typename U::reference, typename dimension_unit<D>::reference>;
|
|
|
|
// Quantity
|
|
namespace detail {
|
|
|
|
template<typename T>
|
|
inline constexpr bool is_quantity = false;
|
|
|
|
template<typename T>
|
|
inline constexpr bool is_quantity_point = false;
|
|
|
|
} // namespace detail
|
|
|
|
/**
|
|
* @brief A concept matching all quantities in the library.
|
|
*
|
|
* Satisfied by all instantiations of :class:`quantity`.
|
|
*/
|
|
template<typename T>
|
|
concept Quantity = detail::is_quantity<T>;
|
|
|
|
/**
|
|
* @brief A concept matching all quantity points in the library.
|
|
*
|
|
* Satisfied by all instantiations of :class:`quantity_point`.
|
|
*/
|
|
template<typename T>
|
|
concept QuantityPoint = detail::is_quantity_point<T>;
|
|
|
|
|
|
// WrappedQuantity
|
|
namespace detail {
|
|
|
|
template<typename T>
|
|
inline constexpr bool is_wrapped_quantity = false;
|
|
|
|
template<typename T>
|
|
requires requires { typename T::value_type; }
|
|
inline constexpr bool is_wrapped_quantity<T> = Quantity<typename T::value_type> || is_wrapped_quantity<typename T::value_type>;
|
|
|
|
} // namespace detail
|
|
|
|
/**
|
|
* @brief A concept matching types that wrap quantity objects.
|
|
*
|
|
* Satisfied by all wrapper types that satisfy `Quantity<typename T::value_type>`
|
|
* recursively (i.e. `std::optional<si::length<si::metre>>`).
|
|
*/
|
|
template<typename T>
|
|
concept WrappedQuantity = detail::is_wrapped_quantity<T>;
|
|
|
|
// Scalar
|
|
|
|
namespace detail {
|
|
|
|
template<typename T>
|
|
concept constructible_from_integral =
|
|
// construction from an integral type
|
|
std::constructible_from<T, std::int64_t> &&
|
|
// unit scaling
|
|
std::regular_invocable<std::multiplies<>, T, T> &&
|
|
std::regular_invocable<std::divides<>, T, T>;
|
|
|
|
template<typename T>
|
|
concept not_constructible_from_integral =
|
|
// not construction from an integral type
|
|
(!std::constructible_from<T, std::int64_t>) &&
|
|
|
|
// scaling by the value from ratio
|
|
std::regular_invocable<std::multiplies<>, T, std::int64_t> &&
|
|
std::regular_invocable<std::multiplies<>, std::int64_t, T>; // &&
|
|
// std::regular_invocable<std::divides<>, T, std::int64_t>; // TODO Uncomment when a bug in LA is fixed
|
|
|
|
} // namespace detail
|
|
|
|
/**
|
|
* @brief A concept matching non-Quantity types.
|
|
*
|
|
* Satisfied by types that satisfy `(!Quantity<T>) && (!WrappedQuantity<T>) && std::regular<T>`.
|
|
*/
|
|
template<typename T>
|
|
concept Scalar =
|
|
(!Quantity<T>) &&
|
|
(!WrappedQuantity<T>) &&
|
|
std::regular<T> &&
|
|
(detail::constructible_from_integral<T> || detail::not_constructible_from_integral<T>);
|
|
|
|
} // namespace units
|