diff options
Diffstat (limited to 'doc/test/gold/boost/array.html')
| -rw-r--r-- | doc/test/gold/boost/array.html | 641 |
1 files changed, 641 insertions, 0 deletions
diff --git a/doc/test/gold/boost/array.html b/doc/test/gold/boost/array.html new file mode 100644 index 0000000000..6ed4b9a389 --- /dev/null +++ b/doc/test/gold/boost/array.html @@ -0,0 +1,641 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title>Class template array</title> +<link rel="stylesheet" href="../../../../doc/html/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot_8125"> +<link rel="home" href="../index.html" title="Document To Test Formatting"> +<link rel="up" href="../document_to_test_formatting/array.html#header.boost.array_hpp" title="Header <boost/array.hpp>"> +<link rel="prev" href="../document_to_test_formatting/array.html" title="Array Example Boostbook XML Documentation"> +<link rel="next" href="../document_to_test_formatting/accumulators.html" title="Accumulators Example Doxygen Documentation"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../document_to_test_formatting/array.html"><img src="../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../document_to_test_formatting/array.html#header.boost.array_hpp"><img src="../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="../document_to_test_formatting/accumulators.html"><img src="../../../../doc/html/images/next.png" alt="Next"></a> +</div> +<div class="refentry" lang="en"> +<a name="boost.array"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Class template array</span></h2> +<p>boost::array — STL compliant container wrapper for arrays of constant size</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="emphasis"><em>// In header: <<a class="link" href="../document_to_test_formatting/array.html#header.boost.array_hpp" title="Header <boost/array.hpp>">boost/array.hpp</a>> + +</em></span><span class="bold"><strong>template</strong></span><<span class="bold"><strong>typename</strong></span> T, std::size_t N> +<span class="bold"><strong>class</strong></span> <a class="link" href="array.html" title="Class template array">array</a> { +<span class="bold"><strong>public</strong></span>: + <span class="emphasis"><em>// types</em></span> + <span class="bold"><strong>typedef</strong></span> T <a name="boost.array.value_type"></a>value_type; + <span class="bold"><strong>typedef</strong></span> T* <a name="boost.array.iterator"></a>iterator; + <span class="bold"><strong>typedef</strong></span> <span class="bold"><strong>const</strong></span> T* <a name="boost.array.const_iterator"></a>const_iterator; + <span class="bold"><strong>typedef</strong></span> + std::reverse_iterator<iterator> + <a name="boost.array.reverse_iterator"></a>reverse_iterator; + <span class="bold"><strong>typedef</strong></span> + std::reverse_iterator<const_iterator> + <a name="boost.array.const_reverse_iterator"></a>const_reverse_iterator; + <span class="bold"><strong>typedef</strong></span> T& <a name="boost.array.reference"></a>reference; + <span class="bold"><strong>typedef</strong></span> <span class="bold"><strong>const</strong></span> T& <a name="boost.array.const_reference"></a>const_reference; + <span class="bold"><strong>typedef</strong></span> std::size_t <a name="boost.array.size_type"></a>size_type; + <span class="bold"><strong>typedef</strong></span> std::ptrdiff_t <a name="boost.array.difference_type"></a>difference_type; + + <span class="emphasis"><em>// static constants</em></span> + <span class="bold"><strong>static</strong></span> <span class="bold"><strong>const</strong></span> <span class="type">size_type</span> static_size = N; + + <span class="emphasis"><em>// <a class="link" href="array.html#boost.arrayconstruct-copy-destruct">construct/copy/destruct</a></em></span> + <span class="bold"><strong>template</strong></span><<span class="bold"><strong>typename</strong></span> U> + array& <a class="link" href="array.html#id225116-bb"><span class="bold"><strong>operator</strong></span>=</a>( + <span class="bold"><strong>const</strong></span> <a class="link" href="array.html" title="Class template array">array</a><U, N>& + ); + + <span class="emphasis"><em>// <a class="link" href="array.html#id225163-bb">iterator support</a></em></span> + <span class="type">iterator</span> <a class="link" href="array.html#id225172-bb">begin</a>(); + <span class="type">const_iterator</span> <a class="link" href="array.html#id225179-bb">begin</a>() <span class="bold"><strong>const</strong></span>; + <span class="type">iterator</span> <a class="link" href="array.html#id225209-bb">end</a>(); + <span class="type">const_iterator</span> <a class="link" href="array.html#id185009-bb">end</a>() <span class="bold"><strong>const</strong></span>; + + <span class="emphasis"><em>// <a class="link" href="array.html#id185036-bb">reverse iterator support</a></em></span> + <span class="type">reverse_iterator</span> <a class="link" href="array.html#id185046-bb">rbegin</a>(); + <span class="type">const_reverse_iterator</span> <a class="link" href="array.html#id185053-bb">rbegin</a>() <span class="bold"><strong>const</strong></span>; + <span class="type">reverse_iterator</span> <a class="link" href="array.html#id185076-bb">rend</a>(); + <span class="type">const_reverse_iterator</span> <a class="link" href="array.html#id185084-bb">rend</a>() <span class="bold"><strong>const</strong></span>; + + <span class="emphasis"><em>// <a class="link" href="array.html#id185103-bb">capacity</a></em></span> + <span class="type">size_type</span> <a class="link" href="array.html#id185107-bb">size</a>(); + <span class="type"><span class="bold"><strong>bool</strong></span></span> <a class="link" href="array.html#id185128-bb">empty</a>(); + <span class="type">size_type</span> <a class="link" href="array.html#id185156-bb">max_size</a>(); + + <span class="emphasis"><em>// <a class="link" href="array.html#id155125-bb">element access</a></em></span> + <span class="type">reference</span> <a class="link" href="array.html#id155134-bb"><span class="bold"><strong>operator</strong></span>[]</a>(size_type); + <span class="type">const_reference</span> <a class="link" href="array.html#id155151-bb"><span class="bold"><strong>operator</strong></span>[]</a>(size_type) <span class="bold"><strong>const</strong></span>; + <span class="type">reference</span> <a class="link" href="array.html#id155207-bb">at</a>(size_type); + <span class="type">const_reference</span> <a class="link" href="array.html#id155224-bb">at</a>(size_type) <span class="bold"><strong>const</strong></span>; + <span class="type">reference</span> <a class="link" href="array.html#id155281-bb">front</a>(); + <span class="type">const_reference</span> <a class="link" href="array.html#id155288-bb">front</a>() <span class="bold"><strong>const</strong></span>; + <span class="type">reference</span> <a class="link" href="array.html#id155329-bb">back</a>(); + <span class="type">const_reference</span> <a class="link" href="array.html#id155336-bb">back</a>() <span class="bold"><strong>const</strong></span>; + <span class="type"><span class="bold"><strong>const</strong></span> T*</span> <a class="link" href="array.html#id155372-bb">data</a>() <span class="bold"><strong>const</strong></span>; + <span class="type">T*</span> <a class="link" href="array.html#id227218-bb">c_array</a>(); + + <span class="emphasis"><em>// <a class="link" href="array.html#id227247-bb">modifiers</a></em></span> + <span class="type"><span class="bold"><strong>void</strong></span></span> <a class="link" href="array.html#id227252-bb">swap</a>( + <a class="link" href="array.html" title="Class template array">array</a><T, N>& + ); + <span class="type"><span class="bold"><strong>void</strong></span></span> <a class="link" href="array.html#id227310-bb">assign</a>(<span class="bold"><strong>const</strong></span> T&); + <span class="type">T</span> elems[N]; +}; + +<span class="emphasis"><em>// <a class="link" href="array.html#id227358-bb">specialized algorithms</a></em></span> +<span class="bold"><strong>template</strong></span><<span class="bold"><strong>typename</strong></span> T, std::size_t N> + <span class="type"><span class="bold"><strong>void</strong></span></span> <a class="link" href="array.html#boost.swap">swap</a>( + <a class="link" href="array.html" title="Class template array">array</a><T, N>& + , + + <a class="link" href="array.html" title="Class template array">array</a><T, N>& + ); + +<span class="emphasis"><em>// <a class="link" href="array.html#id227444-bb">comparisons</a></em></span> +<span class="bold"><strong>template</strong></span><<span class="bold"><strong>typename</strong></span> T, std::size_t N> + <span class="type"><span class="bold"><strong>bool</strong></span></span> <a class="link" href="array.html#boost.operator=="><span class="bold"><strong>operator</strong></span>==</a>( + <span class="bold"><strong>const</strong></span> <a class="link" href="array.html" title="Class template array">array</a><T, N>& + , + + <span class="bold"><strong>const</strong></span> <a class="link" href="array.html" title="Class template array">array</a><T, N>& + ); +<span class="bold"><strong>template</strong></span><<span class="bold"><strong>typename</strong></span> T, std::size_t N> + <span class="type"><span class="bold"><strong>bool</strong></span></span> <a class="link" href="array.html#boost.operator!="><span class="bold"><strong>operator</strong></span>!=</a>( + <span class="bold"><strong>const</strong></span> <a class="link" href="array.html" title="Class template array">array</a><T, N>& + , + + <span class="bold"><strong>const</strong></span> <a class="link" href="array.html" title="Class template array">array</a><T, N>& + ); +<span class="bold"><strong>template</strong></span><<span class="bold"><strong>typename</strong></span> T, std::size_t N> + <span class="type"><span class="bold"><strong>bool</strong></span></span> <a class="link" href="array.html#boost.operator_id227596"><span class="bold"><strong>operator</strong></span><</a>( + <span class="bold"><strong>const</strong></span> <a class="link" href="array.html" title="Class template array">array</a><T, N>& + , + + <span class="bold"><strong>const</strong></span> <a class="link" href="array.html" title="Class template array">array</a><T, N>& + ); +<span class="bold"><strong>template</strong></span><<span class="bold"><strong>typename</strong></span> T, std::size_t N> + <span class="type"><span class="bold"><strong>bool</strong></span></span> <a class="link" href="array.html#boost.operator_id227679"><span class="bold"><strong>operator</strong></span>></a>( + <span class="bold"><strong>const</strong></span> <a class="link" href="array.html" title="Class template array">array</a><T, N>& + , + + <span class="bold"><strong>const</strong></span> <a class="link" href="array.html" title="Class template array">array</a><T, N>& + ); +<span class="bold"><strong>template</strong></span><<span class="bold"><strong>typename</strong></span> T, std::size_t N> + <span class="type"><span class="bold"><strong>bool</strong></span></span> <a class="link" href="array.html#boost.operator_=_id227747"><span class="bold"><strong>operator</strong></span><=</a>( + <span class="bold"><strong>const</strong></span> <a class="link" href="array.html" title="Class template array">array</a><T, N>& + , + + <span class="bold"><strong>const</strong></span> <a class="link" href="array.html" title="Class template array">array</a><T, N>& + ); +<span class="bold"><strong>template</strong></span><<span class="bold"><strong>typename</strong></span> T, std::size_t N> + <span class="type"><span class="bold"><strong>bool</strong></span></span> <a class="link" href="array.html#boost.operator_=_id227814"><span class="bold"><strong>operator</strong></span>>=</a>( + <span class="bold"><strong>const</strong></span> <a class="link" href="array.html" title="Class template array">array</a><T, N>& + , + + <span class="bold"><strong>const</strong></span> <a class="link" href="array.html" title="Class template array">array</a><T, N>& + );</pre></div> +<div class="refsect1" lang="en"> +<a name="id542541"></a><h2>Description</h2> +<div class="refsect2" lang="en"> +<a name="id542545"></a><h3> +<a name="boost.arrayconstruct-copy-destruct"></a><code class="computeroutput">array</code> + public + construct/copy/destruct</h3> +<div class="orderedlist"><ol type="1"><li> +<pre class="literallayout"><span class="bold"><strong>template</strong></span><<span class="bold"><strong>typename</strong></span> U> + array& <a name="id225116-bb"></a><span class="bold"><strong>operator</strong></span>=( + <span class="bold"><strong>const</strong></span> <a class="link" href="array.html" title="Class template array">array</a><U, N>& + other);</pre> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term">Effects:</span></p></td> +<td> + <code class="computeroutput"> + std::copy(rhs.<a class="link" href="array.html#id225167-bb">begin</a>(),rhs.<a class="link" href="array.html#id225205-bb">end</a>(), <a class="link" href="array.html#id225167-bb">begin</a>()) + </code> + </td> +</tr></tbody> +</table></div> +</li></ol></div> +</div> +<div class="refsect2" lang="en"> +<a name="id542665"></a><h3> +<a name="id225163-bb"></a><code class="computeroutput">array</code> iterator support</h3> +<div class="orderedlist"><ol type="1"> +<li> +<pre class="literallayout"><a name="id225167-bb"></a><span class="type">iterator</span> <a name="id225172-bb"></a>begin(); +<span class="type">const_iterator</span> <a name="id225179-bb"></a>begin() <span class="bold"><strong>const</strong></span>;</pre> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term">Returns:</span></p></td> +<td>iterator for the first element</td> +</tr> +<tr> +<td><p><span class="term">Throws:</span></p></td> +<td>will not throw</td> +</tr> +</tbody> +</table></div> +</li> +<li> +<pre class="literallayout"><a name="id225205-bb"></a><span class="type">iterator</span> <a name="id225209-bb"></a>end(); +<span class="type">const_iterator</span> <a name="id185009-bb"></a>end() <span class="bold"><strong>const</strong></span>;</pre> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term">Returns:</span></p></td> +<td>iterator for position after the last element</td> +</tr> +<tr> +<td><p><span class="term">Throws:</span></p></td> +<td>will not throw</td> +</tr> +</tbody> +</table></div> +</li> +</ol></div> +</div> +<div class="refsect2" lang="en"> +<a name="id542810"></a><h3> +<a name="id185036-bb"></a><code class="computeroutput">array</code> reverse iterator support</h3> +<div class="orderedlist"><ol type="1"> +<li> +<pre class="literallayout"><a name="id185041-bb"></a><span class="type">reverse_iterator</span> <a name="id185046-bb"></a>rbegin(); +<span class="type">const_reverse_iterator</span> <a name="id185053-bb"></a>rbegin() <span class="bold"><strong>const</strong></span>;</pre> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term">Returns:</span></p></td> +<td>reverse iterator for the first element of reverse iteration</td> +</tr></tbody> +</table></div> +</li> +<li> +<pre class="literallayout"><a name="id185072-bb"></a><span class="type">reverse_iterator</span> <a name="id185076-bb"></a>rend(); +<span class="type">const_reverse_iterator</span> <a name="id185084-bb"></a>rend() <span class="bold"><strong>const</strong></span>;</pre> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term">Returns:</span></p></td> +<td>reverse iterator for position after the last element in reverse iteration</td> +</tr></tbody> +</table></div> +</li> +</ol></div> +</div> +<div class="refsect2" lang="en"> +<a name="id542942"></a><h3> +<a name="id185103-bb"></a><code class="computeroutput">array</code> capacity</h3> +<div class="orderedlist"><ol type="1"> +<li> +<pre class="literallayout"><span class="type">size_type</span> <a name="id185107-bb"></a>size();</pre> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term">Returns:</span></p></td> +<td> + <code class="computeroutput">N</code> + </td> +</tr></tbody> +</table></div> +</li> +<li> +<pre class="literallayout"><span class="type"><span class="bold"><strong>bool</strong></span></span> <a name="id185128-bb"></a>empty();</pre> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term">Returns:</span></p></td> +<td> + <code class="computeroutput">N==0</code> + </td> +</tr> +<tr> +<td><p><span class="term">Throws:</span></p></td> +<td>will not throw</td> +</tr> +</tbody> +</table></div> +</li> +<li> +<pre class="literallayout"><span class="type">size_type</span> <a name="id185156-bb"></a>max_size();</pre> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term">Returns:</span></p></td> +<td> + <code class="computeroutput">N</code> + </td> +</tr> +<tr> +<td><p><span class="term">Throws:</span></p></td> +<td>will not throw</td> +</tr> +</tbody> +</table></div> +</li> +</ol></div> +</div> +<div class="refsect2" lang="en"> +<a name="id543096"></a><h3> +<a name="id155125-bb"></a><code class="computeroutput">array</code> element access</h3> +<div class="orderedlist"><ol type="1"> +<li> +<pre class="literallayout"><a name="id155129-bb"></a><span class="type">reference</span> <a name="id155134-bb"></a><span class="bold"><strong>operator</strong></span>[](size_type i); +<span class="type">const_reference</span> <a name="id155151-bb"></a><span class="bold"><strong>operator</strong></span>[](size_type i) <span class="bold"><strong>const</strong></span>;</pre> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term">Requires:</span></p></td> +<td> + <code class="computeroutput">i < N</code> + </td> +</tr> +<tr> +<td><p><span class="term">Returns:</span></p></td> +<td> + element with index <code class="computeroutput">i</code> + </td> +</tr> +<tr> +<td><p><span class="term">Throws:</span></p></td> +<td>will not throw.</td> +</tr> +</tbody> +</table></div> +</li> +<li> +<pre class="literallayout"><a name="id155202-bb"></a><span class="type">reference</span> <a name="id155207-bb"></a>at(size_type i); +<span class="type">const_reference</span> <a name="id155224-bb"></a>at(size_type i) <span class="bold"><strong>const</strong></span>;</pre> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term">Returns:</span></p></td> +<td> + element with index <code class="computeroutput">i</code> + </td> +</tr> +<tr> +<td><p><span class="term">Throws:</span></p></td> +<td> + <code class="computeroutput"> + std::range_error + </code> if <code class="computeroutput">i >= N</code> + </td> +</tr> +</tbody> +</table></div> +</li> +<li> +<pre class="literallayout"><a name="id155276-bb"></a><span class="type">reference</span> <a name="id155281-bb"></a>front(); +<span class="type">const_reference</span> <a name="id155288-bb"></a>front() <span class="bold"><strong>const</strong></span>;</pre> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term">Requires:</span></p></td> +<td> + <code class="computeroutput">N > 0</code> + </td> +</tr> +<tr> +<td><p><span class="term">Returns:</span></p></td> +<td>the first element</td> +</tr> +<tr> +<td><p><span class="term">Throws:</span></p></td> +<td>will not throw</td> +</tr> +</tbody> +</table></div> +</li> +<li> +<pre class="literallayout"><a name="id155324-bb"></a><span class="type">reference</span> <a name="id155329-bb"></a>back(); +<span class="type">const_reference</span> <a name="id155336-bb"></a>back() <span class="bold"><strong>const</strong></span>;</pre> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term">Requires:</span></p></td> +<td> + <code class="computeroutput">N > 0</code> + </td> +</tr> +<tr> +<td><p><span class="term">Returns:</span></p></td> +<td>the last element</td> +</tr> +<tr> +<td><p><span class="term">Throws:</span></p></td> +<td>will not throw</td> +</tr> +</tbody> +</table></div> +</li> +<li> +<pre class="literallayout"><span class="type"><span class="bold"><strong>const</strong></span> T*</span> <a name="id155372-bb"></a>data() <span class="bold"><strong>const</strong></span>;</pre> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term">Returns:</span></p></td> +<td> + <code class="computeroutput">elems</code> + </td> +</tr> +<tr> +<td><p><span class="term">Throws:</span></p></td> +<td>will not throw</td> +</tr> +</tbody> +</table></div> +</li> +<li> +<pre class="literallayout"><span class="type">T*</span> <a name="id227218-bb"></a>c_array();</pre> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term">Returns:</span></p></td> +<td> + <code class="computeroutput">elems</code> + </td> +</tr> +<tr> +<td><p><span class="term">Throws:</span></p></td> +<td>will not throw</td> +</tr> +</tbody> +</table></div> +</li> +</ol></div> +</div> +<div class="refsect2" lang="en"> +<a name="id543547"></a><h3> +<a name="id227247-bb"></a><code class="computeroutput">array</code> modifiers</h3> +<div class="orderedlist"><ol type="1"> +<li> +<pre class="literallayout"><span class="type"><span class="bold"><strong>void</strong></span></span> <a name="id227252-bb"></a>swap( + <a class="link" href="array.html" title="Class template array">array</a><T, N>& + other);</pre> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term">Effects:</span></p></td> +<td> + <code class="computeroutput"> + std::swap_ranges(<a class="link" href="array.html#id225167-bb">begin</a>(), <a class="link" href="array.html#id225205-bb">end</a>(), other.<a class="link" href="array.html#id225167-bb">begin</a>()) + </code> + </td> +</tr> +<tr> +<td><p><span class="term">Complexity:</span></p></td> +<td> + linear in <code class="computeroutput">N</code> + </td> +</tr> +</tbody> +</table></div> +</li> +<li> +<pre class="literallayout"><span class="type"><span class="bold"><strong>void</strong></span></span> <a name="id227310-bb"></a>assign(<span class="bold"><strong>const</strong></span> T& value);</pre> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term">Effects:</span></p></td> +<td> + <code class="computeroutput"> + std::fill_n(<a class="link" href="array.html#id225167-bb">begin</a>(), N, value) + </code> + </td> +</tr></tbody> +</table></div> +</li> +</ol></div> +</div> +<div class="refsect2" lang="en"> +<a name="id543718"></a><h3> +<a name="id227358-bb"></a><code class="computeroutput">array</code> specialized algorithms</h3> +<div class="orderedlist"><ol type="1"><li> +<pre class="literallayout"><span class="bold"><strong>template</strong></span><<span class="bold"><strong>typename</strong></span> T, std::size_t N> + <span class="type"><span class="bold"><strong>void</strong></span></span> <a name="boost.swap"></a>swap( + <a class="link" href="array.html" title="Class template array">array</a><T, N>& + x, + + <a class="link" href="array.html" title="Class template array">array</a><T, N>& + y);</pre> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term">Effects:</span></p></td> +<td> + <code class="computeroutput"> + x.<a class="link" href="array.html#id227252-bb">swap</a>(y) + </code> + </td> +</tr> +<tr> +<td><p><span class="term">Throws:</span></p></td> +<td>will not throw.</td> +</tr> +</tbody> +</table></div> +</li></ol></div> +</div> +<div class="refsect2" lang="en"> +<a name="id543830"></a><h3> +<a name="id227444-bb"></a><code class="computeroutput">array</code> comparisons</h3> +<div class="orderedlist"><ol type="1"> +<li> +<pre class="literallayout"><span class="bold"><strong>template</strong></span><<span class="bold"><strong>typename</strong></span> T, std::size_t N> + <span class="type"><span class="bold"><strong>bool</strong></span></span> <a name="boost.operator=="></a><span class="bold"><strong>operator</strong></span>==( + <span class="bold"><strong>const</strong></span> <a class="link" href="array.html" title="Class template array">array</a><T, N>& + x, + + <span class="bold"><strong>const</strong></span> <a class="link" href="array.html" title="Class template array">array</a><T, N>& + y);</pre> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term">Returns:</span></p></td> +<td> + <code class="computeroutput"> + std::equal(x.<a class="link" href="array.html#id225167-bb">begin</a>(), x.<a class="link" href="array.html#id225205-bb">end</a>(), y.<a class="link" href="array.html#id225167-bb">begin</a>()) + </code> + </td> +</tr></tbody> +</table></div> +</li> +<li> +<pre class="literallayout"><span class="bold"><strong>template</strong></span><<span class="bold"><strong>typename</strong></span> T, std::size_t N> + <span class="type"><span class="bold"><strong>bool</strong></span></span> <a name="boost.operator!="></a><span class="bold"><strong>operator</strong></span>!=( + <span class="bold"><strong>const</strong></span> <a class="link" href="array.html" title="Class template array">array</a><T, N>& + x, + + <span class="bold"><strong>const</strong></span> <a class="link" href="array.html" title="Class template array">array</a><T, N>& + y);</pre> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term">Returns:</span></p></td> +<td> + <code class="computeroutput">!(x == y)</code> + </td> +</tr></tbody> +</table></div> +</li> +<li> +<pre class="literallayout"><span class="bold"><strong>template</strong></span><<span class="bold"><strong>typename</strong></span> T, std::size_t N> + <span class="type"><span class="bold"><strong>bool</strong></span></span> <a name="boost.operator_id227596"></a><span class="bold"><strong>operator</strong></span><( + <span class="bold"><strong>const</strong></span> <a class="link" href="array.html" title="Class template array">array</a><T, N>& + x, + + <span class="bold"><strong>const</strong></span> <a class="link" href="array.html" title="Class template array">array</a><T, N>& + y);</pre> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term">Returns:</span></p></td> +<td> + <code class="computeroutput"> + std::lexicographical_compare(x.<a class="link" href="array.html#id225167-bb">begin</a>(), x.<a class="link" href="array.html#id225205-bb">end</a>(), y.<a class="link" href="array.html#id225167-bb">begin</a>(), y.<a class="link" href="array.html#id225205-bb">end</a>()) + </code> + </td> +</tr></tbody> +</table></div> +</li> +<li> +<pre class="literallayout"><span class="bold"><strong>template</strong></span><<span class="bold"><strong>typename</strong></span> T, std::size_t N> + <span class="type"><span class="bold"><strong>bool</strong></span></span> <a name="boost.operator_id227679"></a><span class="bold"><strong>operator</strong></span>>( + <span class="bold"><strong>const</strong></span> <a class="link" href="array.html" title="Class template array">array</a><T, N>& + x, + + <span class="bold"><strong>const</strong></span> <a class="link" href="array.html" title="Class template array">array</a><T, N>& + y);</pre> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term">Returns:</span></p></td> +<td> + <code class="computeroutput">y < x</code> + </td> +</tr></tbody> +</table></div> +</li> +<li> +<pre class="literallayout"><span class="bold"><strong>template</strong></span><<span class="bold"><strong>typename</strong></span> T, std::size_t N> + <span class="type"><span class="bold"><strong>bool</strong></span></span> <a name="boost.operator_=_id227747"></a><span class="bold"><strong>operator</strong></span><=( + <span class="bold"><strong>const</strong></span> <a class="link" href="array.html" title="Class template array">array</a><T, N>& + x, + + <span class="bold"><strong>const</strong></span> <a class="link" href="array.html" title="Class template array">array</a><T, N>& + y);</pre> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term">Returns:</span></p></td> +<td> + <code class="computeroutput">!(y < x)</code> + </td> +</tr></tbody> +</table></div> +</li> +<li> +<pre class="literallayout"><span class="bold"><strong>template</strong></span><<span class="bold"><strong>typename</strong></span> T, std::size_t N> + <span class="type"><span class="bold"><strong>bool</strong></span></span> <a name="boost.operator_=_id227814"></a><span class="bold"><strong>operator</strong></span>>=( + <span class="bold"><strong>const</strong></span> <a class="link" href="array.html" title="Class template array">array</a><T, N>& + x, + + <span class="bold"><strong>const</strong></span> <a class="link" href="array.html" title="Class template array">array</a><T, N>& + y);</pre> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term">Returns:</span></p></td> +<td> + <code class="computeroutput">!(x < y)</code> + </td> +</tr></tbody> +</table></div> +</li> +</ol></div> +</div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2007 John Maddock, Joel de Guzman, Eric Niebler and Matias + Capeletto<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + 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>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../document_to_test_formatting/array.html"><img src="../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../document_to_test_formatting/array.html#header.boost.array_hpp"><img src="../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="../document_to_test_formatting/accumulators.html"><img src="../../../../doc/html/images/next.png" alt="Next"></a> +</div> +</body> +</html> |