]> git.proxmox.com Git - ceph.git/blame - ceph/src/boost/libs/iterator/doc/SwappableIterator.rst
bump version to 12.2.2-pve1
[ceph.git] / ceph / src / boost / libs / iterator / doc / SwappableIterator.rst
CommitLineData
7c673cae
FG
1.. Copyright David Abrahams 2006. Distributed under the Boost
2.. Software License, Version 1.0. (See accompanying
3.. file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
4
5Swappable Iterator Concept
6..........................
7
8A class or built-in type ``X`` models the *Swappable Iterator* concept
9if, in addition to ``X`` being Copy Constructible, the following
10expressions are valid and respect the stated semantics.
11
12+---------------------------------------------------------------------+
13|Swappable Iterator Requirements (in addition to Copy Constructible) |
14+-------------------------+-------------+-----------------------------+
15|Expression |Return Type |Postcondition |
16+=========================+=============+=============================+
17|``iter_swap(a, b)`` |``void`` |the pointed to values are |
18| | |exchanged |
19+-------------------------+-------------+-----------------------------+
20
21[*Note:* An iterator that is a model of the *Readable* and *Writable Iterator* concepts
22 is also a model of *Swappable Iterator*. *--end note*]
23