Cmp< T > Class Template Reference

#include <Cmp.hh>

Collaboration diagram for Cmp< T >:

List of all members.

Public Member Functions
	operator CmpState () const
	Automatically convert to an enum.
	operator int () const
	Automatically convert to an integer.
template<typename U >
const Cmp< T > &	operator|| (const Cmp< U > &c) const
	If this state is equivalent, set this state to the state of c.
Standard constructors etc.
	Cmp (const T &t1, const T &t2)
	The default constructor.
template<typename U >
	Cmp (const Cmp< U > &x)
	The copy constructor.
	~Cmp ()
	The destructor is not virtual since this is not intended to be a base class.
template<typename U >
const Cmp< T > &	operator= (const Cmp< U > &x)
	The assignment operator.
Private Member Functions
void	_compare () const
	Perform the actual comparison if necessary.
Private Attributes
CmpState	_value
	The state of this object.
pair< const T *, const T * >	_objects
	The objects to be compared.

---

Detailed Description

template<typename T>
class Rivet::Cmp< T >

Helper class when checking the ordering of two objects.

Cmp is a helper class to be used when checking the ordering of two objects. When implicitly converted to an integer the value will be negative if the two objects used in the constructor are ordered and positive if they are not. Zero will be returned if they are equal.

The main usage of the Cmp class is if several variables should be checked for ordering in which case several Cmp objects can be combined as follows: cmp(a1, a2) || cmp(b1, b2) || cmp(c1, c2) where cmp is a global function for easy creation of Cmp objects.

Definition at line 27 of file Cmp.hh.

---

Constructor & Destructor Documentation

Cmp	(	const T &	t1,
		const T &	t2
	)		[inline]

The default constructor.

Definition at line 34 of file Cmp.hh.

      : _value(UNDEFINED), _objects(&t1, &t2) { }

Cmp

(

const Cmp< U > &

x

)

[inline]

The copy constructor.

Definition at line 39 of file Cmp.hh.

      : _value(x), _objects(0, 0) { }

~Cmp

(

)

[inline]

The destructor is not virtual since this is not intended to be a base class.

Definition at line 43 of file Cmp.hh.

{ };

---

Member Function Documentation

void _compare

(

)

const [inline, private]

Perform the actual comparison if necessary.

Definition at line 79 of file Cmp.hh.

References Cmp< T >::_objects, Cmp< T >::_value, Rivet::EQUIVALENT, Rivet::ORDERED, Rivet::UNDEFINED, and Rivet::UNORDERED.

Referenced by Cmp< T >::operator CmpState(), Cmp< Projection >::operator CmpState(), Cmp< double >::operator CmpState(), Cmp< T >::operator int(), Cmp< Projection >::operator int(), Cmp< double >::operator int(), Cmp< T >::operator||(), Cmp< Projection >::operator||(), and Cmp< double >::operator||().

                          {
      if (_value == UNDEFINED) {
        less<T> l;
        if ( l(*_objects.first, *_objects.second) ) _value = ORDERED;
        else if ( l(*_objects.second, *_objects.first) ) _value = UNORDERED;
        else _value = EQUIVALENT;
      }
    }

operator CmpState

(

)

const [inline]

Automatically convert to an enum.

Definition at line 57 of file Cmp.hh.

References Cmp< T >::_compare(), and Cmp< T >::_value.

                              {
      _compare();
      return _value;
    }

operator int

(

)

const [inline]

Automatically convert to an integer.

Definition at line 63 of file Cmp.hh.

References Cmp< T >::_compare(), and Cmp< T >::_value.

                         {
      _compare();
      return _value;
    }

const Cmp<T>& operator=

(

const Cmp< U > &

x

)

[inline]

The assignment operator.

Definition at line 47 of file Cmp.hh.

References Cmp< T >::_value.

                                             {
      _value = x;
      return *this;
    }

const Cmp<T>& operator||

(

const Cmp< U > &

c

)

const [inline]

If this state is equivalent, set this state to the state of c.

Definition at line 70 of file Cmp.hh.

References Cmp< T >::_compare(), Cmp< T >::_value, and Rivet::EQUIVALENT.

                                                    {
      _compare();
      if (_value == EQUIVALENT) _value = c;
      return *this;
    }

---

Member Data Documentation

pair<const T*, const T*> _objects [private]

The objects to be compared.

Definition at line 92 of file Cmp.hh.

Referenced by Cmp< T >::_compare(), and Cmp< Projection >::_compare().

CmpState _value [mutable, private]

The state of this object.

Definition at line 89 of file Cmp.hh.

Referenced by Cmp< T >::_compare(), Cmp< Projection >::_compare(), Cmp< double >::_compare(), Cmp< T >::operator CmpState(), Cmp< Projection >::operator CmpState(), Cmp< double >::operator CmpState(), Cmp< T >::operator int(), Cmp< Projection >::operator int(), Cmp< double >::operator int(), Cmp< T >::operator=(), Cmp< Projection >::operator=(), Cmp< double >::operator=(), Cmp< T >::operator||(), Cmp< Projection >::operator||(), and Cmp< double >::operator||().

---

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

• Cmp.hh