2003-08-05 19:48:41 +00:00
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
< html xmlns = "http://www.w3.org/1999/xhtml" xml:lang = "en" lang = "en" >
< head >
< meta http-equiv = "Content-Type" content = "text/html; charset=utf-8" / >
2006-09-11 22:27:29 +00:00
< meta name = "generator" content = "Docutils 0.4: http://docutils.sourceforge.net/" / >
2003-08-05 19:48:41 +00:00
< title > Counting Iterator< / title >
< meta name = "author" content = "David Abrahams, Jeremy Siek, Thomas Witt" / >
< meta name = "organization" content = "Boost Consulting, Indiana University Open Systems Lab, University of Hanover Institute for Transport Railway Operation and Construction" / >
2004-11-02 14:31:27 +00:00
< meta name = "date" content = "2004-11-01" / >
< meta name = "copyright" content = "Copyright David Abrahams, Jeremy Siek, and Thomas Witt 2003." / >
2006-09-11 22:27:29 +00:00
< style type = "text/css" >
/*
:Author: David Goodger
:Contact: goodger@users.sourceforge.net
:Date: $Date$
:Revision: $Revision$
:Copyright: This stylesheet has been placed in the public domain.
Default cascading style sheet for the HTML output of Docutils.
See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
customize this style sheet.
*/
/* used to remove borders from tables and images */
. borderless , table . borderless td , table . borderless th {
border : 0 }
table . borderless td , table . borderless th {
/* Override padding for "table.docutils td" with "! important".
The right padding separates the table cells. */
padding : 0 0.5 em 0 0 ! important }
. first {
/* Override more specific margin styles with "! important". */
margin-top : 0 ! important }
. last , . with-subtitle {
margin-bottom : 0 ! important }
. hidden {
display : none }
a . toc-backref {
text-decoration : none ;
color : black }
blockquote . epigraph {
margin : 2 em 5 em ; }
dl . docutils dd {
margin-bottom : 0.5 em }
/* Uncomment (and remove this text!) to get bold-faced definition list terms
dl.docutils dt {
font-weight: bold }
*/
div . abstract {
margin : 2 em 5 em }
div . abstract p . topic-title {
font-weight : bold ;
text-align : center }
div . admonition , div . attention , div . caution , div . danger , div . error ,
div . hint , div . important , div . note , div . tip , div . warning {
margin : 2 em ;
border : medium outset ;
padding : 1 em }
div . admonition p . admonition-title , div . hint p . admonition-title ,
div . important p . admonition-title , div . note p . admonition-title ,
div . tip p . admonition-title {
font-weight : bold ;
font-family : sans-serif }
div . attention p . admonition-title , div . caution p . admonition-title ,
div . danger p . admonition-title , div . error p . admonition-title ,
div . warning p . admonition-title {
color : red ;
font-weight : bold ;
font-family : sans-serif }
/* Uncomment (and remove this text!) to get reduced vertical space in
compound paragraphs.
div.compound .compound-first, div.compound .compound-middle {
margin-bottom: 0.5em }
div.compound .compound-last, div.compound .compound-middle {
margin-top: 0.5em }
*/
div . dedication {
margin : 2 em 5 em ;
text-align : center ;
font-style : italic }
div . dedication p . topic-title {
font-weight : bold ;
font-style : normal }
div . figure {
margin-left : 2 em ;
margin-right : 2 em }
div . footer , div . header {
clear : both ;
font-size : smaller }
div . line-block {
display : block ;
margin-top : 1 em ;
margin-bottom : 1 em }
div . line-block div . line-block {
margin-top : 0 ;
margin-bottom : 0 ;
margin-left : 1.5 em }
div . sidebar {
margin-left : 1 em ;
border : medium outset ;
padding : 1 em ;
background-color : #ffffee ;
width : 40 % ;
float : right ;
clear : right }
div . sidebar p . rubric {
font-family : sans-serif ;
font-size : medium }
div . system-messages {
margin : 5 em }
div . system-messages h1 {
color : red }
div . system-message {
border : medium outset ;
padding : 1 em }
div . system-message p . system-message-title {
color : red ;
font-weight : bold }
div . topic {
margin : 2 em }
h1 . section-subtitle , h2 . section-subtitle , h3 . section-subtitle ,
h4 . section-subtitle , h5 . section-subtitle , h6 . section-subtitle {
margin-top : 0.4 em }
h1 . title {
text-align : center }
h2 . subtitle {
text-align : center }
hr . docutils {
width : 75 % }
img . align-left {
clear : left }
img . align-right {
clear : right }
ol . simple , ul . simple {
margin-bottom : 1 em }
ol . arabic {
list-style : decimal }
ol . loweralpha {
list-style : lower-alpha }
ol . upperalpha {
list-style : upper-alpha }
ol . lowerroman {
list-style : lower-roman }
ol . upperroman {
list-style : upper-roman }
p . attribution {
text-align : right ;
margin-left : 50 % }
p . caption {
font-style : italic }
p . credits {
font-style : italic ;
font-size : smaller }
p . label {
white-space : nowrap }
p . rubric {
font-weight : bold ;
font-size : larger ;
color : maroon ;
text-align : center }
p . sidebar-title {
font-family : sans-serif ;
font-weight : bold ;
font-size : larger }
p . sidebar-subtitle {
font-family : sans-serif ;
font-weight : bold }
p . topic-title {
font-weight : bold }
pre . address {
margin-bottom : 0 ;
margin-top : 0 ;
font-family : serif ;
font-size : 100 % }
pre . literal-block , pre . doctest-block {
margin-left : 2 em ;
margin-right : 2 em ;
background-color : #eeeeee }
span . classifier {
font-family : sans-serif ;
font-style : oblique }
span . classifier-delimiter {
font-family : sans-serif ;
font-weight : bold }
span . interpreted {
font-family : sans-serif }
span . option {
white-space : nowrap }
span . pre {
white-space : pre }
span . problematic {
color : red }
span . section-subtitle {
/* font-size relative to parent (h1..h6 element) */
font-size : 80 % }
table . citation {
border-left : solid 1 px gray ;
margin-left : 1 px }
table . docinfo {
margin : 2 em 4 em }
table . docutils {
margin-top : 0.5 em ;
margin-bottom : 0.5 em }
table . footnote {
border-left : solid 1 px black ;
margin-left : 1 px }
table . docutils td , table . docutils th ,
table . docinfo td , table . docinfo th {
padding-left : 0.5 em ;
padding-right : 0.5 em ;
vertical-align : top }
table . docutils th . field-name , table . docinfo th . docinfo-name {
font-weight : bold ;
text-align : left ;
white-space : nowrap ;
padding-left : 0 }
h1 tt . docutils , h2 tt . docutils , h3 tt . docutils ,
h4 tt . docutils , h5 tt . docutils , h6 tt . docutils {
font-size : 100 % }
tt . docutils {
background-color : #eeeeee }
ul . auto-toc {
list-style-type : none }
< / style >
2003-08-05 19:48:41 +00:00
< / head >
< body >
2005-05-20 15:32:55 +00:00
< div class = "document" id = "counting-iterator" >
2003-08-05 19:48:41 +00:00
< h1 class = "title" > Counting Iterator< / h1 >
< table class = "docinfo" frame = "void" rules = "none" >
< col class = "docinfo-name" / >
< col class = "docinfo-content" / >
< tbody valign = "top" >
< tr > < th class = "docinfo-name" > Author:< / th >
< td > David Abrahams, Jeremy Siek, Thomas Witt< / td > < / tr >
< tr > < th class = "docinfo-name" > Contact:< / th >
< td > < a class = "first reference" href = "mailto:dave@boost-consulting.com" > dave@ boost-consulting.com< / a > , < a class = "reference" href = "mailto:jsiek@osl.iu.edu" > jsiek@ osl.iu.edu< / a > , < a class = "last reference" href = "mailto:witt@ive.uni-hannover.de" > witt@ ive.uni-hannover.de< / a > < / td > < / tr >
< tr > < th class = "docinfo-name" > Organization:< / th >
< td > < a class = "first reference" href = "http://www.boost-consulting.com" > Boost Consulting< / a > , Indiana University < a class = "reference" href = "http://www.osl.iu.edu" > Open Systems
Lab< / a > , University of Hanover < a class = "last reference" href = "http://www.ive.uni-hannover.de" > Institute for Transport
Railway Operation and Construction< / a > < / td > < / tr >
< tr > < th class = "docinfo-name" > Date:< / th >
2004-11-02 14:31:27 +00:00
< td > 2004-11-01< / td > < / tr >
2003-08-05 19:48:41 +00:00
< tr > < th class = "docinfo-name" > Copyright:< / th >
2004-11-02 14:31:27 +00:00
< td > Copyright David Abrahams, Jeremy Siek, and Thomas Witt 2003.< / td > < / tr >
2003-08-05 19:48:41 +00:00
< / tbody >
< / table >
2006-09-11 22:27:29 +00:00
<!-- Distributed under the Boost -->
<!-- Software License, Version 1.0. (See accompanying -->
<!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
2005-05-20 15:32:55 +00:00
< table class = "docutils field-list" frame = "void" rules = "none" >
2003-08-05 19:48:41 +00:00
< col class = "field-name" / >
< col class = "field-body" / >
< tbody valign = "top" >
2004-01-13 13:36:55 +00:00
< tr class = "field" > < th class = "field-name" > abstract:< / th > < td class = "field-body" > < p class = "first" > How would you fill up a vector with the numbers zero
2005-05-20 15:32:55 +00:00
through one hundred using < tt class = "docutils literal" > < span class = "pre" > std::copy()< / span > < / tt > ? The only iterator
2004-01-12 20:58:22 +00:00
operation missing from builtin integer types is an
2005-05-20 15:32:55 +00:00
< tt class = "docutils literal" > < span class = "pre" > operator*()< / span > < / tt > that returns the current value of the integer.
2004-01-12 20:58:22 +00:00
The counting iterator adaptor adds this crucial piece of
functionality to whatever type it wraps. One can use the
counting iterator adaptor not only with integer types, but with
2004-01-13 13:36:55 +00:00
any incrementable type.< / p >
2006-09-11 22:27:29 +00:00
<!-- Copyright David Abrahams 2006. Distributed under the Boost -->
<!-- Software License, Version 1.0. (See accompanying -->
<!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
2005-05-20 15:32:55 +00:00
< p class = "last" > < tt class = "docutils literal" > < span class = "pre" > counting_iterator< / span > < / tt > adapts an object by adding an < tt class = "docutils literal" > < span class = "pre" > operator*< / span > < / tt > that
2004-01-13 13:36:55 +00:00
returns the current value of the object. All other iterator operations
are forwarded to the adapted object.< / p >
< / td >
2003-08-05 19:48:41 +00:00
< / tr >
< / tbody >
< / table >
2006-09-11 22:27:29 +00:00
< div class = "contents topic" >
< p class = "topic-title first" > < a id = "table-of-contents" name = "table-of-contents" > Table of Contents< / a > < / p >
2003-08-05 19:48:41 +00:00
< ul class = "simple" >
2005-05-20 15:32:55 +00:00
< li > < a class = "reference" href = "#counting-iterator-synopsis" id = "id2" name = "id2" > < tt class = "docutils literal" > < span class = "pre" > counting_iterator< / span > < / tt > synopsis< / a > < / li >
< li > < a class = "reference" href = "#counting-iterator-requirements" id = "id3" name = "id3" > < tt class = "docutils literal" > < span class = "pre" > counting_iterator< / span > < / tt > requirements< / a > < / li >
< li > < a class = "reference" href = "#counting-iterator-models" id = "id4" name = "id4" > < tt class = "docutils literal" > < span class = "pre" > counting_iterator< / span > < / tt > models< / a > < / li >
< li > < a class = "reference" href = "#counting-iterator-operations" id = "id5" name = "id5" > < tt class = "docutils literal" > < span class = "pre" > counting_iterator< / span > < / tt > operations< / a > < / li >
2004-01-12 16:10:29 +00:00
< li > < a class = "reference" href = "#example" id = "id6" name = "id6" > Example< / a > < / li >
2003-08-05 19:48:41 +00:00
< / ul >
< / div >
2006-09-11 22:27:29 +00:00
< div class = "section" >
< h1 > < a class = "toc-backref" href = "#id2" id = "counting-iterator-synopsis" name = "counting-iterator-synopsis" > < tt class = "docutils literal" > < span class = "pre" > counting_iterator< / span > < / tt > synopsis< / a > < / h1 >
<!-- Copyright David Abrahams 2006. Distributed under the Boost -->
<!-- Software License, Version 1.0. (See accompanying -->
<!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
2003-08-05 19:48:41 +00:00
< pre class = "literal-block" >
2003-11-24 05:02:46 +00:00
template <
class Incrementable
2004-01-12 00:48:21 +00:00
, class CategoryOrTraversal = use_default
2003-11-24 05:02:46 +00:00
, class Difference = use_default
>
2003-08-05 19:48:41 +00:00
class counting_iterator
{
2004-01-19 18:52:48 +00:00
public:
2004-01-12 19:01:57 +00:00
typedef Incrementable value_type;
typedef const Incrementable& reference;
typedef const Incrementable* pointer;
typedef /* see below */ difference_type;
typedef /* see below */ iterator_category;
2003-08-05 19:48:41 +00:00
counting_iterator();
counting_iterator(counting_iterator const& rhs);
2004-01-12 00:48:21 +00:00
explicit counting_iterator(Incrementable x);
2004-01-18 20:54:59 +00:00
Incrementable const& base() const;
2004-01-12 15:53:04 +00:00
reference operator*() const;
counting_iterator& operator++();
counting_iterator& operator--();
2004-01-19 18:52:48 +00:00
private:
2004-01-12 15:53:04 +00:00
Incrementable m_inc; // exposition
2004-01-19 18:52:48 +00:00
};
2003-08-05 19:48:41 +00:00
< / pre >
2005-05-20 15:32:55 +00:00
< p > If the < tt class = "docutils literal" > < span class = "pre" > Difference< / span > < / tt > argument is < tt class = "docutils literal" > < span class = "pre" > use_default< / span > < / tt > then
< tt class = "docutils literal" > < span class = "pre" > difference_type< / span > < / tt > is an unspecified signed integral
type. Otherwise < tt class = "docutils literal" > < span class = "pre" > difference_type< / span > < / tt > is < tt class = "docutils literal" > < span class = "pre" > Difference< / span > < / tt > .< / p >
< p > < tt class = "docutils literal" > < span class = "pre" > iterator_category< / span > < / tt > is determined according to the following
2004-01-15 00:01:33 +00:00
algorithm:< / p >
< pre class = "literal-block" >
if (CategoryOrTraversal is not use_default)
return CategoryOrTraversal
else if (numeric_limits< Incrementable> ::is_specialized)
return < a class = "reference" href = "iterator_facade.html#iterator-category" > < em > iterator-category< / em > < / a > (
random_access_traversal_tag, Incrementable, const Incrementable& )
else
return < a class = "reference" href = "iterator_facade.html#iterator-category" > < em > iterator-category< / em > < / a > (
2006-09-11 22:27:29 +00:00
iterator_traversal< Incrementable> ::type,
2004-01-15 00:01:33 +00:00
Incrementable, const Incrementable& )
< / pre >
2005-05-20 15:32:55 +00:00
< dl class = "docutils" >
2004-01-18 20:54:59 +00:00
< dt > [< em > Note:< / em > implementers are encouraged to provide an implementation of< / dt >
2005-05-20 15:32:55 +00:00
< dd > < tt class = "docutils literal" > < span class = "pre" > operator-< / span > < / tt > and a < tt class = "docutils literal" > < span class = "pre" > difference_type< / span > < / tt > that avoids overflows in
the cases where < tt class = "docutils literal" > < span class = "pre" > std::numeric_limits< Incrementable> ::is_specialized< / span > < / tt >
2004-01-18 20:54:59 +00:00
is true.]< / dd >
< / dl >
2004-01-12 15:53:04 +00:00
< / div >
2006-09-11 22:27:29 +00:00
< div class = "section" >
< h1 > < a class = "toc-backref" href = "#id3" id = "counting-iterator-requirements" name = "counting-iterator-requirements" > < tt class = "docutils literal" > < span class = "pre" > counting_iterator< / span > < / tt > requirements< / a > < / h1 >
2005-05-20 15:32:55 +00:00
< p > The < tt class = "docutils literal" > < span class = "pre" > Incrementable< / span > < / tt > argument shall be Copy Constructible and Assignable.< / p >
< p > If < tt class = "docutils literal" > < span class = "pre" > iterator_category< / span > < / tt > is convertible to < tt class = "docutils literal" > < span class = "pre" > forward_iterator_tag< / span > < / tt >
or < tt class = "docutils literal" > < span class = "pre" > forward_traversal_tag< / span > < / tt > , the following must be well-formed:< / p >
2003-08-05 19:48:41 +00:00
< pre class = "literal-block" >
Incrementable i, j;
2004-01-13 13:36:55 +00:00
++i; // pre-increment
i == j; // operator equal
2003-08-05 19:48:41 +00:00
< / pre >
2005-05-20 15:32:55 +00:00
< p > If < tt class = "docutils literal" > < span class = "pre" > iterator_category< / span > < / tt > is convertible to
< tt class = "docutils literal" > < span class = "pre" > bidirectional_iterator_tag< / span > < / tt > or < tt class = "docutils literal" > < span class = "pre" > bidirectional_traversal_tag< / span > < / tt > ,
2004-01-13 13:36:55 +00:00
the following expression must also be well-formed:< / p >
2003-08-05 19:48:41 +00:00
< pre class = "literal-block" >
--i
< / pre >
2005-05-20 15:32:55 +00:00
< p > If < tt class = "docutils literal" > < span class = "pre" > iterator_category< / span > < / tt > is convertible to
< tt class = "docutils literal" > < span class = "pre" > random_access_iterator_tag< / span > < / tt > or < tt class = "docutils literal" > < span class = "pre" > random_access_traversal_tag< / span > < / tt > ,
2004-01-13 13:36:55 +00:00
the following must must also be valid:< / p >
2003-08-05 19:48:41 +00:00
< pre class = "literal-block" >
counting_iterator::difference_type n;
2004-01-13 13:36:55 +00:00
i += n;
n = i - j;
i < j;
2003-08-05 19:48:41 +00:00
< / pre >
< / div >
2006-09-11 22:27:29 +00:00
< div class = "section" >
< h1 > < a class = "toc-backref" href = "#id4" id = "counting-iterator-models" name = "counting-iterator-models" > < tt class = "docutils literal" > < span class = "pre" > counting_iterator< / span > < / tt > models< / a > < / h1 >
2005-05-20 15:32:55 +00:00
< p > Specializations of < tt class = "docutils literal" > < span class = "pre" > counting_iterator< / span > < / tt > model Readable Lvalue
2004-01-13 13:36:55 +00:00
Iterator. In addition, they model the concepts corresponding to the
2005-05-20 15:32:55 +00:00
iterator tags to which their < tt class = "docutils literal" > < span class = "pre" > iterator_category< / span > < / tt > is convertible.
Also, if < tt class = "docutils literal" > < span class = "pre" > CategoryOrTraversal< / span > < / tt > is not < tt class = "docutils literal" > < span class = "pre" > use_default< / span > < / tt > then
< tt class = "docutils literal" > < span class = "pre" > counting_iterator< / span > < / tt > models the concept corresponding to the iterator
tag < tt class = "docutils literal" > < span class = "pre" > CategoryOrTraversal< / span > < / tt > . Otherwise, if
< tt class = "docutils literal" > < span class = "pre" > numeric_limits< Incrementable> ::is_specialized< / span > < / tt > , then
< tt class = "docutils literal" > < span class = "pre" > counting_iterator< / span > < / tt > models Random Access Traversal Iterator.
Otherwise, < tt class = "docutils literal" > < span class = "pre" > counting_iterator< / span > < / tt > models the same iterator traversal
concepts modeled by < tt class = "docutils literal" > < span class = "pre" > Incrementable< / span > < / tt > .< / p >
< p > < tt class = "docutils literal" > < span class = "pre" > counting_iterator< X,C1,D1> < / span > < / tt > is interoperable with
< tt class = "docutils literal" > < span class = "pre" > counting_iterator< Y,C2,D2> < / span > < / tt > if and only if < tt class = "docutils literal" > < span class = "pre" > X< / span > < / tt > is
interoperable with < tt class = "docutils literal" > < span class = "pre" > Y< / span > < / tt > .< / p >
2004-01-12 21:18:52 +00:00
< / div >
2006-09-11 22:27:29 +00:00
< div class = "section" >
< h1 > < a class = "toc-backref" href = "#id5" id = "counting-iterator-operations" name = "counting-iterator-operations" > < tt class = "docutils literal" > < span class = "pre" > counting_iterator< / span > < / tt > operations< / a > < / h1 >
2004-01-12 15:53:04 +00:00
< p > In addition to the operations required by the concepts modeled by
2005-05-20 15:32:55 +00:00
< tt class = "docutils literal" > < span class = "pre" > counting_iterator< / span > < / tt > , < tt class = "docutils literal" > < span class = "pre" > counting_iterator< / span > < / tt > provides the following
2004-01-12 15:53:04 +00:00
operations.< / p >
2005-05-20 15:32:55 +00:00
< p > < tt class = "docutils literal" > < span class = "pre" > counting_iterator();< / span > < / tt > < / p >
< table class = "docutils field-list" frame = "void" rules = "none" >
2003-08-05 19:48:41 +00:00
< col class = "field-name" / >
< col class = "field-body" / >
< tbody valign = "top" >
2005-05-20 15:32:55 +00:00
< tr class = "field" > < th class = "field-name" > Requires:< / th > < td class = "field-body" > < tt class = "docutils literal" > < span class = "pre" > Incrementable< / span > < / tt > is Default Constructible.< / td >
2004-01-13 14:10:54 +00:00
< / tr >
2005-05-20 15:32:55 +00:00
< tr class = "field" > < th class = "field-name" > Effects:< / th > < td class = "field-body" > Default construct the member < tt class = "docutils literal" > < span class = "pre" > m_inc< / span > < / tt > .< / td >
2003-08-05 19:48:41 +00:00
< / tr >
< / tbody >
< / table >
2005-05-20 15:32:55 +00:00
< p > < tt class = "docutils literal" > < span class = "pre" > counting_iterator(counting_iterator< / span > < span class = "pre" > const& < / span > < span class = "pre" > rhs);< / span > < / tt > < / p >
< table class = "docutils field-list" frame = "void" rules = "none" >
2003-08-05 19:48:41 +00:00
< col class = "field-name" / >
< col class = "field-body" / >
< tbody valign = "top" >
2005-05-20 15:32:55 +00:00
< tr class = "field" > < th class = "field-name" > Effects:< / th > < td class = "field-body" > Construct member < tt class = "docutils literal" > < span class = "pre" > m_inc< / span > < / tt > from < tt class = "docutils literal" > < span class = "pre" > rhs.m_inc< / span > < / tt > .< / td >
2003-08-05 19:48:41 +00:00
< / tr >
< / tbody >
< / table >
2005-05-20 15:32:55 +00:00
< p > < tt class = "docutils literal" > < span class = "pre" > explicit< / span > < span class = "pre" > counting_iterator(Incrementable< / span > < span class = "pre" > x);< / span > < / tt > < / p >
< table class = "docutils field-list" frame = "void" rules = "none" >
2003-08-05 19:48:41 +00:00
< col class = "field-name" / >
< col class = "field-body" / >
< tbody valign = "top" >
2005-05-20 15:32:55 +00:00
< tr class = "field" > < th class = "field-name" > Effects:< / th > < td class = "field-body" > Construct member < tt class = "docutils literal" > < span class = "pre" > m_inc< / span > < / tt > from < tt class = "docutils literal" > < span class = "pre" > x< / span > < / tt > .< / td >
2004-01-12 00:48:21 +00:00
< / tr >
< / tbody >
< / table >
2005-05-20 15:32:55 +00:00
< p > < tt class = "docutils literal" > < span class = "pre" > reference< / span > < span class = "pre" > operator*()< / span > < span class = "pre" > const;< / span > < / tt > < / p >
< table class = "docutils field-list" frame = "void" rules = "none" >
2004-01-12 00:48:21 +00:00
< col class = "field-name" / >
< col class = "field-body" / >
< tbody valign = "top" >
2005-05-20 15:32:55 +00:00
< tr class = "field" > < th class = "field-name" > Returns:< / th > < td class = "field-body" > < tt class = "docutils literal" > < span class = "pre" > m_inc< / span > < / tt > < / td >
2004-01-12 00:48:21 +00:00
< / tr >
< / tbody >
< / table >
2005-05-20 15:32:55 +00:00
< p > < tt class = "docutils literal" > < span class = "pre" > counting_iterator& < / span > < span class = "pre" > operator++();< / span > < / tt > < / p >
< table class = "docutils field-list" frame = "void" rules = "none" >
2004-01-12 00:48:21 +00:00
< col class = "field-name" / >
< col class = "field-body" / >
< tbody valign = "top" >
2005-05-20 15:32:55 +00:00
< tr class = "field" > < th class = "field-name" > Effects:< / th > < td class = "field-body" > < tt class = "docutils literal" > < span class = "pre" > ++m_inc< / span > < / tt > < / td >
2004-01-12 15:53:04 +00:00
< / tr >
2005-05-20 15:32:55 +00:00
< tr class = "field" > < th class = "field-name" > Returns:< / th > < td class = "field-body" > < tt class = "docutils literal" > < span class = "pre" > *this< / span > < / tt > < / td >
2004-01-12 15:53:04 +00:00
< / tr >
< / tbody >
< / table >
2005-05-20 15:32:55 +00:00
< p > < tt class = "docutils literal" > < span class = "pre" > counting_iterator& < / span > < span class = "pre" > operator--();< / span > < / tt > < / p >
< table class = "docutils field-list" frame = "void" rules = "none" >
2004-01-12 15:53:04 +00:00
< col class = "field-name" / >
< col class = "field-body" / >
< tbody valign = "top" >
2005-05-20 15:32:55 +00:00
< tr class = "field" > < th class = "field-name" > Effects:< / th > < td class = "field-body" > < tt class = "docutils literal" > < span class = "pre" > --m_inc< / span > < / tt > < / td >
2004-01-12 15:53:04 +00:00
< / tr >
2005-05-20 15:32:55 +00:00
< tr class = "field" > < th class = "field-name" > Returns:< / th > < td class = "field-body" > < tt class = "docutils literal" > < span class = "pre" > *this< / span > < / tt > < / td >
2004-01-12 00:48:21 +00:00
< / tr >
< / tbody >
< / table >
2005-05-20 15:32:55 +00:00
< p > < tt class = "docutils literal" > < span class = "pre" > Incrementable< / span > < span class = "pre" > const& < / span > < span class = "pre" > base()< / span > < span class = "pre" > const;< / span > < / tt > < / p >
< table class = "docutils field-list" frame = "void" rules = "none" >
2004-01-12 00:48:21 +00:00
< col class = "field-name" / >
< col class = "field-body" / >
< tbody valign = "top" >
2005-05-20 15:32:55 +00:00
< tr class = "field" > < th class = "field-name" > Returns:< / th > < td class = "field-body" > < tt class = "docutils literal" > < span class = "pre" > m_inc< / span > < / tt > < / td >
2004-01-12 00:48:21 +00:00
< / tr >
< / tbody >
< / table >
2006-09-11 22:27:29 +00:00
<!-- Copyright David Abrahams 2006. Distributed under the Boost -->
<!-- Software License, Version 1.0. (See accompanying -->
<!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
2004-01-12 00:48:21 +00:00
< pre class = "literal-block" >
template < class Incrementable>
2004-01-12 01:30:47 +00:00
counting_iterator< Incrementable> make_counting_iterator(Incrementable x);
2004-01-12 00:48:21 +00:00
< / pre >
2005-05-20 15:32:55 +00:00
< table class = "docutils field-list" frame = "void" rules = "none" >
2004-01-12 00:48:21 +00:00
< col class = "field-name" / >
< col class = "field-body" / >
< tbody valign = "top" >
2005-05-20 15:32:55 +00:00
< tr class = "field" > < th class = "field-name" > Returns:< / th > < td class = "field-body" > An instance of < tt class = "docutils literal" > < span class = "pre" > counting_iterator< Incrementable> < / span > < / tt >
with < tt class = "docutils literal" > < span class = "pre" > current< / span > < / tt > constructed from < tt class = "docutils literal" > < span class = "pre" > x< / span > < / tt > .< / td >
2003-08-05 19:48:41 +00:00
< / tr >
< / tbody >
< / table >
2006-09-11 22:27:29 +00:00
<!-- Copyright David Abrahams 2006. Distributed under the Boost -->
<!-- Software License, Version 1.0. (See accompanying -->
<!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
2003-08-05 19:48:41 +00:00
< / div >
2006-09-11 22:27:29 +00:00
< div class = "section" >
< h1 > < a class = "toc-backref" href = "#id6" id = "example" name = "example" > Example< / a > < / h1 >
2004-01-12 00:48:21 +00:00
< p > This example fills an array with numbers and a second array with
2005-05-20 15:32:55 +00:00
pointers into the first array, using < tt class = "docutils literal" > < span class = "pre" > counting_iterator< / span > < / tt > for both
tasks. Finally < tt class = "docutils literal" > < span class = "pre" > indirect_iterator< / span > < / tt > is used to print out the numbers
2004-01-12 00:48:21 +00:00
into the first array via indirection through the second array.< / p >
< pre class = "literal-block" >
int N = 7;
std::vector< int> numbers;
typedef std::vector< int> ::iterator n_iter;
std::copy(boost::counting_iterator< int> (0),
boost::counting_iterator< int> (N),
std::back_inserter(numbers));
std::vector< std::vector< int> ::iterator> pointers;
std::copy(boost::make_counting_iterator(numbers.begin()),
boost::make_counting_iterator(numbers.end()),
std::back_inserter(pointers));
2006-09-11 22:27:29 +00:00
std::cout < < " indirectly printing out the numbers from 0 to "
2004-01-12 00:48:21 +00:00
< < N < < std::endl;
std::copy(boost::make_indirect_iterator(pointers.begin()),
boost::make_indirect_iterator(pointers.end()),
std::ostream_iterator< int> (std::cout, " " ));
std::cout < < std::endl;
< / pre >
< p > The output is:< / p >
< pre class = "literal-block" >
indirectly printing out the numbers from 0 to 7
2006-09-11 22:27:29 +00:00
0 1 2 3 4 5 6
2004-01-12 00:48:21 +00:00
< / pre >
2004-01-12 16:10:29 +00:00
< p > The source code for this example can be found < a class = "reference" href = "../example/counting_iterator_example.cpp" > here< / a > .< / p >
2003-08-05 19:48:41 +00:00
< / div >
2003-09-14 02:17:41 +00:00
< / div >
2003-08-05 19:48:41 +00:00
< / body >
< / html >
