Range.h

Go to the documentation of this file.

#ifndef GAUDI_RANGE_H
#define GAUDI_RANGE_H 1
// ============================================================================
// Include files
// ============================================================================
// STD & STL
// ============================================================================
#include <utility>
#include <vector>
#include <algorithm>
#include "GaudiKernel/Kernel.h"
// ============================================================================
// ============================================================================
namespace Gaudi
{
  namespace details
  {
    // ========================================================================
    GAUDI_API void rangeException
    ( const long   index ,
      const size_t size  ) ;
    // ========================================================================
  }
  // ==========================================================================
  struct RangeBase_ {} ;
  // ==========================================================================
  template <class CONTAINER>
  class Range_ : public RangeBase_
  {
  public:
    // ========================================================================
    typedef std::pair<typename CONTAINER::const_iterator,
                      typename CONTAINER::const_iterator> Base ;
    // ========================================================================
  public:
    // ========================================================================
    typedef CONTAINER                                  Container              ;
    typedef typename Container::value_type             value_type             ;
    typedef typename Container::const_iterator         iterator               ;
    typedef typename Container::const_iterator         const_iterator         ;
    typedef typename Container::const_reverse_iterator reverse_iterator       ;
    typedef typename Container::const_reverse_iterator const_reverse_iterator ;
    typedef typename Container::const_reference        reference              ;
    typedef typename Container::const_reference        const_reference        ;
    typedef std::pair<iterator,iterator>               _Base                  ;
    typedef Range_<Container>                          _Self                  ;
    // ========================================================================
  public:
    // ========================================================================
    Range_()  = default;
    Range_( iterator ibegin , iterator iend ) : m_base ( ibegin , iend ) {}
    Range_( const Base&      base ) : m_base( base ) {}
    Range_( const Container& cont ) : m_base( cont.begin() , cont.end() ) {}
    /* constructor of empty range/sequence
     * @param ibegin  iterator to begin of empty sequence
     */
    Range_( iterator ibegin       ) : m_base( ibegin , ibegin ) {}
    ~Range_() = default;
    // ========================================================================
    inline bool   empty () const { return m_base.second == m_base.first  ; }
    inline size_t size  () const
    { return std::distance ( m_base.first  , m_base.second  ) ; }
    inline iterator begin () const { return m_base.first  ; }
    inline iterator end   () const { return m_base.second ; }
    inline reverse_iterator rbegin   () const { return reverse_iterator ( end   () ) ; }
    inline reverse_iterator rend     () const { return reverse_iterator ( begin () ) ; }
    inline const_reference front () const { return *begin() ; }
    inline const_reference back  () const { return *std::prev( end() ); }
    // ========================================================================
    inline Range_ slice( long index1 , long index2 ) const
    {
      // trivial cases
      if ( empty() || index1 == index2 ) { return Range_() ; } // RETURN
      // adjust indices
      if ( index1 < 0      ) { index1 += size () ; }
      if ( index2 < 0      ) { index2 += size () ; }
      // check
      if ( index1 < 0      ) { return  Range_ () ; }            // RETURN
      if ( index2 < index1 ) { return  Range_ () ; }            // RETURN

      if ( index1 > (long) size () ) { return  Range_() ; }     // RETURN
      if ( index2 > (long) size () ) { index2  = size() ; }

      // construct the slice
      return Range_( std::next ( begin() , index1 ) , 
                     std::next ( begin() , index2 ) ) ;        // RETURN
    }
    // ========================================================================
    inline const_reference operator () ( const size_t index ) const
    {
      return *std::next ( begin() , index ) ;
    }
    inline const_reference operator [] ( const long index ) const
    { return (*this)( index ) ; }
    inline const_reference at          ( const long index ) const
    {
      if ( index < 0 || index >= (long) size () )
      { Gaudi::details::rangeException( index , size() ) ; }
      return (*this) ( index );
    }
    // ========================================================================
  public:
    // ========================================================================
    bool operator< ( const Range_& right ) const
    {
      return std::lexicographical_compare
        ( begin () , end () , right.begin () , right.end () ) ;
    }
    bool operator< ( const Container& right ) const
    {
      return std::lexicographical_compare
        ( begin () , end () , right.begin () , right.end () ) ;
    }
    // ========================================================================
  public:
    // ========================================================================
    bool operator==( const Range_& right ) const
    {
      if ( &right        == this    ) { return true  ; } // RETURN
      return right.size() == size() &&  
             std::equal ( begin () , end () , right.begin() ) ;
    }
    bool operator==( const Container& right ) const
    {
      return right.size() == size() && 
             std::equal ( begin () , end () , right.begin() ) ;
    }
    // ========================================================================
  public:
    // ========================================================================
    bool operator!        () const { return  empty () ; }
    // ========================================================================
  public:
    // ========================================================================
    operator const Base&      () const { return   base () ; }
    inline   const Base& base () const { return m_base    ; }
    // ========================================================================
  private:
    // ========================================================================
    // the base itself
    Base m_base ;    
    // ========================================================================
  }; // end of class Range_
  // ==========================================================================
  template <class CONTAINER>
  inline
  Range_<CONTAINER>
  range ( const CONTAINER& cnt )
  { return Range_<CONTAINER>( cnt.begin() , cnt.end() ) ; }
  // ==========================================================================
} // end of namespace Gaudi
// ============================================================================
// The END
// ============================================================================
#endif // GAUDI_RANGE_H
// ============================================================================