Circulator_from_container< Ctnr > Class Template Reference

#include <circulator.h>

Public Types
typedef Circulator_from_container < Ctnr >	Self
typedef Ctnr	Container
typedef Ctnr::iterator	iterator
typedef Ctnr::value_type	value_type
typedef Ctnr::reference	reference
typedef value_type *	pointer
typedef Ctnr::size_type	size_type
typedef Ctnr::difference_type	difference_type
typedef std::iterator_traits < iterator >	ITraits
typedef ITraits::iterator_category	Icategory
typedef I_Circulator_from_iterator_traits < Icategory >	CTraits
typedef CTraits::iterator_category	iterator_category

Public Member Functions
	Circulator_from_container ()
	Circulator_from_container (Ctnr *c)
	Circulator_from_container (Ctnr *c, iterator j)
Self &	operator= (const Self &c)
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 &c) const
reference	operator[] (difference_type n) const
iterator	current_iterator () const
Self	min_circulator () const
Ctnr *	container () const

Private Attributes
Ctnr *	ctnr
iterator	i

Detailed Description

template<class Ctnr>
class Circulator_from_container< Ctnr >

Definition at line 768 of file circulator.h.

Member Typedef Documentation

typedef Ctnr Container

Definition at line 773 of file circulator.h.

typedef I_Circulator_from_iterator_traits<Icategory> CTraits

Definition at line 783 of file circulator.h.

typedef Ctnr::difference_type difference_type

Definition at line 779 of file circulator.h.

typedef ITraits::iterator_category Icategory

Definition at line 782 of file circulator.h.

typedef Ctnr::iterator iterator

Definition at line 774 of file circulator.h.

typedef CTraits::iterator_category iterator_category

Definition at line 784 of file circulator.h.

typedef std::iterator_traits<iterator> ITraits

Definition at line 781 of file circulator.h.

typedef value_type* pointer

Definition at line 777 of file circulator.h.

typedef Ctnr::reference reference

Definition at line 776 of file circulator.h.

typedef Circulator_from_container<Ctnr> Self

Definition at line 772 of file circulator.h.

typedef Ctnr::size_type size_type

Definition at line 778 of file circulator.h.

typedef Ctnr::value_type value_type

Definition at line 775 of file circulator.h.

Constructor & Destructor Documentation

Circulator_from_container ( )

inline

Definition at line 793 of file circulator.h.

: ctnr(NULL) {}

Circulator_from_container ( Ctnr *  c )

inline

Definition at line 794 of file circulator.h.

: ctnr(c), i(c->begin()) {}

Circulator_from_container ( Ctnr *  c, iterator  j  )

inline

Definition at line 795 of file circulator.h.

: ctnr(c), i(j) {}

Member Function Documentation

Ctnr* container ( ) const

inline

Definition at line 887 of file circulator.h.

References Circulator_from_container< Ctnr >::ctnr.

{ return ctnr; }

iterator current_iterator ( ) const

inline

Definition at line 885 of file circulator.h.

References Circulator_from_container< Ctnr >::i.

{ return i;}

Self min_circulator ( ) const

inline

Definition at line 886 of file circulator.h.

References Circulator_from_container< Ctnr >::ctnr.

{ return Self(ctnr); }

bool operator!= ( CGAL_NULL_TYPE  p ) const

inline

Definition at line 810 of file circulator.h.

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

bool operator!= ( const Self &  c ) const

inline

Definition at line 812 of file circulator.h.

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

reference operator* ( ) const

inline

Definition at line 813 of file circulator.h.

References CGAL_assertion, Circulator_from_container< Ctnr >::ctnr, and Circulator_from_container< Ctnr >::i.

                                 {
        CGAL_assertion( ctnr != NULL);
        CGAL_assertion( i != ctnr->end());
        return *i;
    }

Self operator+ ( difference_type  n ) const

inline

Definition at line 866 of file circulator.h.

References n.

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

Self& operator++ ( )

inline

Definition at line 823 of file circulator.h.

References CGAL_assertion, Circulator_from_container< Ctnr >::ctnr, and Circulator_from_container< Ctnr >::i.

                       {
        CGAL_assertion( ctnr != NULL);
        CGAL_assertion( i != ctnr->end());
        ++i;
        if ( i == ctnr->end())
            i = ctnr->begin();
        return *this;
    }

