Cmp< double > Class Template Reference

Specialization of Cmp for checking the ordering of two floating point numbers. More...

#include <Cmp.hh>

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< double > &	operator|| (const Cmp< U > &c) const
	If this state is equivalent, set this state to the state of c.
Standard constructors and destructors.
	Cmp (const double p1, const double p2)
	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< double > &	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.
double	_numA
	The objects to be compared.
double	_numB

---

Detailed Description

template<>
class Rivet::Cmp< double >

Specialization of Cmp for checking the ordering of two floating point numbers.

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. This specialization uses the Rivet fuzzyEquals function to indicate equivalence protected from numerical precision effects.

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

---

Constructor & Destructor Documentation

Cmp	(	const double	p1,
		const double	p2
	)		[inline]

The default constructor.

Definition at line 213 of file Cmp.hh.

      : _value(UNDEFINED), _numA(p1), _numB(p2)
    { }

Cmp

(

const Cmp< U > &

x

)

[inline]

The copy constructor.

Definition at line 219 of file Cmp.hh.

      : _value(x), _numA(0.0), _numB(0.0)
    { }

~Cmp

(

)

[inline]

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

Definition at line 224 of file Cmp.hh.

{ }

---

Member Function Documentation

void _compare

(

)

const [inline, private]

Perform the actual comparison if necessary.

Definition at line 259 of file Cmp.hh.

References Cmp< T >::_value, Rivet::EQUIVALENT, Rivet::fuzzyEquals(), Rivet::ORDERED, Rivet::UNDEFINED, and Rivet::UNORDERED.

                          {
      if (_value == UNDEFINED) {
        if (fuzzyEquals(_numA,_numB)) _value = EQUIVALENT;
        else if (_numA < _numB) _value = ORDERED;
        else _value = UNORDERED;
      }
    }

operator CmpState

(

)

const [inline]

Automatically convert to an enum.

Definition at line 237 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 243 of file Cmp.hh.

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

                         {
      _compare();
      return _value;
    }

const Cmp<double>& operator=

(

const Cmp< U > &

x

)

[inline]

The assignment operator.

Definition at line 228 of file Cmp.hh.

References Cmp< T >::_value.

                                                  {
      _value = x;
      return *this;
    }

const Cmp<double>& operator||

(

const Cmp< U > &

c

)

const [inline]

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

Definition at line 250 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

double _numA [private]

The objects to be compared.

Definition at line 273 of file Cmp.hh.

double _numB [private]

Definition at line 273 of file Cmp.hh.

CmpState _value [mutable, private]

The state of this object.

Definition at line 270 of file Cmp.hh.

---

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

• Cmp.hh