xtd::collections::generic::comparer< type_t > Class Template Reference

Inheritance diagram for xtd::collections::generic::comparer< type_t >:

Definition

template<typename type_t>
class xtd::collections::generic::comparer< type_t >

Provides a base class for implementations of the xtd::collections::generic::icomparer <type_t> generic interface.

Definition

template<typename type_t>
class comparer : public xtd::object, public xtd::collections::generic::icomparer<type_t>;

Header

#include <xtd/collections/generic/comparer>

Namespace

xtd::collections::generic

Library

xtd.core

Public Aliases
using	first_argument_type
	Represents the first argument type.
using	second_argument_type
	Represents the second argument type.
using	result_type
	Represents the result type.

Public Properties
static const comparer< type_t >	default_comparer
	Returns a default sort order comparer for the type specified by the generic argument.

Public Methods
auto	compare (const first_argument_type &x, const second_argument_type &y) const -> result_type override
	Compares two entities and returns a value indicating whether one is less than, equal to, or greater than the other.

Protected Constructors
	comparer ()=default
	Initializes a new instance of the xtd::collections::generic::comparer <type_t> class.

Additional Inherited Members
	object ()=default
	Create a new instance of the ultimate base class object.
virtual auto	equals (const object &obj) const noexcept -> bool
	Determines whether the specified object is equal to the current object.
virtual auto	get_hash_code () const noexcept -> xtd::usize
	Serves as a hash function for a particular type.
virtual auto	get_type () const noexcept -> type_object
	Gets the type of the current instance.
template<typename object_t>
auto	memberwise_clone () const -> xtd::unique_ptr_object< object_t >
	Creates a shallow copy of the current object.
virtual auto	to_string () const -> xtd::string
	Returns a xtd::string that represents the current object.
template<typename object_a_t, typename object_b_t>
static auto	equals (const object_a_t &object_a, const object_b_t &object_b) noexcept -> bool
	Determines whether the specified object instances are considered equal.
template<typename object_a_t, typename object_b_t>
static auto	reference_equals (const object_a_t &object_a, const object_b_t &object_b) noexcept -> bool
	Determines whether the specified object instances are the same instance.

Member Typedef Documentation

first_argument_type

template<typename type_t>

using xtd::collections::generic::comparer< type_t >::first_argument_type

Represents the first argument type.

second_argument_type

template<typename type_t>

using xtd::collections::generic::comparer< type_t >::second_argument_type

Represents the second argument type.

result_type

template<typename type_t>

using xtd::collections::generic::comparer< type_t >::result_type

Represents the result type.

Constructor & Destructor Documentation

comparer()

template<typename type_t>

xtd::collections::generic::comparer< type_t >::comparer ( )

protecteddefault

Initializes a new instance of the xtd::collections::generic::comparer <type_t> class.

Member Function Documentation

compare()

template<typename type_t>

auto xtd::collections::generic::comparer< type_t >::compare ( const first_argument_type & x, const second_argument_type & y ) const -> result_type

inlinenodiscardoverridevirtual

Compares two entities and returns a value indicating whether one is less than, equal to, or greater than the other.

Parameters

x	The first entity to compare.
y	The second entity to compare.

Returns

A 32-bit signed integer that indicates the relative order of the entities being compared. The return value has these meanings:

Value	Condition
Less than zero	x is less than y.
Zero	x equals y.
Greater than zero	x is greater than y.

Implements xtd::collections::generic::icomparer< type_t >.

Member Data Documentation

default_comparer

template<typename type_t>

const comparer<type_t> xtd::collections::generic::comparer< type_t >::default_comparer

static

Returns a default sort order comparer for the type specified by the generic argument.

---

The documentation for this class was generated from the following file:

• xtd.core/include/xtd/collections/generic/comparer.hpp