Self operator++ ( int  )

inline

Definition at line 831 of file circulator.h.

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

Circulator_from_container< Ctnr > & operator+=

(

typename Ctnr::difference_type

n

)

Definition at line 903 of file circulator.h.

References CGAL_assertion, j, and non_negative_mod().

Referenced by Circulator_from_container< Ctnr >::operator-=().

                                            {
    CGAL_assertion( ctnr != NULL);
    CGAL_assertion( i != ctnr->end());
    typename Ctnr::difference_type j    = i - ctnr->begin();
    typename Ctnr::difference_type size = ctnr->size();
    CGAL_assertion( j    >= 0);
    CGAL_assertion( size >= 0);
    j = non_negative_mod( j + n, size);
    CGAL_assertion( j >= 0);
    CGAL_assertion( j < size);
    i = ctnr->begin() + j;
    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 871 of file circulator.h.

References n.

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

difference_type operator- ( const Self &  c ) const

inline

Definition at line 875 of file circulator.h.

References CGAL_assertion, Circulator_from_container< Ctnr >::ctnr, and Circulator_from_container< Ctnr >::i.

                                                    {
        CGAL_assertion( ctnr != NULL);
        CGAL_assertion( c.ctnr != NULL);
        return i - c.i;
    }

Self& operator-- ( )

inline

Definition at line 836 of file circulator.h.

References CGAL_assertion, Circulator_from_container< Ctnr >::ctnr, and Circulator_from_container< Ctnr >::i.

                       {
        CGAL_assertion( ctnr != NULL);
        CGAL_assertion( i != ctnr->end());
        if ( i == ctnr->begin())
            i = ctnr->end();
        --i;
        return *this;
    }

Self operator-- ( int  )

inline

Definition at line 844 of file circulator.h.

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

Self& operator-= ( difference_type  n )

inline

Definition at line 870 of file circulator.h.

References Circulator_from_container< Ctnr >::operator+=().

{ return operator+=( -n); }

Here is the call graph for this function:

pointer operator-> ( ) const

inline

Definition at line 818 of file circulator.h.

References CGAL_assertion, and Circulator_from_container< Ctnr >::ctnr.

                                {
        CGAL_assertion( ctnr != NULL);
        CGAL_assertion( i != ctnr->end());
        return i.operator->();
    }

Self& operator= ( const Self &  c )

inline

Definition at line 798 of file circulator.h.

References Circulator_from_container< Ctnr >::ctnr, and Circulator_from_container< Ctnr >::i.

                                    {
        ctnr = c.ctnr;
        i    = c.i;
        return *this;
    }

bool operator== ( CGAL_NULL_TYPE  p ) const

inline

Definition at line 806 of file circulator.h.

References CGAL_assertion, CGAL_CIRC_NULL, and Circulator_from_container< Ctnr >::ctnr.

                                             {
        CGAL_assertion( p == CGAL_CIRC_NULL);
        return (ctnr == NULL) || (ctnr->begin() == ctnr->end());
    }

bool operator== ( const Self &  c ) const

inline

Definition at line 811 of file circulator.h.

References Circulator_from_container< Ctnr >::i.

{ return i == c.i; }

reference operator[] ( difference_type  n ) const

inline

Definition at line 880 of file circulator.h.

References n.

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

Member Data Documentation

Ctnr* ctnr

private

Definition at line 787 of file circulator.h.

Referenced by Circulator_from_container< Ctnr >::container(), Circulator_from_container< Ctnr >::min_circulator(), Circulator_from_container< Ctnr >::operator*(), Circulator_from_container< Ctnr >::operator++(), Circulator_from_container< Ctnr >::operator-(), Circulator_from_container< Ctnr >::operator--(), Circulator_from_container< Ctnr >::operator->(), Circulator_from_container< Ctnr >::operator=(), and Circulator_from_container< Ctnr >::operator==().

iterator i

private

Definition at line 788 of file circulator.h.

Referenced by Circulator_from_container< Ctnr >::current_iterator(), Circulator_from_container< Ctnr >::operator*(), Circulator_from_container< Ctnr >::operator++(), Circulator_from_container< Ctnr >::operator-(), Circulator_from_container< Ctnr >::operator--(), Circulator_from_container< Ctnr >::operator=(), and Circulator_from_container< Ctnr >::operator==().

---

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

• circulator.h