~ubuntu-branches/debian/sid/boost1.49/sid

« back to all changes in this revision

Viewing changes to doc/html/boost_asio/reference/ConstBufferSequence.html

  • Committer: Package Import Robot
  • Author(s): Steve M. Robbins
  • Date: 2012-02-26 00:31:44 UTC
  • Revision ID: package-import@ubuntu.com-20120226003144-eaytp12cbf6ubpms
Tags: upstream-1.49.0
ImportĀ upstreamĀ versionĀ 1.49.0

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<html>
 
2
<head>
 
3
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
 
4
<title>Constant buffer sequence requirements</title>
 
5
<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
 
7
<link rel="home" href="../../boost_asio.html" title="Boost.Asio">
 
8
<link rel="up" href="../reference.html" title="Reference">
 
9
<link rel="prev" href="ConnectHandler.html" title="Connect handler requirements">
 
10
<link rel="next" href="ConvertibleToConstBuffer.html" title="Convertible to const buffer requirements">
 
11
</head>
 
12
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
 
13
<table cellpadding="2" width="100%"><tr>
 
14
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
 
15
<td align="center"><a href="../../../../index.html">Home</a></td>
 
16
<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
 
17
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
 
18
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
 
19
<td align="center"><a href="../../../../more/index.htm">More</a></td>
 
20
</tr></table>
 
21
<hr>
 
22
<div class="spirit-nav">
 
23
<a accesskey="p" href="ConnectHandler.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../boost_asio.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="ConvertibleToConstBuffer.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
 
24
</div>
 
25
<div class="section">
 
26
<div class="titlepage"><div><div><h3 class="title">
 
27
<a name="boost_asio.reference.ConstBufferSequence"></a><a class="link" href="ConstBufferSequence.html" title="Constant buffer sequence requirements">Constant buffer
 
28
      sequence requirements</a>
 
29
</h3></div></div></div>
 
30
<p>
 
31
        In the table below, <code class="computeroutput"><span class="identifier">X</span></code> denotes
 
32
        a class containing objects of type <code class="computeroutput"><span class="identifier">T</span></code>,
 
33
        <code class="computeroutput"><span class="identifier">a</span></code> denotes a value of type
 
34
        <code class="computeroutput"><span class="identifier">X</span></code> and <code class="computeroutput"><span class="identifier">u</span></code>
 
35
        denotes an identifier.
 
36
      </p>
 
37
<div class="table">
 
38
<a name="boost_asio.reference.ConstBufferSequence.t0"></a><p class="title"><b>Table&#160;5.&#160;ConstBufferSequence requirements</b></p>
 
39
<div class="table-contents"><table class="table" summary="ConstBufferSequence requirements">
 
40
<colgroup>
 
41
<col>
 
42
<col>
 
43
<col>
 
44
</colgroup>
 
45
<thead><tr>
 
46
<th>
 
47
                <p>
 
48
                  expression
 
49
                </p>
 
50
              </th>
 
51
<th>
 
52
                <p>
 
53
                  return type
 
54
                </p>
 
55
              </th>
 
56
<th>
 
57
                <p>
 
58
                  assertion/note<br> pre/post-condition
 
59
                </p>
 
60
              </th>
 
61
</tr></thead>
 
62
<tbody>
 
63
<tr>
 
64
<td>
 
65
                <p>
 
66
                  <code class="computeroutput"><span class="identifier">X</span><span class="special">::</span><span class="identifier">value_type</span></code>
 
67
                </p>
 
68
              </td>
 
69
<td>
 
70
                <p>
 
71
                  <code class="computeroutput"><span class="identifier">T</span></code>
 
72
                </p>
 
73
              </td>
 
74
<td>
 
75
                <p>
 
76
                  <code class="computeroutput"><span class="identifier">T</span></code> meets the requirements
 
77
                  for <a class="link" href="ConvertibleToConstBuffer.html" title="Convertible to const buffer requirements">ConvertibleToConstBuffer</a>.
 
