diff options
Diffstat (limited to 'doc/html/boost/array.html')
| -rwxr-xr-x | doc/html/boost/array.html | 503 |
1 files changed, 503 insertions, 0 deletions
diff --git a/doc/html/boost/array.html b/doc/html/boost/array.html new file mode 100755 index 0000000000..46d77b2a86 --- /dev/null +++ b/doc/html/boost/array.html @@ -0,0 +1,503 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Class template array</title> +<link rel="stylesheet" href="../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../array/reference.html#header.boost.array_hpp" title="Header <boost/array.hpp>"> +<link rel="prev" href="../array/reference.html" title="Reference"> +<link rel="next" href="../array/rationale.html" title="Design Rationale"> +</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="../array/reference.html"><img src="../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../array/reference.html#header.boost.array_hpp"><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="../array/rationale.html"><img src="../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<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="comment">// In header: <<a class="link" href="../array/reference.html#header.boost.array_hpp" title="Header <boost/array.hpp>">boost/array.hpp</a>> + +</span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> N<span class="special">></span> +<span class="keyword">class</span> <a class="link" href="array.html" title="Class template array">array</a> <span class="special">{</span> +<span class="keyword">public</span><span class="special">:</span> + <span class="comment">// types</span> + <span class="keyword">typedef</span> <span class="identifier">T</span> <a name="boost.array.value_type"></a><span class="identifier">value_type</span><span class="special">;</span> + <span class="keyword">typedef</span> <span class="identifier">T</span><span class="special">*</span> <a name="boost.array.iterator"></a><span class="identifier">iterator</span><span class="special">;</span> + <span class="keyword">typedef</span> <span class="keyword">const</span> <span class="identifier">T</span><span class="special">*</span> <a name="boost.array.const_iterator"></a><span class="identifier">const_iterator</span><span class="special">;</span> + <span class="keyword">typedef</span> std::reverse_iterator<span class="special"><</span><span class="identifier">iterator</span><span class="special">></span> <a name="boost.array.reverse_iterator"></a><span class="identifier">reverse_iterator</span><span class="special">;</span> + <span class="keyword">typedef</span> std::reverse_iterator<span class="special"><</span><span class="identifier">const_iterator</span><span class="special">></span> <a name="boost.array.const_reverse_iterator"></a><span class="identifier">const_reverse_iterator</span><span class="special">;</span> + <span class="keyword">typedef</span> <span class="identifier">T</span><span class="special">&</span> <a name="boost.array.reference"></a><span class="identifier">reference</span><span class="special">;</span> + <span class="keyword">typedef</span> <span class="keyword">const</span> <span class="identifier">T</span><span class="special">&</span> <a name="boost.array.const_reference"></a><span class="identifier">const_reference</span><span class="special">;</span> + <span class="keyword">typedef</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a name="boost.array.size_type"></a><span class="identifier">size_type</span><span class="special">;</span> + <span class="keyword">typedef</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ptrdiff_t</span> <a name="boost.array.difference_type"></a><span class="identifier">difference_type</span><span class="special">;</span> + + <span class="comment">// static constants</span> + <span class="keyword">static</span> <span class="keyword">const</span> <span class="identifier">size_type</span> <span class="identifier">static_size</span> = <span class="identifier">N</span><span class="special">;</span> + + <span class="comment">// <a class="link" href="array.html#boost.arrayconstruct-copy-destruct">construct/copy/destruct</a></span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> U<span class="special">></span> array& <a class="link" href="array.html#id428160-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="array.html" title="Class template array">array</a><span class="special"><</span><span class="identifier">U</span><span class="special">,</span> <span class="identifier">N</span><span class="special">></span><span class="special">&</span><span class="special">)</span><span class="special">;</span> + + <span class="comment">// <a class="link" href="array.html#id428197-bb">iterator support</a></span> + <span class="identifier">iterator</span> <a class="link" href="array.html#id428205-bb"><span class="identifier">begin</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">const_iterator</span> <a class="link" href="array.html#id428211-bb"><span class="identifier">begin</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">iterator</span> <a class="link" href="array.html#id428233-bb"><span class="identifier">end</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">const_iterator</span> <a class="link" href="array.html#id428239-bb"><span class="identifier">end</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + + <span class="comment">// <a class="link" href="array.html#id428259-bb">reverse iterator support</a></span> + <span class="identifier">reverse_iterator</span> <a class="link" href="array.html#id428267-bb"><span class="identifier">rbegin</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">const_reverse_iterator</span> <a class="link" href="array.html#id428273-bb"><span class="identifier">rbegin</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">reverse_iterator</span> <a class="link" href="array.html#id425113-bb"><span class="identifier">rend</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">const_reverse_iterator</span> <a class="link" href="array.html#id424538-bb"><span class="identifier">rend</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + + <span class="comment">// <a class="link" href="array.html#id424554-bb">capacity</a></span> + <span class="identifier">size_type</span> <a class="link" href="array.html#id424558-bb"><span class="identifier">size</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="array.html#id424572-bb"><span class="identifier">empty</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">size_type</span> <a class="link" href="array.html#id424590-bb"><span class="identifier">max_size</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + + <span class="comment">// <a class="link" href="array.html#id424609-bb">element access</a></span> + <span class="identifier">reference</span> <a class="link" href="array.html#id424617-bb"><span class="keyword">operator</span><span class="special">[</span><span class="special">]</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">const_reference</span> <a class="link" href="array.html#id424632-bb"><span class="keyword">operator</span><span class="special">[</span><span class="special">]</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">reference</span> <a class="link" href="array.html#id424669-bb"><span class="identifier">at</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">const_reference</span> <a class="link" href="array.html#id424684-bb"><span class="identifier">at</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">reference</span> <a class="link" href="array.html#id424721-bb"><span class="identifier">front</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">const_reference</span> <a class="link" href="array.html#id424728-bb"><span class="identifier">front</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">reference</span> <a class="link" href="array.html#id424755-bb"><span class="identifier">back</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">const_reference</span> <a class="link" href="array.html#id424761-bb"><span class="identifier">back</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">const</span> <span class="identifier">T</span><span class="special">*</span> <a class="link" href="array.html#id424785-bb"><span class="identifier">data</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">T</span><span class="special">*</span> <a class="link" href="array.html#id424804-bb"><span class="identifier">c_array</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + + <span class="comment">// <a class="link" href="array.html#id424823-bb">modifiers</a></span> + <span class="keyword">void</span> <a class="link" href="array.html#id424827-bb"><span class="identifier">swap</span></a><span class="special">(</span><a class="link" href="array.html" title="Class template array">array</a><span class="special"><</span><span class="identifier">T</span><span class="special">,</span> <span class="identifier">N</span><span class="special">></span><span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="array.html#id424867-bb"><span class="identifier">assign</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">T</span><span class="special">&</span><span class="special">)</span><span class="special">;</span> + + <span class="comment">// public data members</span> + <span class="identifier">T</span> <span class="identifier">elems[N]</span><span class="special">;</span> +<span class="special">}</span><span class="special">;</span> + +<span class="comment">// <a class="link" href="array.html#id424904-bb">specialized algorithms</a></span> +<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> N<span class="special">></span> <span class="keyword">void</span> <a class="link" href="array.html#boost.array.swap_id424908"><span class="identifier">swap</span></a><span class="special">(</span><a class="link" href="array.html" title="Class template array">array</a><span class="special"><</span><span class="identifier">T</span><span class="special">,</span> <span class="identifier">N</span><span class="special">></span><span class="special">&</span><span class="special">,</span> <a class="link" href="array.html" title="Class template array">array</a><span class="special"><</span><span class="identifier">T</span><span class="special">,</span> <span class="identifier">N</span><span class="special">></span><span class="special">&</span><span class="special">)</span><span class="special">;</span> + +<span class="comment">// <a class="link" href="array.html#id424966-bb">comparisons</a></span> +<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> N<span class="special">></span> + <span class="keyword">bool</span> <a class="link" href="array.html#boost.array.operator==_id424970"><span class="keyword">operator</span><span class="special">==</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="array.html" title="Class template array">array</a><span class="special"><</span><span class="identifier">T</span><span class="special">,</span> <span class="identifier">N</span><span class="special">></span><span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="array.html" title="Class template array">array</a><span class="special"><</span><span class="identifier">T</span><span class="special">,</span> <span class="identifier">N</span><span class="special">></span><span class="special">&</span><span class="special">)</span><span class="special">;</span> +<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> N<span class="special">></span> + <span class="keyword">bool</span> <a class="link" href="array.html#boost.array.operator!=_id425033"><span class="keyword">operator</span><span class="special">!=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="array.html" title="Class template array">array</a><span class="special"><</span><span class="identifier">T</span><span class="special">,</span> <span class="identifier">N</span><span class="special">></span><span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="array.html" title="Class template array">array</a><span class="special"><</span><span class="identifier">T</span><span class="special">,</span> <span class="identifier">N</span><span class="special">></span><span class="special">&</span><span class="special">)</span><span class="special">;</span> +<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> N<span class="special">></span> + <span class="keyword">bool</span> <a class="link" href="array.html#boost.array.operator_id425086"><span class="keyword">operator</span><span class="special"><</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="array.html" title="Class template array">array</a><span class="special"><</span><span class="identifier">T</span><span class="special">,</span> <span class="identifier">N</span><span class="special">></span><span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="array.html" title="Class template array">array</a><span class="special"><</span><span class="identifier">T</span><span class="special">,</span> <span class="identifier">N</span><span class="special">></span><span class="special">&</span><span class="special">)</span><span class="special">;</span> +<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> N<span class="special">></span> + <span class="keyword">bool</span> <a class="link" href="array.html#boost.array.operator_id421946"><span class="keyword">operator</span><span class="special">></span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="array.html" title="Class template array">array</a><span class="special"><</span><span class="identifier">T</span><span class="special">,</span> <span class="identifier">N</span><span class="special">></span><span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="array.html" title="Class template array">array</a><span class="special"><</span><span class="identifier">T</span><span class="special">,</span> <span class="identifier">N</span><span class="special">></span><span class="special">&</span><span class="special">)</span><span class="special">;</span> +<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> N<span class="special">></span> + <span class="keyword">bool</span> <a class="link" href="array.html#boost.array.operator_=_id421998"><span class="keyword">operator</span><span class="special"><=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="array.html" title="Class template array">array</a><span class="special"><</span><span class="identifier">T</span><span class="special">,</span> <span class="identifier">N</span><span class="special">></span><span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="array.html" title="Class template array">array</a><span class="special"><</span><span class="identifier">T</span><span class="special">,</span> <span class="identifier">N</span><span class="special">></span><span class="special">&</span><span class="special">)</span><span class="special">;</span> +<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> N<span class="special">></span> + <span class="keyword">bool</span> <a class="link" href="array.html#boost.array.operator_=_id422050"><span class="keyword">operator</span><span class="special">>=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="array.html" title="Class template array">array</a><span class="special"><</span><span class="identifier">T</span><span class="special">,</span> <span class="identifier">N</span><span class="special">></span><span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="array.html" title="Class template array">array</a><span class="special"><</span><span class="identifier">T</span><span class="special">,</span> <span class="identifier">N</span><span class="special">></span><span class="special">&</span><span class="special">)</span><span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="id1035357"></a><h2>Description</h2> +<div class="refsect2"> +<a name="id1035360"></a><h3> +<a name="boost.arrayconstruct-copy-destruct"></a><code class="computeroutput">array</code> + public + construct/copy/destruct</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> U<span class="special">></span> array& <a name="id428160-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="array.html" title="Class template array">array</a><span class="special"><</span><span class="identifier">U</span><span class="special">,</span> <span class="identifier">N</span><span class="special">></span><span class="special">&</span> other<span class="special">)</span><span class="special">;</span></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#id428201-bb">begin</a>(),rhs.<a class="link" href="array.html#id428229-bb">end</a>(), <a class="link" href="array.html#id428201-bb">begin</a>())</code></td> +</tr></tbody> +</table></div> +</li></ol></div> +</div> +<div class="refsect2"> +<a name="id1035512"></a><h3> +<a name="id428197-bb"></a><code class="computeroutput">array</code> iterator support</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"> +<pre class="literallayout"><a name="id428201-bb"></a><span class="identifier">iterator</span> <a name="id428205-bb"></a><span class="identifier">begin</span><span class="special">(</span><span class="special">)</span><span class="special">;</span> +<span class="identifier">const_iterator</span> <a name="id428211-bb"></a><span class="identifier">begin</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</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 class="listitem"> +<pre class="literallayout"><a name="id428229-bb"></a><span class="identifier">iterator</span> <a name="id428233-bb"></a><span class="identifier">end</span><span class="special">(</span><span class="special">)</span><span class="special">;</span> +<span class="identifier">const_iterator</span> <a name="id428239-bb"></a><span class="identifier">end</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</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"> +<a name="id1035715"></a><h3> +<a name="id428259-bb"></a><code class="computeroutput">array</code> reverse iterator support</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"> +<pre class="literallayout"><a name="id428263-bb"></a><span class="identifier">reverse_iterator</span> <a name="id428267-bb"></a><span class="identifier">rbegin</span><span class="special">(</span><span class="special">)</span><span class="special">;</span> +<span class="identifier">const_reverse_iterator</span> <a name="id428273-bb"></a><span class="identifier">rbegin</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</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 class="listitem"> +<pre class="literallayout"><a name="id425109-bb"></a><span class="identifier">reverse_iterator</span> <a name="id425113-bb"></a><span class="identifier">rend</span><span class="special">(</span><span class="special">)</span><span class="special">;</span> +<span class="identifier">const_reverse_iterator</span> <a name="id424538-bb"></a><span class="identifier">rend</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</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"> +<a name="id1035906"></a><h3> +<a name="id424554-bb"></a><code class="computeroutput">array</code> capacity</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"> +<pre class="literallayout"><span class="identifier">size_type</span> <a name="id424558-bb"></a><span class="identifier">size</span><span class="special">(</span><span class="special">)</span><span class="special">;</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">N</code></td> +</tr></tbody> +</table></div> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">bool</span> <a name="id424572-bb"></a><span class="identifier">empty</span><span class="special">(</span><span class="special">)</span><span class="special">;</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">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 class="listitem"> +<pre class="literallayout"><span class="identifier">size_type</span> <a name="id424590-bb"></a><span class="identifier">max_size</span><span class="special">(</span><span class="special">)</span><span class="special">;</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">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"> +<a name="id1036086"></a><h3> +<a name="id424609-bb"></a><code class="computeroutput">array</code> element access</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"> +<pre class="literallayout"><a name="id424613-bb"></a><span class="identifier">reference</span> <a name="id424617-bb"></a><span class="keyword">operator</span><span class="special">[</span><span class="special">]</span><span class="special">(</span><span class="identifier">size_type</span> i<span class="special">)</span><span class="special">;</span> +<span class="identifier">const_reference</span> <a name="id424632-bb"></a><span class="keyword">operator</span><span class="special">[</span><span class="special">]</span><span class="special">(</span><span class="identifier">size_type</span> i<span class="special">)</span> <span class="keyword">const</span><span class="special">;</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 class="listitem"> +<pre class="literallayout"><a name="id424665-bb"></a><span class="identifier">reference</span> <a name="id424669-bb"></a><span class="identifier">at</span><span class="special">(</span><span class="identifier">size_type</span> i<span class="special">)</span><span class="special">;</span> +<span class="identifier">const_reference</span> <a name="id424684-bb"></a><span class="identifier">at</span><span class="special">(</span><span class="identifier">size_type</span> i<span class="special">)</span> <span class="keyword">const</span><span class="special">;</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 class="listitem"> +<pre class="literallayout"><a name="id424717-bb"></a><span class="identifier">reference</span> <a name="id424721-bb"></a><span class="identifier">front</span><span class="special">(</span><span class="special">)</span><span class="special">;</span> +<span class="identifier">const_reference</span> <a name="id424728-bb"></a><span class="identifier">front</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</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 class="listitem"> +<pre class="literallayout"><a name="id424751-bb"></a><span class="identifier">reference</span> <a name="id424755-bb"></a><span class="identifier">back</span><span class="special">(</span><span class="special">)</span><span class="special">;</span> +<span class="identifier">const_reference</span> <a name="id424761-bb"></a><span class="identifier">back</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</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 class="listitem"> +<pre class="literallayout"><span class="keyword">const</span> <span class="identifier">T</span><span class="special">*</span> <a name="id424785-bb"></a><span class="identifier">data</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</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 class="listitem"> +<pre class="literallayout"><span class="identifier">T</span><span class="special">*</span> <a name="id424804-bb"></a><span class="identifier">c_array</span><span class="special">(</span><span class="special">)</span><span class="special">;</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> +</ol></div> +</div> +<div class="refsect2"> +<a name="id1036693"></a><h3> +<a name="id424823-bb"></a><code class="computeroutput">array</code> modifiers</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">void</span> <a name="id424827-bb"></a><span class="identifier">swap</span><span class="special">(</span><a class="link" href="array.html" title="Class template array">array</a><span class="special"><</span><span class="identifier">T</span><span class="special">,</span> <span class="identifier">N</span><span class="special">></span><span class="special">&</span> other<span class="special">)</span><span class="special">;</span></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#id428201-bb">begin</a>(), <a class="link" href="array.html#id428229-bb">end</a>(), other.<a class="link" href="array.html#id428201-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 class="listitem"> +<pre class="literallayout"><span class="keyword">void</span> <a name="id424867-bb"></a><span class="identifier">assign</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">T</span><span class="special">&</span> value<span class="special">)</span><span class="special">;</span></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#id428201-bb">begin</a>(), N, value)</code></td> +</tr></tbody> +</table></div> +</li> +</ol></div> +</div> +<div class="refsect2"> +<a name="id1036898"></a><h3> +<a name="id424904-bb"></a><code class="computeroutput">array</code> specialized algorithms</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> N<span class="special">></span> <span class="keyword">void</span> <a name="boost.array.swap_id424908"></a><span class="identifier">swap</span><span class="special">(</span><a class="link" href="array.html" title="Class template array">array</a><span class="special"><</span><span class="identifier">T</span><span class="special">,</span> <span class="identifier">N</span><span class="special">></span><span class="special">&</span> x<span class="special">,</span> <a class="link" href="array.html" title="Class template array">array</a><span class="special"><</span><span class="identifier">T</span><span class="special">,</span> <span class="identifier">N</span><span class="special">></span><span class="special">&</span> y<span class="special">)</span><span class="special">;</span></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#id424827-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"> +<a name="id1037094"></a><h3> +<a name="id424966-bb"></a><code class="computeroutput">array</code> comparisons</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> N<span class="special">></span> + <span class="keyword">bool</span> <a name="boost.array.operator==_id424970"></a><span class="keyword">operator</span><span class="special">==</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="array.html" title="Class template array">array</a><span class="special"><</span><span class="identifier">T</span><span class="special">,</span> <span class="identifier">N</span><span class="special">></span><span class="special">&</span> x<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="array.html" title="Class template array">array</a><span class="special"><</span><span class="identifier">T</span><span class="special">,</span> <span class="identifier">N</span><span class="special">></span><span class="special">&</span> y<span class="special">)</span><span class="special">;</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">std::equal(x.<a class="link" href="array.html#id428201-bb">begin</a>(), x.<a class="link" href="array.html#id428229-bb">end</a>(), y.<a class="link" href="array.html#id428201-bb">begin</a>())</code></td> +</tr></tbody> +</table></div> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> N<span class="special">></span> + <span class="keyword">bool</span> <a name="boost.array.operator!=_id425033"></a><span class="keyword">operator</span><span class="special">!=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="array.html" title="Class template array">array</a><span class="special"><</span><span class="identifier">T</span><span class="special">,</span> <span class="identifier">N</span><span class="special">></span><span class="special">&</span> x<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="array.html" title="Class template array">array</a><span class="special"><</span><span class="identifier">T</span><span class="special">,</span> <span class="identifier">N</span><span class="special">></span><span class="special">&</span> y<span class="special">)</span><span class="special">;</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">!(x == y)</code></td> +</tr></tbody> +</table></div> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> N<span class="special">></span> + <span class="keyword">bool</span> <a name="boost.array.operator_id425086"></a><span class="keyword">operator</span><span class="special"><</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="array.html" title="Class template array">array</a><span class="special"><</span><span class="identifier">T</span><span class="special">,</span> <span class="identifier">N</span><span class="special">></span><span class="special">&</span> x<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="array.html" title="Class template array">array</a><span class="special"><</span><span class="identifier">T</span><span class="special">,</span> <span class="identifier">N</span><span class="special">></span><span class="special">&</span> y<span class="special">)</span><span class="special">;</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">std::lexicographical_compare(x.<a class="link" href="array.html#id428201-bb">begin</a>(), x.<a class="link" href="array.html#id428229-bb">end</a>(), y.<a class="link" href="array.html#id428201-bb">begin</a>(), y.<a class="link" href="array.html#id428229-bb">end</a>())</code></td> +</tr></tbody> +</table></div> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> N<span class="special">></span> + <span class="keyword">bool</span> <a name="boost.array.operator_id421946"></a><span class="keyword">operator</span><span class="special">></span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="array.html" title="Class template array">array</a><span class="special"><</span><span class="identifier">T</span><span class="special">,</span> <span class="identifier">N</span><span class="special">></span><span class="special">&</span> x<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="array.html" title="Class template array">array</a><span class="special"><</span><span class="identifier">T</span><span class="special">,</span> <span class="identifier">N</span><span class="special">></span><span class="special">&</span> y<span class="special">)</span><span class="special">;</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">y < x</code></td> +</tr></tbody> +</table></div> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> N<span class="special">></span> + <span class="keyword">bool</span> <a name="boost.array.operator_=_id421998"></a><span class="keyword">operator</span><span class="special"><=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="array.html" title="Class template array">array</a><span class="special"><</span><span class="identifier">T</span><span class="special">,</span> <span class="identifier">N</span><span class="special">></span><span class="special">&</span> x<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="array.html" title="Class template array">array</a><span class="special"><</span><span class="identifier">T</span><span class="special">,</span> <span class="identifier">N</span><span class="special">></span><span class="special">&</span> y<span class="special">)</span><span class="special">;</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">!(y < x)</code></td> +</tr></tbody> +</table></div> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> N<span class="special">></span> + <span class="keyword">bool</span> <a name="boost.array.operator_=_id422050"></a><span class="keyword">operator</span><span class="special">>=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="array.html" title="Class template array">array</a><span class="special"><</span><span class="identifier">T</span><span class="special">,</span> <span class="identifier">N</span><span class="special">></span><span class="special">&</span> x<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="array.html" title="Class template array">array</a><span class="special"><</span><span class="identifier">T</span><span class="special">,</span> <span class="identifier">N</span><span class="special">></span><span class="special">&</span> y<span class="special">)</span><span class="special">;</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">!(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 © 2001-2004 Nicolai M. Josuttis<p>Distributed under the Boost Software License, Version 1.0. + (See accompanying file <code class="filename">LICENSE_1_0.txt</code> 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="../array/reference.html"><img src="../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../array/reference.html#header.boost.array_hpp"><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="../array/rationale.html"><img src="../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> |