elm::Comparator< T > Class Template Reference

#include <elm/compare.h>

Public Member Functions
int	doCompare (const T &v1, const T &v2) const

Static Public Member Functions
static int	compare (const T &v1, const T &v2)

Detailed Description

template<class T>
class elm::Comparator< T >

Comparator concept (elm/compare.h) allows comparing two data. Comparator may be used statically with the compare() method but also as in instance with doCompare() method. As a default, doCompare() performs a call to compare().

Several implementation of Comparator concept exists:

• Comparator – default implementation based on == and < operators.
• CompareComparator – assumes that data has a compare() method.
• AssocComparator – works on pairs assuming order in based on the first component.
• ReverseComparator – invert direction of another comparator.

Member Function Documentation

template<class T >

int elm::Comparator< T >::compare ( const T &  v1, const T &  v2  )

static

Compare v1 and v2 and returns:

• > 0 if v1 > v2
• = 0 if v1 = v2
• < 0 if v1 < v2

  Parameters

  v1	First value.
  v2	Second value

  Returns

  See above.

Referenced by elm::Comparator< T >::doCompare().

template<class T >

int elm::Comparator< T >::doCompare	(	const T &	v1,
		const T &	v2
	)		const

Compare v1 and v2 and returns:

• > 0 if v1 > v2
• = 0 if v1 = v2
• < 0 if v1 < v2

  Parameters

  v1	First value.
  v2	Second value

  Returns

  See above.

References elm::Comparator< T >::compare().

---

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

• include/elm/compare.h
• src/util_Comparator.cpp