78
                </p>
 
79
              </td>
 
80
</tr>
 
81
<tr>
 
82
<td>
 
83
                <p>
 
84
                  <code class="computeroutput"><span class="identifier">X</span><span class="special">::</span><span class="identifier">const_iterator</span></code>
 
85
                </p>
 
86
              </td>
 
87
<td>
 
88
                <p>
 
89
                  iterator type pointing to <code class="computeroutput"><span class="identifier">T</span></code>
 
90
                </p>
 
91
              </td>
 
92
<td>
 
93
                <p>
 
94
                  <code class="computeroutput"><span class="identifier">const_iterator</span></code>
 
95
                  meets the requirements for bidirectional iterators (C++ Std, 24.1.4).
 
96
                </p>
 
97
              </td>
 
98
</tr>
 
99
<tr>
 
100
<td>
 
101
                <p>
 
102
                  <code class="computeroutput"><span class="identifier">X</span><span class="special">(</span><span class="identifier">a</span><span class="special">);</span></code>
 
103
                </p>
 
104
              </td>
 
105
<td>
 
106
              </td>
 
107
<td>
 
108
                <p>
 
109
                  post: <code class="computeroutput"><span class="identifier">equal_const_buffer_seq</span><span class="special">(</span><span class="identifier">a</span><span class="special">,</span> <span class="identifier">X</span><span class="special">(</span><span class="identifier">a</span><span class="special">))</span></code> where the binary predicate <code class="computeroutput"><span class="identifier">equal_const_buffer_seq</span></code> is defined
 
110
                  as
 
111
</p>
 
