Deveel.Data.Index.IIndexComparer< T > Interface Template Reference

A comparer that is used within IIndex<T> to compares two values which are indices to data that is being compared. More...

Public Member Functions
int	CompareValue (T index, DataObject value)
	Compares a value contained in the underlying index at the given position and the More...
int	Compare (T index1, T index2)
	Comnpares two values referenced by the indices given. More...

Detailed Description

A comparer that is used within IIndex<T> to compares two values which are indices to data that is being compared.

For example, an instance of IIndex<T> may contains indices to cells in the column of a table. This object is used to make sorted lists, to lookup the index values in the list for sorting and searching.

Definition at line 29 of file IIndexComparer_T.cs.

Member Function Documentation

int Deveel.Data.Index.IIndexComparer< T >.Compare	(	T	index1,
		T	index2
	)

Comnpares two values referenced by the indices given.

Parameters

index1	The offset within the underlying index at which to get the first value to compare.
index2	The offset within the underlying index at which to get the second value to compare.

Returns

Returns an integer greather than 0 if the value pointed to by index1 is greater than the value pointed to by index2 , or an integer smaller than 0 if the value pointed to by index1 1 is less than the value pointed to by index2 . If the indexed values are equal, it returns 0.

int Deveel.Data.Index.IIndexComparer< T >.CompareValue	(	T	index,
		DataObject	value
	)

Compares a value contained in the underlying index at the given position and the

Parameters

index	The offset within the underlying index at which to get the first value to compare.
value	The value to compare with the one retrieved from the underlying index at the given position.

Returns

Returns > 0 if the value pointed to by index1 is greater than 'val', or < 0 if the value pointed to by index 1 is less than 'val'. If the indexed value is equal to 'val', it returns 0.

---

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

• /var/calculate/remote/distfiles/egit-src/deveeldb.git/src/deveeldb/Deveel.Data.Index/IIndexComparer_T.cs