mirror of
https://github.com/boostorg/array.git
synced 2026-04-29 18:23:31 +02:00
Compare commits
48 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 25e959e4a9 | |||
| 2fde5e334b | |||
| 4ee6e051fe | |||
| bac6446111 | |||
| cfb6d6eae6 | |||
| 0543286830 | |||
| 1c6f9ef038 | |||
| d38c367afd | |||
| a5a75f81bd | |||
| ab72ec517c | |||
| 8a119110be | |||
| 3daa34744f | |||
| 0f3969f9e0 | |||
| c501468b53 | |||
| faf0005e86 | |||
| 785e98fcac | |||
| 13d4e8bc40 | |||
| 9ea2182afa | |||
| bf3b240686 | |||
| 6b9c6c9de3 | |||
| fe013c42b7 | |||
| b87433497e | |||
| 09c271cf34 | |||
| f5699ae164 | |||
| f96ac657dd | |||
| 7f73413eed | |||
| 640d1434bf | |||
| 624bd0e218 | |||
| ad82e2b25c | |||
| 44887bfe59 | |||
| fd76085150 | |||
| aac83e6667 | |||
| a673bc6e82 | |||
| a91e96a8ab | |||
| debb0f0908 | |||
| 52dadb9764 | |||
| b62e1aa4e7 | |||
| 8c5daba6b3 | |||
| 6533fa4606 | |||
| e3d87e942c | |||
| e4ca9354ab | |||
| ee67849b60 | |||
| 38a335e3e7 | |||
| 6aa207d813 | |||
| a921a66a65 | |||
| 51cd7d0ca5 | |||
| 7eb947be47 | |||
| d578504cfc |
-330
@@ -1,330 +0,0 @@
|
||||
<!doctype html public "-//w3c//dtd html 4.0 transitional//en">
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
|
||||
<meta name="Keywords" content="array, block, carray, c_array, array wrapper, adapter, adaptor, STL, C++ Standard Library, array.hpp">
|
||||
|
||||
<title>array.hpp, an STL Array Wrapper</title>
|
||||
</head>
|
||||
<body text="#000000" bgcolor="#FFFFFF" link="#186ABF">
|
||||
<font face="Arial, Helvetica, sans-serif"> </font>
|
||||
<table width="100%" height="40">
|
||||
<tr>
|
||||
<td BGCOLOR="#DDDDDD"><b><font face="Arial,helvetica" color="#000000" size="+1">Class
|
||||
<font face="Courier New, Courier, mono">array</font>, an STL Container (as
|
||||
Wrapper) for Arrays of Constant Size</font></b></td>
|
||||
</tr>
|
||||
</table>
|
||||
<p><font size="-1" face="Arial, Helvetica, sans-serif">[<a href="#intro">intro</a>]
|
||||
[<a href="#interface">interface</a>] [<a href="#discussion">discussion</a>]
|
||||
[<a href="#code">code</a>]</font>
|
||||
<p><font face="Arial, Helvetica, sans-serif" size="-1"><a name="intro"></a>The
|
||||
C++ Standard Template Library STL as part of the C++ Standard Library provides
|
||||
a framework for processing algorithms on different kind of containers. However,
|
||||
ordinary arrays don't provide the interface of STL containers (although, they
|
||||
provide the iterator interface of STL containers).</font>
|
||||
<p><font face="Arial, Helvetica, sans-serif" size="-1">As replacement for ordinary
|
||||
arrays, the STL provides class <font face="Courier New, Courier, mono">vector<></font>.
|
||||
However, <font face="Courier New, Courier, mono">vector<></font> provides
|
||||
the semantics of dynamic arrays. Thus, it manages data to be able to change
|
||||
the number of elements. This results in some overhead in case only arrays with
|
||||
static size are needed.</font>
|
||||
<p><font face="Arial, Helvetica, sans-serif" size="-1">In his book, <i>Generic
|
||||
Programming and the STL</i>, Matthew H. Austern introduces a useful wrapper
|
||||
class for ordinary arrays with static size, called <font face="Courier New, Courier, mono"><b>block</b></font>.
|
||||
It is safer and has no worse performance than ordinary arrays. In <i>The C++
|
||||
Programming Language</i>, 3rd edition, Bjarne Stroustrup introduces a similar
|
||||
class, called <font face="Courier New, Courier, mono"><b>c_array</b></font>,
|
||||
which I (<a href="http://www.josuttis.com">Nicolai Josuttis</a>) present slightly
|
||||
modified in my book <i>The C++ Standard Library - A Tutorial and Reference</i>,
|
||||
called <font face="Courier New, Courier, mono"><b>carray</b></font>. This is
|
||||
the essence of these approaches spiced with many feedback from <a href="http://www.boost.org">boost</a>.</font>
|
||||
<p><font face="Arial, Helvetica, sans-serif" size="-1">After considering different
|
||||
names, we decided to name this class simply <font face="Courier New, Courier, mono"><b>array</b></font>.</font>
|
||||
<p><font face="Arial, Helvetica, sans-serif" size="-1"><a name="interface"></a>The
|
||||
class provides the following interface:</font>
|
||||
<table border="0">
|
||||
<tr>
|
||||
<td><font face="Arial, Helvetica, sans-serif" size="-1"><b>Types:</b></font></td>
|
||||
<td><font size="-1"></font></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><font face="Courier New, Courier, mono" size="-1">value_type</font></td>
|
||||
<td><font face="Arial, Helvetica, sans-serif" size="-1">type of the elements</font></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><font face="Courier New, Courier, mono" size="-1">iterator</font></td>
|
||||
<td><font face="Arial, Helvetica, sans-serif" size="-1">type of the iterator
|
||||
(random-access iterator)</font></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><font face="Courier New, Courier, mono" size="-1">const_iterator</font></td>
|
||||
<td><font face="Arial, Helvetica, sans-serif" size="-1">type of iterator that
|
||||
considers elements as being constant</font></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><font face="Courier New, Courier, mono" size="-1">reference</font></td>
|
||||
<td><font face="Arial, Helvetica, sans-serif" size="-1">type of element reference</font></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><font face="Courier New, Courier, mono" size="-1">const_reference</font></td>
|
||||
<td><font face="Arial, Helvetica, sans-serif" size="-1">type of element reference
|
||||
that considers elements as being constant</font></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><font face="Courier New, Courier, mono" size="-1">size_type</font></td>
|
||||
<td><font face="Arial, Helvetica, sans-serif" size="-1">type for signed size
|
||||
values</font></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><font face="Courier New, Courier, mono" size="-1">difference_type</font></td>
|
||||
<td><font face="Arial, Helvetica, sans-serif" size="-1">type for unsigned
|
||||
difference values</font></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><font face="Arial, Helvetica, sans-serif" size="-1"><b>Operations:</b></font></td>
|
||||
<td><font size="-1"></font></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<p><font face="Courier New, Courier, mono" size="-1">array<<i>type</i>,<i>num</i>></font></p>
|
||||
</td>
|
||||
<td><font face="Arial, Helvetica, sans-serif" size="-1">default constructor,
|
||||
creates array of <i><font face="Courier New, Courier, mono">num</font></i>
|
||||
element of <i><font face="Courier New, Courier, mono">type</font></i>, see
|
||||
comment below</font></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><font face="Courier New, Courier, mono" size="-1">array<<i>type</i>,<i>num</i>>(<i>a</i>)</font></td>
|
||||
<td><font face="Arial, Helvetica, sans-serif" size="-1">copy constructor,
|
||||
copies all elements of <i><font face="Courier New, Courier, mono">a</font></i>
|
||||
(<i><font face="Courier New, Courier, mono">a</font></i> must have same
|
||||
<i> <font face="Courier New, Courier, mono">type</font></i><font face="Courier New, Courier, mono"><font face="Arial, Helvetica, sans-serif">
|
||||
and </font></font><i><font face="Courier New, Courier, mono">num</font></i>)</font></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><font face="Courier New, Courier, mono" size="-1">operator=</font></td>
|
||||
<td><font face="Arial, Helvetica, sans-serif" size="-1">assignment, assigns
|
||||
all elements</font></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><font face="Courier New, Courier, mono" size="-1">assign(<i>val</i>)</font></td>
|
||||
<td><font face="Arial, Helvetica, sans-serif" size="-1">assigns <i>val</i>
|
||||
to all elements</font></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><font face="Courier New, Courier, mono" size="-1">begin()</font></td>
|
||||
<td><font face="Arial, Helvetica, sans-serif" size="-1">returns iterator for
|
||||
the first element</font></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><font face="Courier New, Courier, mono" size="-1">end()</font></td>
|
||||
<td><font face="Arial, Helvetica, sans-serif" size="-1">returns iterator for
|
||||
position after the last element</font></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><font face="Courier New, Courier, mono" size="-1">rbegin()</font></td>
|
||||
<td><font face="Arial, Helvetica, sans-serif" size="-1">returns reverse iterator
|
||||
for position of first element of reverse iteration</font></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><font face="Courier New, Courier, mono" size="-1">rend()</font></td>
|
||||
<td><font face="Arial, Helvetica, sans-serif" size="-1">returns reverse iterator
|
||||
for position behind last element of reverse iteration </font></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><font face="Courier New, Courier, mono" size="-1">operator[<i>i</i>]</font></td>
|
||||
<td><font face="Arial, Helvetica, sans-serif" size="-1">returns element with
|
||||
index <i><font face="Courier New, Courier, mono">i</font></i> (no range
|
||||
checking)</font></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><font face="Courier New, Courier, mono" size="-1">at(<i>i</i>)</font></td>
|
||||
<td><font face="Arial, Helvetica, sans-serif" size="-1">returns element with
|
||||
index <font face="Courier New, Courier, mono"><i>i</i></font> (throw std::range_error
|
||||
if <i><font face="Courier New, Courier, mono">i</font></i> is not valid)</font></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><font face="Courier New, Courier, mono" size="-1">front()</font></td>
|
||||
<td><font face="Arial, Helvetica, sans-serif" size="-1">returns first element
|
||||
(caller has to ensure that it exists)</font></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><font face="Courier New, Courier, mono" size="-1">back()</font></td>
|
||||
<td><font face="Arial, Helvetica, sans-serif" size="-1">returns last element
|
||||
(caller has to ensure that it exists)</font></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><font face="Courier New, Courier, mono" size="-1">data()</font></td>
|
||||
<td><font face="Arial, Helvetica, sans-serif" size="-1">returns raw element
|
||||
array for read-only element access</font></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><font face="Courier New, Courier, mono" size="-1">size()</font></td>
|
||||
<td><font face="Arial, Helvetica, sans-serif" size="-1">returns number of
|
||||
elements</font></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><font face="Courier New, Courier, mono" size="-1">empty()</font></td>
|
||||
<td><font face="Arial, Helvetica, sans-serif" size="-1">returns whether array
|
||||
is empty</font></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><font face="Courier New, Courier, mono" size="-1">max_size()</font></td>
|
||||
<td><font face="Arial, Helvetica, sans-serif" size="-1">returns maximum possible
|
||||
number of elements (same as size())</font></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><font face="Courier New, Courier, mono" size="-1">swap(a)</font></td>
|
||||
<td><font face="Arial, Helvetica, sans-serif" size="-1">swap elements with
|
||||
array a</font></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><font face="Courier New, Courier, mono" size="-1">==<font face="Arial, Helvetica, sans-serif">,
|
||||
</font>!=</font></td>
|
||||
<td><font face="Arial, Helvetica, sans-serif" size="-1">checks for equality</font></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><font face="Courier New, Courier, mono" size="-1"><<font face="Arial, Helvetica, sans-serif">,
|
||||
</font><=<font face="Arial, Helvetica, sans-serif">, </font>><font face="Arial, Helvetica, sans-serif">,
|
||||
</font>>=</font></td>
|
||||
<td><font face="Arial, Helvetica, sans-serif" size="-1">compares array</font></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><font face="Arial, Helvetica, sans-serif" size="-1"><b>Values:</b></font></td>
|
||||
<td> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><font face="Courier New, Courier, mono" size="-1">static_size</font></td>
|
||||
<td><font size="-1" face="Arial, Helvetica, sans-serif">yields size at compile
|
||||
time</font></td>
|
||||
</tr>
|
||||
</table>
|
||||
<p><font face="Arial, Helvetica, sans-serif" size="-1"><a name="discussion"></a>Class
|
||||
array fulfills most but not all of the requirements of "reversible containers"
|
||||
(see Section 23.1, [lib.container.requirements] of the C++ Standard). The reasons
|
||||
array is not an reversible STL container is because: </font> <font face="Arial, Helvetica, sans-serif" size="-1"><br>
|
||||
- No constructors are provided<br>
|
||||
- Elements may have an indetermined initial value (see below)<br>
|
||||
- swap() has no constant complexity<br>
|
||||
- size() is always constant, based on the second template argument of the type<br>
|
||||
- The container provides no allocator support</font>
|
||||
<p><font face="Arial, Helvetica, sans-serif" size="-1">It doesn't fulfill the
|
||||
requirements of a "sequence" (see Section 23.1.1, [lib.sequence.reqmts]
|
||||
of the C++ Standard), except that</font> <font face="Arial, Helvetica, sans-serif" size="-1"><br>
|
||||
- front() and back() are provided<br>
|
||||
- operator[] and at() are provided</font>
|
||||
<p><font face="Arial, Helvetica, sans-serif" size="-1">Regarding the constructors
|
||||
there was an important design tradeoff: We could implement array as an "<b>aggregate</b>"
|
||||
(see Section 8.5.1, [dcl.init.aggr], of the C++ Standard). This would mean:</font></p>
|
||||
<ul>
|
||||
<li><font face="Arial, Helvetica, sans-serif" size="-1">An array can be initialized
|
||||
with a brace-enclosing, comma-separated list of initializers for the elements
|
||||
of the container, written in increasing subscript order:</font>
|
||||
<blockquote>
|
||||
<p><font face="Arial, Helvetica, sans-serif" size="-1">boost::array<int,4>
|
||||
a = { { 1, 2, 3 } };</font></p>
|
||||
</blockquote>
|
||||
<p><font face="Arial, Helvetica, sans-serif" size="-1">Note that if there
|
||||
are fewer elements in the initializer list, then each remaining element
|
||||
gets default-initialized (thus, it has a defined value).</font></p>
|
||||
</li>
|
||||
<li><font face="Arial, Helvetica, sans-serif" size="-1">However, <b>passing
|
||||
no initializer list means that the elements have an indetermined initial value</b>.</font></li>
|
||||
<li><font face="Arial, Helvetica, sans-serif" size="-1">It has no user-declared
|
||||
constructors.</font></li>
|
||||
<li><font face="Arial, Helvetica, sans-serif" size="-1">It has no private or
|
||||
protected non-static data members.</font></li>
|
||||
<li><font face="Arial, Helvetica, sans-serif" size="-1">It has no base classes.</font></li>
|
||||
<li><font face="Arial, Helvetica, sans-serif" size="-1">It has no virtual functions.</font></li>
|
||||
</ul>
|
||||
<p><font face="Arial, Helvetica, sans-serif" size="-1">The current implementation
|
||||
uses this approach. However, being able to have indeterminate initial values
|
||||
is a big drawback. So, please give me some feedback, how useful you consider
|
||||
this feature to be. This leads to the list of <b>Open issues:</b></font>
|
||||
<ul>
|
||||
<li><font face="Arial, Helvetica, sans-serif" size="-1">Do we want initializer
|
||||
list support or would the following be OK?:</font>
|
||||
<blockquote>
|
||||
<p><font face="Courier New, Courier, mono" size="-1">int data[] = { 1, 2,
|
||||
3, 4 }</font></p>
|
||||
<p><font face="Courier New, Courier, mono" size="-1">array<int,5>
|
||||
x(data); <font face="Arial, Helvetica, sans-serif">or </font> array<int,data>
|
||||
x;</font></p>
|
||||
</blockquote>
|
||||
</li>
|
||||
<li><font face="Arial, Helvetica, sans-serif" size="-1">Could "<font face="Courier New, Courier, mono">{
|
||||
</font>...<font face="Courier New, Courier, mono"> }</font>" be used
|
||||
portably instead of "<font face="Courier New, Courier, mono">{ { </font>...<font face="Courier New, Courier, mono">
|
||||
} }</font>" to initialize values?</font> </li>
|
||||
<blockquote>
|
||||
<p><font face="Arial, Helvetica, sans-serif" size="-1">8.5.1 (11) of the Standard
|
||||
seems to allow it; however, gcc 2.95.2 prints a warning message.</font></p>
|
||||
</blockquote>
|
||||
<li><font face="Arial, Helvetica, sans-serif" size="-1">Any way to have determinate
|
||||
initial values and initializer list support?</font></li>
|
||||
<li><font face="Arial, Helvetica, sans-serif" size="-1">Static_casts for reverse
|
||||
iterator stuff?</font></li>
|
||||
</ul>
|
||||
<p><font face="Arial, Helvetica, sans-serif" size="-1">I'd appreciate any constructive
|
||||
<a href="mailto:solutions@josuttis.com">feedback</a>. <b>Please note: I don't
|
||||
have time to read all boost mails. Thus, to make sure that feedback arrives
|
||||
me, please send me a copy of each mail regarding this class.</b></font>
|
||||
<p><font face="Arial, Helvetica, sans-serif"><a name="code"></a>The code is provided
|
||||
"as is" without expressed or implied warranty.</font>
|
||||
<p><font face="Arial, Helvetica, sans-serif"><b>array.hpp</b>, the implementation
|
||||
of <font face="Courier New, Courier, mono">array<></font><b>:</b> </font>
|
||||
<li><font face="Arial, Helvetica, sans-serif">
|
||||
<a href="array.hpp.html">as HTML file</a></font></li>
|
||||
<li><font face="Arial, Helvetica, sans-serif">
|
||||
<a href="../../boost/array.hpp">as plain file</a></font></li>
|
||||
<p> <font face="Arial, Helvetica, sans-serif">Simple Example for using <font face="Courier New, Courier, mono">array<><font face="Arial, Helvetica, sans-serif">:</font></font></font>
|
||||
<li><font face="Arial, Helvetica, sans-serif">
|
||||
<a href="array1.cpp.html">as HTML file</a></font> </li>
|
||||
<li><font face="Arial, Helvetica, sans-serif">
|
||||
<a href="array1.cpp">as plain file</a></font></li>
|
||||
<p> <font face="Arial, Helvetica, sans-serif">Another Example for using <font face="Courier New, Courier, mono">array<><font face="Arial, Helvetica, sans-serif">:</font></font></font>
|
||||
<li><font face="Arial, Helvetica, sans-serif">
|
||||
<a href="array2.cpp.html">as HTML file</a></font></li>
|
||||
<li><font face="Arial, Helvetica, sans-serif">
|
||||
<a href="array2.cpp">as plain file</a></font></li>
|
||||
<p> <font face="Arial, Helvetica, sans-serif">A third Example for using <font face="Courier New, Courier, mono">array<><font face="Arial, Helvetica, sans-serif">:</font></font></font>
|
||||
<li><font face="Arial, Helvetica, sans-serif">
|
||||
<a href="array3.cpp.html">as HTML file</a></font></li>
|
||||
<li><font face="Arial, Helvetica, sans-serif">
|
||||
<a href="array3.cpp">as plain file</a></font></li>
|
||||
<p> <font face="Arial, Helvetica, sans-serif">An Example for using <font face="Courier New, Courier, mono">array</font>s
|
||||
of <font face="Courier New, Courier, mono">array</font>s<font face="Courier New, Courier, mono"><font face="Arial, Helvetica, sans-serif">:</font></font></font>
|
||||
<li><font face="Arial, Helvetica, sans-serif"> <a href="array4.cpp.html">as HTML
|
||||
file</a></font></li>
|
||||
<li><font face="Arial, Helvetica, sans-serif"> <a href="array4.cpp">as plain file</a></font></li>
|
||||
<p><font face="Arial, Helvetica, sans-serif">An Example for testing other operations
|
||||
of <font face="Courier New, Courier, mono">array<></font><font face="Courier New, Courier, mono"><font face="Arial, Helvetica, sans-serif">:</font></font></font>
|
||||
<li><font face="Arial, Helvetica, sans-serif"> <a href="array5.cpp.html">as HTML
|
||||
file</a></font></li>
|
||||
<li><font face="Arial, Helvetica, sans-serif"> <a href="array5.cpp">as plain file</a></font></li>
|
||||
<p><b><font face="Arial, Helvetica, sans-serif">All files</font></b>
|
||||
<li><font face="Arial, Helvetica, sans-serif"> <a href="array.zip">as ZIP file
|
||||
(24KB)</a></font></li>
|
||||
<li><font face="Arial, Helvetica, sans-serif"> <a href="array.tgz">as TGZ file
|
||||
(13KB)</a><br>
|
||||
<br>
|
||||
To find more details about using ordinary arrays in C++ and the framework of
|
||||
the STL, see e.g.</font> <font face="Arial, Helvetica, sans-serif"><br>
|
||||
<i> <a href="http://www.josuttis.com/libbook/">The C++
|
||||
Standard Library - A Tutorial and Reference</a></i> <br>
|
||||
by <a href="http://www.josuttis.com" target="_top">Nicolai
|
||||
M. Josuttis</a></font> <font face="Arial, Helvetica, sans-serif"><br>
|
||||
Addison Wesley Longman, 1999</font> <font face="Arial, Helvetica, sans-serif"><br>
|
||||
ISBN 0-201-37926-0</font> <font face="Arial, Helvetica, sans-serif"><br>
|
||||
</font></li>
|
||||
<p><font face="Arial, Helvetica, sans-serif"><a href="http://www.josuttis.com/" TARGET="_top">Home
|
||||
Page of Nicolai Josuttis</a></font><font face="Arial, Helvetica, sans-serif">
|
||||
</font>
|
||||
<p><font size="-1" face="Arial, Helvetica, sans-serif">[<a href="#intro">intro</a>]
|
||||
[<a href="#interface">interface</a>] [<a href="#discussion">discussion</a>]
|
||||
[<a href="#code">code</a>]</font>
|
||||
<p><font face="Arial, Helvetica, sans-serif" size="-1"></font>
|
||||
<p><font face="Arial, Helvetica, sans-serif"> </font>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,198 @@
|
||||
/* The following code declares class array,
|
||||
* an STL container (as wrapper) for arrays of constant size.
|
||||
*
|
||||
* See
|
||||
* http://www.josuttis.com/cppcode
|
||||
* for details and the latest version.
|
||||
* See
|
||||
* http://www.boost.org/libs/array for Documentation.
|
||||
* for documentation.
|
||||
*
|
||||
* (C) Copyright Nicolai M. Josuttis 2001.
|
||||
* Distributed under the Boost Software License, Version 1.0. (See
|
||||
* accompanying file LICENSE_1_0.txt or copy at
|
||||
* http://www.boost.org/LICENSE_1_0.txt)
|
||||
*
|
||||
* 29 Jan 2004 - c_array() added, BOOST_NO_PRIVATE_IN_AGGREGATE removed (Nico Josuttis)
|
||||
* 23 Aug 2002 - fix for Non-MSVC compilers combined with MSVC libraries.
|
||||
* 05 Aug 2001 - minor update (Nico Josuttis)
|
||||
* 20 Jan 2001 - STLport fix (Beman Dawes)
|
||||
* 29 Sep 2000 - Initial Revision (Nico Josuttis)
|
||||
*
|
||||
* Jan 29, 2004
|
||||
*/
|
||||
#ifndef BOOST_ARRAY_HPP
|
||||
#define BOOST_ARRAY_HPP
|
||||
|
||||
#include <cstddef>
|
||||
#include <stdexcept>
|
||||
#include <boost/assert.hpp>
|
||||
|
||||
// Handles broken standard libraries better than <iterator>
|
||||
#include <boost/detail/iterator.hpp>
|
||||
#include <algorithm>
|
||||
|
||||
// FIXES for broken compilers
|
||||
#include <boost/config.hpp>
|
||||
|
||||
|
||||
namespace boost {
|
||||
|
||||
template<class T, std::size_t N>
|
||||
class array {
|
||||
public:
|
||||
T elems[N]; // fixed-size array of elements of type T
|
||||
|
||||
public:
|
||||
// type definitions
|
||||
typedef T value_type;
|
||||
typedef T* iterator;
|
||||
typedef const T* const_iterator;
|
||||
typedef T& reference;
|
||||
typedef const T& const_reference;
|
||||
typedef std::size_t size_type;
|
||||
typedef std::ptrdiff_t difference_type;
|
||||
|
||||
// iterator support
|
||||
iterator begin() { return elems; }
|
||||
const_iterator begin() const { return elems; }
|
||||
iterator end() { return elems+N; }
|
||||
const_iterator end() const { return elems+N; }
|
||||
|
||||
// reverse iterator support
|
||||
#if !defined(BOOST_NO_TEMPLATE_PARTIAL_SPECIALIZATION) && !defined(BOOST_MSVC_STD_ITERATOR) && !defined(BOOST_NO_STD_ITERATOR_TRAITS)
|
||||
typedef std::reverse_iterator<iterator> reverse_iterator;
|
||||
typedef std::reverse_iterator<const_iterator> const_reverse_iterator;
|
||||
#elif defined(_MSC_VER) && (_MSC_VER == 1300) && defined(BOOST_DINKUMWARE_STDLIB) && (BOOST_DINKUMWARE_STDLIB == 310)
|
||||
// workaround for broken reverse_iterator in VC7
|
||||
typedef std::reverse_iterator<std::_Ptrit<value_type, difference_type, iterator,
|
||||
reference, iterator, reference> > reverse_iterator;
|
||||
typedef std::reverse_iterator<std::_Ptrit<value_type, difference_type, const_iterator,
|
||||
const_reference, iterator, reference> > const_reverse_iterator;
|
||||
#else
|
||||
// workaround for broken reverse_iterator implementations
|
||||
typedef std::reverse_iterator<iterator,T> reverse_iterator;
|
||||
typedef std::reverse_iterator<const_iterator,T> const_reverse_iterator;
|
||||
#endif
|
||||
|
||||
reverse_iterator rbegin() { return reverse_iterator(end()); }
|
||||
const_reverse_iterator rbegin() const {
|
||||
return const_reverse_iterator(end());
|
||||
}
|
||||
reverse_iterator rend() { return reverse_iterator(begin()); }
|
||||
const_reverse_iterator rend() const {
|
||||
return const_reverse_iterator(begin());
|
||||
}
|
||||
|
||||
// operator[]
|
||||
reference operator[](size_type i)
|
||||
{
|
||||
BOOST_ASSERT( i < N && "out of range" );
|
||||
return elems[i];
|
||||
}
|
||||
|
||||
const_reference operator[](size_type i) const
|
||||
{
|
||||
BOOST_ASSERT( i < N && "out of range" );
|
||||
return elems[i];
|
||||
}
|
||||
|
||||
// at() with range check
|
||||
reference at(size_type i) { rangecheck(i); return elems[i]; }
|
||||
const_reference at(size_type i) const { rangecheck(i); return elems[i]; }
|
||||
|
||||
// front() and back()
|
||||
reference front()
|
||||
{
|
||||
return elems[0];
|
||||
}
|
||||
|
||||
const_reference front() const
|
||||
{
|
||||
return elems[0];
|
||||
}
|
||||
|
||||
reference back()
|
||||
{
|
||||
return elems[N-1];
|
||||
}
|
||||
|
||||
const_reference back() const
|
||||
{
|
||||
return elems[N-1];
|
||||
}
|
||||
|
||||
// size is constant
|
||||
static size_type size() { return N; }
|
||||
static bool empty() { return false; }
|
||||
static size_type max_size() { return N; }
|
||||
enum { static_size = N };
|
||||
|
||||
// swap (note: linear complexity)
|
||||
void swap (array<T,N>& y) {
|
||||
std::swap_ranges(begin(),end(),y.begin());
|
||||
}
|
||||
|
||||
// direct access to data (read-only)
|
||||
const T* data() const { return elems; }
|
||||
|
||||
// use array as C array (direct read/write access to data)
|
||||
T* c_array() { return elems; }
|
||||
|
||||
// assignment with type conversion
|
||||
template <typename T2>
|
||||
array<T,N>& operator= (const array<T2,N>& rhs) {
|
||||
std::copy(rhs.begin(),rhs.end(), begin());
|
||||
return *this;
|
||||
}
|
||||
|
||||
// assign one value to all elements
|
||||
void assign (const T& value)
|
||||
{
|
||||
std::fill_n(begin(),size(),value);
|
||||
}
|
||||
|
||||
// check range (may be private because it is static)
|
||||
static void rangecheck (size_type i) {
|
||||
if (i >= size()) {
|
||||
throw std::range_error("array<>: index out of range");
|
||||
}
|
||||
}
|
||||
|
||||
};
|
||||
|
||||
// comparisons
|
||||
template<class T, std::size_t N>
|
||||
bool operator== (const array<T,N>& x, const array<T,N>& y) {
|
||||
return std::equal(x.begin(), x.end(), y.begin());
|
||||
}
|
||||
template<class T, std::size_t N>
|
||||
bool operator< (const array<T,N>& x, const array<T,N>& y) {
|
||||
return std::lexicographical_compare(x.begin(),x.end(),y.begin(),y.end());
|
||||
}
|
||||
template<class T, std::size_t N>
|
||||
bool operator!= (const array<T,N>& x, const array<T,N>& y) {
|
||||
return !(x==y);
|
||||
}
|
||||
template<class T, std::size_t N>
|
||||
bool operator> (const array<T,N>& x, const array<T,N>& y) {
|
||||
return y<x;
|
||||
}
|
||||
template<class T, std::size_t N>
|
||||
bool operator<= (const array<T,N>& x, const array<T,N>& y) {
|
||||
return !(y<x);
|
||||
}
|
||||
template<class T, std::size_t N>
|
||||
bool operator>= (const array<T,N>& x, const array<T,N>& y) {
|
||||
return !(x<y);
|
||||
}
|
||||
|
||||
// global swap()
|
||||
template<class T, std::size_t N>
|
||||
inline void swap (array<T,N>& x, array<T,N>& y) {
|
||||
x.swap(y);
|
||||
}
|
||||
|
||||
} /* namespace boost */
|
||||
|
||||
#endif /*BOOST_ARRAY_HPP*/
|
||||
Reference in New Issue
Block a user