Iterator_from_circulator< C, Ref, Ptr > Class Template Reference

#include <circulator.h>

Public Types
typedef C	Circulator
typedef Iterator_from_circulator< C, Ref, Ptr >	Self
typedef I__traits::iterator_category	iterator_category
typedef C::value_type	value_type
typedef C::difference_type	difference_type
typedef C::size_type	size_type
typedef C::reference	reference
typedef C::pointer	pointer

Public Member Functions
	Iterator_from_circulator ()
	Iterator_from_circulator (const C *circ, int n)
template<class CC , class CREF , class CPTR >
	Iterator_from_circulator (const Iterator_from_circulator< CC, CREF, CPTR > &c)
bool	operator== (const Self &i) const
bool	operator!= (const Self &i) const
Ref	operator* () const
Ptr	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
Ref	operator[] (difference_type n) const
bool	operator< (const Self &i) const
bool	operator> (const Self &i) const
bool	operator<= (const Self &i) const
bool	operator>= (const Self &i) const
const C *	anchor () const
int	winding () const
Circulator	current_circulator () const

Private Types
typedef std::iterator_traits< C >	I_traits
typedef I_traits::iterator_category	I_Iter_cat
typedef I_Iterator_from_circulator_traits < I_Iter_cat >	I__traits

Private Attributes
const C *	m_anchor
C	current
int	m_winding

Detailed Description

template<class C, class Ref, class Ptr>
class Iterator_from_circulator< C, Ref, Ptr >

Definition at line 538 of file circulator.h.

Member Typedef Documentation

typedef C Circulator

Definition at line 553 of file circulator.h.

typedef C::difference_type difference_type

Definition at line 559 of file circulator.h.

typedef I_Iterator_from_circulator_traits<I_Iter_cat> I__traits

private

Definition at line 547 of file circulator.h.

typedef I_traits::iterator_category I_Iter_cat

private

Definition at line 546 of file circulator.h.

typedef std::iterator_traits<C> I_traits

private

Definition at line 545 of file circulator.h.

typedef I__traits::iterator_category iterator_category

Definition at line 556 of file circulator.h.

typedef C::pointer pointer

Definition at line 562 of file circulator.h.

typedef C::reference reference

Definition at line 561 of file circulator.h.

typedef Iterator_from_circulator<C,Ref,Ptr> Self

Definition at line 554 of file circulator.h.

typedef C::size_type size_type

Definition at line 560 of file circulator.h.

typedef C::value_type value_type

Definition at line 558 of file circulator.h.

Constructor & Destructor Documentation

Iterator_from_circulator ( )

inline

Definition at line 567 of file circulator.h.

: m_anchor(0), m_winding(0) {}

Iterator_from_circulator ( const C *  circ, int  n  )

inline

Definition at line 569 of file circulator.h.

        : m_anchor( circ), current( *circ), m_winding(n) {}

Iterator_from_circulator ( const Iterator_from_circulator< CC, CREF, CPTR > &  c )

inline

Definition at line 575 of file circulator.h.

    : m_anchor( c.anchor()), current( c.current_circulator()),
        m_winding(c.winding()) {}

Member Function Documentation

const C* anchor ( ) const

inline

Definition at line 682 of file circulator.h.

References Iterator_from_circulator< C, Ref, Ptr >::m_anchor.

{ return m_anchor;}

Circulator current_circulator ( ) const

inline

Definition at line 684 of file circulator.h.

References Iterator_from_circulator< C, Ref, Ptr >::current.

{ return current;}

bool operator!= ( const Self &  i ) const

inline

Definition at line 587 of file circulator.h.

References i.

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

Ref operator* ( ) const

inline

Definition at line 590 of file circulator.h.

References CGAL_assertion, CGAL_CIRC_NULL, Iterator_from_circulator< C, Ref, Ptr >::current, and Iterator_from_circulator< C, Ref, Ptr >::m_anchor.

                           {
        CGAL_assertion( m_anchor != CGAL_CIRC_NULL);
        CGAL_assertion( current  != CGAL_CIRC_NULL);
        return Ref(*current);
    }

