◐ Shell
clean mode source ↗

Заголовочный файл стандартной библиотеки <compare> (C++20) — cppreference.com

Материал из cppreference.com

Этот заголовок является частью библиотеки поддержки языка.

Концепты

указывает, что оператор <=> даёт согласованный результат для данных типов
(концепт) [править]

Классы

тип результата трёхстороннего сравнения, который поддерживает все 6 операторов, невзаимозаменяемый и допускает несравнимые значения
(класс) [править]
тип результата трёхстороннего сравнения, который поддерживает все 6 операторов и невзаимозаменяемый
(класс) [править]
тип результата трёхстороннего сравнения, который поддерживает все 6 операторов и может быть взаимозаменяемым
(класс) [править]
самая строгая категория сравнения, в которую можно преобразовать все указанные типы
(шаблон класса) [править]
получает тип результата оператора трёхстороннего сравнения <=> для заданных типов
(шаблон класса) [править]
функциональный объект, реализующий x <=> y
(класс) [править]

Объекты точек настройки

выполняет трёхстороннее сравнение и возвращает результат типа std::strong_ordering
(объект точки настройки) [править]
выполняет трёхстороннее сравнение и возвращает результат типа std::weak_ordering
(объект точки настройки) [править]
выполняет трёхстороннее сравнение и возвращает результат типа std::partial_ordering
(объект точки настройки) [править]
выполняет трёхстороннее сравнение и возвращает результат типа std::strong_ordering, даже если operator<=> недоступен
(объект точки настройки) [править]
выполняет трёхстороннее сравнение и возвращает результат типа std::weak_ordering, даже если operator<=> недоступен
(объект точки настройки) [править]
выполняет трёхстороннее сравнение и возвращает результат типа std::partial_ordering, даже если operator<=> недоступен
(объект точки настройки) [править]

Функции

именованные функции сравнения
(функция) [править]

Резюме

namespace std {
  // типы категорий сравнения
  class partial_ordering;
  class weak_ordering;
  class strong_ordering;

  // именованные функции сравнения
  constexpr bool is_eq  (partial_ordering cmp) noexcept { return cmp == 0; }
  constexpr bool is_neq (partial_ordering cmp) noexcept { return cmp != 0; }
  constexpr bool is_lt  (partial_ordering cmp) noexcept { return cmp < 0; }
  constexpr bool is_lteq(partial_ordering cmp) noexcept { return cmp <= 0; }
  constexpr bool is_gt  (partial_ordering cmp) noexcept { return cmp > 0; }
  constexpr bool is_gteq(partial_ordering cmp) noexcept { return cmp >= 0; }

  // общий тип категории сравнения
  template<class... Ts>
  struct common_comparison_category {
    using type = /* смотри описание */;
  };
  template<class... Ts>
    using common_comparison_category_t = typename common_comparison_category<Ts...>::type;

  // концепт three_way_comparable
  template<class T, class Cat = partial_ordering>
    concept three_way_comparable = /* смотри описание */;
  template<class T, class U, class Cat = partial_ordering>
    concept three_way_comparable_with = /* смотри описание */;

  // результат трёхстороннего сравнения
  template<class T, class U = T> struct compare_three_way_result;

  template<class T, class U = T>
    using compare_three_way_result_t = typename compare_three_way_result<T, U>::type;

  // класс compare_three_way
  struct compare_three_way;

  // алгоритмы сравнения
  inline namespace /* не определено */ {
    inline constexpr /* не определено */ strong_order = /* не определено */;
    inline constexpr /* не определено */ weak_order = /* не определено */;
    inline constexpr /* не определено */ partial_order = /* не определено */;
    inline constexpr /* не определено */ compare_strong_order_fallback =
                                                         /* не определено */;
    inline constexpr /* не определено */ compare_weak_order_fallback = /* не определено */;
    inline constexpr /* не определено */ compare_partial_order_fallback =
                                                         /* не определено */;
  }
}

Концепт three_way_comparable

namespace std {
  template<class T, class Cat>
    concept __ComparesAs =                // только экспозиция
      same_as<common_comparison_category_t<T, Cat>, Cat>;

