3 <meta http-equiv=
"Content-Type" content=
"text/html; charset=US-ASCII">
4 <title>Container
</title>
5 <link rel=
"stylesheet" href=
"../../../../../../../doc/src/boostbook.css" type=
"text/css">
6 <meta name=
"generator" content=
"DocBook XSL Stylesheets V1.75.2">
7 <link rel=
"home" href=
"../../../index.html" title=
"Chapter 1. Phoenix 3.2.0">
8 <link rel=
"up" href=
"../stl.html" title=
"STL">
9 <link rel=
"prev" href=
"../stl.html" title=
"STL">
10 <link rel=
"next" href=
"algorithm.html" title=
"Algorithm">
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>
22 <div class=
"spirit-nav">
23 <a accesskey=
"p" href=
"../stl.html"><img src=
"../../../../../../../doc/src/images/prev.png" alt=
"Prev"></a><a accesskey=
"u" href=
"../stl.html"><img src=
"../../../../../../../doc/src/images/up.png" alt=
"Up"></a><a accesskey=
"h" href=
"../../../index.html"><img src=
"../../../../../../../doc/src/images/home.png" alt=
"Home"></a><a accesskey=
"n" href=
"algorithm.html"><img src=
"../../../../../../../doc/src/images/next.png" alt=
"Next"></a>
26 <div class=
"titlepage"><div><div><h4 class=
"title">
27 <a name=
"phoenix.modules.stl.container"></a><a class=
"link" href=
"container.html" title=
"Container">Container
</a>
28 </h4></div></div></div>
29 <pre class=
"programlisting"><span class=
"preprocessor">#include
</span> <span class=
"special"><</span><span class=
"identifier">boost
</span><span class=
"special">/
</span><span class=
"identifier">phoenix
</span><span class=
"special">/
</span><span class=
"identifier">stl
</span><span class=
"special">/
</span><span class=
"identifier">container
</span><span class=
"special">.
</span><span class=
"identifier">hpp
</span><span class=
"special">></span>
32 The container module predefines a set of lazy functions that work on STL
33 containers. These functions provide a mechanism for the lazy evaluation
34 of the public member functions of the STL containers. The lazy functions
35 are thin wrappers that simply forward to their respective counterparts
39 Lazy functions are provided for all of the member functions of the following
42 <div class=
"itemizedlist"><ul class=
"itemizedlist" type=
"disc">
60 Indeed, should your class have member functions with the same names and
61 signatures as those listed below, then it will automatically be supported.
62 To summarize, lazy functions are provided for member functions:
64 <div class=
"itemizedlist"><ul class=
"itemizedlist" type=
"disc">
101 <li class=
"listitem">
104 <li class=
"listitem">
107 <li class=
"listitem">
110 <li class=
"listitem">
113 <li class=
"listitem">
116 <li class=
"listitem">
119 <li class=
"listitem">
122 <li class=
"listitem">
125 <li class=
"listitem">
128 <li class=
"listitem">
131 <li class=
"listitem">
134 <li class=
"listitem">
137 <li class=
"listitem">
142 The lazy functions' names are the same as the corresponding member function.
143 The difference is that the lazy functions are free functions and therefore
144 does not use the member
"dot" syntax.
147 <a name=
"phoenix.modules.stl.container.t0"></a><p class=
"title"><b>Table
 1.4.
 Sample usage
</b></p>
148 <div class=
"table-contents"><table class=
"table" summary=
"Sample usage">
169 <code class=
"computeroutput"><span class=
"identifier">my_vector
</span><span class=
"special">.
</span><span class=
"identifier">at
</span><span class=
"special">(
</span><span class=
"number">5</span><span class=
"special">)
</span></code>
174 <code class=
"computeroutput"><span class=
"identifier">at
</span><span class=
"special">(
</span><span class=
"identifier">arg1
</span><span class=
"special">,
</span>
175 <span class=
"number">5</span><span class=
"special">)
</span></code>
182 <code class=
"computeroutput"><span class=
"identifier">my_list
</span><span class=
"special">.
</span><span class=
"identifier">size
</span><span class=
"special">()
</span></code>
187 <code class=
"computeroutput"><span class=
"identifier">size
</span><span class=
"special">(
</span><span class=
"identifier">arg1
</span><span class=
"special">)
</span></code>
194 <code class=
"computeroutput"><span class=
"identifier">my_vector1
</span><span class=
"special">.
</span><span class=
"identifier">swap
</span><span class=
"special">(
</span><span class=
"identifier">my_vector2
</span><span class=
"special">)
</span></code>
199 <code class=
"computeroutput"><span class=
"identifier">swap
</span><span class=
"special">(
</span><span class=
"identifier">arg1
</span><span class=
"special">,
</span>
200 <span class=
"identifier">arg2
</span><span class=
"special">)
</span></code>
207 <br class=
"table-break"><p>
208 Notice that member functions with names that clash with stl algorithms
209 are absent. This will be provided in Phoenix's algorithm module.
212 No support is provided here for lazy versions of
<code class=
"computeroutput"><span class=
"keyword">operator
</span><span class=
"special">+=
</span></code>,
<code class=
"computeroutput"><span class=
"keyword">operator
</span><span class=
"special">[]
</span></code> etc. Such operators are not specific
213 to STL containers and lazy versions can therefore be found in
<a class=
"link" href=
"../operator.html" title=
"Operator">operators
</a>.
216 The following table describes the container functions and their semantics.
218 <div class=
"sidebar">
219 <p class=
"title"><b></b></p>
221 <span class=
"inlinemediaobject"><img src=
"../../../images/tip.png"></span>
222 Arguments in brackets denote optional parameters.
226 <a name=
"phoenix.modules.stl.container.t1"></a><p class=
"title"><b>Table
 1.5.
 Lazy STL Container Functions
