Circulator_from_iterator< I, TT, SS, DD > Class Template Reference

#include <circulator.h>

Public Types
typedef Circulator_from_iterator< I, TT, SS, DD >	Self
typedef I	iterator
typedef std::iterator_traits < iterator >	Traits
typedef Traits::value_type	value_type
typedef std::size_t	size_type
typedef Traits::difference_type	difference_type
typedef Traits::reference	reference
typedef Traits::pointer	pointer
typedef Traits::iterator_category	Icategory
typedef I_Circulator_from_iterator_traits < Icategory >	CTraits
typedef CTraits::iterator_category	iterator_category

Public Member Functions
	Circulator_from_iterator ()
	Circulator_from_iterator (const I &bgn, const I &end)
	Circulator_from_iterator (const I &bgn, const I &end, const I &cur)
	Circulator_from_iterator (const Self &c, const I &cur)
template<class II , class A1 , class A2 , class A3 >
	Circulator_from_iterator (const Circulator_from_iterator< II, A1, A2, A3 > &ii)
bool	operator== (CGAL_NULL_TYPE p) const
bool	operator!= (CGAL_NULL_TYPE p) const
bool	operator== (const Self &c) const
bool	operator!= (const Self &c) const
reference	operator* () const
pointer	operator-> () const
Self &	operator++ ()
Self	operator++ (int)
Self &	operator-- ()
Self	operator-- (int)
Self &	operator+= (difference_type n)
Self	operator+ (difference_type n) const
Self &	operator-= (difference_type n)
Self	operator- (difference_type n) const
difference_type	operator- (const Self &i) const
reference	operator[] (difference_type n) const
iterator	begin () const
iterator	end () const
iterator	current_iterator () const
Self	min_circulator () const

Private Attributes
I	m_begin
I	m_end
I	current

Detailed Description

template<class I, class TT = int, class SS = int, class DD = int>
class Circulator_from_iterator< I, TT, SS, DD >

Definition at line 1078 of file circulator.h.

Member Typedef Documentation

typedef I_Circulator_from_iterator_traits<Icategory> CTraits

Definition at line 1093 of file circulator.h.

typedef Traits::difference_type difference_type

Definition at line 1088 of file circulator.h.

typedef Traits::iterator_category Icategory

Definition at line 1092 of file circulator.h.

typedef I iterator

Definition at line 1083 of file circulator.h.

typedef CTraits::iterator_category iterator_category

Definition at line 1094 of file circulator.h.

typedef Traits::pointer pointer

Definition at line 1090 of file circulator.h.

typedef Traits::reference reference

Definition at line 1089 of file circulator.h.

typedef Circulator_from_iterator<I,TT,SS,DD> Self

Definition at line 1082 of file circulator.h.

typedef std::size_t size_type

Definition at line 1087 of file circulator.h.

typedef std::iterator_traits<iterator> Traits

Definition at line 1084 of file circulator.h.

typedef Traits::value_type value_type

Definition at line 1086 of file circulator.h.

Constructor & Destructor Documentation

Circulator_from_iterator ( )

inline

Definition at line 1104 of file circulator.h.

: m_begin(I()), m_end(I()), current(I()) {}

Circulator_from_iterator ( const I &  bgn, const I &  end  )

inline

Definition at line 1106 of file circulator.h.

        : m_begin(bgn), m_end(end), current(bgn) {}

Circulator_from_iterator ( const I &  bgn, const I &  end, const I &  cur  )

inline

Definition at line 1109 of file circulator.h.

        : m_begin(bgn), m_end(end), current(cur) {}

Circulator_from_iterator ( const Self &  c, const I &  cur  )

inline

Definition at line 1112 of file circulator.h.

        : m_begin( c.m_begin), m_end( c.m_end), current(cur) {}

Circulator_from_iterator ( const Circulator_from_iterator< II, A1, A2, A3 > &  ii )

inline

