cgal/Circulator/doc_tex/Circulator_ref/ConstRange.tex

42 lines
1020 B
TeX

\begin{ccRefConcept}{ConstRange}
\ccDefinition
A constant iterator range. Refer to the \ccc{Range} concept for more details.
\ccRefines
Boost's Range concept
\ccCreationVariable{r} %% choose variable name
\ccTypes
\ccNestedType{const_iterator} {The constant iterator type.}
\ccNestedType{size_type} {An unsigned integral type that can represent the
size of a range.}
\ccHeading{Member functions}
\def\ccTagRmTrailingConst{\ccFalse}
\ccMethod{const_iterator begin() const;}{returns the const iterator pointing to the first element.}
\ccGlue
\ccMethod{const_iterator end() const;}{returns the past-the-end const iterator.}
\ccMethod{size_type size() const;}{returns the size of the range.}
\ccGlue
\ccMethod{bool empty() const;}{returns whether the range is empty.}
\def\ccTagRmTrailingConst{\ccTrue}
\ccHasModels
STL containers\\
\ccAnchor{http://www.boost.org/libs/range/doc/html/range/reference/utilities/iterator_range.html}%
{\ccc{boost::iterator_range}}
\ccSeeAlso
\ccc{Range}
\end{ccRefConcept}