comparator

class comparator#( type T = int )

singleton Provides strategies to compare objects.

Parameter

T	optional The type of an object to be compared. The default is int.

Summary

comparator	singleton Provides strategies to compare objects.
Types
this_type	The shorthand of comparator #(T).
Functions
new	protected Creates a new comparator.
get_instance	static Returns the singleton instance of this comparator.
eq	virtual Returns 1 if two inputs are equal.
ne	virtual Returns 1 if two inputs are not equal.
lt	virtual Returns 1 if x is less than y.
gt	virtual Returns 1 if x is greater than y.
le	virtual Returns 1 if x is less than or equal to y.
ge	virtual Returns 1 if x is greater than or equal to y.

Types

this_type

typedef comparator#( T ) this_type

The shorthand of comparator #(T).

Functions

new

protected function new()

protected Creates a new comparator.

get_instance

static function this_type get_instance()

static Returns the singleton instance of this comparator.

Returns

The singleton instance.

eq

virtual function bit eq( T x,
T y )

virtual Returns 1 if two inputs are equal. This function uses the logical equality operator (==) for the object comparison.

Arguments

x	An input of type T.
y	Another input of type T.

Returns

If x is equal to y, then returns 1. Otherwise, returns 0.

ne

virtual function bit ne( T x,
T y )

virtual Returns 1 if two inputs are not equal.

Arguments

x	An input of type T.
y	Another input of type T.

Returns

This function returns the negated value of eq (x,y).

lt

virtual function bit lt( T x,
T y )

virtual Returns 1 if x is less than y.

Arguments

x	An input of type T.
y	Another input of type T.

Returns

This function always returns 0. A subclass should implement this function if necessary.

gt

virtual function bit gt( T x,
T y )

virtual Returns 1 if x is greater than y.

Arguments

x	An input of type T.
y	Another input of type T.

Returns

This function returns the value of lt (y,x).

le

virtual function bit le( T x,
T y )

virtual Returns 1 if x is less than or equal to y.

Arguments

x	An input of type T.
y	Another input of type T.

Returns

This function returns the negated value of gt (x,y).

ge

virtual function bit ge( T x,
T y )

virtual Returns 1 if x is greater than or equal to y.

Arguments

x	An input of type T.
y	Another input of type T.

Returns

This function returns the negated value of lt (x,y).