Definition at line 1119 of file circulator.h.

    : m_begin( ii.begin()), m_end( ii.end()),
        current(ii.current_iterator()) {}

Member Function Documentation

iterator begin ( ) const

inline

Definition at line 1197 of file circulator.h.

References Circulator_from_iterator< I, TT, SS, DD >::m_begin.

{ return m_begin;}

iterator current_iterator ( ) const

inline

Definition at line 1199 of file circulator.h.

References Circulator_from_iterator< I, TT, SS, DD >::current.

{ return current;}

iterator end ( ) const

inline

Definition at line 1198 of file circulator.h.

References Circulator_from_iterator< I, TT, SS, DD >::m_end.

{ return m_end;}

Self min_circulator ( ) const

inline

Definition at line 1200 of file circulator.h.

References Circulator_from_iterator< I, TT, SS, DD >::m_begin, and Circulator_from_iterator< I, TT, SS, DD >::m_end.

{ return Self( m_begin, m_end); }

bool operator!= ( CGAL_NULL_TYPE  p ) const

inline

Definition at line 1132 of file circulator.h.

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

bool operator!= ( const Self &  c ) const

inline

Definition at line 1134 of file circulator.h.

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

reference operator* ( ) const

inline

Definition at line 1135 of file circulator.h.

References CGAL_assertion, Circulator_from_iterator< I, TT, SS, DD >::current, and Circulator_from_iterator< I, TT, SS, DD >::m_end.

                                 {
        CGAL_assertion( current != m_end);
        return *current;
    }

Self operator+ ( difference_type  n ) const

inline

Definition at line 1179 of file circulator.h.

References n.

                                              {
        Self tmp = *this;
        return tmp += n;
    }

Self& operator++ ( )

inline

Definition at line 1143 of file circulator.h.

References CGAL_assertion, Circulator_from_iterator< I, TT, SS, DD >::current, Circulator_from_iterator< I, TT, SS, DD >::m_begin, and Circulator_from_iterator< I, TT, SS, DD >::m_end.

                       {
        CGAL_assertion( current != m_end);
        ++current;
        if ( current == m_end)
            current = m_begin;
        return *this;
    }

Self operator++ ( int  )

inline

Definition at line 1150 of file circulator.h.

                          {
        Self tmp= *this;
        ++*this;
        return tmp;
    }

Self& operator+= ( difference_type  n )

inline

Definition at line 1167 of file circulator.h.

References CGAL_assertion, Circulator_from_iterator< I, TT, SS, DD >::current, i, Circulator_from_iterator< I, TT, SS, DD >::m_begin, Circulator_from_iterator< I, TT, SS, DD >::m_end, and non_negative_mod().

