2004-01-27 17:03:46 +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-27 17:03:46 +00:00
< title > Readable Iterator Concept< / title >
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-27 17:03:46 +00:00
< / head >
< body >
2004-11-02 14:31:27 +00:00
< div class = "document" id = "readable-iterator-concept" >
2006-09-11 22:27:29 +00:00
< h1 class = "title" > Readable Iterator Concept< / 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) -->
< p > A class or built-in type < tt class = "docutils literal" > < span class = "pre" > X< / span > < / tt > models the < em > Readable Iterator< / em > concept
for value type < tt class = "docutils literal" > < span class = "pre" > T< / span > < / tt > if, in addition to < tt class = "docutils literal" > < span class = "pre" > X< / span > < / tt > being Assignable and
2004-01-27 17:03:46 +00:00
Copy Constructible, the following expressions are valid and respect
2006-09-11 22:27:29 +00:00
the stated semantics. < tt class = "docutils literal" > < span class = "pre" > U< / span > < / tt > is the type of any specified member of
type < tt class = "docutils literal" > < span class = "pre" > T< / span > < / tt > .< / p >
< table border = "1" class = "docutils" >
2004-01-27 17:03:46 +00:00
< colgroup >
< col width = "28%" / >
< col width = "20%" / >
< col width = "52%" / >
< / colgroup >
< thead valign = "bottom" >
2006-09-11 22:27:29 +00:00
< tr > < th class = "head" colspan = "3" > Readable Iterator Requirements (in addition to Assignable and Copy Constructible)< / th >
2004-01-27 17:03:46 +00:00
< / tr >
2006-09-11 22:27:29 +00:00
< tr > < th class = "head" > Expression< / th >
< th class = "head" > Return Type< / th >
< th class = "head" > Note/Precondition< / th >
2004-01-27 17:03:46 +00:00
< / tr >
< / thead >
< tbody valign = "top" >
2006-09-11 22:27:29 +00:00
< tr > < td > < tt class = "docutils literal" > < span class = "pre" > iterator_traits< X> ::value_type< / span > < / tt > < / td >
< td > < tt class = "docutils literal" > < span class = "pre" > T< / span > < / tt > < / td >
2004-01-27 17:03:46 +00:00
< td > Any non-reference,
non-cv-qualified type< / td >
< / tr >
2006-09-11 22:27:29 +00:00
< tr > < td > < tt class = "docutils literal" > < span class = "pre" > *a< / span > < / tt > < / td >
< td > Convertible to < tt class = "docutils literal" > < span class = "pre" > T< / span > < / tt > < / td >
< td > < dl class = "first last docutils" >
< dt > pre: < tt class = "docutils literal" > < span class = "pre" > a< / span > < / tt > is dereferenceable. If < tt class = "docutils literal" > < span class = "pre" > a< / span > < span class = "pre" > ==< / span > < span class = "pre" > b< / span > < / tt > then < tt class = "docutils literal" > < span class = "pre" > *a< / span > < / tt > < / dt >
< dd > is equivalent to < tt class = "docutils literal" > < span class = "pre" > *b< / span > < / tt > .< / dd >
2004-01-27 17:03:46 +00:00
< / dl >
< / td >
< / tr >
2006-09-11 22:27:29 +00:00
< tr > < td > < tt class = "docutils literal" > < span class = "pre" > a-> m< / span > < / tt > < / td >
< td > < tt class = "docutils literal" > < span class = "pre" > U& < / span > < / tt > < / td >
< td > pre: < tt class = "docutils literal" > < span class = "pre" > pre:< / span > < span class = "pre" > (*a).m< / span > < / tt > is well-defined. Equivalent to < tt class = "docutils literal" > < span class = "pre" > (*a).m< / span > < / tt > .< / td >
2004-01-27 17:03:46 +00:00
< / tr >
< / tbody >
< / table >
< / div >
< / body >
< / html >
