Skip to content

Commit

Permalink
refactor: private unit_magnitude interface renamed to not use leadi…
Browse files Browse the repository at this point in the history 
…ng `_`
  • Loading branch information
@mpusz
mpusz committed Nov 21, 2024
1 parent a673c8d commit de534b3
Show file tree
Hide file tree
Showing 6 changed files with 59 additions and 59 deletions.
18 changes: 9 additions & 9 deletions src/core/include/mp-units/bits/sudo_cast.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -76,12 +76,12 @@ struct conversion_type_traits {
*/
template<UnitMagnitude auto M, typename T>
struct conversion_value_traits {
static constexpr UnitMagnitude auto num = _numerator(M);
static constexpr UnitMagnitude auto den = _denominator(M);
static constexpr UnitMagnitude auto num = numerator(M);
static constexpr UnitMagnitude auto den = denominator(M);
static constexpr UnitMagnitude auto irr = M * (den / num);
static constexpr T num_mult = _get_value<T>(num);
static constexpr T den_mult = _get_value<T>(den);
static constexpr T irr_mult = _get_value<T>(irr);
static constexpr T num_mult = get_value<T>(num);
static constexpr T den_mult = get_value<T>(den);
static constexpr T irr_mult = get_value<T>(irr);
static constexpr T ratio = num_mult / den_mult * irr_mult;
};

Expand Down Expand Up @@ -120,10 +120,10 @@ template<Quantity To, typename FwdFrom, Quantity From = std::remove_cvref_t<FwdF
};

