JLANG::JBidirectionalIterator< T > Class Template Reference

Template interface for method bool decrement(). More...

#include <JBidirectionalIterator.hh>

Inheritance diagram for JLANG::JBidirectionalIterator< T >:

Public Member Functions
virtual	~JBidirectionalIterator ()
	Virtual destructor. More...
T &	operator-- ()
	Decrement iterator. More...
T	operator-- (int)
	Decrement iterator. More...
T &	operator-= (const size_t offset)
	Regress iterator. More...
virtual bool	decrement ()=0
	Decrement iterator. More...
virtual bool	decrement (const size_t offset)
	Decrement iterator. More...
T &	operator++ ()
	Increment iterator. More...
T	operator++ (int)
	Increment iterator. More...
T &	operator+= (const size_t offset)
	Advance iterator. More...
virtual bool	increment ()=0
	Increment iterator. More...
virtual bool	increment (const size_t offset)
	Increment iterator. More...

Friends
T	operator- (const T &object, const size_t offset)
	Regress operator. More...

Detailed Description

template<class T>
class JLANG::JBidirectionalIterator< T >

Template interface for method bool decrement().

This interface implements the pre-fix and post-fix operators –.

Definition at line 20 of file JBidirectionalIterator.hh.

Constructor & Destructor Documentation

template<class T >

virtual JLANG::JBidirectionalIterator< T >::~JBidirectionalIterator ( )

inlinevirtual

Virtual destructor.

Definition at line 27 of file JBidirectionalIterator.hh.

    {}

Member Function Documentation

template<class T >

T& JLANG::JBidirectionalIterator< T >::operator-- ( )

inline

Decrement iterator.

Returns

this iterator

Definition at line 36 of file JBidirectionalIterator.hh.

    {
      this->decrement();

      return static_cast<T&>(*this);
    }

template<class T >

T JLANG::JBidirectionalIterator< T >::operator-- ( int  )

inline

Decrement iterator.

Returns

decrement iterator

Definition at line 49 of file JBidirectionalIterator.hh.

    {
      const T tmp(static_cast<const T&>(*this));

      this->decrement();

      return tmp;
    }

template<class T >

T& JLANG::JBidirectionalIterator< T >::operator-= ( const size_t  offset )

inline

Regress iterator.

Parameters

offset

offset

Returns

iterator

Definition at line 65 of file JBidirectionalIterator.hh.

    {
      this->decrement(offset);

      return static_cast<T&>(*this);
    }

template<class T >

virtual bool JLANG::JBidirectionalIterator< T >::decrement ( )

pure virtual

Decrement iterator.

Returns

true if decremented; else false

Implemented in JSUPPORT::JTreeScannerInterface< JClass_t, JNullType >::basic_iterator< T >.

template<class T >

virtual bool JLANG::JBidirectionalIterator< T >::decrement ( const size_t  offset )

inlinevirtual

Decrement iterator.

Parameters

offset

offset

Returns

true if decremented; else false

Reimplemented in JSUPPORT::JTreeScannerInterface< JClass_t, JNullType >::basic_iterator< T >.

Definition at line 104 of file JBidirectionalIterator.hh.

    {
      size_t i = 0;

      while (i != offset && this->decrement()) {
        ++i;
      }

      return i == offset;
    }

template<class T>

T& JLANG::JForwardIterator< T >::operator++ ( )

inlineinherited

Increment iterator.

Returns

this iterator

Definition at line 34 of file JForwardIterator.hh.

    {
      this->increment();
      
      return static_cast<T&>(*this);
    }

template<class T>

T JLANG::JForwardIterator< T >::operator++ ( int  )

inlineinherited

Increment iterator.

Returns

previous iterator

Definition at line 47 of file JForwardIterator.hh.

    {
      const T tmp(static_cast<const T&>(*this));

      this->increment();

      return tmp;
    }

template<class T>

T& JLANG::JForwardIterator< T >::operator+= ( const size_t  offset )

inlineinherited

Advance iterator.

Parameters

offset

offset

Returns

iterator

Definition at line 63 of file JForwardIterator.hh.

    {
      this->increment(offset);

      return static_cast<T&>(*this);
    }

template<class T>

virtual bool JLANG::JForwardIterator< T >::increment ( )

pure virtualinherited

Increment iterator.

Returns

true if incremented; else false

Implemented in JTOOLS::JMultiMap< JAbscissa_t, JOrdinate_t, JMapList< JHead_t, JLANG::JNullType >, JDistance_t >::iterator_helper< iterator_type, ordinate_type >, JTOOLS::JHashMap< JTypeList< JHead_t, JNullType >, JValue_t, JEvaluator_t >::super_const_iterator, JTOOLS::JHashMap< JTypeList< JHead_t, JNullType >, JValue_t, JEvaluator_t >::super_iterator, JTOOLS::JMultiMap< JAbscissa_t, JOrdinate_t, JMapList< JHead_t, JTail_t >, JDistance_t >::reverse_iterator_helper< first_iterator, second_iterator >, JTOOLS::JMultiMap< JAbscissa_t, JOrdinate_t, JMapList< JHead_t, JTail_t >, JDistance_t >::iterator_helper< first_iterator, second_iterator >, JTOOLS::JHashMap< JTypeList< JHead_t, JTail_t >, JValue_t, JEvaluator_t >::super_const_iterator, JTOOLS::JHashMap< JTypeList< JHead_t, JTail_t >, JValue_t, JEvaluator_t >::super_iterator, and JSUPPORT::JTreeScannerInterface< JClass_t, JNullType >::basic_iterator< T >.

template<class T>

virtual bool JLANG::JForwardIterator< T >::increment ( const size_t  offset )

inlinevirtualinherited

Increment iterator.

Parameters

offset

offset

Returns

true if incremented; else false

Reimplemented in JSUPPORT::JTreeScannerInterface< JClass_t, JNullType >::basic_iterator< T >.

Definition at line 102 of file JForwardIterator.hh.

    {
      size_t i = 0;

      while (i != offset && this->increment()) {
        ++i;
      }

      return i == offset;
    }

Friends And Related Function Documentation

template<class T >

T operator- ( const T &  object, const size_t  offset  )

friend

Regress operator.

Parameters

object	iterator
offset	offset

Returns

iterator

Definition at line 80 of file JBidirectionalIterator.hh.

    {
      T tmp(object);

      tmp.decrement(offset);

      return tmp;
    }

---

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

• JBidirectionalIterator.hh