Cmp< T > Class Template Reference

#include <Cmp.hh>

Collaboration diagram for Cmp< T >:
Collaboration graph
[legend]

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 24 of file Cmp.hh.

Constructor & Destructor Documentation

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

The default constructor.

Definition at line 14 of file Cmp.hh.

Referenced by Cmp< T >::operator=().

00023                          : <code>cmp(a1, a2) || cmp(b1, b2) || cmp(c1,

Cmp ( const Cmp< U > &  x  )  [inline]

The copy constructor.

Definition at line 19 of file Cmp.hh.

00023                          : <code>cmp(a1, a2) || cmp(b1, b2) || cmp(c1,

~Cmp (  )  [inline]

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

Definition at line 23 of file Cmp.hh.

00023 : <code>cmp(a1, a2) || cmp(b1, b2) || cmp(c1,

Member Function Documentation

void _compare (  )  const [inline, private]

Perform the actual comparison if necessary.

Definition at line 58 of file Cmp.hh.

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

00061                          {
00062       _compare();
00063       return _value;
00064     }
00065

operator CmpState (  )  const [inline]

Automatically convert to an enum.

Definition at line 36 of file Cmp.hh.

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

operator int (  )  const [inline]

Automatically convert to an integer.

Definition at line 42 of file Cmp.hh.

00042            { };
00043 
00044     /// The assignment operator.
00045     template <typename U>

const Cmp<T>& operator= ( const Cmp< U > &  x  )  [inline]

The assignment operator.

Definition at line 27 of file Cmp.hh.

References Cmp< T >::_objects, Cmp< T >::_value, Cmp< T >::Cmp(), and Rivet::UNDEFINED.

00027             {
00028   public:
00029 
00030     /// @name Standard constructors etc.

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 49 of file Cmp.hh.

00053         :

Member Data Documentation

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

The objects to be compared.

Definition at line 71 of file Cmp.hh.

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

CmpState _value [mutable, private]

The state of this object.

Definition at line 68 of file Cmp.hh.

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

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