Referenced by Circulator_from_iterator< I, TT, SS, DD >::operator-=().

                                         {
        CGAL_assertion( current != m_end);
        difference_type i    = current - m_begin;
        difference_type size = m_end    - m_begin;
        CGAL_assertion( i    >= 0);
        CGAL_assertion( size >= 0);
        i = non_negative_mod( i + n, size);
        CGAL_assertion( i >= 0);
        CGAL_assertion( i < size);
        current = m_begin + i;
        return *this;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Self operator- ( difference_type  n ) const

inline

Definition at line 1184 of file circulator.h.

References n.

                                              {
        Self tmp = *this;
        return tmp += -n;
    }

difference_type operator- ( const Self &  i ) const

inline

Definition at line 1188 of file circulator.h.

References CGAL_assertion, Circulator_from_iterator< I, TT, SS, DD >::current, Circulator_from_iterator< I, TT, SS, DD >::m_begin, and Circulator_from_iterator< I, TT, SS, DD >::m_end.

                                                     {
        CGAL_assertion((m_begin == i.m_begin) && (m_end == i.m_end));
        return current - i.current;
    }

Self& operator-- ( )

inline

Definition at line 1155 of file circulator.h.

References CGAL_assertion, Circulator_from_iterator< I, TT, SS, DD >::current, Circulator_from_iterator< I, TT, SS, DD >::m_begin, and Circulator_from_iterator< I, TT, SS, DD >::m_end.

                       {
        CGAL_assertion( current != m_end);
        if ( current == m_begin)
            current = m_end;
        --current;
        return *this;
    }

Self operator-- ( int  )

inline

Definition at line 1162 of file circulator.h.

                          {
        Self tmp = *this;
        --*this;
        return tmp;
    }

Self& operator-= ( difference_type  n )

inline

Definition at line 1183 of file circulator.h.

References Circulator_from_iterator< I, TT, SS, DD >::operator+=().

{ return operator+=( -n); }

Here is the call graph for this function:

pointer operator-> ( ) const

inline

Definition at line 1139 of file circulator.h.

References CGAL_assertion, Circulator_from_iterator< I, TT, SS, DD >::current, and Circulator_from_iterator< I, TT, SS, DD >::m_end.

                                {
        CGAL_assertion( current != m_end);
        return &(*current);
    }

bool operator== ( CGAL_NULL_TYPE  p ) const

inline

Definition at line 1127 of file circulator.h.

References CGAL_assertion, CGAL_CIRC_NULL, Circulator_from_iterator< I, TT, SS, DD >::current, Circulator_from_iterator< I, TT, SS, DD >::m_begin, and Circulator_from_iterator< I, TT, SS, DD >::m_end.

                                             {
        CGAL_assertion( p == CGAL_CIRC_NULL);
        CGAL_assertion((m_end == m_begin) || (current != m_end));
        return m_end == m_begin;
    }

bool operator== ( const Self &  c ) const

inline

Definition at line 1133 of file circulator.h.

References Circulator_from_iterator< I, TT, SS, DD >::current.

{ return current == c.current;}

reference operator[] ( difference_type  n ) const

inline

Definition at line 1192 of file circulator.h.

References n.

                                                   {
        Self tmp = *this;
        tmp += n;
        return tmp.operator*();
    }

Member Data Documentation

I current

private

Definition at line 1099 of file circulator.h.

Referenced by Circulator_from_iterator< I, TT, SS, DD >::current_iterator(), Circulator_from_iterator< I, TT, SS, DD >::operator*(), Circulator_from_iterator< I, TT, SS, DD >::operator++(), Circulator_from_iterator< I, TT, SS, DD >::operator+=(), Circulator_from_iterator< I, TT, SS, DD >::operator-(), Circulator_from_iterator< I, TT, SS, DD >::operator--(), Circulator_from_iterator< I, TT, SS, DD >::operator->(), and Circulator_from_iterator< I, TT, SS, DD >::operator==().

I m_begin

private

Definition at line 1097 of file circulator.h.

Referenced by Circulator_from_iterator< I, TT, SS, DD >::begin(), Circulator_from_iterator< I, TT, SS, DD >::min_circulator(), Circulator_from_iterator< I, TT, SS, DD >::operator++(), Circulator_from_iterator< I, TT, SS, DD >::operator+=(), Circulator_from_iterator< I, TT, SS, DD >::operator-(), Circulator_from_iterator< I, TT, SS, DD >::operator--(), and Circulator_from_iterator< I, TT, SS, DD >::operator==().

I m_end

private

Definition at line 1098 of file circulator.h.

Referenced by Circulator_from_iterator< I, TT, SS, DD >::end(), Circulator_from_iterator< I, TT, SS, DD >::min_circulator(), Circulator_from_iterator< I, TT, SS, DD >::operator*(), Circulator_from_iterator< I, TT, SS, DD >::operator++(), Circulator_from_iterator< I, TT, SS, DD >::operator+=(), Circulator_from_iterator< I, TT, SS, DD >::operator-(), Circulator_from_iterator< I, TT, SS, DD >::operator--(), Circulator_from_iterator< I, TT, SS, DD >::operator->(), and Circulator_from_iterator< I, TT, SS, DD >::operator==().

---

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

• circulator.h