mirror of
				https://github.com/boostorg/iterator.git
				synced 2025-11-04 02:11:37 +01:00 
			
		
		
		
	
		
			
				
	
	
		
			65 lines
		
	
	
		
			3.3 KiB
		
	
	
	
		
			HTML
		
	
	
	
	
	
			
		
		
	
	
			65 lines
		
	
	
		
			3.3 KiB
		
	
	
	
		
			HTML
		
	
	
	
	
	
<?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" />
 | 
						|
<meta name="generator" content="Docutils 0.5: http://docutils.sourceforge.net/" />
 | 
						|
<title>Readable Iterator Concept</title>
 | 
						|
<link rel="stylesheet" href="../../../rst.css" type="text/css" />
 | 
						|
</head>
 | 
						|
<body>
 | 
						|
<div class="document" id="readable-iterator-concept">
 | 
						|
<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
 | 
						|
Copy Constructible, the following expressions are valid and respect
 | 
						|
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">
 | 
						|
<colgroup>
 | 
						|
<col width="28%" />
 | 
						|
<col width="20%" />
 | 
						|
<col width="52%" />
 | 
						|
</colgroup>
 | 
						|
<thead valign="bottom">
 | 
						|
<tr><th class="head" colspan="3">Readable Iterator Requirements (in addition to Assignable and Copy Constructible)</th>
 | 
						|
</tr>
 | 
						|
<tr><th class="head">Expression</th>
 | 
						|
<th class="head">Return Type</th>
 | 
						|
<th class="head">Note/Precondition</th>
 | 
						|
</tr>
 | 
						|
</thead>
 | 
						|
<tbody valign="top">
 | 
						|
<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>
 | 
						|
<td>Any non-reference,
 | 
						|
non-cv-qualified type</td>
 | 
						|
</tr>
 | 
						|
<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>
 | 
						|
</dl>
 | 
						|
</td>
 | 
						|
</tr>
 | 
						|
<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>
 | 
						|
</tr>
 | 
						|
</tbody>
 | 
						|
</table>
 | 
						|
</div>
 | 
						|
<div class="footer">
 | 
						|
<hr class="footer" />
 | 
						|
<a class="reference external" href="ReadableIterator.rst">View document source</a>.
 | 
						|
Generated by <a class="reference external" href="http://docutils.sourceforge.net/">Docutils</a> from <a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source.
 | 
						|
 | 
						|
</div>
 | 
						|
</body>
 | 
						|
</html>
 |