// scale the number
if constexpr (_is_integral(c_mag))
return scale([&](auto value) { return value * _get_value<multiplier_type>(_numerator(c_mag)); });
else if constexpr (_is_integral(_pow<-1>(c_mag)))
return scale([&](auto value) { return value / _get_value<multiplier_type>(_denominator(c_mag)); });
if constexpr (is_integral(c_mag))
return scale([&](auto value) { return value * get_value<multiplier_type>(numerator(c_mag)); });
else if constexpr (is_integral(pow<-1>(c_mag)))
return scale([&](auto value) { return value / get_value<multiplier_type>(denominator(c_mag)); });
else {
using value_traits = conversion_value_traits<c_mag, multiplier_type>;
if constexpr (std::is_floating_point_v<multiplier_type>)
Expand Down
72 changes: 36 additions & 36 deletions src/core/include/mp-units/bits/unit_magnitude.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -214,7 +214,7 @@ struct magnitude_base {};
template<auto H, auto... T>
struct magnitude_base<unit_magnitude<H, T...>> {
template<auto H2, auto... T2>
[[nodiscard]] friend consteval UnitMagnitude auto _multiply_impl(unit_magnitude<H, T...>, unit_magnitude<H2, T2...>)
[[nodiscard]] friend consteval UnitMagnitude auto multiply_impl(unit_magnitude<H, T...>, unit_magnitude<H2, T2...>)
{
if constexpr (mag_less(H, H2)) {
if constexpr (sizeof...(T) == 0) {
Expand Down Expand Up @@ -262,19 +262,19 @@ struct magnitude_base<unit_magnitude<H, T...>> {
// Thus, we make the _simplest_ choice which reproduces the correct convention in the rational case: namely, taking
// the minimum power for each base (where absent bases implicitly have a power of 0).
template<auto H2, auto... T2>
[[nodiscard]] friend consteval auto _common_magnitude(unit_magnitude<H, T...>, unit_magnitude<H2, T2...>)
[[nodiscard]] friend consteval auto common_magnitude(unit_magnitude<H, T...>, unit_magnitude<H2, T2...>)
{
if constexpr (get_base_value(H) < get_base_value(H2)) {
// When H1 has the smaller base, prepend to result from recursion.
return remove_positive_power(unit_magnitude<H>{}) *
_common_magnitude(unit_magnitude<T...>{}, unit_magnitude<H2, T2...>{});
common_magnitude(unit_magnitude<T...>{}, unit_magnitude<H2, T2...>{});
} else if constexpr (get_base_value(H2) < get_base_value(H)) {
// When H2 has the smaller base, prepend to result from recursion.
return remove_positive_power(unit_magnitude<H2>{}) *
_common_magnitude(unit_magnitude<H, T...>{}, unit_magnitude<T2...>{});
common_magnitude(unit_magnitude<H, T...>{}, unit_magnitude<T2...>{});
} else {
// When the bases are equal, pick whichever has the lower power.
constexpr auto common_tail = _common_magnitude(unit_magnitude<T...>{}, unit_magnitude<T2...>{});
constexpr auto common_tail = common_magnitude(unit_magnitude<T...>{}, unit_magnitude<T2...>{});
if constexpr (get_exponent(H) < get_exponent(H2)) {
return unit_magnitude<H>{} * common_tail;
} else {
Expand Down Expand Up @@ -329,7 +329,7 @@ template<typename CharT, UnitMagnitude auto Num, UnitMagnitude auto Den, UnitMag
constexpr Out magnitude_symbol_impl(Out out, const unit_symbol_formatting& fmt)
{
bool numerator = false;
constexpr auto num_value = _get_value<std::intmax_t>(Num);
constexpr auto num_value = get_value<std::intmax_t>(Num);
if constexpr (num_value != 1) {
constexpr auto num = regular<num_value>();
out = copy_symbol<CharT>(num, fmt.char_set, false, out);
Expand All @@ -345,7 +345,7 @@ constexpr Out magnitude_symbol_impl(Out out, const unit_symbol_formatting& fmt)

using enum unit_symbol_solidus;
bool denominator = false;
constexpr auto den_value = _get_value<std::intmax_t>(Den);
constexpr auto den_value = get_value<std::intmax_t>(Den);
constexpr auto den_constants_size = magnitude_list_size(DenConstants);
constexpr auto den_size = (den_value != 1) + den_constants_size;
auto start_denominator = [&]() {
Expand Down Expand Up @@ -403,12 +403,12 @@ struct unit_magnitude : magnitude_base<unit_magnitude<Ms...>> {
else if constexpr (is_same_v<M, unit_magnitude<>>)
return lhs;
else
return _multiply_impl(lhs, rhs);
return multiply_impl(lhs, rhs);
}

[[nodiscard]] friend consteval auto operator/(unit_magnitude lhs, UnitMagnitude auto rhs)
{
return lhs * _pow<-1>(rhs);
return lhs * pow<-1>(rhs);
}

template<UnitMagnitude Rhs>
Expand All @@ -419,9 +419,9 @@ struct unit_magnitude : magnitude_base<unit_magnitude<Ms...>> {

private:
// all below functions should in fact be in a `detail` namespace but are placed here to benefit from the ADL
[[nodiscard]] friend consteval bool _is_integral(const unit_magnitude&) { return (is_integral_impl(Ms) && ...); }
[[nodiscard]] friend consteval bool _is_rational(const unit_magnitude&) { return (is_rational_impl(Ms) && ...); }
[[nodiscard]] friend consteval bool _is_positive_integral_power(const unit_magnitude&)
[[nodiscard]] friend consteval bool is_integral(const unit_magnitude&) { return (is_integral_impl(Ms) && ...); }
[[nodiscard]] friend consteval bool is_rational(const unit_magnitude&) { return (is_rational_impl(Ms) && ...); }
[[nodiscard]] friend consteval bool is_positive_integral_power(const unit_magnitude&)
{
return (is_positive_integral_power_impl(Ms) && ...);
}
Expand All @@ -431,7 +431,7 @@ struct unit_magnitude : magnitude_base<unit_magnitude<Ms...>> {
*/
template<typename T>
requires((is_integral_impl(Ms) && ...)) || treat_as_floating_point<T>
[[nodiscard]] friend consteval T _get_value(const unit_magnitude&)
[[nodiscard]] friend consteval T get_value(const unit_magnitude&)
{
// Force the expression to be evaluated in a constexpr context, to catch, e.g., overflow.
constexpr T result = checked_static_cast<T>((compute_base_power<T>(Ms) * ... * T{1}));
Expand All @@ -441,7 +441,7 @@ struct unit_magnitude : magnitude_base<unit_magnitude<Ms...>> {
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
// Magnitude rational powers implementation.
template<int Num, int Den = 1>
[[nodiscard]] friend consteval auto _pow(unit_magnitude)
[[nodiscard]] friend consteval auto pow(unit_magnitude)
{
if constexpr (Num == 0) {
return unit_magnitude<>{};
Expand All @@ -452,24 +452,24 @@ struct unit_magnitude : magnitude_base<unit_magnitude<Ms...>> {

////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
// Magnitude numerator and denominator implementation.
[[nodiscard]] friend consteval auto _numerator(unit_magnitude)
[[nodiscard]] friend consteval auto numerator(unit_magnitude)
{
return (integer_part(unit_magnitude<Ms>{}) * ... * unit_magnitude<>{});
}

[[nodiscard]] friend consteval auto _denominator(unit_magnitude) { return _numerator(_pow<-1>(unit_magnitude{})); }
[[nodiscard]] friend consteval auto denominator(unit_magnitude) { return numerator(pow<-1>(unit_magnitude{})); }

[[nodiscard]] friend consteval auto _remove_positive_powers(unit_magnitude)
[[nodiscard]] friend consteval auto remove_positive_powers(unit_magnitude)
{
return (unit_magnitude<>{} * ... * remove_positive_power(unit_magnitude<Ms>{}));
}

[[nodiscard]] friend consteval auto _common_magnitude_type_impl(unit_magnitude)
[[nodiscard]] friend consteval auto common_magnitude_type_impl(unit_magnitude)
{
return (std::intmax_t{} * ... * decltype(get_base_value(Ms)){});
}

[[nodiscard]] friend consteval auto _extract_components(unit_magnitude)
[[nodiscard]] friend consteval auto extract_components(unit_magnitude)
{
constexpr auto ratio = (unit_magnitude<>{} * ... * remove_mag_constants(unit_magnitude<Ms>{}));
if constexpr (ratio == unit_magnitude{})
Expand All @@ -482,45 +482,45 @@ struct unit_magnitude : magnitude_base<unit_magnitude<Ms...>> {
}

template<typename T>
[[nodiscard]] friend consteval ratio _get_power([[maybe_unused]] T base, unit_magnitude)
[[nodiscard]] friend consteval ratio get_power([[maybe_unused]] T base, unit_magnitude)
{
return ((get_base_value(Ms) == base ? get_exponent(Ms) : ratio{0}) + ... + ratio{0});
}

[[nodiscard]] friend consteval std::intmax_t _extract_power_of_10(unit_magnitude m)
[[nodiscard]] friend consteval std::intmax_t extract_power_of_10(unit_magnitude m)
{
const auto power_of_2 = _get_power(2, m);
const auto power_of_5 = _get_power(5, m);
const auto power_of_2 = get_power(2, m);
const auto power_of_5 = get_power(5, m);

if ((power_of_2 * power_of_5).num <= 0) return 0;

return integer_part((abs(power_of_2) < abs(power_of_5)) ? power_of_2 : power_of_5);
}

template<typename CharT, std::output_iterator<CharT> Out>
friend constexpr Out _magnitude_symbol(Out out, unit_magnitude, const unit_symbol_formatting& fmt)
friend constexpr Out magnitude_symbol(Out out, unit_magnitude, const unit_symbol_formatting& fmt)
{
if constexpr (unit_magnitude{} == unit_magnitude<1>{}) {
return out;
} else {
constexpr auto extract_res = _extract_components(unit_magnitude{});
constexpr auto extract_res = extract_components(unit_magnitude{});
constexpr UnitMagnitude auto ratio = std::get<0>(extract_res);
constexpr UnitMagnitude auto num_constants = std::get<1>(extract_res);
constexpr UnitMagnitude auto den_constants = std::get<2>(extract_res);
constexpr std::intmax_t exp10 = _extract_power_of_10(ratio);
constexpr std::intmax_t exp10 = extract_power_of_10(ratio);
if constexpr (abs(exp10) < 3) {
// print the value as a regular number (without exponent)
constexpr UnitMagnitude auto num = _numerator(unit_magnitude{});
constexpr UnitMagnitude auto den = _denominator(unit_magnitude{});
constexpr UnitMagnitude auto num = numerator(unit_magnitude{});
constexpr UnitMagnitude auto den = denominator(unit_magnitude{});
// TODO address the below
static_assert(ratio == num / den, "Printing rational powers not yet supported");
return magnitude_symbol_impl<CharT, num, den, num_constants, den_constants, 0>(out, fmt);
} else {
// print the value as a number with exponent
// if user wanted a regular number for this magnitude then probably a better scaled unit should be used
constexpr UnitMagnitude auto base = ratio / mag_power_lazy<10, exp10>();
constexpr UnitMagnitude auto num = _numerator(base);
constexpr UnitMagnitude auto den = _denominator(base);
constexpr UnitMagnitude auto num = numerator(base);
constexpr UnitMagnitude auto den = denominator(base);

// TODO address the below
static_assert(base == num / den, "Printing rational powers not yet supported");
Expand All @@ -530,15 +530,15 @@ struct unit_magnitude : magnitude_base<unit_magnitude<Ms...>> {
}
};

[[nodiscard]] consteval auto _common_magnitude(unit_magnitude<>, UnitMagnitude auto m)
[[nodiscard]] consteval auto common_magnitude(unit_magnitude<>, UnitMagnitude auto m)
{
return _remove_positive_powers(m);
return remove_positive_powers(m);
}
[[nodiscard]] consteval auto _common_magnitude(UnitMagnitude auto m, unit_magnitude<>)
[[nodiscard]] consteval auto common_magnitude(UnitMagnitude auto m, unit_magnitude<>)
{
return _remove_positive_powers(m);
return remove_positive_powers(m);
}
[[nodiscard]] consteval auto _common_magnitude(unit_magnitude<> m, unit_magnitude<>) { return m; }
[[nodiscard]] consteval auto common_magnitude(unit_magnitude<> m, unit_magnitude<>) { return m; }


// The largest integer which can be extracted from any magnitude with only a single basis vector.
Expand Down Expand Up @@ -595,7 +595,7 @@ template<auto M>

// Returns the most precise type to express the magnitude factor
template<UnitMagnitude auto M>
using common_magnitude_type = decltype(_common_magnitude_type_impl(M));
using common_magnitude_type = decltype(common_magnitude_type_impl(M));

////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
// `mag()` implementation.
Expand Down
2 changes: 1 addition & 1 deletion src/core/include/mp-units/framework/quantity.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ template<Unit UFrom, Unit UTo>
if constexpr (is_same_v<UFrom, UTo>)
return true;
else
return _is_integral(get_canonical_unit(from).mag / get_canonical_unit(to).mag);
return is_integral(get_canonical_unit(from).mag / get_canonical_unit(to).mag);
}

template<typename T>
Expand Down
18 changes: 9 additions & 9 deletions src/core/include/mp-units/framework/unit.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -440,11 +440,11 @@ template<Unit U1, Unit U2>
{
constexpr auto canonical_lhs = get_canonical_unit(U1{});
constexpr auto canonical_rhs = get_canonical_unit(U2{});
constexpr auto common_magnitude = _common_magnitude(canonical_lhs.mag, canonical_rhs.mag);
if constexpr (common_magnitude == mag<1>)
constexpr auto common_mag = common_magnitude(canonical_lhs.mag, canonical_rhs.mag);
if constexpr (common_mag == mag<1>)
return canonical_lhs.reference_unit;
else
return scaled_unit<common_magnitude, MP_UNITS_NONCONST_TYPE(canonical_lhs.reference_unit)>{};
return scaled_unit<common_mag, MP_UNITS_NONCONST_TYPE(canonical_lhs.reference_unit)>{};
}

[[nodiscard]] consteval Unit auto get_common_scaled_unit(Unit auto u1, Unit auto u2, Unit auto u3, Unit auto... rest)
Expand Down Expand Up @@ -572,7 +572,7 @@ template<Unit T, symbol_text Symbol, Unit auto U, auto... Args>
template<typename F, int Num, int... Den, typename... Us>
[[nodiscard]] consteval auto get_canonical_unit_impl(const power<F, Num, Den...>&, const type_list<Us...>&)
{
auto mag = (mp_units::mag<1> * ... * _pow<Num, Den...>(get_canonical_unit_impl(Us{}, Us{}).mag));
auto mag = (mp_units::mag<1> * ... * pow<Num, Den...>(get_canonical_unit_impl(Us{}, Us{}).mag));
auto u = (one * ... * pow<Num, Den...>(get_canonical_unit_impl(Us{}, Us{}).reference_unit));
return canonical_unit{mag, u};
}
Expand All @@ -584,9 +584,9 @@ template<typename T, typename F, int Num, int... Den>
if constexpr (requires { typename decltype(base.reference_unit)::_num_; }) {
auto num = get_canonical_unit_impl(power<F, Num, Den...>{}, typename decltype(base.reference_unit)::_num_{});
auto den = get_canonical_unit_impl(power<F, Num, Den...>{}, typename decltype(base.reference_unit)::_den_{});
return canonical_unit{_pow<Num, Den...>(base.mag) * num.mag / den.mag, num.reference_unit / den.reference_unit};
return canonical_unit{pow<Num, Den...>(base.mag) * num.mag / den.mag, num.reference_unit / den.reference_unit};
} else {
return canonical_unit{_pow<Num, Den...>(base.mag),
return canonical_unit{pow<Num, Den...>(base.mag),
derived_unit<power<decltype(base.reference_unit), Num, Den...>>{}};
}
}
Expand Down Expand Up @@ -696,9 +696,9 @@ template<Unit U1, Unit U2>
constexpr auto canonical_lhs = get_canonical_unit(U1{});
constexpr auto canonical_rhs = get_canonical_unit(U2{});

if constexpr (_is_positive_integral_power(canonical_lhs.mag / canonical_rhs.mag))
if constexpr (is_positive_integral_power(canonical_lhs.mag / canonical_rhs.mag))
return u2;
else if constexpr (_is_positive_integral_power(canonical_rhs.mag / canonical_lhs.mag))
else if constexpr (is_positive_integral_power(canonical_rhs.mag / canonical_lhs.mag))
return u1;
else {
if constexpr (detail::unit_less<U1, U2>::value)
Expand Down Expand Up @@ -793,7 +793,7 @@ constexpr Out unit_symbol_impl(Out out, const scaled_unit_impl<M, U>& u, const u
bool negative_power)
{
*out++ = '[';
_magnitude_symbol<CharT>(out, M, fmt);
magnitude_symbol<CharT>(out, M, fmt);
if constexpr (space_before_unit_symbol<scaled_unit<M, U>::_reference_unit_>) *out++ = ' ';
unit_symbol_impl<CharT>(out, u._reference_unit_, fmt, negative_power);
*out++ = ']';
Expand Down
4 changes: 2 additions & 2 deletions src/core/include/mp-units/framework/unit_magnitude.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ constexpr UnitMagnitude auto mag_ratio = detail::prime_factorization_v<N> / deta
*/
template<detail::MagArg auto Base, int Num, int Den = 1>
requires(detail::get_base_value(Base) > 0)
constexpr UnitMagnitude auto mag_power = _pow<Num, Den>(mag<Base>);
constexpr UnitMagnitude auto mag_power = pow<Num, Den>(mag<Base>);

/**
* @brief A convenient Magnitude constant for pi, which we can manipulate like a regular number.
Expand All @@ -107,7 +107,7 @@ template<MagArg auto Base, int Num, int Den>
requires(get_base_value(Base) > 0)
[[nodiscard]] consteval UnitMagnitude auto mag_power_lazy()
{
return _pow<Num, Den>(mag<Base>);
return pow<Num, Den>(mag<Base>);
}

} // namespace detail
Expand Down
4 changes: 2 additions & 2 deletions src/systems/include/mp-units/systems/si/chrono.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -123,9 +123,9 @@ struct quantity_point_like_traits<std::chrono::time_point<C, std::chrono::durati
namespace detail {

[[nodiscard]] constexpr auto as_ratio(UnitMagnitude auto m)
requires(_is_rational(m))
requires(is_rational(m))
{
return std::ratio<_get_value<std::intmax_t>(_numerator(m)), _get_value<std::intmax_t>(_denominator(m))>{};
return std::ratio<get_value<std::intmax_t>(numerator(m)), get_value<std::intmax_t>(denominator(m))>{};
}

} // namespace detail
Expand Down

0 comments on commit de534b3

Please sign in to comment.