xtd::icomparable< type_t > Class Template Reference

#include <icomparable.h>

Definition

template<typename type_t>
class xtd::icomparable< type_t >

Defines a generalized comparison method that a value type or class implements to create a type-specific comparison method.

Namespace

xtd

Library

xtd.core

Inherits xtd::interface.

Public Member Functions
virtual int32_t	compare_to (const object &obj) const noexcept
	Compares the current instance with another object of the same type.
virtual int32_t	compare_to (const type_t &obj) const noexcept=0
	Compares the current instance with another object of the same type.

Member Function Documentation

compare_to() [1/2]

template<typename type_t >

virtual int32_t xtd::icomparable< type_t >::compare_to ( const object &  obj ) const

inlinevirtualnoexcept

Compares the current instance with another object of the same type.

Parameters

obj	An object to compare with this instance.

Returns

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

Value	Condition
Less than zero	This instance is less than obj.
Zero	This instance is equal to obj.
Greater than zero	This instance is greater than obj.

Reimplemented in xtd::guid, and xtd::version.

compare_to() [2/2]

template<typename type_t >

virtual int32_t xtd::icomparable< type_t >::compare_to ( const type_t &  obj ) const

pure virtualnoexcept

Compares the current instance with another object of the same type.

Parameters

obj	An object to compare with this instance.

Returns

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

Value	Condition
Less than zero	This instance is less than obj.
Zero	This instance is equal to obj.
Greater than zero	This instance is greater than obj.

Implemented in xtd::guid, and xtd::version.

---

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

• xtd.core/include/xtd/icomparable.h