</b></p>
227 <div class=
"table-contents"><table class=
"table" summary=
"Lazy STL Container Functions">
248 <code class=
"computeroutput"><span class=
"identifier">assign
</span><span class=
"special">(
</span><span class=
"identifier">c
</span><span class=
"special">,
</span>
249 <span class=
"identifier">a
</span><span class=
"special">[,
</span>
250 <span class=
"identifier">b
</span><span class=
"special">,
</span>
251 <span class=
"identifier">c
</span><span class=
"special">])
</span></code>
256 <code class=
"computeroutput"><span class=
"identifier">c
</span><span class=
"special">.
</span><span class=
"identifier">assign
</span><span class=
"special">(
</span><span class=
"identifier">a
</span><span class=
"special">[,
</span>
257 <span class=
"identifier">b
</span><span class=
"special">,
</span>
258 <span class=
"identifier">c
</span><span class=
"special">])
</span></code>
265 <code class=
"computeroutput"><span class=
"identifier">at
</span><span class=
"special">(
</span><span class=
"identifier">c
</span><span class=
"special">,
</span>
266 <span class=
"identifier">i
</span><span class=
"special">)
</span></code>
271 <code class=
"computeroutput"><span class=
"identifier">c
</span><span class=
"special">.
</span><span class=
"identifier">at
</span><span class=
"special">(
</span><span class=
"identifier">i
</span><span class=
"special">)
</span></code>
278 <code class=
"computeroutput"><span class=
"identifier">back
</span><span class=
"special">(
</span><span class=
"identifier">c
</span><span class=
"special">)
</span></code>
283 <code class=
"computeroutput"><span class=
"identifier">c
</span><span class=
"special">.
</span><span class=
"identifier">back
</span><span class=
"special">()
</span></code>
290 <code class=
"computeroutput"><span class=
"identifier">begin
</span><span class=
"special">(
</span><span class=
"identifier">c
</span><span class=
"special">)
</span></code>
295 <code class=
"computeroutput"><span class=
"identifier">c
</span><span class=
"special">.
</span><span class=
"identifier">begin
</span><span class=
"special">()
</span></code>
302 <code class=
"computeroutput"><span class=
"identifier">capacity
</span><span class=
"special">(
</span><span class=
"identifier">c
</span><span class=
"special">)
</span></code>
307 <code class=
"computeroutput"><span class=
"identifier">c
</span><span class=
"special">.
</span><span class=
"identifier">capacity
</span><span class=
"special">()
</span></code>
314 <code class=
"computeroutput"><span class=
"identifier">clear
</span><span class=
"special">(
</span><span class=
"identifier">c
</span><span class=
"special">)
</span></code>
319 <code class=
"computeroutput"><span class=
"identifier">c
</span><span class=
"special">.
</span><span class=
"identifier">clear
</span><span class=
"special">()
</span></code>
326 <code class=
"computeroutput"><span class=
"identifier">empty
</span><span class=
"special">(
</span><span class=
"identifier">c
</span><span class=
"special">)
</span></code>
331 <code class=
"computeroutput"><span class=
"identifier">c
</span><span class=
"special">.
</span><span class=
"identifier">empty
</span><span class=
"special">()
</span></code>
338 <code class=
"computeroutput"><span class=
"identifier">end
</span><span class=
"special">(
</span><span class=
"identifier">c
</span><span class=
"special">)
</span></code>
343 <code class=
"computeroutput"><span class=
"identifier">c
</span><span class=
"special">.
</span><span class=
"identifier">end
</span><span class=
"special">()
</span></code>
350 <code class=
"computeroutput"><span class=
"identifier">erase
</span><span class=
"special">(
</span><span class=
"identifier">c
</span><span class=
"special">,
</span>
351 <span class=
"identifier">a
</span><span class=
"special">[,
</span>
352 <span class=
"identifier">b
</span><span class=
"special">])
</span></code>
357 <code class=
"computeroutput"><span class=
"identifier">c
</span><span class=
"special">.
</span><span class=
"identifier">erase
</span><span class=
"special">(
</span><span class=
"identifier">a
</span><span class=
"special">[,
</span>
358 <span class=
"identifier">b
</span><span class=
"special">])
</span></code>
365 <code class=
"computeroutput"><span class=
"identifier">front
</span><span class=
"special">(
</span><span class=
"identifier">c
</span><span class=
"special">)
</span></code>
370 <code class=
"computeroutput"><span class=
"identifier">c
</span><span class=
"special">.
</span><span class=
"identifier">front
</span><span class=
"special">()
</span></code>
377 <code class=
"computeroutput"><span class=
"identifier">get_allocator
</span><span class=
"special">(
</span><span class=
"identifier">c
</span><span class=
"special">)
</span></code>
382 <code class=
"computeroutput"><span class=
"identifier">c
</span><span class=
"special">.
</span><span class=
"identifier">get_allocator
</span><span class=
"special">()
</span></code>
389 <code class=
"computeroutput"><span class=
"identifier">insert
</span><span class=
"special">(
</span><span class=
"identifier">c
</span><span class=
"special">,
</span>
390 <span class=
"identifier">a
</span><span class=
"special">[,
</span>
391 <span class=
"identifier">b
</span><span class=
"special">,
</span>
392 <span class=
"identifier">c
</span><span class=
"special">])
</span></code>
397 <code class=
"computeroutput"><span class=
"identifier">c
</span><span class=
"special">.
</span><span class=
"identifier">insert
</span><span class=
"special">(
</span><span class=
"identifier">a
</span><span class=
"special">[,
</span>
398 <span class=
"identifier">b
</span><span class=
"special">,
</span>
399 <span class=
"identifier">c
</span><span class=
"special">])
</span></code>
406 <code class=
"computeroutput"><span class=
"identifier">key_comp
</span><span class=
"special">(
</span><span class=
"identifier">c
</span><span class=
"special">)
</span></code>
411 <code class=
"computeroutput"><span class=
"identifier">c
</span><span class=
"special">.
</span><span class=
"identifier">key_comp
</span><span class=
"special">()
</span></code>
418 <code class=
"computeroutput"><span class=
"identifier">max_size
</span><span class=
"special">(
</span><span class=
"identifier">c
</span><span class=
"special">)
</span></code>
423 <code class=
"computeroutput"><span class=
"identifier">c
</span><span class=
"special">.
</span><span class=
"identifier">max_size
</span><span class=
"special">()
</span></code>
430 <code class=
"computeroutput"><span class=
"identifier">pop_back
</span><span class=
"special">(
</span><span class=
"identifier">c
</span><span class=
"special">)
</span></code>
435 <code class=
"computeroutput"><span class=
"identifier">c
</span><span class=
"special">.
</span><span class=
"identifier">pop_back
</span><span class=
"special">()
</span></code>
442 <code class=
"computeroutput"><span class=
"identifier">pop_front
</span><span class=
"special">(
</span><span class=
"identifier">c
</span><span class=
"special">)
</span></code>
447 <code class=
"computeroutput"><span class=
"identifier">c
</span><span class=
"special">.
</span><span class=
"identifier">pop_front
</span><span class=
"special">()
</span></code>
454 <code class=
"computeroutput"><span class=
"identifier">push_back
</span><span class=
"special">(
</span><span class=
"identifier">c
</span><span class=
"special">,
</span>
455 <span class=
"identifier">d
</span><span class=
"special">)
</span></code>
460 <code class=
"computeroutput"><span class=
"identifier">c
</span><span class=
"special">.
</span><span class=
"identifier">push_back
</span><span class=
"special">(
</span><span class=
"identifier">d
</span><span class=
"special">)
</span></code>
467 <code class=
"computeroutput"><span class=
"identifier">push_front
</span><span class=
"special">(
</span><span class=
"identifier">c
</span><span class=
"special">,
</span>
468 <span class=
"identifier">d
</span><span class=
"special">)
</span></code>
473 <code class=
"computeroutput"><span class=
"identifier">c
</span><span class=
"special">.
</span><span class=
"identifier">push_front
</span><span class=
"special">(
</span><span class=
"identifier">d
</span><span class=
"special">)
</span></code>
480 <code class=
"computeroutput"><span class=
"identifier">pop_front
</span><span class=
"special">(
</span><span class=
"identifier">c
</span><span class=
"special">)
</span></code>
485 <code class=
"computeroutput"><span class=
"identifier">c
</span><span class=
"special">.
</span><span class=
"identifier">pop_front
</span><span class=
"special">()
</span></code>
492 <code class=
"computeroutput"><span class=
"identifier">rbegin
</span><span class=
"special">(
</span><span class=
"identifier">c
</span><span class=
"special">)
</span></code>
497 <code class=
"computeroutput"><span class=
"identifier">c
</span><span class=
"special">.
</span><span class=
"identifier">rbegin
</span><span class=
"special">()
</span></code>
504 <code class=
"computeroutput"><span class=
"identifier">rend
</span><span class=
"special">(
</span><span class=
"identifier">c
</span><span class=
"special">)
</span></code>
509 <code class=
"computeroutput"><span class=
"identifier">c
</span><span class=
"special">.
</span><span class=
"identifier">rend
</span><span class=
"special">()
</span></code>
516 <code class=
"computeroutput"><span class=
"identifier">reserve
</span><span class=
"special">(
</span><span class=
"identifier">c
</span><span class=
"special">,
</span>
517 <span class=
"identifier">n
</span><span class=
"special">)
</span></code>
522 <code class=
"computeroutput"><span class=
"identifier">c
</span><span class=
"special">.
</span><span class=
"identifier">reserve
</span><span class=
"special">(
</span><span class=
"identifier">n
</span><span class=
"special">)
</span></code>
529 <code class=
"computeroutput"><span class=
"identifier">resize
</span><span class=
"special">(
</span><span class=
"identifier">c
</span><span class=
"special">,
</span>
530 <span class=
"identifier">a
</span><span class=
"special">[,
</span>
531 <span class=
"identifier">b
</span><span class=
"special">])
</span></code>
536 <code class=
"computeroutput"><span class=
"identifier">c
</span><span class=
"special">.
</span><span class=
"identifier">resize
</span><span class=
"special">(
</span><span class=
"identifier">a
</span><span class=
"special">[,
</span>
537 <span class=
"identifier">b
</span><span class=
"special">])
</span></code>
544 <code class=
"computeroutput"><span class=
"identifier">size
</span><span class=
"special">(
</span><span class=
"identifier">c
</span><span class=
"special">)
</span></code>
549 <code class=
"computeroutput"><span class=
"identifier">c
</span><span class=
"special">.
</span><span class=
"identifier">size
</span><span class=
"special">()
</span></code>
556 <code class=
"computeroutput"><span class=
"identifier">splice
</span><span class=
"special">(
</span><span class=
"identifier">c
</span><span class=
"special">,
</span>
557 <span class=
"identifier">a
</span><span class=
"special">[,
</span>
558 <span class=
"identifier">b
</span><span class=
"special">,
</span>
559 <span class=
"identifier">c
</span><span class=
"special">,
</span>
560 <span class=
"identifier">d
</span><span class=
"special">])
</span></code>
565 <code class=
"computeroutput"><span class=
"identifier">c
</span><span class=
"special">.
</span><span class=
"identifier">splice
</span><span class=
"special">(
</span><span class=
"identifier">a
</span><span class=
"special">[,
</span>
566 <span class=
"identifier">b
</span><span class=
"special">,
</span>
567 <span class=
"identifier">c
</span><span class=
"special">,
</span>
568 <span class=
"identifier">d
</span><span class=
"special">])
</span></code>
575 <code class=
"computeroutput"><span class=
"identifier">value_comp
</span><span class=
"special">(
</span><span class=
"identifier">c
</span><span class=
"special">)
</span></code>
580 <code class=
"computeroutput"><span class=
"identifier">c
</span><span class=
"special">.
</span><span class=
"identifier">value_comp
</span><span class=
"special">()
</span></code>
587 <br class=
"table-break">
589 <table xmlns:
rev=
"http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width=
"100%"><tr>
590 <td align=
"left"></td>
591 <td align=
"right"><div class=
"copyright-footer">Copyright
© 2002-
2005,
2010,
2014,
2015 Joel de Guzman, Dan Marsden, Thomas
592 Heller, John Fletcher
<p>
593 Distributed under the Boost Software License, Version
1.0. (See accompanying
594 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>)
599 <div class=
"spirit-nav">
600 <a accesskey=
"p" href=
"../stl.html"><img src=
"../../../../../../../doc/src/images/prev.png" alt=
"Prev"></a><a accesskey=
"u" href=
"../stl.html"><img src=
"../../../../../../../doc/src/images/up.png" alt=
"Up"></a><a accesskey=
"h" href=
"../../../index.html"><img src=
"../../../../../../../doc/src/images/home.png" alt=
"Home"></a><a accesskey=
"n" href=
"algorithm.html"><img src=
"../../../../../../../doc/src/images/next.png" alt=
"Next"></a>