Self operator+ ( difference_type  n ) const

inline

Definition at line 636 of file circulator.h.

References n.

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

Self& operator++ ( )

inline

Definition at line 600 of file circulator.h.

References CGAL_assertion, CGAL_CIRC_NULL, Iterator_from_circulator< C, Ref, Ptr >::current, Iterator_from_circulator< C, Ref, Ptr >::m_anchor, and Iterator_from_circulator< C, Ref, Ptr >::m_winding.

                       {
        CGAL_assertion( m_anchor != CGAL_CIRC_NULL);
        CGAL_assertion( current  != CGAL_CIRC_NULL);
        ++current;
        if ( current == *m_anchor)
            ++m_winding;
        return *this;
    }

Self operator++ ( int  )

inline

Definition at line 608 of file circulator.h.

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

Self& operator+= ( difference_type  n )

inline

Definition at line 626 of file circulator.h.

References CGAL_assertion, CGAL_CIRC_NULL, Iterator_from_circulator< C, Ref, Ptr >::current, Iterator_from_circulator< C, Ref, Ptr >::m_anchor, Iterator_from_circulator< C, Ref, Ptr >::m_winding, and n.

Referenced by Iterator_from_circulator< C, Ref, Ptr >::operator-=().

                                         {
        CGAL_assertion( m_anchor != CGAL_CIRC_NULL);
        CGAL_assertion( current != CGAL_CIRC_NULL);
        if ( n < 0 && current == *m_anchor)  // We are leaving the anchor.
            --m_winding;
        current += n;
        if ( n > 0 && current == *m_anchor)  // Back again at the anchor.
            ++m_winding;
        return *this;
    }

Here is the caller graph for this function:

Self operator- ( difference_type  n ) const

inline

Definition at line 643 of file circulator.h.

References n.

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

C::difference_type operator-

(

const Self &

i

)

const

Definition at line 698 of file circulator.h.

References CGAL_assertion, CGAL_CIRC_NULL, Iterator_from_circulator< C, Ref, Ptr >::current, I_min_circulator_size(), Iterator_from_circulator< C, Ref, Ptr >::m_anchor, and Iterator_from_circulator< C, Ref, Ptr >::m_winding.

                                                               {
    CGAL_assertion( m_anchor  != CGAL_CIRC_NULL);
    CGAL_assertion( current   != CGAL_CIRC_NULL);
    CGAL_assertion( m_anchor  == i.m_anchor);
    if ( m_winding != i.m_winding) {
        difference_type s = I_min_circulator_size( *m_anchor);
        return   (current - *m_anchor) - (i.current - *m_anchor)
               + s * (m_winding - i.m_winding);
    }
    return (current - *m_anchor) - (i.current - *m_anchor);
}

Here is the call graph for this function:

Self& operator-- ( )

inline

Definition at line 613 of file circulator.h.

References CGAL_assertion, CGAL_CIRC_NULL, Iterator_from_circulator< C, Ref, Ptr >::current, Iterator_from_circulator< C, Ref, Ptr >::m_anchor, and Iterator_from_circulator< C, Ref, Ptr >::m_winding.

                       {
        CGAL_assertion( m_anchor != CGAL_CIRC_NULL);
        CGAL_assertion( current != CGAL_CIRC_NULL);
        if ( current == *m_anchor)
            --m_winding;
        --current;
        return *this;
    }

Self operator-- ( int  )

inline

Definition at line 621 of file circulator.h.

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

Self& operator-= ( difference_type  n )

inline

Definition at line 640 of file circulator.h.

References Iterator_from_circulator< C, Ref, Ptr >::operator+=().

                                         {
        return operator+=( -n);
    }

Here is the call graph for this function:

Ptr operator-> ( ) const

inline

Definition at line 595 of file circulator.h.

References CGAL_assertion, CGAL_CIRC_NULL, Iterator_from_circulator< C, Ref, Ptr >::current, and Iterator_from_circulator< C, Ref, Ptr >::m_anchor.

                            {
        CGAL_assertion( m_anchor != CGAL_CIRC_NULL);
        CGAL_assertion( current  != CGAL_CIRC_NULL);
        return Ptr(current.operator->());
    }

