mirror of
https://github.com/boostorg/ublas.git
synced 2026-02-11 12:12:29 +00:00
216 lines
10 KiB
HTML
216 lines
10 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii" />
|
|
<link href="ublas.css" type="text/css" />
|
|
<title>Bounded Array;</title>
|
|
</head>
|
|
<body>
|
|
<h1><img src="../../../../boost.png" align="middle" />
|
|
Array Storage</h1>
|
|
<h2><a name="array_adaptor" id="array_adaptor"></a>Array Adaptor</h2>
|
|
<h4>Description</h4>
|
|
<p>The templated class <code>carray_adaptor<T></code> implements a storage array using a pointer to an existing memory buffer (a C array for example). The storage specified array size must never exceed the size of the memory buffer.</p>
|
|
<p><code>carray_adaptor</code> defines <code>size_type</code> as <code>size_t</code> and <code>difference_type</code> as <code>std::ptrdiff_t</code>.
|
|
</p>
|
|
<h4>Example</h4>
|
|
<pre>
|
|
#include <boost/numeric/ublas/storage.hpp>
|
|
|
|
int main () {
|
|
using namespace boost::numeric::ublas;
|
|
double aarray[10];
|
|
carray_adaptor<double> a (aarray, 3);
|
|
for (unsigned i = 0; i < a.size (); ++ i) {
|
|
a [i] = i;
|
|
std::cout << a [i] << std::endl;
|
|
}
|
|
}
|
|
</pre>
|
|
<h4>Definition</h4>
|
|
<p>Defined in the header storage.hpp.</p>
|
|
<h4>Template parameters</h4>
|
|
<table border="1" summary="parameters">
|
|
<tbody>
|
|
<tr>
|
|
<th>Parameter</th>
|
|
<th>Description</th>
|
|
<th>Default</th>
|
|
</tr>
|
|
<tr>
|
|
<td><code>T</code></td>
|
|
<td>The type of object stored in the array.</td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h4>Model of</h4>
|
|
<p><a href="storage_concept.htm">Storage</a> but NOT Copy Constructable</p>
|
|
<h4>Type requirements</h4>
|
|
<p>None, except for those imposed by the requirements of Storage.</p>
|
|
<h4>Public base classes</h4>
|
|
<p>None.</p>
|
|
<h4>Members</h4>
|
|
<ul>
|
|
<li>The description does not describe what the member actually does, this can be looked up
|
|
in the corresponding concept documentation, but instead contains a remark on the implementation of the
|
|
member inside this model of the concept.</li>
|
|
<li>Typography:
|
|
<ul>
|
|
<li>Members that are not part of the implemented concepts are <font color="blue">in blue</font>.</li>
|
|
<li>Differences compared to the concept are <font color="red">in red</font>.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<table border="1" summary="members">
|
|
<tbody>
|
|
<tr>
|
|
<th>Member</th>
|
|
<th>Where defined</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
<tr><td><code>value_type</code></td><td><a href="http://www.sgi.com/tech/stl/Container.html">Container</a></td><td></tr>
|
|
<tr><td><code>pointer</code></td><td><a href="http://www.sgi.com/tech/stl/Container.html">Container</a></td><td>Defined as <code>value_type*</code></td></tr>
|
|
<tr><td><code>const_pointer</code></td><td><a href="http://www.sgi.com/tech/stl/Container.html">Container</a></td><td>Defined as <code>const value_type*</code></td></tr>
|
|
<tr><td><code>reference</code></td><td><a href="http://www.sgi.com/tech/stl/Container.html">Container</a></td><td>Defined as <code>value_type&</code></td></tr>
|
|
<tr><td><code>const_reference</code></td><td><a href="http://www.sgi.com/tech/stl/Container.html">Container</a></td><td>Defined as <code>const value_type&</code></td></tr>
|
|
<tr><td><code>size_type</code></td><td><a href="http://www.sgi.com/tech/stl/Container.html">Container</a></td><td>Defined as <code>Alloc::size_type</code></td></tr>
|
|
<tr><td><code>difference_type</code></td><td><a href="http://www.sgi.com/tech/stl/Container.html">Container</a></td><td>Defined as <code>Alloc::difference_type</code></td></tr>
|
|
<tr><td><code>iterator</code></td><td><a href="http://www.sgi.com/tech/stl/Container.html">Container</a></td><td>Defined as <code>pointer</code></td></tr>
|
|
<tr><td><code>const_iterator</code></td><td><a href="http://www.sgi.com/tech/stl/Container.html">Container</a></td><td>Defined as <code>const_pointer</code></td></tr>
|
|
<tr><td><code>revere_iterator</code></td><td><a href="http://www.sgi.com/tech/stl/Container.html">Container</a></td><td>Defined as <code>std::reverse_iterator<iterator></code></td></tr>
|
|
<tr><td><code>const_revere_iterator</code></td><td><a href="http://www.sgi.com/tech/stl/Container.html">Container</a></td><td>Defined as <code>std::reverse_iterator<const_iterator></code></td></tr>
|
|
<tr>
|
|
<td><code>carray_adaptor ()</code></td>
|
|
<td><a href="storage_concept.htm">Storage</a></td>
|
|
<td>Creates an <code>carray_adaptor</code> that holds <strong>zero</strong> elements.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><font color="Red"><code>carray_adaptor (size_type size)</code></font></td>
|
|
<td><a href="storage_concept.htm">Storage</a>
|
|
<td>The size-constructor is undefined. A <code>carray_adaptor</code> cannot be constructed like this as a memory buffer cannot
|
|
be specifed in this context.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><font color="Red"><code>carray_adaptor (size_type size, const T& init)</code></font></td>
|
|
<td><a href="storage_concept.htm">Storage</a>
|
|
<td>The fill-constructor is undefined. A <code>carray_adaptor</code> cannot be constructed like this as a memory buffer cannot
|
|
be specifed in this context.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>bounded_array (size_type size, pointer data)</code></td>
|
|
<td><a href="storage_concept.htm">Storage</a></td>
|
|
<td>Creates a uninitialized <code>bounded_array</code> that holds <code>size</code> elements from the memory buffer <code>data</code>. All the elements are default constructed.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>bounded_array (size_type size, pointer data, const T& init)</code></td>
|
|
<td><a href="storage_concept.htm">Storage</a></td>
|
|
<td>Creates an initialized <code>bounded_array</code> that holds <code>size</code> elements from the memory buffer <code>data</code>. All the elements are constructed from the <code>init</code> value.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><font color="Red"><code>carray_adaptor (const carray_adaptor &c)</code></font></td>
|
|
<td><a href="http://www.sgi.com/tech/stl/Container.html">Container</a></td>
|
|
<td>The copy constructor is private and undefined. A <code>carray_adaptor</code> cannot be constructed like this as a memory buffer cannot
|
|
be specifed in this context.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>~carray_adaptor ()</code></td>
|
|
<td><a href="http://www.sgi.com/tech/stl/Container.html">Container</a></td>
|
|
<td>Deallocates the <code>carray_adaptor</code> itself.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>void resize (size_type size)</code></td>
|
|
<td><a href="storage_concept.htm">Storage</a>
|
|
<td>Reallocates a <code>carray_adaptor</code> to hold <code>size</code> elements.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>void resize (size_type size, const T& t)</code></td>
|
|
<td><a href="storage_concept.htm">Storage</a>
|
|
<td>Reallocates a <code>carray_adaptor</code> to hold <code>size</code> elements.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>void resize (size_type size pointer data)</code></td>
|
|
<td><a href="storage_concept.htm">Storage</a>
|
|
<td>Reallocates a <code>carray_adaptor</code> to hold <code>size</code> elements.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>void resize (size_type size pointer data, const T& t)</code></td>
|
|
<td><a href="storage_concept.htm">Storage</a>
|
|
<td>Reallocates a <code>carray_adaptor</code> to hold <code>size</code> elements.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>size_type size () const</code></td>
|
|
<td><a href="http://www.sgi.com/tech/stl/Container.html">Container</a></td>
|
|
<td>Returns the size of the <code>carray_adaptor</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>const_reference operator [] (size_type i) const</code></td>
|
|
<td><a href="http://www.sgi.com/tech/stl/Container.html">Container</a></td>
|
|
<td>Returns a <code>const</code> reference of the <code>i</code> -th element.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>reference operator [] (size_type i)</code></td>
|
|
<td><a href="http://www.sgi.com/tech/stl/Container.html">Container</a></td>
|
|
<td>Returns a reference of the <code>i</code>-th element.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>carray_adaptor &operator = (const carray_adaptor &a)</code></td>
|
|
<td><a href="http://www.sgi.com/tech/stl/Container.html">Container</a></td>
|
|
<td>The assignment operator.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><font color="blue"><code>carray_adaptor &assign_temporary (carray_adaptor &a)</code></font></td>
|
|
<td></td>
|
|
<td>Assigns a temporary. May change the array <code>a</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>void swap (carray_adaptor &a)</code></td>
|
|
<td><a href="http://www.sgi.com/tech/stl/Container.html">Container</a></td>
|
|
<td>Swaps the contents of the arrays.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>const_iterator begin () const</code></td>
|
|
<td><a href="http://www.sgi.com/tech/stl/Container.html">Container</a></td>
|
|
<td>Returns a <code>const_iterator</code> pointing to the beginning of the <code>carray_adaptor</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>const_iterator end () const</code></td>
|
|
<td><a href="http://www.sgi.com/tech/stl/Container.html">Container</a></td>
|
|
<td>Returns a <code>const_iterator</code> pointing to the end of the <code>carray_adaptor</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>iterator begin ()</code></td>
|
|
<td><a href="http://www.sgi.com/tech/stl/Container.html">Container</a></td>
|
|
<td>Returns a <code>iterator</code> pointing to the beginning of the <code>carray_adaptor</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>iterator end ()</code></td>
|
|
<td><a href="http://www.sgi.com/tech/stl/Container.html">Container</a></td>
|
|
<td>Returns a <code>iterator</code> pointing to the end of the <code>carray_adaptor</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>const_reverse_iterator rbegin () const</code></td>
|
|
<td><a href="http://www.sgi.com/tech/stl/ReversibleContainer.html">Reversible Container</a></td>
|
|
<td>Returns a <code>const_reverse_iterator</code> pointing to the beginning of the reversed <code>carray_adaptor</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>const_reverse_iterator rend () const</code></td>
|
|
<td><a href="http://www.sgi.com/tech/stl/ReversibleContainer.html">Reversible Container</a></td>
|
|
<td>Returns a <code>const_reverse_iterator</code> pointing to the end of the reversed <code>carray_adaptor</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>reverse_iterator rbegin ()</code></td>
|
|
<td><a href="http://www.sgi.com/tech/stl/ReversibleContainer.html">Reversible Container</a></td>
|
|
<td>Returns a <code>reverse_iterator</code> pointing to the beginning of the reversed <code>carray_adaptor</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>reverse_iterator rend ()</code></td>
|
|
<td><a href="http://www.sgi.com/tech/stl/ReversibleContainer.html">Reversible Container</a></td>
|
|
<td>Returns a <code>reverse_iterator</code> pointing to the end of the reversed <code>carray_adaptor</code>.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</body>
|
|
</html>
|