Const_circulator_from_container< Ctnr > Class Template Reference

#include <circulator.h>

Public Types
typedef Const_circulator_from_container < Ctnr >	Self
typedef Circulator_from_container < Ctnr >	Mutable
typedef Ctnr	Container
typedef Ctnr::const_iterator	const_iterator
typedef Ctnr::value_type	value_type
typedef Ctnr::const_reference	reference
typedef const value_type *	pointer
typedef Ctnr::size_type	size_type
typedef Ctnr::difference_type	difference_type
typedef std::iterator_traits < const_iterator >	ITraits
typedef ITraits::iterator_category	Icategory
typedef I_Circulator_from_iterator_traits < Icategory >	CTraits
typedef CTraits::iterator_category	iterator_category

Public Member Functions
	Const_circulator_from_container ()
	Const_circulator_from_container (const Ctnr *c)
	Const_circulator_from_container (const Ctnr *c, const_iterator j)
	Const_circulator_from_container (const Mutable &c)
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
const_iterator	current_iterator () const
Self	min_circulator () const
const Ctnr *	container () const

Private Attributes
const Ctnr *	ctnr
const_iterator	i

Detailed Description

template<class Ctnr>
class Const_circulator_from_container< Ctnr >

Definition at line 920 of file circulator.h.

Member Typedef Documentation

typedef Ctnr::const_iterator const_iterator

Definition at line 927 of file circulator.h.

typedef Ctnr Container

Definition at line 926 of file circulator.h.

typedef I_Circulator_from_iterator_traits<Icategory> CTraits

Definition at line 936 of file circulator.h.

typedef Ctnr::difference_type difference_type

Definition at line 932 of file circulator.h.

typedef ITraits::iterator_category Icategory

Definition at line 935 of file circulator.h.

typedef CTraits::iterator_category iterator_category

Definition at line 937 of file circulator.h.

typedef std::iterator_traits<const_iterator> ITraits

Definition at line 934 of file circulator.h.

typedef Circulator_from_container<Ctnr> Mutable

Definition at line 925 of file circulator.h.

typedef const value_type* pointer

Definition at line 930 of file circulator.h.

typedef Ctnr::const_reference reference

Definition at line 929 of file circulator.h.

typedef Const_circulator_from_container<Ctnr> Self

Definition at line 924 of file circulator.h.

typedef Ctnr::size_type size_type

Definition at line 931 of file circulator.h.

typedef Ctnr::value_type value_type

Definition at line 928 of file circulator.h.

Constructor & Destructor Documentation

Const_circulator_from_container ( )

inline

Definition at line 946 of file circulator.h.

: ctnr(NULL) {}

Const_circulator_from_container ( const Ctnr *  c )

inline

Definition at line 947 of file circulator.h.

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

Const_circulator_from_container ( const Ctnr *  c, const_iterator  j  )

inline

Definition at line 949 of file circulator.h.

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

Const_circulator_from_container ( const Mutable &  c )

inline

Definition at line 951 of file circulator.h.

        : ctnr( c.container()), i( c.current_iterator()) {}

Member Function Documentation

const Ctnr* container ( ) const

inline

Definition at line 1044 of file circulator.h.

References Const_circulator_from_container< Ctnr >::ctnr.

{ return ctnr; }

const_iterator current_iterator ( ) const

inline

Definition at line 1042 of file circulator.h.

References Const_circulator_from_container< Ctnr >::i.

{ return i;}

Self min_circulator ( ) const

inline

Definition at line 1043 of file circulator.h.

References Const_circulator_from_container< Ctnr >::ctnr.

{ return Self(ctnr); }

bool operator!= ( CGAL_NULL_TYPE  p ) const

inline

Definition at line 967 of file circulator.h.

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

bool operator!= ( const Self &  c ) const

inline

Definition at line 969 of file circulator.h.

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

reference operator* ( ) const

inline

Definition at line 970 of file circulator.h.

References CGAL_assertion, Const_circulator_from_container< Ctnr >::ctnr, and Const_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 1023 of file circulator.h.

References n.

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

Self& operator++ ( )

inline

Definition at line 980 of file circulator.h.

References CGAL_assertion, Const_circulator_from_container< Ctnr >::ctnr, and Const_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 988 of file circulator.h.

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

Const_circulator_from_container< Ctnr > & operator+=

(

typename Ctnr::difference_type

n

)

Definition at line 1061 of file circulator.h.

References CGAL_assertion, j, and non_negative_mod().

Referenced by Const_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 1028 of file circulator.h.

References n.

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

difference_type operator- ( const Self &  c ) const

inline

Definition at line 1032 of file circulator.h.

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

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

Self& operator-- ( )

inline

Definition at line 993 of file circulator.h.

References CGAL_assertion, Const_circulator_from_container< Ctnr >::ctnr, and Const_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 1001 of file circulator.h.

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

Self& operator-= ( difference_type  n )

inline

Definition at line 1027 of file circulator.h.

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

{ return operator+=( -n); }

Here is the call graph for this function:

pointer operator-> ( ) const

inline

Definition at line 975 of file circulator.h.

References CGAL_assertion, and Const_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 955 of file circulator.h.

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

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

bool operator== ( CGAL_NULL_TYPE  p ) const

inline

Definition at line 963 of file circulator.h.

References CGAL_assertion, CGAL_CIRC_NULL, and Const_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 968 of file circulator.h.

References Const_circulator_from_container< Ctnr >::i.

{ return i == c.i; }

reference operator[] ( difference_type  n ) const

inline

Definition at line 1037 of file circulator.h.

References n.

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

Member Data Documentation

const Ctnr* ctnr

private

Definition at line 940 of file circulator.h.

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

const_iterator i

private

Definition at line 941 of file circulator.h.

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

---

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

• circulator.h