JLANG::JForwardIterator< T > Class Template Reference

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

#include <JForwardIterator.hh>

Inheritance diagram for JLANG::JForwardIterator< T >:

Public Member Functions
virtual	~JForwardIterator ()
	Virtual destructor. 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)
	Advance operator. More...

Detailed Description

template<class T>
class JLANG::JForwardIterator< T >

Template interface for method bool increment().

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

Definition at line 20 of file JForwardIterator.hh.

Constructor & Destructor Documentation

template<class T>

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

inlinevirtual

Virtual destructor.

Definition at line 25 of file JForwardIterator.hh.

    {}

Member Function Documentation

template<class T>

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

inline

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  )

inline

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 )

inline

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 virtual

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 )

inlinevirtual

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

Advance operator.

Parameters

object	iterator
offset	offset

Returns

iterator

Definition at line 78 of file JForwardIterator.hh.

    {
      T tmp(object);

      tmp.increment(offset);

      return tmp;
    }

---

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

• JForwardIterator.hh