112
<pre class="programlisting"><span class="keyword">bool</span> <span class="identifier">equal_const_buffer_seq</span><span class="special">(</span>
 
113
  <span class="keyword">const</span> <span class="identifier">X</span><span class="special">&amp;</span> <span class="identifier">x1</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">X</span><span class="special">&amp;</span> <span class="identifier">x2</span><span class="special">)</span>
 
114
<span class="special">{</span>
 
115
  <span class="keyword">return</span>
 
116
    <span class="identifier">distance</span><span class="special">(</span><span class="identifier">x1</span><span class="special">.</span><span class="identifier">begin</span><span class="special">(),</span> <span class="identifier">x1</span><span class="special">.</span><span class="identifier">end</span><span class="special">())</span>
 
117
      <span class="special">==</span> <span class="identifier">distance</span><span class="special">(</span><span class="identifier">x2</span><span class="special">.</span><span class="identifier">begin</span><span class="special">(),</span> <span class="identifier">x2</span><span class="special">.</span><span class="identifier">end</span><span class="special">())</span>
 
118
        <span class="special">&amp;&amp;</span> <span class="identifier">equal</span><span class="special">(</span><span class="identifier">x1</span><span class="special">.</span><span class="identifier">begin</span><span class="special">(),</span> <span class="identifier">x1</span><span class="special">.</span><span class="identifier">end</span><span class="special">(),</span>
 
119
                 <span class="identifier">x2</span><span class="special">.</span><span class="identifier">begin</span><span class="special">(),</span> <span class="identifier">equal_buffer</span><span class="special">);</span>
 
120
<span class="special">}</span>
 
121
</pre>
 
122
<p>
 
123
                  and the binary predicate <code class="computeroutput"><span class="identifier">equal_buffer</span></code>
 
124
                  is defined as
 
125
</p>
 
126
<pre class="programlisting"><span class="keyword">bool</span> <span class="identifier">equal_buffer</span><span class="special">(</span>
 
127
  <span class="keyword">const</span> <span class="identifier">X</span><span class="special">::</span><span class="identifier">value_type</span><span class="special">&amp;</span> <span class="identifier">v1</span><span class="special">,</span>
 
128
  <span class="keyword">const</span> <span class="identifier">X</span><span class="special">::</span><span class="identifier">value_type</span><span class="special">&amp;</span> <span class="identifier">v2</span><span class="special">)</span>
 
129
<span class="special">{</span>
 
130
  <span class="identifier">const_buffer</span> <span class="identifier">b1</span><span class="special">(</span><span class="identifier">v1</span><span class="special">);</span>
 
131
  <span class="identifier">const_buffer</span> <span class="identifier">b2</span><span class="special">(</span><span class="identifier">v2</span><span class="special">);</span>
 
132
  <span class="keyword">return</span>
 
133
    <span class="identifier">buffer_cast</span><span class="special">&lt;</span><span class="keyword">const</span> <span class="keyword">void</span><span class="special">*&gt;(</span><span class="identifier">b1</span><span class="special">)</span>
 
134
      <span class="special">==</span> <span class="identifier">buffer_cast</span><span class="special">&lt;</span><span class="keyword">const</span> <span class="keyword">void</span><span class="special">*&gt;(</span><span class="identifier">b2</span><span class="special">)</span>
 
135
        <span class="special">&amp;&amp;</span> <span class="identifier">buffer_size</span><span class="special">(</span><span class="identifier">b1</span><span class="special">)</span> <span class="special">==</span> <span class="identifier">buffer_size</span><span class="special">(</span><span class="identifier">b2</span><span class="special">);</span>
 
136
<span class="special">}</span>
 
137
</pre>
 
138
<p>
 
139
                </p>
 
140
              </td>
 
141
</tr>
 
142
<tr>
 
143
<td>
 
144
                <p>
 
145
                  <code class="computeroutput"><span class="identifier">X</span> <span class="identifier">u</span><span class="special">(</span><span class="identifier">a</span><span class="special">);</span></code>
 
146
                </p>
 
147
              </td>
 
148
<td>
 
149
              </td>
 
150
<td>
 
151
                <p>
 
152
                  post:
 
153
</p>
 
154
<pre class="programlisting"><span class="identifier">distance</span><span class="special">(</span><span class="identifier">a</span><span class="special">.</span><span class="identifier">begin</span><span class="special">(),</span> <span class="identifier">a</span><span class="special">.</span><span class="identifier">end</span><span class="special">())</span>
 
155
  <span class="special">==</span> <span class="identifier">distance</span><span class="special">(</span><span class="identifier">u</span><span class="special">.</span><span class="identifier">begin</span><span class="special">(),</span> <span class="identifier">u</span><span class="special">.</span><span class="identifier">end</span><span class="special">())</span>
 
156
    <span class="special">&amp;&amp;</span> <span class="identifier">equal</span><span class="special">(</span><span class="identifier">a</span><span class="special">.</span><span class="identifier">begin</span><span class="special">(),</span> <span class="identifier">a</span><span class="special">.</span><span class="identifier">end</span><span class="special">(),</span>
 
157
             <span class="identifier">u</span><span class="special">.</span><span class="identifier">begin</span><span class="special">(),</span> <span class="identifier">equal_buffer</span><span class="special">)</span>
 
158
</pre>
 
159
<p>
 
160
                  where the binary predicate <code class="computeroutput"><span class="identifier">equal_buffer</span></code>
 
161
                  is defined as
 
162
</p>
 
163
<pre class="programlisting"><span class="keyword">bool</span> <span class="identifier">equal_buffer</span><span class="special">(</span>
 
164
  <span class="keyword">const</span> <span class="identifier">X</span><span class="special">::</span><span class="identifier">value_type</span><span class="special">&amp;</span> <span class="identifier">v1</span><span class="special">,</span>
 
165
  <span class="keyword">const</span> <span class="identifier">X</span><span class="special">::</span><span class="identifier">value_type</span><span class="special">&amp;</span> <span class="identifier">v2</span><span class="special">)</span>
 
166
<span class="special">{</span>
 
167
  <span class="identifier">const_buffer</span> <span class="identifier">b1</span><span class="special">(</span><span class="identifier">v1</span><span class="special">);</span>
 
168
  <span class="identifier">const_buffer</span> <span class="identifier">b2</span><span class="special">(</span><span class="identifier">v2</span><span class="special">);</span>
 
169
  <span class="keyword">return</span>
 
170
    <span class="identifier">buffer_cast</span><span class="special">&lt;</span><span class="keyword">const</span> <span class="keyword">void</span><span class="special">*&gt;(</span><span class="identifier">b1</span><span class="special">)</span>
 
171
      <span class="special">==</span> <span class="identifier">buffer_cast</span><span class="special">&lt;</span><span class="keyword">const</span> <span class="keyword">void</span><span class="special">*&gt;(</span><span class="identifier">b2</span><span class="special">)</span>
 
172
        <span class="special">&amp;&amp;</span> <span class="identifier">buffer_size</span><span class="special">(</span><span class="identifier">b1</span><span class="special">)</span> <span class="special">==</span> <span class="identifier">buffer_size</span><span class="special">(</span><span class="identifier">b2</span><span class="special">);</span>
 
173
<span class="special">}</span>
 
174
</pre>
 
175
<p>
 
176
                </p>
 
177
              </td>
 
178
</tr>
 
179
<tr>
 
180
<td>
 
181
                <p>
 
182
                  <code class="computeroutput"><span class="special">(&amp;</span><span class="identifier">a</span><span class="special">)-&gt;~</span><span class="identifier">X</span><span class="special">();</span></code>
 
183
                </p>
 
184
              </td>
 
185
<td>
 
186
                <p>
 
187
                  <code class="computeroutput"><span class="keyword">void</span></code>
 
188
                </p>
 
189
              </td>
 
190
<td>
 
191
                <p>
 
192
                  note: the destructor is applied to every element of <code class="computeroutput"><span class="identifier">a</span></code>; all the memory is deallocated.
 
193
                </p>
 
194
              </td>
 
195
</tr>
 
196
<tr>
 
197
<td>
 
198
                <p>
 
199
                  <code class="computeroutput"><span class="identifier">a</span><span class="special">.</span><span class="identifier">begin</span><span class="special">();</span></code>
 
200
                </p>
 
201
              </td>
 
202
<td>
 
203
                <p>
 
204
                  <code class="computeroutput"><span class="identifier">const_iterator</span></code>
 
205
                  or convertible to <code class="computeroutput"><span class="identifier">const_iterator</span></code>
 
206
                </p>
 
207
              </td>
 
208
<td>
 
209
              </td>
 
210
</tr>
 
211
<tr>
 
212
<td>
 
213
                <p>
 
214
                  <code class="computeroutput"><span class="identifier">a</span><span class="special">.</span><span class="identifier">end</span><span class="special">();</span></code>
 
215
                </p>
 
216
              </td>
 
217
<td>
 
218
                <p>
 
219
                  <code class="computeroutput"><span class="identifier">const_iterator</span></code>
 
220
                  or convertible to <code class="computeroutput"><span class="identifier">const_iterator</span></code>
 
221
                </p>
 
222
              </td>
 
223
<td>
 
224
              </td>
 
225
</tr>
 
226
</tbody>
 
227
</table></div>
 
228
</div>
 
229
<br class="table-break">
 
230
</div>
 
231
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 
232
<td align="left"></td>
 
233
<td align="right"><div class="copyright-footer">Copyright &#169; 2003-2012 Christopher M. Kohlhoff<p>
 
234
        Distributed under the Boost Software License, Version 1.0. (See accompanying
 
235
        file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
 
236
      </p>
 
237
</div></td>
 
238
</tr></table>
 
239
<hr>
 
240
<div class="spirit-nav">
 
241
<a accesskey="p" href="ConnectHandler.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../boost_asio.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="ConvertibleToConstBuffer.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
 
242
</div>
 
243
</body>
 
244
</html>