  template<class T, class U>
    concept __PartiallyOrderedWith =      // только экспозиция
      requires(const remove_reference_t<T>& t, const remove_reference_t<U>& u) {
        { t <  u } -> boolean-testable;
        { t >  u } -> boolean-testable;
        { t <= u } -> boolean-testable;
        { t >= u } -> boolean-testable;
        { u <  t } -> boolean-testable;
        { u >  t } -> boolean-testable;
        { u <= t } -> boolean-testable;
        { u >= t } -> boolean-testable;
      };

  template<class T, class Cat = partial_ordering>
    concept three_way_comparable =
      __WeaklyEqualityComparableWith<T, T> &&
      __PartiallyOrderedWith<T, T> &&
      requires(const remove_reference_t<T>& a, const remove_reference_t<T>& b) {
        { a <=> b } -> __ComparesAs<Cat>;
      };
}

Концепт three_way_comparable_with

namespace std {
  template<class T, class U, class Cat = partial_ordering>
    concept three_way_comparable_with =
      __WeaklyEqualityComparableWith<T, U> &&
      __PartiallyOrderedWith<T, U> &&
      three_way_comparable<T, Cat> &&
      three_way_comparable<U, Cat> &&
      common_reference_with<const remove_reference_t<T>&, const remove_reference_t<U>&> &&
      three_way_comparable<
        common_reference_t<
          const remove_reference_t<T>&, const remove_reference_t<U>&>, Cat> &&
      requires(const remove_reference_t<T>& t, const remove_reference_t<U>& u) {
        { t <=> u } -> __ComparesAs<Cat>;
        { u <=> t } -> __ComparesAs<Cat>;
      };
}

Класс std::partial_ordering

namespace std {
  class partial_ordering {
    int value;          // только экспозиция
    bool is_ordered;    // только экспозиция

    // конструкторы только для экспозиции
    constexpr explicit
      partial_ordering(eq v) noexcept :
        value(int(v)), is_ordered(true) {}      // только экспозиция
    constexpr explicit
      partial_ordering(ord v) noexcept :
        value(int(v)), is_ordered(true) {}     // только экспозиция
      partial_ordering(ncmp v) noexcept :
        value(int(v)), is_ordered(false) {}   // только экспозиция

  public:
    // действительные значения
    static const partial_ordering less;
    static const partial_ordering equivalent;
    static const partial_ordering greater;
    static const partial_ordering unordered;

    // сравнения
    friend constexpr bool operator==(partial_ordering v, /* не определено */) noexcept;
    friend constexpr bool
      operator==(partial_ordering v, partial_ordering w) noexcept = default;
    friend constexpr bool operator< (partial_ordering v, /* не определено */) noexcept;
    friend constexpr bool operator> (partial_ordering v, /* не определено */) noexcept;
    friend constexpr bool operator<=(partial_ordering v, /* не определено */) noexcept;
    friend constexpr bool operator>=(partial_ordering v, /* не определено */) noexcept;
    friend constexpr bool operator< (/* не определено */, partial_ordering v) noexcept;
    friend constexpr bool operator> (/* не определено */, partial_ordering v) noexcept;
    friend constexpr bool operator<=(/* не определено */, partial_ordering v) noexcept;
    friend constexpr bool operator>=(/* не определено */, partial_ordering v) noexcept;
    friend constexpr partial_ordering
      operator<=>(partial_ordering v, /* не определено */) noexcept;
    friend constexpr partial_ordering
      operator<=>(/* не определено */, partial_ordering v) noexcept;
  };

  // определения допустимых значений
  inline constexpr partial_ordering partial_ordering::less(ord::less);
  inline constexpr partial_ordering partial_ordering::equivalent(eq::equivalent);
  inline constexpr partial_ordering partial_ordering::greater(ord::greater);
  inline constexpr partial_ordering partial_ordering::unordered(ncmp::unordered);
}

Класс std::weak_ordering

namespace std {
  class weak_ordering {
    int value;  // только экспозиция

