2004-01-29 05:55:26 +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/" / >
2004-01-29 05:55:26 +00:00
< title > Iterator Traits< / title >
< meta name = "author" content = "David Abrahams" / >
< meta name = "organization" content = "Boost Consulting" / >
2004-11-02 14:31:27 +00:00
< meta name = "date" content = "2004-11-01" / >
< meta name = "copyright" content = "Copyright David Abrahams 2004." / >
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 >
2004-01-29 05:55:26 +00:00
< / head >
< body >
2005-05-20 15:32:55 +00:00
< div class = "document" id = "iterator-traits" >
2004-01-29 05:55:26 +00:00
< h1 class = "title" > Iterator Traits< / 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< / td > < / tr >
< tr > < th class = "docinfo-name" > Contact:< / th >
< td > < a class = "first last reference" href = "mailto:dave@boost-consulting.com" > dave@ boost-consulting.com< / a > < / td > < / tr >
< tr > < th class = "docinfo-name" > Organization:< / th >
< td > < a class = "first last reference" href = "http://www.boost-consulting.com" > Boost Consulting< / a > < / td > < / tr >
< tr > < th class = "docinfo-name" > Date:< / th >
2004-11-02 14:31:27 +00:00
< td > 2004-11-01< / td > < / tr >
2004-01-29 05:55:26 +00:00
< tr > < th class = "docinfo-name" > Copyright:< / th >
2004-11-02 14:31:27 +00:00
< td > Copyright David Abrahams 2004.< / td > < / tr >
2004-01-29 05:55:26 +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" >
2004-01-29 05:55:26 +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" > abstract:< / th > < td class = "field-body" > Header < tt class = "docutils literal" > < span class = "pre" > < boost/iterator/iterator_traits.hpp> < / span > < / tt > provides
2004-01-29 05:55:26 +00:00
the ability to access an iterator's associated types using
2006-09-11 22:27:29 +00:00
MPL-compatible < a class = "reference" href = "../../mpl/doc/index.html#metafunctions" > metafunctions< / a > .< / td >
2004-01-29 05:55:26 +00:00
< / tr >
< / tbody >
< / table >
2006-09-11 22:27:29 +00:00
< div class = "section" >
< h1 > < a id = "overview" name = "overview" > Overview< / a > < / h1 >
2005-05-20 15:32:55 +00:00
< p > < tt class = "docutils literal" > < span class = "pre" > std::iterator_traits< / span > < / tt > provides access to five associated types
of any iterator: its < tt class = "docutils literal" > < span class = "pre" > value_type< / span > < / tt > , < tt class = "docutils literal" > < span class = "pre" > reference< / span > < / tt > , < tt class = "docutils literal" > < span class = "pre" > pointer< / span > < / tt > ,
< tt class = "docutils literal" > < span class = "pre" > iterator_category< / span > < / tt > , and < tt class = "docutils literal" > < span class = "pre" > difference_type< / span > < / tt > . Unfortunately,
2004-01-29 05:55:26 +00:00
such a " multi-valued" traits template can be difficult to use in a
2005-05-20 15:32:55 +00:00
metaprogramming context. < tt class = "docutils literal" > < span class = "pre" > < boost/iterator/iterator_traits.hpp> < / span > < / tt >
2006-09-11 22:27:29 +00:00
provides access to these types using a standard < a class = "reference" href = "../../mpl/doc/index.html#metafunctions" > metafunctions< / a > .< / p >
2004-01-29 05:55:26 +00:00
< / div >
2006-09-11 22:27:29 +00:00
< div class = "section" >
< h1 > < a id = "summary" name = "summary" > Summary< / a > < / h1 >
2005-05-20 15:32:55 +00:00
< p > Header < tt class = "docutils literal" > < span class = "pre" > < boost/iterator/iterator_traits.hpp> < / span > < / tt > :< / p >
2004-01-29 05:55:26 +00:00
< pre class = "literal-block" >
template < class Iterator>
struct iterator_value
{
2006-09-11 22:27:29 +00:00
typedef typename
std::iterator_traits< Iterator> ::value_type
2004-01-29 05:55:26 +00:00
type;
};
template < class Iterator>
struct iterator_reference
{
2006-09-11 22:27:29 +00:00
typedef typename
2004-01-29 05:55:26 +00:00
std::iterator_traits< Iterator> ::reference
type;
};
template < class Iterator>
struct iterator_pointer
{
2006-09-11 22:27:29 +00:00
typedef typename
std::iterator_traits< Iterator> ::pointer
2004-01-29 05:55:26 +00:00
type;
};
template < class Iterator>
struct iterator_difference
{
typedef typename
detail::iterator_traits< Iterator> ::difference_type
type;
};
template < class Iterator>
struct iterator_category
{
typedef typename
detail::iterator_traits< Iterator> ::iterator_category
type;
};
< / pre >
< / div >
2006-09-11 22:27:29 +00:00
< div class = "section" >
< h1 > < a id = "broken-compiler-notes" name = "broken-compiler-notes" > Broken Compiler Notes< / a > < / h1 >
2004-01-29 05:55:26 +00:00
< p > Because of workarounds in Boost, you may find that these
2006-09-11 22:27:29 +00:00
< a class = "reference" href = "../../mpl/doc/index.html#metafunctions" > metafunctions< / a > actually work better than the facilities provided by
2004-01-29 05:55:26 +00:00
your compiler's standard library.< / p >
< p > On compilers that don't support partial specialization, such as
Microsoft Visual C++ 6.0 or 7.0, you may need to manually invoke
2006-09-11 22:27:29 +00:00
< a class = "reference" href = "../../type_traits/index.html#transformations" > BOOST_BROKEN_COMPILER_TYPE_TRAITS_SPECIALIZATION< / a > on the
2005-05-20 15:32:55 +00:00
< tt class = "docutils literal" > < span class = "pre" > value_type< / span > < / tt > of pointers that are passed to these metafunctions.< / p >
2004-01-29 05:55:26 +00:00
< p > Because of bugs in the implementation of GCC-2.9x, the name of
2005-05-20 15:32:55 +00:00
< tt class = "docutils literal" > < span class = "pre" > iterator_category< / span > < / tt > is changed to < tt class = "docutils literal" > < span class = "pre" > iterator_category_< / span > < / tt > on that
compiler. A macro, < tt class = "docutils literal" > < span class = "pre" > BOOST_ITERATOR_CATEGORY< / span > < / tt > , that expands to
either < tt class = "docutils literal" > < span class = "pre" > iterator_category< / span > < / tt > or < tt class = "docutils literal" > < span class = "pre" > iterator_category_< / span > < / tt > , as
2004-01-29 05:55:26 +00:00
appropriate to the platform, is provided for portability.< / p >
< / div >
< / div >
< / body >
< / html >