bool operator< ( const Self &  i ) const

inline

Definition at line 668 of file circulator.h.

References CGAL_assertion, CGAL_CIRC_NULL, Iterator_from_circulator< C, Ref, Ptr >::current, Iterator_from_circulator< C, Ref, Ptr >::m_anchor, and Iterator_from_circulator< C, Ref, Ptr >::m_winding.

                                         {
        CGAL_assertion( m_anchor  != CGAL_CIRC_NULL);
        CGAL_assertion( current != CGAL_CIRC_NULL);
        CGAL_assertion( m_anchor  == i.m_anchor);
        return (     (m_winding < i.m_winding)
                 || (    (m_winding == i.m_winding)
                      && (current - *m_anchor) < (i.current - *m_anchor)
                    )
               );
    }

bool operator<= ( const Self &  i ) const

inline

Definition at line 679 of file circulator.h.

{ return !(i < *this); }

bool operator== ( const Self &  i ) const

inline

Definition at line 583 of file circulator.h.

References CGAL_assertion, Iterator_from_circulator< C, Ref, Ptr >::current, Iterator_from_circulator< C, Ref, Ptr >::m_anchor, and Iterator_from_circulator< C, Ref, Ptr >::m_winding.

                                          {
        CGAL_assertion( m_anchor == i.m_anchor);  // same anchor?
        return ( current == i.current) && ( m_winding == i.m_winding);
    }

bool operator> ( const Self &  i ) const

inline

Definition at line 678 of file circulator.h.

{ return i < *this; }

bool operator>= ( const Self &  i ) const

inline

Definition at line 680 of file circulator.h.

References i.

{ return !(*this < i); }

Ref operator[] ( difference_type  n ) const

inline

Definition at line 663 of file circulator.h.

References n.

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

int winding ( ) const

inline

Definition at line 683 of file circulator.h.

References Iterator_from_circulator< C, Ref, Ptr >::m_winding.

{ return m_winding;}

Member Data Documentation

C current

private

Definition at line 542 of file circulator.h.

Referenced by Iterator_from_circulator< C, Ref, Ptr >::current_circulator(), Iterator_from_circulator< C, Ref, Ptr >::operator*(), Iterator_from_circulator< C, Ref, Ptr >::operator++(), Iterator_from_circulator< C, Ref, Ptr >::operator+=(), Iterator_from_circulator< C, Ref, Ptr >::operator-(), Iterator_from_circulator< C, Ref, Ptr >::operator--(), Iterator_from_circulator< C, Ref, Ptr >::operator->(), Iterator_from_circulator< C, Ref, Ptr >::operator<(), and Iterator_from_circulator< C, Ref, Ptr >::operator==().

const C* m_anchor

private

Definition at line 541 of file circulator.h.

Referenced by Iterator_from_circulator< C, Ref, Ptr >::anchor(), Iterator_from_circulator< C, Ref, Ptr >::operator*(), Iterator_from_circulator< C, Ref, Ptr >::operator++(), Iterator_from_circulator< C, Ref, Ptr >::operator+=(), Iterator_from_circulator< C, Ref, Ptr >::operator-(), Iterator_from_circulator< C, Ref, Ptr >::operator--(), Iterator_from_circulator< C, Ref, Ptr >::operator->(), Iterator_from_circulator< C, Ref, Ptr >::operator<(), and Iterator_from_circulator< C, Ref, Ptr >::operator==().

int m_winding

private

Definition at line 543 of file circulator.h.

Referenced by Iterator_from_circulator< C, Ref, Ptr >::operator++(), Iterator_from_circulator< C, Ref, Ptr >::operator+=(), Iterator_from_circulator< C, Ref, Ptr >::operator-(), Iterator_from_circulator< C, Ref, Ptr >::operator--(), Iterator_from_circulator< C, Ref, Ptr >::operator<(), Iterator_from_circulator< C, Ref, Ptr >::operator==(), and Iterator_from_circulator< C, Ref, Ptr >::winding().

---

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

• circulator.h