    // конструкторы только для экспозиции
    constexpr explicit weak_ordering(eq v) noexcept : value(int(v)) {} 
        // только экспозиция
    constexpr explicit weak_ordering(ord v) noexcept : value(int(v)) {}
        // только экспозиция

  public:
    // действительные значения
    static const weak_ordering less;
    static const weak_ordering equivalent;
    static const weak_ordering greater;

    // преобразования
    constexpr operator partial_ordering() const noexcept;

    // сравнения
    friend constexpr bool operator==(weak_ordering v, /* не определено */) noexcept;
    friend constexpr bool operator==(weak_ordering v, weak_ordering w) noexcept = default;
    friend constexpr bool operator< (weak_ordering v, /* не определено */) noexcept;
    friend constexpr bool operator> (weak_ordering v, /* не определено */) noexcept;
    friend constexpr bool operator<=(weak_ordering v, /* не определено */) noexcept;
    friend constexpr bool operator>=(weak_ordering v, /* не определено */) noexcept;
    friend constexpr bool operator< (/* не определено */, weak_ordering v) noexcept;
    friend constexpr bool operator> (/* не определено */, weak_ordering v) noexcept;
    friend constexpr bool operator<=(/* не определено */, weak_ordering v) noexcept;
    friend constexpr bool operator>=(/* не определено */, weak_ordering v) noexcept;
    friend constexpr weak_ordering
      operator<=>(weak_ordering v, /* не определено */) noexcept;
    friend constexpr weak_ordering
      operator<=>(/* не определено */, weak_ordering v) noexcept;
  };

  // определения допустимых значений
  inline constexpr weak_ordering weak_ordering::less(ord::less);
  inline constexpr weak_ordering weak_ordering::equivalent(eq::equivalent);
  inline constexpr weak_ordering weak_ordering::greater(ord::greater);
}

Класс std::strong_ordering

namespace std {
  class strong_ordering {
    int value;  // только экспозиция

    // конструкторы только для экспозиции
    constexpr explicit strong_ordering(eq v) noexcept :
      value(int(v)) {}    // только экспозиция
    constexpr explicit strong_ordering(ord v) noexcept :
      value(int(v)) {}   // только экспозиция

  public:
    // действительные значения
    static const strong_ordering less;
    static const strong_ordering equal;
    static const strong_ordering equivalent;
    static const strong_ordering greater;

    // преобразования
    constexpr operator partial_ordering() const noexcept;
    constexpr operator weak_ordering() const noexcept;

    // сравнения
    friend constexpr bool operator==(strong_ordering v, /* не определено */) noexcept;
    friend constexpr bool
      operator==(strong_ordering v, strong_ordering w) noexcept = default;
    friend constexpr bool operator< (strong_ordering v, /* не определено */) noexcept;
    friend constexpr bool operator> (strong_ordering v, /* не определено */) noexcept;
    friend constexpr bool operator<=(strong_ordering v, /* не определено */) noexcept;
    friend constexpr bool operator>=(strong_ordering v, /* не определено */) noexcept;
    friend constexpr bool operator< (/* не определено */, strong_ordering v) noexcept;
    friend constexpr bool operator> (/* не определено */, strong_ordering v) noexcept;
    friend constexpr bool operator<=(/* не определено */, strong_ordering v) noexcept;
    friend constexpr bool operator>=(/* не определено */, strong_ordering v) noexcept;
    friend constexpr strong_ordering
      operator<=>(strong_ordering v, /* не определено */) noexcept;
    friend constexpr strong_ordering
    operator<=>(/* не определено */, strong_ordering v) noexcept;
  };

  // определения допустимых значений
  inline constexpr strong_ordering strong_ordering::less(ord::less);
  inline constexpr strong_ordering strong_ordering::equal(eq::equal);
  inline constexpr strong_ordering strong_ordering::equivalent(eq::equivalent);
  inline constexpr strong_ordering strong_ordering::greater(ord::greater);
}

Класс std::compare_three_way

namespace std {
  struct compare_three_way {
    template<class T, class U>
    constexpr auto operator()(T&& t, U&& u) const;

    using is_transparent = /* не определено */;
  };
}

Смотрите также