strong_order.h 5.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141
  1. //===----------------------------------------------------------------------===//
  2. //
  3. // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
  4. // See https://llvm.org/LICENSE.txt for license information.
  5. // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
  6. //
  7. //===----------------------------------------------------------------------===//
  8. #ifndef _LIBCPP___COMPARE_STRONG_ORDER
  9. #define _LIBCPP___COMPARE_STRONG_ORDER
  10. #include <__bit/bit_cast.h>
  11. #include <__compare/compare_three_way.h>
  12. #include <__compare/ordering.h>
  13. #include <__config>
  14. #include <__math/exponential_functions.h>
  15. #include <__math/traits.h>
  16. #include <__type_traits/conditional.h>
  17. #include <__type_traits/decay.h>
  18. #include <__type_traits/is_floating_point.h>
  19. #include <__type_traits/is_same.h>
  20. #include <__utility/forward.h>
  21. #include <__utility/priority_tag.h>
  22. #include <cstdint>
  23. #include <limits>
  24. #ifndef _LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER
  25. # pragma GCC system_header
  26. #endif
  27. _LIBCPP_PUSH_MACROS
  28. #include <__undef_macros>
  29. _LIBCPP_BEGIN_NAMESPACE_STD
  30. #if _LIBCPP_STD_VER >= 20
  31. // [cmp.alg]
  32. namespace __strong_order {
  33. struct __fn {
  34. // NOLINTBEGIN(libcpp-robust-against-adl) strong_order should use ADL, but only here
  35. template <class _Tp, class _Up>
  36. requires is_same_v<decay_t<_Tp>, decay_t<_Up>>
  37. _LIBCPP_HIDE_FROM_ABI static constexpr auto __go(_Tp&& __t, _Up&& __u, __priority_tag<2>) noexcept(
  38. noexcept(strong_ordering(strong_order(std::forward<_Tp>(__t), std::forward<_Up>(__u)))))
  39. -> decltype(strong_ordering(strong_order(std::forward<_Tp>(__t), std::forward<_Up>(__u)))) {
  40. return strong_ordering(strong_order(std::forward<_Tp>(__t), std::forward<_Up>(__u)));
  41. }
  42. // NOLINTEND(libcpp-robust-against-adl)
  43. template <class _Tp, class _Up, class _Dp = decay_t<_Tp>>
  44. requires is_same_v<_Dp, decay_t<_Up>> && is_floating_point_v<_Dp>
  45. _LIBCPP_HIDE_FROM_ABI static constexpr strong_ordering __go(_Tp&& __t, _Up&& __u, __priority_tag<1>) noexcept {
  46. if constexpr (numeric_limits<_Dp>::is_iec559 && sizeof(_Dp) == sizeof(int32_t)) {
  47. int32_t __rx = std::bit_cast<int32_t>(__t);
  48. int32_t __ry = std::bit_cast<int32_t>(__u);
  49. __rx = (__rx < 0) ? (numeric_limits<int32_t>::min() - __rx - 1) : __rx;
  50. __ry = (__ry < 0) ? (numeric_limits<int32_t>::min() - __ry - 1) : __ry;
  51. return (__rx <=> __ry);
  52. } else if constexpr (numeric_limits<_Dp>::is_iec559 && sizeof(_Dp) == sizeof(int64_t)) {
  53. int64_t __rx = std::bit_cast<int64_t>(__t);
  54. int64_t __ry = std::bit_cast<int64_t>(__u);
  55. __rx = (__rx < 0) ? (numeric_limits<int64_t>::min() - __rx - 1) : __rx;
  56. __ry = (__ry < 0) ? (numeric_limits<int64_t>::min() - __ry - 1) : __ry;
  57. return (__rx <=> __ry);
  58. } else if (__t < __u) {
  59. return strong_ordering::less;
  60. } else if (__t > __u) {
  61. return strong_ordering::greater;
  62. } else if (__t == __u) {
  63. if constexpr (numeric_limits<_Dp>::radix == 2) {
  64. return __math::signbit(__u) <=> __math::signbit(__t);
  65. } else {
  66. // This is bullet 3 of the IEEE754 algorithm, relevant
  67. // only for decimal floating-point;
  68. // see https://stackoverflow.com/questions/69068075/
  69. if (__t == 0 || __math::isinf(__t)) {
  70. return __math::signbit(__u) <=> __math::signbit(__t);
  71. } else {
  72. int __texp, __uexp;
  73. (void)__math::frexp(__t, &__texp);
  74. (void)__math::frexp(__u, &__uexp);
  75. return (__t < 0) ? (__texp <=> __uexp) : (__uexp <=> __texp);
  76. }
  77. }
  78. } else {
  79. // They're unordered, so one of them must be a NAN.
  80. // The order is -QNAN, -SNAN, numbers, +SNAN, +QNAN.
  81. bool __t_is_nan = __math::isnan(__t);
  82. bool __u_is_nan = __math::isnan(__u);
  83. bool __t_is_negative = __math::signbit(__t);
  84. bool __u_is_negative = __math::signbit(__u);
  85. using _IntType =
  86. conditional_t< sizeof(__t) == sizeof(int32_t),
  87. int32_t,
  88. conditional_t< sizeof(__t) == sizeof(int64_t), int64_t, void> >;
  89. if constexpr (is_same_v<_IntType, void>) {
  90. static_assert(sizeof(_Dp) == 0, "std::strong_order is unimplemented for this floating-point type");
  91. } else if (__t_is_nan && __u_is_nan) {
  92. // Order by sign bit, then by "payload bits" (we'll just use bit_cast).
  93. if (__t_is_negative != __u_is_negative) {
  94. return (__u_is_negative <=> __t_is_negative);
  95. } else {
  96. return std::bit_cast<_IntType>(__t) <=> std::bit_cast<_IntType>(__u);
  97. }
  98. } else if (__t_is_nan) {
  99. return __t_is_negative ? strong_ordering::less : strong_ordering::greater;
  100. } else {
  101. return __u_is_negative ? strong_ordering::greater : strong_ordering::less;
  102. }
  103. }
  104. }
  105. template <class _Tp, class _Up>
  106. requires is_same_v<decay_t<_Tp>, decay_t<_Up>>
  107. _LIBCPP_HIDE_FROM_ABI static constexpr auto __go(_Tp&& __t, _Up&& __u, __priority_tag<0>) noexcept(
  108. noexcept(strong_ordering(compare_three_way()(std::forward<_Tp>(__t), std::forward<_Up>(__u)))))
  109. -> decltype(strong_ordering(compare_three_way()(std::forward<_Tp>(__t), std::forward<_Up>(__u)))) {
  110. return strong_ordering(compare_three_way()(std::forward<_Tp>(__t), std::forward<_Up>(__u)));
  111. }
  112. template <class _Tp, class _Up>
  113. _LIBCPP_HIDE_FROM_ABI constexpr auto operator()(_Tp&& __t, _Up&& __u) const
  114. noexcept(noexcept(__go(std::forward<_Tp>(__t), std::forward<_Up>(__u), __priority_tag<2>())))
  115. -> decltype(__go(std::forward<_Tp>(__t), std::forward<_Up>(__u), __priority_tag<2>())) {
  116. return __go(std::forward<_Tp>(__t), std::forward<_Up>(__u), __priority_tag<2>());
  117. }
  118. };
  119. } // namespace __strong_order
  120. inline namespace __cpo {
  121. inline constexpr auto strong_order = __strong_order::__fn{};
  122. } // namespace __cpo
  123. #endif // _LIBCPP_STD_VER >= 20
  124. _LIBCPP_END_NAMESPACE_STD
  125. _LIBCPP_POP_MACROS
  126. #endif // _LIBCPP___COMPARE_STRONG_ORDER