util::Range< T > Class Template Reference

represents a "Range" w/ notion of ordering. A range is defined by a pair of "start" and "end" values. This is stored in std::pair
attribute util::Range::_window. This attribute is protected so that the start/end cannot
be changed w/o a check that start is always less than end. Note the specialization
requires a template class T to have less operator implemented.
More...

#include "Range.h"

Public Member Functions
	Range (const T &start, const T &end)
	Enforced ctor. start must be less than end. More...
	~Range ()
	Default dtor. More...
const T &	Start () const
	"start" accessor More...
const T &	End () const
	"end" accessor More...
void	Set (const T &s, const T &e)
	Setter. More...
bool	operator< (const Range &rhs) const
bool	operator> (const Range &rhs) const
bool	operator== (const Range &rhs) const
bool	operator!= (const Range &rhs) const
bool	operator< (const T &rhs) const
bool	operator> (const T &rhs) const
void	Merge (const Range &a)
	Merge two util::Range into 1. More...

Protected Attributes
std::pair< T, T >	_window
	Protected to avoid user's illegal modification on first/second (sorry users!) More...

Private Member Functions
	Range ()
	Default ctor is hidden. More...

Friends
class	UniqueRangeSet< T >

Detailed Description

template<class T>
class util::Range< T >

represents a "Range" w/ notion of ordering. A range is defined by a pair of "start" and "end" values. This is stored in std::pair
attribute util::Range::_window. This attribute is protected so that the start/end cannot
be changed w/o a check that start is always less than end. Note the specialization
requires a template class T to have less operator implemented.

Definition at line 35 of file Range.h.

Constructor & Destructor Documentation

template<class T>

util::Range< T >::Range ( )

inlineprivate

Default ctor is hidden.

Definition at line 41 of file Range.h.

{}

template<class T>

util::Range< T >::Range ( const T &  start, const T &  end  )

inline

Enforced ctor. start must be less than end.

Definition at line 45 of file Range.h.

      : _window(start,end)
    { if(start>end) throw std::runtime_error("Inserted invalid range: end before start."); }

template<class T>

util::Range< T >::~Range ( )

inline

Default dtor.

Definition at line 51 of file Range.h.

{}

Member Function Documentation

template<class T>

const T& util::Range< T >::End ( ) const

inline

"end" accessor

Definition at line 56 of file Range.h.

References util::Range< T >::_window.

Referenced by util::Range< T >::Merge(), util::Range< T >::operator==(), and util::Range< T >::operator>().

{ return _window.second; }

template<class T>

void util::Range< T >::Merge ( const Range< T > &  a )

inline

Merge two util::Range into 1.

Definition at line 86 of file Range.h.

References util::Range< T >::_window, util::Range< T >::End(), max, min, and util::Range< T >::Start().

Referenced by util::UniqueRangeSet< T >::emplace().

                               {
      _window.first  = std::min( _window.first,  a.Start() );
      _window.second = std::max( _window.second, a.End()   );
    }

template<class T>

bool util::Range< T >::operator!= ( const Range< T > &  rhs ) const

inline

Definition at line 74 of file Range.h.

    {return !( (*this) == rhs ); }

template<class T>

bool util::Range< T >::operator< ( const Range< T > &  rhs ) const

inline

Definition at line 68 of file Range.h.

References util::Range< T >::_window, and util::Range< T >::Start().

    {return ( _window.second < rhs.Start() ); }

template<class T>

bool util::Range< T >::operator< ( const T &  rhs ) const

inline

Definition at line 80 of file Range.h.

References util::Range< T >::_window.

    {return (_window.second < rhs); }

template<class T>

bool util::Range< T >::operator== ( const Range< T > &  rhs ) const

inline

Definition at line 72 of file Range.h.

References util::Range< T >::_window, util::Range< T >::End(), and util::Range< T >::Start().

    {return ( _window.first == rhs.Start() && _window.second == rhs.End() ); }

template<class T>

bool util::Range< T >::operator> ( const Range< T > &  rhs ) const

inline

Definition at line 70 of file Range.h.

References util::Range< T >::_window, and util::Range< T >::End().

    {return ( _window.first > rhs.End() ); }

template<class T>

bool util::Range< T >::operator> ( const T &  rhs ) const

inline

Definition at line 82 of file Range.h.

References util::Range< T >::_window.

    {return (_window.first > rhs); }

template<class T>

void util::Range< T >::Set ( const T &  s, const T &  e  )

inline

Setter.

Definition at line 58 of file Range.h.

References util::Range< T >::_window, e, and s.

    { 
      if(s>=e) throw std::runtime_error("Inserted invalid range: end before start."); 
      _window.first  = s;
      _window.second = e;
    }

template<class T>

const T& util::Range< T >::Start ( ) const

inline

"start" accessor

Definition at line 54 of file Range.h.

References util::Range< T >::_window.

Referenced by util::Range< T >::Merge(), util::Range< T >::operator<(), and util::Range< T >::operator==().

{ return _window.first;  }

Friends And Related Function Documentation

template<class T>

friend class UniqueRangeSet< T >

friend

Definition at line 37 of file Range.h.

Member Data Documentation

template<class T>

std::pair<T,T> util::Range< T >::_window

protected

Protected to avoid user's illegal modification on first/second (sorry users!)

Definition at line 93 of file Range.h.

Referenced by util::Range< T >::End(), util::UniqueRangeSet< T >::insert(), util::Range< T >::Merge(), util::Range< T >::operator<(), util::Range< T >::operator==(), util::Range< T >::operator>(), util::Range< T >::Set(), and util::Range< T >::Start().

---

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

• /cvmfs/larsoft.opensciencegrid.org/products/lardata/v07_01_01/source/lardata/Utilities/Range.h