mirror of
https://github.com/boostorg/ublas.git
synced 2026-02-22 03:42:19 +00:00
merged doc in uBLAS CVS to boost CVS
This commit is contained in:
Toon Knapen
@@ -10,7 +10,7 @@
|
||||
<title>Banded Matrix</title>
|
||||
</head>
|
||||
<body>
|
||||
<h1><img src="../../../../boost.png" alt="boost.png" align="middle" />
|
||||
<h1><img src="c++boost.gif" alt="c++boost.gif" align="middle" />
|
||||
Banded Matrix</h1>
|
||||
<h2><a name="banded_matrix" id="banded_matrix"></a> Banded
|
||||
Matrix</h2>
|
||||
@@ -352,11 +352,11 @@ int main () {
|
||||
</tbody>
|
||||
</table>
|
||||
<h4>Model of</h4>
|
||||
<p><a href="expression.htm#matrix_expression">Matrix Expression</a>
|
||||
<p><a href="expression_concept.htm#matrix_expression">Matrix Expression</a>
|
||||
.</p>
|
||||
<h4>Type requirements</h4>
|
||||
<p>None, except for those imposed by the requirements of <a href=
|
||||
"expression.htm#matrix_expression">Matrix Expression</a> .</p>
|
||||
"expression_concept.htm#matrix_expression">Matrix Expression</a> .</p>
|
||||
<h4>Public base classes</h4>
|
||||
<p><code>matrix_expression<banded_adaptor<M>
|
||||
></code></p>
|
||||
|
||||
@@ -10,7 +10,7 @@
|
||||
<title>Hermitian Matrix</title>
|
||||
</head>
|
||||
<body>
|
||||
<h1><img src="../../../../boost.png" alt="boost.png" align="middle" />
|
||||
<h1><img src="c++boost.gif" alt="c++boost.gif" align="middle" />
|
||||
Hermitian Matrix</h1>
|
||||
<h2><a name="hermitian_matrix" id="hermitian_matrix"></a> Hermitian
|
||||
Matrix</h2>
|
||||
@@ -374,11 +374,11 @@ int main () {
|
||||
</tbody>
|
||||
</table>
|
||||
<h4>Model of</h4>
|
||||
<p><a href="expression.htm#matrix_expression">Matrix Expression</a>
|
||||
<p><a href="expression_concept.htm#matrix_expression">Matrix Expression</a>
|
||||
.</p>
|
||||
<h4>Type requirements</h4>
|
||||
<p>None, except for those imposed by the requirements of <a href=
|
||||
"expression.htm#matrix_expression">Matrix Expression</a> .</p>
|
||||
"expression_concept.htm#matrix_expression">Matrix Expression</a> .</p>
|
||||
<h4>Public base classes</h4>
|
||||
<p><code>matrix_expression<hermitian_adaptor<M, F>
|
||||
></code></p>
|
||||
|
||||
@@ -10,7 +10,7 @@
|
||||
<title>Boost Basic Linear Algebra</title>
|
||||
</head>
|
||||
<body>
|
||||
<h1><img src="../../../../boost.png" alt="boost.png" align="middle" />
|
||||
<h1><img src="c++boost.gif" alt="c++boost.gif" align="middle" />
|
||||
Basic Linear Algebra</h1>
|
||||
<p>uBLAS is a C++ template class library that provides <a href=
|
||||
"http://www.netlib.org/blas">BLAS</a> level 1, 2, 3 functionality
|
||||
@@ -46,51 +46,38 @@ suite.</p>
|
||||
<li><a href="operations_overview.htm">Overview of Matrix and Vector Operations</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href="expression.htm">Expression Concepts</a>
|
||||
<li>uBLAS Concept definitions
|
||||
<ul>
|
||||
<li><a href="expression.htm#scalar_expression">Scalar
|
||||
<li><a href="container_concept.htm">Container Concepts</a>
|
||||
<ul>
|
||||
<li><a href="container_concept.htm#vector">Vector</a></li>
|
||||
<li><a href="container_concept.htm#matrix">Matrix</a></li>
|
||||
</ul>
|
||||
<li><a href="expression_concept.htm">Expression Concepts</a>
|
||||
<ul>
|
||||
<li><a href="expression_concept.htm#scalar_expression">Scalar
|
||||
Expression</a></li>
|
||||
<li><a href="expression.htm#vector_expression">Vector
|
||||
<li><a href="expression_concept.htm#vector_expression">Vector
|
||||
Expression</a></li>
|
||||
<li><a href="expression.htm#matrix_expression">Matrix
|
||||
<li><a href="expression_concept.htm#matrix_expression">Matrix
|
||||
Expression</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href="container.htm">Container Concepts</a>
|
||||
<li><a href="storage_concept.htm">Storage Concept</a>
|
||||
<li><a href="iterator_concept.htm">Iterator Concepts</a>
|
||||
<ul>
|
||||
<li><a href="container.htm#vector">Vector</a></li>
|
||||
<li><a href="container.htm#matrix">Matrix</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href="iterator.htm">Iterator Concepts</a>
|
||||
<ul>
|
||||
<li><a href="iterator.htm#indexed_bidirectional_iterator">Indexed
|
||||
<li><a href="iterator_concept.htm#indexed_bidirectional_iterator">Indexed
|
||||
Bidirectional Iterator</a></li>
|
||||
<li><a href="iterator.htm#indexed_random_access_iterator">Indexed
|
||||
<li><a href="iterator_concept.htm#indexed_random_access_iterator">Indexed
|
||||
Random Access Iterator</a></li>
|
||||
<li><a href=
|
||||
"iterator.htm#indexed_bidirectional_cr_iterator">Indexed
|
||||
"iterator_concept.htm#indexed_bidirectional_cr_iterator">Indexed
|
||||
Bidirectional Column/Row Iterator</a></li>
|
||||
<li><a href=
|
||||
"iterator.htm#indexed_random_access_cr_iterator">Indexed Random
|
||||
"iterator_concept.htm#indexed_random_access_cr_iterator">Indexed Random
|
||||
Access Column/Row Iterator</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href="storage.htm">Storage</a>
|
||||
<ul>
|
||||
<li><a href="storage.htm#unbounded_array">Unbounded Array</a></li>
|
||||
<li><a href="storage.htm#bounded_array">Bounded Array</a></li>
|
||||
<li><a href="storage.htm#range">Range</a></li>
|
||||
<li><a href="storage.htm#slice">Slice</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href="storage_sparse.htm">Sparse Storage</a>
|
||||
<ul>
|
||||
<li><a href="storage_sparse.htm#map_std">Default Standard
|
||||
Map</a></li>
|
||||
<li><a href="storage_sparse.htm#map_array">Map Array</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href="vector.htm">Vector</a>
|
||||
<ul>
|
||||
<li><a href="vector.htm#vector">Vector</a></li>
|
||||
@@ -115,15 +102,15 @@ Vector</a></li>
|
||||
<li><a href="vector_proxy.htm#vector_slice">Vector Slice</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href="vector_expression.htm">Vector Expressions</a>
|
||||
<li><a href="vector_expression_concept.htm">Vector Expressions</a>
|
||||
<ul>
|
||||
<li><a href="vector_expression.htm#vector_expression">Vector
|
||||
<li><a href="vector_expression_concept.htm#vector_expression">Vector
|
||||
Expression</a></li>
|
||||
<li><a href="vector_expression.htm#vector_references">Vector
|
||||
<li><a href="vector_expression_concept.htm#vector_references">Vector
|
||||
References</a></li>
|
||||
<li><a href="vector_expression.htm#vector_operations">Vector
|
||||
<li><a href="vector_expression_concept.htm#vector_operations">Vector
|
||||
Operations</a></li>
|
||||
<li><a href="vector_expression.htm#vector_reductions">Vector
|
||||
<li><a href="vector_expression_concept.htm#vector_reductions">Vector
|
||||
Reductions</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
@@ -185,20 +172,35 @@ Matrix</a></li>
|
||||
<li><a href="matrix_proxy.htm#matrix_slice">Matrix Slice</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href="matrix_expression.htm">Matrix Expressions</a>
|
||||
<li><a href="matrix_expression_concept.htm">Matrix Expressions</a>
|
||||
<ul>
|
||||
<li><a href="matrix_expression.htm#matrix_expression">Matrix
|
||||
<li><a href="matrix_expression_concept.htm#matrix_expression">Matrix
|
||||
Expression</a></li>
|
||||
<li><a href="matrix_expression.htm#matrix_references">Matrix
|
||||
<li><a href="matrix_expression_concept.htm#matrix_references">Matrix
|
||||
References</a></li>
|
||||
<li><a href="matrix_expression.htm#matrix_operations">Matrix
|
||||
<li><a href="matrix_expression_concept.htm#matrix_operations">Matrix
|
||||
Operations</a></li>
|
||||
<li><a href="matrix_expression.htm#matrix_vector_operations">Matrix
|
||||
<li><a href="matrix_expression_concept.htm#matrix_vector_operations">Matrix
|
||||
Vector Operations</a></li>
|
||||
<li><a href="matrix_expression.htm#matrix_matrix_operations">Matrix
|
||||
<li><a href="matrix_expression_concept.htm#matrix_matrix_operations">Matrix
|
||||
Matrix Operations</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>Storage
|
||||
<ul>
|
||||
<li><a href="unbounded_array.htm">Unbounded Array</a></li>
|
||||
<li><a href="bounded_array.htm">Bounded Array</a></li>
|
||||
<li><a href="range.htm#range">Range</a></li>
|
||||
<li><a href="range.htm#slice">Slice</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href="storage_sparse.htm">Sparse Storage</a>
|
||||
<ul>
|
||||
<li><a href="storage_sparse.htm#map_std">Default Standard
|
||||
Map</a></li>
|
||||
<li><a href="storage_sparse.htm#map_array">Map Array</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>Operations & Functions
|
||||
<ul>
|
||||
<li><a href="products.htm">Special Products</a></li>
|
||||
@@ -208,14 +210,14 @@ Matrix Operations</a></li>
|
||||
</ul>
|
||||
<h2>Supported Platforms</h2>
|
||||
<p>The original development platform for uBLAS we used MSVC 6.0
|
||||
with Dinkumware STL. Other compilers known to accept the library
|
||||
are</p>
|
||||
with Dinkumware STL. Compilers known to accept the library
|
||||
are:</p>
|
||||
<ul>
|
||||
<li>MSVC 6.0 with STLPort-4.5.3, 7.0, 7.1</li>
|
||||
<li>GCC 2.95.x, 3.0.x, 3.1.x, 3.2.x, 3.3.x, 3.4.x</li>
|
||||
<li>ICC 7.0, 7.1 8.0</li>
|
||||
<li>ICC 7.0, 7.1, 8.0, 8.1</li>
|
||||
<li>Comeau 4.2.x</li>
|
||||
<li>MWCW</li>
|
||||
<li>MWCW 8.3, 9.3</li>
|
||||
</ul>
|
||||
<p>For possible problems please consider to consult the Boost
|
||||
regression tests.</p>
|
||||
@@ -228,8 +230,8 @@ regression tests.</p>
|
||||
"http://www.crystalclearsoftware.com/cgi-bin/boost_wiki/wiki.pl?Effective_UBLAS">
|
||||
Effective uBLAS</a> wiki for up to date information and
|
||||
contributions.</p>
|
||||
<p>There is also an active uBLAS <a href=
|
||||
"http://lists.boost.org/">mailing list</a> where uBLAS specific
|
||||
<p>There is also an active uBLAS development <a href=
|
||||
"http://groups.yahoo.com/group/ublas-dev">mailing list</a> where
|
||||
user and development questions are answered.</p>
|
||||
<h3>uBLAS and Boost Project</h3>
|
||||
<p>uBLAS development takes place via a two tier structure. Active
|
||||
|
||||
@@ -10,7 +10,7 @@
|
||||
<title>Matrix</title>
|
||||
</head>
|
||||
<body>
|
||||
<h1><img src="../../../../boost.png" alt="boost.png" align="middle" />
|
||||
<h1><img src="c++boost.gif" alt="c++boost.gif" align="middle" />
|
||||
Matrix</h1>
|
||||
<h2><a name="matrix" id="matrix"></a> Matrix</h2>
|
||||
<h4>Description</h4>
|
||||
@@ -332,11 +332,11 @@ int main () {
|
||||
</tbody>
|
||||
</table>
|
||||
<h4>Model of</h4>
|
||||
<p><a href="expression.htm#matrix_expression">Matrix Expression</a>
|
||||
<p><a href="expression_concept.htm#matrix_expression">Matrix Expression</a>
|
||||
.</p>
|
||||
<h4>Type requirements</h4>
|
||||
<p>None, except for those imposed by the requirements of <a href=
|
||||
"expression.htm#matrix_expression">Matrix Expression</a> .</p>
|
||||
"expression_concept.htm#matrix_expression">Matrix Expression</a> .</p>
|
||||
<h4>Public base classes</h4>
|
||||
<p><code>matrix_expression<identity_matrix<T>
|
||||
></code></p>
|
||||
@@ -476,11 +476,11 @@ int main () {
|
||||
</tbody>
|
||||
</table>
|
||||
<h4>Model of</h4>
|
||||
<p><a href="expression.htm#matrix_expression">Matrix Expression</a>
|
||||
<p><a href="expression_concept.htm#matrix_expression">Matrix Expression</a>
|
||||
.</p>
|
||||
<h4>Type requirements</h4>
|
||||
<p>None, except for those imposed by the requirements of <a href=
|
||||
"expression.htm#matrix_expression">Matrix Expression</a> .</p>
|
||||
"expression_concept.htm#matrix_expression">Matrix Expression</a> .</p>
|
||||
<h4>Public base classes</h4>
|
||||
<p><code>matrix_expression<zero_matrix<T> ></code></p>
|
||||
<h4>Members</h4>
|
||||
@@ -619,11 +619,11 @@ int main () {
|
||||
</tbody>
|
||||
</table>
|
||||
<h4>Model of</h4>
|
||||
<p><a href="expression.htm#matrix_expression">Matrix Expression</a>
|
||||
<p><a href="expression_concept.htm#matrix_expression">Matrix Expression</a>
|
||||
.</p>
|
||||
<h4>Type requirements</h4>
|
||||
<p>None, except for those imposed by the requirements of <a href=
|
||||
"expression.htm#matrix_expression">Matrix Expression</a> .</p>
|
||||
"expression_concept.htm#matrix_expression">Matrix Expression</a> .</p>
|
||||
<h4>Public base classes</h4>
|
||||
<p><code>matrix_expression<scalar_matrix<T>
|
||||
></code></p>
|
||||
|
||||
@@ -10,7 +10,7 @@
|
||||
<title>Matrix Expressions</title>
|
||||
</head>
|
||||
<body>
|
||||
<h1><img src="../../../../boost.png" alt="boost.png" align="middle" />
|
||||
<h1><img src="c++boost.gif" alt="c++boost.gif" align="middle" />
|
||||
Matrix Expressions</h1>
|
||||
<h2><a name="matrix_expression" id="matrix_expression"></a> Matrix
|
||||
Expression</h2>
|
||||
@@ -36,7 +36,8 @@ including class <code>matrix</code> itself.</p>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4>Model of</h4>
|
||||
<p>None.</p>
|
||||
<p>None. <u>Not a Matrix Expression</u>!
|
||||
</p>
|
||||
<h4>Type requirements</h4>
|
||||
<p>None.</p>
|
||||
<h4>Public base classes</h4>
|
||||
@@ -61,104 +62,6 @@ const</code></td>
|
||||
</table>
|
||||
<h2><a name="matrix_references" id="matrix_references"></a> Matrix
|
||||
References</h2>
|
||||
<h3>Constant Reference</h3>
|
||||
<h4>Description</h4>
|
||||
<p>The templated class <code>matrix_const_reference<E></code>
|
||||
contains a constant reference to a matrix expression.</p>
|
||||
<h4>Definition</h4>
|
||||
<p>Defined in the header matrix_expression.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>E</code></td>
|
||||
<td>The type of the matrix expression.</td>
|
||||
<td> </td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4>Model of</h4>
|
||||
<p><a href="expression.htm#matrix_expression">Matrix Expression</a>
|
||||
.</p>
|
||||
<h4>Type requirements</h4>
|
||||
<p>None, except for those imposed by the requirements of <a href=
|
||||
"expression.htm#matrix_expression">Matrix Expression</a> .</p>
|
||||
<h4>Public base classes</h4>
|
||||
<p><code>matrix_expression<matrix_const_reference<E>
|
||||
></code></p>
|
||||
<h4>Members</h4>
|
||||
<table border="1" summary="members">
|
||||
<tbody>
|
||||
<tr>
|
||||
<th>Member</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>matrix_const_reference (const expression_type
|
||||
&e)</code></td>
|
||||
<td>Constructs a constant reference of the expression.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>size_type size1 () const</code></td>
|
||||
<td>Returns the number of rows.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>size_type size2 () const</code></td>
|
||||
<td>Returns the number of columns.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_reference operator () (size_type i, size_type j)
|
||||
const</code></td>
|
||||
<td>Returns the value of the <code>j</code>-th element in the
|
||||
<code>i</code>-th row.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_iterator1 begin1 () const</code></td>
|
||||
<td>Returns a <code>const_iterator1</code> pointing to the
|
||||
beginning of the expression.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_iterator1 end1 () const</code></td>
|
||||
<td>Returns a <code>const_iterator1</code> pointing to the end of
|
||||
the expression.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_iterator2 begin2 () const</code></td>
|
||||
<td>Returns a <code>const_iterator2</code> pointing to the
|
||||
beginning of the expression.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_iterator2 end2 () const</code></td>
|
||||
<td>Returns a <code>const_iterator2</code> pointing to the end of
|
||||
the expression.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_reverse_iterator1 rbegin1 () const</code></td>
|
||||
<td>Returns a <code>const_reverse_iterator1</code> pointing to the
|
||||
beginning of the reversed expression.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_reverse_iterator1 rend1 () const</code></td>
|
||||
<td>Returns a <code>const_reverse_iterator1</code> pointing to the
|
||||
end of the reversed expression.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_reverse_iterator2 rbegin2 () const</code></td>
|
||||
<td>Returns a <code>const_reverse_iterator2</code> pointing to the
|
||||
beginning of the reversed expression.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_reverse_iterator2 rend2 () const</code></td>
|
||||
<td>Returns a <code>const_reverse_iterator2</code> pointing to the
|
||||
end of the reversed expression.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Reference</h3>
|
||||
<h4>Description</h4>
|
||||
<p>The templated class <code>matrix_reference<E></code>
|
||||
@@ -181,11 +84,11 @@ contains a reference to a matrix expression.</p>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4>Model of</h4>
|
||||
<p><a href="expression.htm#matrix_expression">Matrix Expression</a>
|
||||
<p><a href="expression_concept.htm#matrix_expression">Matrix Expression</a>
|
||||
.</p>
|
||||
<h4>Type requirements</h4>
|
||||
<p>None, except for those imposed by the requirements of <a href=
|
||||
"expression.htm#matrix_expression">Matrix Expression</a> .</p>
|
||||
"expression_concept.htm#matrix_expression">Matrix Expression</a> .</p>
|
||||
<h4>Public base classes</h4>
|
||||
<p><code>matrix_expression<matrix_reference<E>
|
||||
></code></p>
|
||||
@@ -337,11 +240,11 @@ operations.</p>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4>Model of</h4>
|
||||
<p><a href="expression.htm#matrix_expression">Matrix Expression</a>
|
||||
<p><a href="expression_concept.htm#matrix_expression">Matrix Expression</a>
|
||||
.</p>
|
||||
<h4>Type requirements</h4>
|
||||
<p>None, except for those imposed by the requirements of <a href=
|
||||
"expression.htm#matrix_expression">Matrix Expression</a> .</p>
|
||||
"expression_concept.htm#matrix_expression">Matrix Expression</a> .</p>
|
||||
<h4>Public base classes</h4>
|
||||
<p><code>matrix_expression<matrix_unary1<E, F> ></code>
|
||||
and <code>matrix_expression<matrix_unary2<E, F>
|
||||
@@ -475,7 +378,7 @@ conjugate of the transpose of a matrix expression.</p>
|
||||
<h4>Type requirements</h4>
|
||||
<ul>
|
||||
<li><code>E</code> is a model of <a href=
|
||||
"expression.htm#matrix_expression">Matrix Expression</a> .</li>
|
||||
"expression_concept.htm#matrix_expression">Matrix Expression</a> .</li>
|
||||
</ul>
|
||||
<h4>Preconditions</h4>
|
||||
<p>None.</p>
|
||||
@@ -533,11 +436,11 @@ describes a binary matrix operation.</p>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4>Model of</h4>
|
||||
<p><a href="expression.htm#matrix_expression">Matrix Expression</a>
|
||||
<p><a href="expression_concept.htm#matrix_expression">Matrix Expression</a>
|
||||
.</p>
|
||||
<h4>Type requirements</h4>
|
||||
<p>None, except for those imposed by the requirements of <a href=
|
||||
"expression.htm#matrix_expression">Matrix Expression</a> .</p>
|
||||
"expression_concept.htm#matrix_expression">Matrix Expression</a> .</p>
|
||||
<h4>Public base classes</h4>
|
||||
<p><code>matrix_expression<matrix_binary<E1, E2, F>
|
||||
></code>.</p>
|
||||
@@ -642,9 +545,9 @@ matrix expressions.</p>
|
||||
<h4>Type requirements</h4>
|
||||
<ul>
|
||||
<li><code>E1</code> is a model of <a href=
|
||||
"expression.htm#matrix_expression">Matrix Expression</a> .</li>
|
||||
"expression_concept.htm#matrix_expression">Matrix Expression</a> .</li>
|
||||
<li><code>E2</code> is a model of <a href=
|
||||
"expression.htm#matrix_expression">Matrix Expression</a> .</li>
|
||||
"expression_concept.htm#matrix_expression">Matrix Expression</a> .</li>
|
||||
</ul>
|
||||
<h4>Preconditions</h4>
|
||||
<ul>
|
||||
@@ -703,11 +606,11 @@ matrix.</p>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4>Model of</h4>
|
||||
<p><a href="expression.htm#matrix_expression">Matrix Expression</a>
|
||||
<p><a href="expression_concept.htm#matrix_expression">Matrix Expression</a>
|
||||
.</p>
|
||||
<h4>Type requirements</h4>
|
||||
<p>None, except for those imposed by the requirements of <a href=
|
||||
"expression.htm#matrix_expression">Matrix Expression</a> .</p>
|
||||
"expression_concept.htm#matrix_expression">Matrix Expression</a> .</p>
|
||||
<h4>Public base classes</h4>
|
||||
<p><code>matrix_expression<matrix_binary_scalar1<E1, E2,
|
||||
F> ></code> and
|
||||
@@ -830,9 +733,9 @@ with the reciprocal of the scalar.</p>
|
||||
<h4>Type requirements</h4>
|
||||
<ul>
|
||||
<li><code>T1/T2</code> is a model of <a href=
|
||||
"expression.htm#scalar_expression">Scalar Expression</a> .</li>
|
||||
"expression_concept.htm#scalar_expression">Scalar Expression</a> .</li>
|
||||
<li><code>E2/E1</code> is a model of <a href=
|
||||
"expression.htm#matrix_expression">Matrix Expression</a> .</li>
|
||||
"expression_concept.htm#matrix_expression">Matrix Expression</a> .</li>
|
||||
</ul>
|
||||
<h4>Preconditions</h4>
|
||||
<p>None.</p>
|
||||
@@ -889,11 +792,11 @@ F></code> describe binary matrix vector operations.</p>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4>Model of</h4>
|
||||
<p><a href="expression.htm#vector_expression">Vector Expression</a>
|
||||
<p><a href="expression_concept.htm#vector_expression">Vector Expression</a>
|
||||
.</p>
|
||||
<h4>Type requirements</h4>
|
||||
<p>None, except for those imposed by the requirements of <a href=
|
||||
"expression.htm#vector_expression">Vector Expression</a> .</p>
|
||||
"expression_concept.htm#vector_expression">Vector Expression</a> .</p>
|
||||
<h4>Public base classes</h4>
|
||||
<p><code>vector_expression<matrix_vector_binary1<E1, E2,
|
||||
F> ></code> and
|
||||
@@ -1055,12 +958,12 @@ precision product of the matrix and the vector expression.</p>
|
||||
<h4>Type requirements</h4>
|
||||
<ul>
|
||||
<li><code>E1</code> is a model of <a href=
|
||||
"expression.htm#matrix_expression">Matrix Expression</a> or
|
||||
<a href="expression.htm#vector_expression">Vector Expression</a>
|
||||
"expression_concept.htm#matrix_expression">Matrix Expression</a> or
|
||||
<a href="expression_concept.htm#vector_expression">Vector Expression</a>
|
||||
.</li>
|
||||
<li><code>E2</code> is a model of <a href=
|
||||
"expression.htm#vector_expression">Vector Expression</a> or
|
||||
<a href="expression.htm#matrix_expression">Matrix Expression</a>
|
||||
"expression_concept.htm#vector_expression">Vector Expression</a> or
|
||||
<a href="expression_concept.htm#matrix_expression">Matrix Expression</a>
|
||||
.</li>
|
||||
</ul>
|
||||
<h4>Preconditions</h4>
|
||||
@@ -1160,12 +1063,12 @@ int main () {
|
||||
<h4>Type requirements</h4>
|
||||
<ul>
|
||||
<li><code>E1</code> is a model of <a href=
|
||||
"expression.htm#matrix_expression">Matrix Expression</a> or
|
||||
<a href="expression.htm#vector_expression">Vector Expression</a>
|
||||
"expression_concept.htm#matrix_expression">Matrix Expression</a> or
|
||||
<a href="expression_concept.htm#vector_expression">Vector Expression</a>
|
||||
.</li>
|
||||
<li><code>E2</code> is a model of <a href=
|
||||
"expression.htm#vector_expression">Vector Expression</a> or
|
||||
<a href="expression.htm#matrix_expression">Matrix Expression</a>
|
||||
"expression_concept.htm#vector_expression">Vector Expression</a> or
|
||||
<a href="expression_concept.htm#matrix_expression">Matrix Expression</a>
|
||||
.</li>
|
||||
</ul>
|
||||
<h4>Preconditions</h4>
|
||||
@@ -1230,11 +1133,11 @@ F></code> describes a binary matrix operation.</p>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4>Model of</h4>
|
||||
<p><a href="expression.htm#matrix_expression">Matrix Expression</a>
|
||||
<p><a href="expression_concept.htm#matrix_expression">Matrix Expression</a>
|
||||
.</p>
|
||||
<h4>Type requirements</h4>
|
||||
<p>None, except for those imposed by the requirements of <a href=
|
||||
"expression.htm#matrix_expression">Matrix Expression</a> .</p>
|
||||
"expression_concept.htm#matrix_expression">Matrix Expression</a> .</p>
|
||||
<h4>Public base classes</h4>
|
||||
<p><code>matrix_expression<matrix_matrix_binary<E1, E2, F>
|
||||
></code> .</p>
|
||||
@@ -1366,9 +1269,9 @@ product of the matrix expressions.</p>
|
||||
<h4>Type requirements</h4>
|
||||
<ul>
|
||||
<li><code>E1</code> is a model of <a href=
|
||||
"expression.htm#matrix_expression">Matrix Expression</a> .</li>
|
||||
"expression_concept.htm#matrix_expression">Matrix Expression</a> .</li>
|
||||
<li><code>E2</code> is a model of <a href=
|
||||
"expression.htm#matrix_expression">Matrix Expression</a> .</li>
|
||||
"expression_concept.htm#matrix_expression">Matrix Expression</a> .</li>
|
||||
</ul>
|
||||
<h4>Preconditions</h4>
|
||||
<ul>
|
||||
@@ -1435,9 +1338,9 @@ int main () {
|
||||
<h4>Type requirements</h4>
|
||||
<ul>
|
||||
<li><code>E1</code> is a model of <a href=
|
||||
"expression.htm#matrix_expression">Matrix Expression</a> .</li>
|
||||
"expression_concept.htm#matrix_expression">Matrix Expression</a> .</li>
|
||||
<li><code>E2</code> is a model of <a href=
|
||||
"expression.htm#matrix_expression">Matrix Expression</a> .</li>
|
||||
"expression_concept.htm#matrix_expression">Matrix Expression</a> .</li>
|
||||
</ul>
|
||||
<h4>Preconditions</h4>
|
||||
<ul>
|
||||
|
||||
@@ -10,7 +10,7 @@
|
||||
<title>Matrix Proxies</title>
|
||||
</head>
|
||||
<body>
|
||||
<h1><img src="../../../../boost.png" alt="boost.png" align="middle" />
|
||||
<h1><img src="c++boost.gif" alt="c++boost.gif" align="middle" />
|
||||
Matrix Proxies</h1>
|
||||
<h2><a name="matrix_row" id="matrix_row"></a> Matrix Row</h2>
|
||||
<h4>Description</h4>
|
||||
@@ -19,6 +19,7 @@ addressing a row of a matrix.</p>
|
||||
<h4>Example</h4>
|
||||
<pre>
|
||||
#include <boost/numeric/ublas/matrix.hpp>
|
||||
#include <boost/numeric/ublas/matrix_proxy.hpp>
|
||||
#include <boost/numeric/ublas/io.hpp>
|
||||
|
||||
int main () {
|
||||
@@ -50,7 +51,7 @@ int main () {
|
||||
</tbody>
|
||||
</table>
|
||||
<h4>Model of</h4>
|
||||
<p><a href="expression.htm#vector_expression">Vector Expression</a>
|
||||
<p><a href="expression_concept.htm#vector_expression">Vector Expression</a>
|
||||
.</p>
|
||||
<p>If the specified row falls outside that of the row index range
|
||||
of the matrix, then the <code>matrix_row</code> is not a well
|
||||
@@ -58,7 +59,7 @@ formed Vector Expression. That is, access to an element which is
|
||||
outside of the matrix is <i>undefined</i>.</p>
|
||||
<h4>Type requirements</h4>
|
||||
<p>None, except for those imposed by the requirements of <a href=
|
||||
"expression.htm#vector_expression">Vector Expression</a> .</p>
|
||||
"expression_concept.htm#vector_expression">Vector Expression</a> .</p>
|
||||
<h4>Public base classes</h4>
|
||||
<p><code>vector_expression<matrix_row<M> ></code></p>
|
||||
<h4>Members</h4>
|
||||
@@ -197,28 +198,29 @@ the reversed <code>matrix_row</code>.</td>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Projections</h3>
|
||||
<h4>Prototypes</h4>
|
||||
<pre>
|
||||
<code>template<class M>
|
||||
matrix_row<M> row (M &data, std::size_t i);
|
||||
template<class M>
|
||||
const matrix_row<const M> row (const M &data, std::size_t i);</code>
|
||||
</pre>
|
||||
<h4>Description</h4>
|
||||
<p>The free <code>row</code> functions support the construction of
|
||||
matrix rows.</p>
|
||||
<h4>Prototypes</h4>
|
||||
<pre><code>
|
||||
template<class M>
|
||||
matrix_row<M> row (M &data, std::size_t i);
|
||||
template<class M>
|
||||
const matrix_row<const M> row (const M &data, std::size_t i);
|
||||
</code></pre>
|
||||
<h4>Definition</h4>
|
||||
<p>Defined in the header matrix_proxy.hpp.</p>
|
||||
<h4>Type requirements</h4>
|
||||
<ul>
|
||||
<li><code>M</code> is a model of <a href=
|
||||
"expression.htm#matrix_expression">Matrix Expression</a> .</li>
|
||||
"expression_concept.htm#matrix_expression">Matrix Expression</a> .</li>
|
||||
</ul>
|
||||
<h4>Complexity</h4>
|
||||
<p>Linear depending from the size of the row.</p>
|
||||
<h4>Examples</h4>
|
||||
<pre>
|
||||
#include <boost/numeric/ublas/matrix.hpp>
|
||||
#include <boost/numeric/ublas/matrix_proxy.hpp>
|
||||
#include <boost/numeric/ublas/io.hpp>
|
||||
|
||||
int main () {
|
||||
@@ -239,6 +241,7 @@ addressing a column of a matrix.</p>
|
||||
<h4>Example</h4>
|
||||
<pre>
|
||||
#include <boost/numeric/ublas/matrix.hpp>
|
||||
#include <boost/numeric/ublas/matrix_proxy.hpp>
|
||||
#include <boost/numeric/ublas/io.hpp>
|
||||
|
||||
int main () {
|
||||
@@ -270,7 +273,7 @@ int main () {
|
||||
</tbody>
|
||||
</table>
|
||||
<h4>Model of</h4>
|
||||
<p><a href="expression.htm#vector_expression">Vector Expression</a>
|
||||
<p><a href="expression_concept.htm#vector_expression">Vector Expression</a>
|
||||
.</p>
|
||||
<p>If the specified row falls outside that of the column index
|
||||
range of the matrix, then the <code>matrix_column</code> is not a
|
||||
@@ -278,7 +281,7 @@ well formed Vector Expression. That is, access to an element which
|
||||
is outside of the matrix is <i>undefined</i>.</p>
|
||||
<h4>Type requirements</h4>
|
||||
<p>None, except for those imposed by the requirements of <a href=
|
||||
"expression.htm#vector_expression">Vector Expression</a> .</p>
|
||||
"expression_concept.htm#vector_expression">Vector Expression</a> .</p>
|
||||
<h4>Public base classes</h4>
|
||||
<p><code>vector_expression<matrix_column<M>
|
||||
></code></p>
|
||||
@@ -418,28 +421,29 @@ the reversed <code>matrix_column</code>.</td>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Projections</h3>
|
||||
<h4>Prototypes</h4>
|
||||
<pre>
|
||||
<code>template<class M>
|
||||
matrix_column<M> column (M &data, std::size_t j);
|
||||
template<class M>
|
||||
const matrix_column<const M> column (const M &data, std::size_t j);</code>
|
||||
</pre>
|
||||
<h4>Description</h4>
|
||||
<p>The free <code>column</code> functions support the construction
|
||||
of matrix columns.</p>
|
||||
<h4>Prototypes</h4>
|
||||
<pre><code>
|
||||
template<class M>
|
||||
matrix_column<M> column (M &data, std::size_t j);
|
||||
template<class M>
|
||||
const matrix_column<const M> column (const M &data, std::size_t j);
|
||||
</code></pre>
|
||||
<h4>Definition</h4>
|
||||
<p>Defined in the header matrix_proxy.hpp.</p>
|
||||
<h4>Type requirements</h4>
|
||||
<ul>
|
||||
<li><code>M</code> is a model of <a href=
|
||||
"expression.htm#matrix_expression">Matrix Expression</a> .</li>
|
||||
"expression_concept.htm#matrix_expression">Matrix Expression</a> .</li>
|
||||
</ul>
|
||||
<h4>Complexity</h4>
|
||||
<p>Linear depending from the size of the column.</p>
|
||||
<h4>Examples</h4>
|
||||
<pre>
|
||||
#include <boost/numeric/ublas/matrix.hpp>
|
||||
#include <boost/numeric/ublas/matrix_proxy.hpp>
|
||||
#include <boost/numeric/ublas/io.hpp>
|
||||
|
||||
int main () {
|
||||
@@ -459,6 +463,7 @@ allows addressing a sub vector of a matrix.</p>
|
||||
<h4>Example</h4>
|
||||
<pre>
|
||||
#include <boost/numeric/ublas/matrix.hpp>
|
||||
#include <boost/numeric/ublas/matrix_proxy.hpp>
|
||||
#include <boost/numeric/ublas/io.hpp>
|
||||
|
||||
int main () {
|
||||
@@ -490,7 +495,7 @@ int main () {
|
||||
</tbody>
|
||||
</table>
|
||||
<h4>Model of</h4>
|
||||
<p><a href="expression.htm#vector_expression">Vector Expression</a>
|
||||
<p><a href="expression_concept.htm#vector_expression">Vector Expression</a>
|
||||
.</p>
|
||||
<p>If the specified ranges fall outside that of the index range of
|
||||
the matrix, then the <code>matrix_vector_range</code> is not a well
|
||||
@@ -498,7 +503,7 @@ formed Vector Expression. That is, access to an element which is
|
||||
outside of the matrix is <i>undefined</i>.</p>
|
||||
<h4>Type requirements</h4>
|
||||
<p>None, except for those imposed by the requirements of <a href=
|
||||
"expression.htm#vector_expression">Vector Expression</a> .</p>
|
||||
"expression_concept.htm#vector_expression">Vector Expression</a> .</p>
|
||||
<h4>Public base classes</h4>
|
||||
<p><code>vector_expression<matrix_vector_range<M>
|
||||
></code></p>
|
||||
@@ -644,6 +649,7 @@ allows addressing a sliced sub vector of a matrix.</p>
|
||||
<h4>Example</h4>
|
||||
<pre>
|
||||
#include <boost/numeric/ublas/matrix.hpp>
|
||||
#include <boost/numeric/ublas/matrix_proxy.hpp>
|
||||
#include <boost/numeric/ublas/io.hpp>
|
||||
|
||||
int main () {
|
||||
@@ -675,7 +681,7 @@ int main () {
|
||||
</tbody>
|
||||
</table>
|
||||
<h4>Model of</h4>
|
||||
<p><a href="expression.htm#vector_expression">Vector Expression</a>
|
||||
<p><a href="expression_concept.htm#vector_expression">Vector Expression</a>
|
||||
.</p>
|
||||
<p>If the specified slices fall outside that of the index range of
|
||||
the matrix, then the <code>matrix_vector_slice</code> is not a well
|
||||
@@ -683,7 +689,7 @@ formed Vector Expression. That is, access to an element which is
|
||||
outside of the matrix is <i>undefined</i>.</p>
|
||||
<h4>Type requirements</h4>
|
||||
<p>None, except for those imposed by the requirements of <a href=
|
||||
"expression.htm#vector_expression">Vector Expression</a> .</p>
|
||||
"expression_concept.htm#vector_expression">Vector Expression</a> .</p>
|
||||
<h4>Public base classes</h4>
|
||||
<p><code>vector_expression<matrix_vector_slice<M>
|
||||
></code></p>
|
||||
@@ -829,6 +835,7 @@ addressing a sub matrix of a matrix.</p>
|
||||
<h4>Example</h4>
|
||||
<pre>
|
||||
#include <boost/numeric/ublas/matrix.hpp>
|
||||
#include <boost/numeric/ublas/matrix_proxy.hpp>
|
||||
#include <boost/numeric/ublas/io.hpp>
|
||||
|
||||
int main () {
|
||||
@@ -859,7 +866,7 @@ int main () {
|
||||
</tbody>
|
||||
</table>
|
||||
<h4>Model of</h4>
|
||||
<p><a href="expression.htm#matrix_expression">Matrix Expression</a>
|
||||
<p><a href="expression_concept.htm#matrix_expression">Matrix Expression</a>
|
||||
.</p>
|
||||
<p>If the specified ranges fall outside that of the index range of
|
||||
the matrix, then the <code>matrix_range</code> is not a well formed
|
||||
@@ -867,7 +874,7 @@ Matrix Expression. That is, access to an element which is outside
|
||||
of the matrix is <i>undefined</i>.</p>
|
||||
<h4>Type requirements</h4>
|
||||
<p>None, except for those imposed by the requirements of <a href=
|
||||
"expression.htm#matrix_expression">Matrix Expression</a> .</p>
|
||||
"expression_concept.htm#matrix_expression">Matrix Expression</a> .</p>
|
||||
<h4>Public base classes</h4>
|
||||
<p><code>matrix_expression<matrix_range<M> ></code></p>
|
||||
<h4>Members</h4>
|
||||
@@ -1061,30 +1068,33 @@ reversed the <code>matrix_range</code>.</td>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Projections</h3>
|
||||
<h4>Description</h4>
|
||||
<p>The free <code>project</code> functions support the construction
|
||||
of matrix ranges. Existing <code>matrix_range</code>'s can be composed with further ranges. The resulting ranges are computed using this existing ranges' <code>compose</code> function.</p>
|
||||
<h4>Prototypes</h4>
|
||||
<pre>
|
||||
<code>template<class M>
|
||||
<pre><code>
|
||||
template<class M>
|
||||
matrix_range<M> project (M &data, const range &r1, const range &r2);
|
||||
template<class M>
|
||||
const matrix_range<const M> project (const M &data, const range &r1, const range &r2);
|
||||
template<class M>
|
||||
matrix_range<M> project (const matrix_range<M> &data, const range &r1, const range &r2);</code>
|
||||
</pre>
|
||||
<h4>Description</h4>
|
||||
<p>The free <code>project</code> functions support the construction
|
||||
of matrix ranges.</p>
|
||||
matrix_range<M> project (matrix_range<M> &data, const range &r1, const range &r2);
|
||||
template<class M>
|
||||
const matrix_range<M> project (const matrix_range<M> &data, const range &r1, const range &r2);
|
||||
</code></pre>
|
||||
<h4>Definition</h4>
|
||||
<p>Defined in the header matrix_proxy.hpp.</p>
|
||||
<h4>Type requirements</h4>
|
||||
<ul>
|
||||
<li><code>M</code> is a model of <a href=
|
||||
"expression.htm#matrix_expression">Matrix Expression</a> .</li>
|
||||
"expression_concept.htm#matrix_expression">Matrix Expression</a> .</li>
|
||||
</ul>
|
||||
<h4>Complexity</h4>
|
||||
<p>Quadratic depending from the size of the ranges.</p>
|
||||
<h4>Examples</h4>
|
||||
<pre>
|
||||
#include <boost/numeric/ublas/matrix.hpp>
|
||||
#include <boost/numeric/ublas/matrix_proxy.hpp>
|
||||
#include <boost/numeric/ublas/io.hpp>
|
||||
|
||||
int main () {
|
||||
@@ -1103,6 +1113,7 @@ addressing a sliced sub matrix of a matrix.</p>
|
||||
<h4>Example</h4>
|
||||
<pre>
|
||||
#include <boost/numeric/ublas/matrix.hpp>
|
||||
#include <boost/numeric/ublas/matrix_proxy.hpp>
|
||||
#include <boost/numeric/ublas/io.hpp>
|
||||
|
||||
int main () {
|
||||
@@ -1133,7 +1144,7 @@ int main () {
|
||||
</tbody>
|
||||
</table>
|
||||
<h4>Model of</h4>
|
||||
<p><a href="expression.htm#matrix_expression">Matrix Expression</a>
|
||||
<p><a href="expression_concept.htm#matrix_expression">Matrix Expression</a>
|
||||
.</p>
|
||||
<p>If the specified slices fall outside that of the index range of
|
||||
the matrix, then the <code>matrix_slice</code> is not a well formed
|
||||
@@ -1141,7 +1152,7 @@ Matrix Expression. That is, access to an element which is outside
|
||||
of the matrix is <i>undefined</i>.</p>
|
||||
<h4>Type requirements</h4>
|
||||
<p>None, except for those imposed by the requirements of <a href=
|
||||
"expression.htm#matrix_expression">Matrix Expression</a> .</p>
|
||||
"expression_concept.htm#matrix_expression">Matrix Expression</a> .</p>
|
||||
<h4>Public base classes</h4>
|
||||
<p><code>matrix_expression<matrix_slice<M> ></code></p>
|
||||
<h4>Members</h4>
|
||||
@@ -1327,32 +1338,37 @@ the reversed <code>matrix_slice</code>.</td>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Projections</h3>
|
||||
<h4>Description</h4>
|
||||
<p>The free <code>project</code> functions support the construction
|
||||
of matrix slices. Existing <code>matrix_slice</code>'s can be composed with further ranges or slices. The resulting slices are computed using this existing slices' <code>compose</code> function.</p>
|
||||
<h4>Prototypes</h4>
|
||||
<pre>
|
||||
<code>template<class M>
|
||||
matrix_slice<M> project (const matrix_slice<M> &data, const range &r1, const range &r2);
|
||||
<pre><code>
|
||||
template<class M>
|
||||
matrix_slice<M> project (M &data, const slice &s1, const slice &s2);
|
||||
template<class M>
|
||||
const matrix_slice<const M> project (const M &data, const slice &s1, const slice &s2);
|
||||
template<class M>
|
||||
matrix_slice<M> project (const matrix_slice<M> &data, const slice &s1, const slice &s2);</code>
|
||||
</pre>
|
||||
<h4>Description</h4>
|
||||
<p>The free <code>project</code> functions support the construction
|
||||
of matrix slices.</p>
|
||||
matrix_slice<M> project (matrix_slice<M> &data, const range &r1, const range &r2);
|
||||
template<class M>
|
||||
const matrix_slice<M> project (const matrix_slice<M> &data, const range &r1, const range &r2);
|
||||
template<class M>
|
||||
matrix_slice<M> project (matrix_slice<M> &data, const slice &s1, const slice &s2);
|
||||
template<class M>
|
||||
const matrix_slice<M> project (const matrix_slice<M> &data, const slice &s1, const slice &s2);
|
||||
</code></pre>
|
||||
<h4>Definition</h4>
|
||||
<p>Defined in the header matrix_proxy.hpp.</p>
|
||||
<h4>Type requirements</h4>
|
||||
<ul>
|
||||
<li><code>M</code> is a model of <a href=
|
||||
"expression.htm#matrix_expression">Matrix Expression</a> .</li>
|
||||
"expression_concept.htm#matrix_expression">Matrix Expression</a> .</li>
|
||||
</ul>
|
||||
<h4>Complexity</h4>
|
||||
<p>Quadratic depending from the size of the slices.</p>
|
||||
<h4>Examples</h4>
|
||||
<pre>
|
||||
#include <boost/numeric/ublas/matrix.hpp>
|
||||
#include <boost/numeric/ublas/matrix_proxy.hpp>
|
||||
#include <boost/numeric/ublas/io.hpp>
|
||||
|
||||
int main () {
|
||||
|
||||
@@ -10,7 +10,7 @@
|
||||
<title>Sparse Matrix</title>
|
||||
</head>
|
||||
<body>
|
||||
<h1><img src="../../../../boost.png" alt="boost.png" align="middle" />
|
||||
<h1><img src="c++boost.gif" alt="c++boost.gif" align="middle" />
|
||||
Sparse Matrix</h1>
|
||||
<h2><a name="sparse_matrix" id="sparse_matrix"></a> Sparse
|
||||
Matrix</h2>
|
||||
|
||||
@@ -11,7 +11,7 @@
|
||||
<title>uBLAS functions overview</title>
|
||||
</head>
|
||||
<body>
|
||||
<h1><img src="../../../../boost.png" alt="boost.png" align="middle" />
|
||||
<h1><img src="c++boost.gif" alt="c++boost.gif" align="middle" />
|
||||
Overview of Matrix and Vector Operations</h1>
|
||||
|
||||
<dl>
|
||||
@@ -34,9 +34,9 @@ Overview of Matrix and Vector Operations</h1>
|
||||
<tr><td><code>t, t1, t2</code></td>
|
||||
<td>are scalar values</td></tr>
|
||||
<tr><td><code>r, r1, r2</code></td>
|
||||
<td>are <a href="storage.htm#range">ranges</a>, e.g. <code>range(0, 3)</code></td></tr>
|
||||
<td>are <a href="range.htm">ranges</a>, e.g. <code>range(0, 3)</code></td></tr>
|
||||
<tr><td><code>s, s1, s2</code></td>
|
||||
<td>are <a href="storage.htm#slice">slices</a>, e.g. <code>slice(0, 1, 3)</code></td></tr>
|
||||
<td>are <a href="range.htm#slice">slices</a>, e.g. <code>slice(0, 1, 3)</code></td></tr>
|
||||
</table>
|
||||
|
||||
<h2><a name="blas">Basic Linear Algebra</a></h2>
|
||||
|
||||
@@ -10,7 +10,7 @@
|
||||
<title>uBLAS Overview</title>
|
||||
</head>
|
||||
<body>
|
||||
<h1><img src="../../../../boost.png" alt="boost.png" align="middle" />
|
||||
<h1><img src="c++boost.gif" alt="c++boost.gif" align="middle" />
|
||||
uBLAS Overview</h1>
|
||||
<h2>Rationale</h2>
|
||||
<p><cite>It would be nice if every kind of numeric software could
|
||||
|
||||
@@ -11,7 +11,7 @@
|
||||
</head>
|
||||
<body>
|
||||
|
||||
<h1><img src="../../../../boost.png" alt="boost.png" align="middle" />
|
||||
<h1><img src="c++boost.gif" alt="c++boost.gif" align="middle" />
|
||||
Special Products </h1>
|
||||
|
||||
<h2>Functions</h2>
|
||||
|
||||
@@ -18,7 +18,7 @@
|
||||
|
||||
int main () {
|
||||
using namespace boost::numeric::ublas;
|
||||
map_array<int, double> a;
|
||||
map_array<int, double> a (3);
|
||||
for (unsigned i = 0; i < a.size (); ++ i) {
|
||||
a [i] = i;
|
||||
std::cout << a [i] << std::endl;
|
||||
|
||||
@@ -10,7 +10,7 @@
|
||||
<title>Sparse Storage</title>
|
||||
</head>
|
||||
<body>
|
||||
<h1><img src="../../../../boost.png" alt="boost.png" align="middle" />
|
||||
<h1><img src="c++boost.gif" alt="c++boost.gif" align="middle" />
|
||||
Sparse Storage</h1>
|
||||
<h2><a name="map_std" id="map_std"></a> Default Standard Map</h2>
|
||||
<h4>Description</h4>
|
||||
|
||||
@@ -10,7 +10,7 @@
|
||||
<title>Symmetric Matrix</title>
|
||||
</head>
|
||||
<body>
|
||||
<h1><img src="../../../../boost.png" alt="boost.png" align="middle" />
|
||||
<h1><img src="c++boost.gif" alt="c++boost.gif" align="middle" />
|
||||
Symmetric Matrix</h1>
|
||||
<h2><a name="symmetric_matrix" id="symmetric_matrix"></a> Symmetric
|
||||
Matrix</h2>
|
||||
@@ -365,11 +365,11 @@ int main () {
|
||||
</tbody>
|
||||
</table>
|
||||
<h4>Model of</h4>
|
||||
<p><a href="expression.htm#matrix_expression">Matrix Expression</a>
|
||||
<p><a href="expression_concept.htm#matrix_expression">Matrix Expression</a>
|
||||
.</p>
|
||||
<h4>Type requirements</h4>
|
||||
<p>None, except for those imposed by the requirements of <a href=
|
||||
"expression.htm#matrix_expression">Matrix Expression</a> .</p>
|
||||
"expression_concept.htm#matrix_expression">Matrix Expression</a> .</p>
|
||||
<h4>Public base classes</h4>
|
||||
<p><code>matrix_expression<symmetric_adaptor<M, F>
|
||||
></code></p>
|
||||
|
||||
@@ -10,7 +10,7 @@
|
||||
<title>Triangular Matrix</title>
|
||||
</head>
|
||||
<body>
|
||||
<h1><img src="../../../../boost.png" alt="boost.png" align="middle" />
|
||||
<h1><img src="c++boost.gif" alt="c++boost.gif" align="middle" />
|
||||
Triangular Matrix</h1>
|
||||
<h2><a name="triangular_matrix" id="triangular_matrix"></a>
|
||||
Triangular Matrix</h2>
|
||||
@@ -374,11 +374,11 @@ int main () {
|
||||
</tbody>
|
||||
</table>
|
||||
<h4>Model of</h4>
|
||||
<p><a href="expression.htm#matrix_expression">Matrix Expression</a>
|
||||
<p><a href="expression_concept.htm#matrix_expression">Matrix Expression</a>
|
||||
.</p>
|
||||
<h4>Type requirements</h4>
|
||||
<p>None, except for those imposed by the requirements of <a href=
|
||||
"expression.htm#matrix_expression">Matrix Expression</a> .</p>
|
||||
"expression_concept.htm#matrix_expression">Matrix Expression</a> .</p>
|
||||
<h4>Public base classes</h4>
|
||||
<p><code>matrix_expression<triangular_adaptor<M, F>
|
||||
></code></p>
|
||||
|
||||
@@ -9,7 +9,7 @@
|
||||
<title>Types Overview</title>
|
||||
</head>
|
||||
<body>
|
||||
<h1><img src="../../../../boost.png" alt="boost.png" align="middle" />
|
||||
<h1><img src="c++boost.gif" alt="c++boost.gif" align="middle" />
|
||||
Overview of Matrix- and Vector-Types </h1>
|
||||
|
||||
<dl>
|
||||
|
||||
110
doc/vector.htm
110
doc/vector.htm
@@ -10,7 +10,7 @@
|
||||
<title>Vector</title>
|
||||
</head>
|
||||
<body>
|
||||
<h1><img src="../../../../boost.png" alt="boost.png" align="middle" />
|
||||
<h1><img src="c++boost.gif" alt="c++boost.gif" align="middle" />
|
||||
Vector</h1>
|
||||
<h2><a name="vector" id="vector"></a> Vector</h2>
|
||||
<h4>Description</h4>
|
||||
@@ -66,76 +66,150 @@ int main () {
|
||||
<tbody>
|
||||
<tr>
|
||||
<th>Member</th>
|
||||
<th>Where defined</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>value_type</code>
|
||||
<td><a href="expression_concept.htm#vector_expression">VectorExpression</a></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>reference</code>
|
||||
<td><a href="expression_concept.htm#vector_expression">VectorExpression</a></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_reference</code>
|
||||
<td><a href="expression_concept.htm#vector_expression">VectorExpression</a></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>size_type</code>
|
||||
<td><a href="expression_concept.htm#vector_expression">VectorExpression</a></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>difference_type</code>
|
||||
<td><a href="expression_concept.htm#vector_expression">VectorExpression</a></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_iterator</code>
|
||||
<td><a href="expression_concept.htm#vector_expression">VectorExpression</a></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>iterator</code>
|
||||
<td><a href="expression_concept.htm#vector_expression">VectorExpression</a></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_reverse_iterator</code>
|
||||
<td><a href="expression_concept.htm#vector_expression">VectorExpression</a></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>reverse_iterator</code>
|
||||
<td><a href="expression_concept.htm#vector_expression">VectorExpression</a></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>array_type</code>
|
||||
<td><a href="container_concept.htm#vector">Vector</a></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>vector ()</code></td>
|
||||
<td><a href="expression_concept.htm#vector_expression">VectorExpression</a></td>
|
||||
<td>Allocates an uninitialized <code>vector</code> that holds zero
|
||||
elements.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>vector (size_type size)</code></td>
|
||||
<td><a href="container_concept.htm#vector">Vector</a></td>
|
||||
<td>Allocates an uninitialized <code>vector</code> that holds
|
||||
<code>size</code> elements.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>vector (const vector &v)</code></td>
|
||||
<td></td>
|
||||
<td>The copy constructor.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
vector (const vector_expression<AE> &ae)</code></td>
|
||||
<td></td>
|
||||
<td>The extended copy constructor.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>void resize (size_type size, bool preserve =
|
||||
true)</code></td>
|
||||
<td><a href="container_concept.htm#vector">Vector</a></td>
|
||||
<td>Reallocates a <code>vector</code> to hold <code>size</code>
|
||||
elements. The existing elements of the <code>vector</code> are
|
||||
preseved when specified.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>size_type size () const</code></td>
|
||||
<td><a href="expression_concept.htm#vector_expression">VectorExpression</a></td>
|
||||
<td>Returns the size of the <code>vector</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const array_type& data () const</code></td>
|
||||
<td><a href="container_concept.htm#vector">Vector</a></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>array_type& data ()</code></td>
|
||||
<td><a href="container_concept.htm#vector">Vector</a></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_reference operator () (size_type i)
|
||||
const</code></td>
|
||||
<td><a href="expression_concept.htm#vector_expression">VectorExpression</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="expression_concept.htm#vector_expression">VectorExpression</a></td>
|
||||
<td>Returns a reference of the <code>i</code>-th element.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_reference operator [] (size_type i)
|
||||
const</code></td>
|
||||
<td><code>const_reference operator [] (size_type i) const</code></td>
|
||||
<td><a href="container_concept.htm#vector">Vector</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="container_concept.htm#vector">Vector</a></td>
|
||||
<td>Returns a reference of the <code>i</code>-th element.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>vector &operator = (const vector &v)</code></td>
|
||||
<td><a href="expression_concept.htm#vector_expression">VectorExpression</a></td>
|
||||
<td>The assignment operator.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>vector &assign_temporary (vector &v)</code></td>
|
||||
<td><a href="expression_concept.htm#vector_expression">VectorExpression</a></td>
|
||||
<td>Assigns a temporary. May change the vector <code>v</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
vector &operator = (const vector_expression<AE>
|
||||
&ae)</code></td>
|
||||
<td><a href="expression_concept.htm#vector_expression">VectorExpression</a></td>
|
||||
<td>The extended assignment operator.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
vector &assign (const vector_expression<AE>
|
||||
&ae)</code></td>
|
||||
<td><a href="expression_concept.htm#vector_expression">VectorExpression</a></td>
|
||||
<td>Assigns a vector expression to the vector. Left and right hand
|
||||
side of the assignment should be independent.</td>
|
||||
</tr>
|
||||
@@ -143,6 +217,7 @@ side of the assignment should be independent.</td>
|
||||
<td><code>template<class AE><br />
|
||||
vector &operator += (const vector_expression<AE>
|
||||
&ae)</code></td>
|
||||
<td><a href="expression_concept.htm#vector_expression">VectorExpression</a></td>
|
||||
<td>A computed assignment operator. Adds the vector expression to
|
||||
the vector.</td>
|
||||
</tr>
|
||||
@@ -150,6 +225,7 @@ the vector.</td>
|
||||
<td><code>template<class AE><br />
|
||||
vector &plus_assign (const vector_expression<AE>
|
||||
&ae)</code></td>
|
||||
<td><a href="expression_concept.htm#vector_expression">VectorExpression</a></td>
|
||||
<td>Adds a vector expression to the vector. Left and right hand
|
||||
side of the assignment should be independent.</td>
|
||||
</tr>
|
||||
@@ -157,6 +233,7 @@ side of the assignment should be independent.</td>
|
||||
<td><code>template<class AE><br />
|
||||
vector &operator -= (const vector_expression<AE>
|
||||
&ae)</code></td>
|
||||
<td><a href="expression_concept.htm#vector_expression">VectorExpression</a></td>
|
||||
<td>A computed assignment operator. Subtracts the vector expression
|
||||
from the vector.</td>
|
||||
</tr>
|
||||
@@ -164,75 +241,90 @@ from the vector.</td>
|
||||
<td><code>template<class AE><br />
|
||||
vector &minus_assign (const vector_expression<AE>
|
||||
&ae)</code></td>
|
||||
<td><a href="expression_concept.htm#vector_expression">VectorExpression</a></td>
|
||||
<td>Subtracts a vector expression from the vector. Left and right
|
||||
hand side of the assignment should be independent.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AT><br />
|
||||
vector &operator *= (const AT &at)</code></td>
|
||||
<td><a href="expression_concept.htm#vector_expression">VectorExpression</a></td>
|
||||
<td>A computed assignment operator. Multiplies the vector with a
|
||||
scalar.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AT><br />
|
||||
vector &operator /= (const AT &at)</code></td>
|
||||
<td><a href="expression_concept.htm#vector_expression">VectorExpression</a></td>
|
||||
<td>A computed assignment operator. Divides the vector through a
|
||||
scalar.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>void swap (vector &v)</code></td>
|
||||
<td><a href="expression_concept.htm#vector_expression">VectorExpression</a></td>
|
||||
<td>Swaps the contents of the vectors.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>void insert (size_type i, const_reference t)</code></td>
|
||||
<td><a href="container_concept.htm#vector">Vector</a></td>
|
||||
<td>Inserts the value <code>t</code> at the <code>i</code>-th
|
||||
element.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>void erase (size_type i)</code></td>
|
||||
<td><a href="container_concept.htm#vector">Vector</a></td>
|
||||
<td>Erases the value at the <code>i</code>-th element.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>void clear ()</code></td>
|
||||
<td><a href="container_concept.htm#vector">Vector</a></td>
|
||||
<td>Clears the vector.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_iterator begin () const</code></td>
|
||||
<td><a href="expression_concept.htm#vector_expression">VectorExpression</a></td>
|
||||
<td>Returns a <code>const_iterator</code> pointing to the beginning
|
||||
of the <code>vector</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_iterator end () const</code></td>
|
||||
<td><a href="expression_concept.htm#vector_expression">VectorExpression</a></td>
|
||||
<td>Returns a <code>const_iterator</code> pointing to the end of
|
||||
the <code>vector</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>iterator begin ()</code></td>
|
||||
<td><a href="expression_concept.htm#vector_expression">VectorExpression</a></td>
|
||||
<td>Returns a <code>iterator</code> pointing to the beginning of
|
||||
the <code>vector</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>iterator end ()</code></td>
|
||||
<td><a href="expression_concept.htm#vector_expression">VectorExpression</a></td>
|
||||
<td>Returns a <code>iterator</code> pointing to the end of the
|
||||
<code>vector</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_reverse_iterator rbegin () const</code></td>
|
||||
<td><a href="expression_concept.htm#vector_expression">VectorExpression</a></td>
|
||||
<td>Returns a <code>const_reverse_iterator</code> pointing to the
|
||||
beginning of the reversed <code>vector</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_reverse_iterator rend () const</code></td>
|
||||
<td><a href="expression_concept.htm#vector_expression">VectorExpression</a></td>
|
||||
<td>Returns a <code>const_reverse_iterator</code> pointing to the
|
||||
end of the reversed <code>vector</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>reverse_iterator rbegin ()</code></td>
|
||||
<td><a href="expression_concept.htm#vector_expression">VectorExpression</a></td>
|
||||
<td>Returns a <code>reverse_iterator</code> pointing to the
|
||||
beginning of the reversed <code>vector</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>reverse_iterator rend ()</code></td>
|
||||
<td><a href="expression_concept.htm#vector_expression">VectorExpression</a></td>
|
||||
<td>Returns a <code>reverse_iterator</code> pointing to the end of
|
||||
the reversed <code>vector</code>.</td>
|
||||
</tr>
|
||||
@@ -283,11 +375,11 @@ int main () {
|
||||
</tbody>
|
||||
</table>
|
||||
<h4>Model of</h4>
|
||||
<p><a href="expression.htm#vector_expression">Vector Expression</a>
|
||||
<p><a href="expression_concept.htm#vector_expression">Vector Expression</a>
|
||||
.</p>
|
||||
<h4>Type requirements</h4>
|
||||
<p>None, except for those imposed by the requirements of <a href=
|
||||
"expression.htm#vector_expression">Vector Expression</a> .</p>
|
||||
"expression_concept.htm#vector_expression">Vector Expression</a> .</p>
|
||||
<h4>Public base classes</h4>
|
||||
<p><code>vector_expression<unit_vector<T> ></code></p>
|
||||
<h4>Members</h4>
|
||||
@@ -408,11 +500,11 @@ int main () {
|
||||
</tbody>
|
||||
</table>
|
||||
<h4>Model of</h4>
|
||||
<p><a href="expression.htm#vector_expression">Vector Expression</a>
|
||||
<p><a href="expression_concept.htm#vector_expression">Vector Expression</a>
|
||||
.</p>
|
||||
<h4>Type requirements</h4>
|
||||
<p>None, except for those imposed by the requirements of <a href=
|
||||
"expression.htm#vector_expression">Vector Expression</a> .</p>
|
||||
"expression_concept.htm#vector_expression">Vector Expression</a> .</p>
|
||||
<h4>Public base classes</h4>
|
||||
<p><code>vector_expression<zero_vector<T> ></code></p>
|
||||
<h4>Members</h4>
|
||||
@@ -530,11 +622,11 @@ int main () {
|
||||
</tbody>
|
||||
</table>
|
||||
<h4>Model of</h4>
|
||||
<p><a href="expression.htm#vector_expression">Vector Expression</a>
|
||||
<p><a href="expression_concept.htm#vector_expression">Vector Expression</a>
|
||||
.</p>
|
||||
<h4>Type requirements</h4>
|
||||
<p>None, except for those imposed by the requirements of <a href=
|
||||
"expression.htm#vector_expression">Vector Expression</a> .</p>
|
||||
"expression_concept.htm#vector_expression">Vector Expression</a> .</p>
|
||||
<h4>Public base classes</h4>
|
||||
<p><code>vector_expression<scalar_vector<T>
|
||||
></code></p>
|
||||
|
||||
@@ -10,7 +10,7 @@
|
||||
<title>Vector Expressions</title>
|
||||
</head>
|
||||
<body>
|
||||
<h1><img src="../../../../boost.png" alt="boost.png" align="middle" />
|
||||
<h1><img src="c++boost.gif" alt="c++boost.gif" align="middle" />
|
||||
Vector Expressions</h1>
|
||||
<h2><a name="vector_expression" id="vector_expression"></a> Vector
|
||||
Expression</h2>
|
||||
@@ -36,7 +36,8 @@ including class <code>vector</code> itself.</p>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4>Model of</h4>
|
||||
<p>None.</p>
|
||||
<p>None. <u>Not a Vector Expression</u>!
|
||||
</p>
|
||||
<h4>Type requirements</h4>
|
||||
<p>None.</p>
|
||||
<h4>Public base classes</h4>
|
||||
@@ -61,79 +62,6 @@ const</code></td>
|
||||
</table>
|
||||
<h2><a name="vector_references" id="vector_references"></a> Vector
|
||||
References</h2>
|
||||
<h3>Constant Reference</h3>
|
||||
<h4>Description</h4>
|
||||
<p>The templated class <code>vector_const_reference<E></code>
|
||||
contains a constant reference to a vector expression.</p>
|
||||
<h4>Definition</h4>
|
||||
<p>Defined in the header vector_expression.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>E</code></td>
|
||||
<td>The type of the vector expression.</td>
|
||||
<td> </td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4>Model of</h4>
|
||||
<p><a href="expression.htm#vector_expression">Vector Expression</a>
|
||||
.</p>
|
||||
<h4>Type requirements</h4>
|
||||
<p>None, except for those imposed by the requirements of <a href=
|
||||
"expression.htm#vector_expression">Vector Expression</a> .</p>
|
||||
<h4>Public base classes</h4>
|
||||
<p><code>vector_expression<vector_const_reference<E>
|
||||
></code></p>
|
||||
<h4>Members</h4>
|
||||
<table border="1" summary="members">
|
||||
<tbody>
|
||||
<tr>
|
||||
<th>Member</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>vector_const_reference (const expression_type
|
||||
&e)</code></td>
|
||||
<td>Constructs a constant reference of the expression.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>size_type size () const</code></td>
|
||||
<td>Returns the size of the expression.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_reference operator () (size_type i)
|
||||
const</code></td>
|
||||
<td>Returns the value of the <code>i</code>-th element.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_iterator begin () const</code></td>
|
||||
<td>Returns a <code>const_iterator</code> pointing to the beginning
|
||||
of the expression.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_iterator end () const</code></td>
|
||||
<td>Returns a <code>const_iterator</code> pointing to the end of
|
||||
the expression.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_reverse_iterator rbegin () const</code></td>
|
||||
<td>Returns a <code>const_reverse_iterator</code> pointing to the
|
||||
beginning of the reversed expression.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_reverse_iterator rend () const</code></td>
|
||||
<td>Returns a <code>const_reverse_iterator</code> pointing to the
|
||||
end of the reversed expression.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Reference</h3>
|
||||
<h4>Description</h4>
|
||||
<p>The templated class <code>vector_reference<E></code>
|
||||
@@ -156,11 +84,11 @@ contains a reference to a vector expression.</p>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4>Model of</h4>
|
||||
<p><a href="expression.htm#vector_expression">Vector Expression</a>
|
||||
<p><a href="expression_concept.htm#vector_expression">Vector Expression</a>
|
||||
.</p>
|
||||
<h4>Type requirements</h4>
|
||||
<p>None, except for those imposed by the requirements of <a href=
|
||||
"expression.htm#vector_expression">Vector Expression</a> .</p>
|
||||
"expression_concept.htm#vector_expression">Vector Expression</a> .</p>
|
||||
<h4>Public base classes</h4>
|
||||
<p><code>vector_expression<vector_reference<E>
|
||||
></code></p>
|
||||
@@ -264,11 +192,11 @@ describes a unary vector operation.</p>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4>Model of</h4>
|
||||
<p><a href="expression.htm#vector_expression">Vector Expression</a>
|
||||
<p><a href="expression_concept.htm#vector_expression">Vector Expression</a>
|
||||
.</p>
|
||||
<h4>Type requirements</h4>
|
||||
<p>None, except for those imposed by the requirements of <a href=
|
||||
"expression.htm#vector_expression">Vector Expression</a> .</p>
|
||||
"expression_concept.htm#vector_expression">Vector Expression</a> .</p>
|
||||
<h4>Public base classes</h4>
|
||||
<p><code>vector_expression<vector_unary<E, F>
|
||||
></code></p>
|
||||
@@ -366,7 +294,7 @@ conjugate of the transpose of a vector expression.</p>
|
||||
<h4>Type requirements</h4>
|
||||
<ul>
|
||||
<li><code>E</code> is a model of <a href=
|
||||
"expression.htm#vector_expression">Vector Expression</a> .</li>
|
||||
"expression_concept.htm#vector_expression">Vector Expression</a> .</li>
|
||||
</ul>
|
||||
<h4>Preconditions</h4>
|
||||
<p>None.</p>
|
||||
@@ -423,11 +351,11 @@ describes a binary vector operation.</p>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4>Model of</h4>
|
||||
<p><a href="expression.htm#vector_expression">Vector Expression</a>
|
||||
<p><a href="expression_concept.htm#vector_expression">Vector Expression</a>
|
||||
.</p>
|
||||
<h4>Type requirements</h4>
|
||||
<p>None, except for those imposed by the requirements of <a href=
|
||||
"expression.htm#vector_expression">Vector Expression</a> .</p>
|
||||
"expression_concept.htm#vector_expression">Vector Expression</a> .</p>
|
||||
<h4>Public base classes</h4>
|
||||
<p><code>vector_expression<vector_binary<E1, E2, F>
|
||||
></code></p>
|
||||
@@ -507,9 +435,9 @@ vector expressions.</p>
|
||||
<h4>Type requirements</h4>
|
||||
<ul>
|
||||
<li><code>E1</code> is a model of <a href=
|
||||
"expression.htm#vector_expression">Vector Expression</a> .</li>
|
||||
"expression_concept.htm#vector_expression">Vector Expression</a> .</li>
|
||||
<li><code>E2</code> is a model of <a href=
|
||||
"expression.htm#vector_expression">Vector Expression</a> .</li>
|
||||
"expression_concept.htm#vector_expression">Vector Expression</a> .</li>
|
||||
</ul>
|
||||
<h4>Preconditions</h4>
|
||||
<ul>
|
||||
@@ -564,11 +492,11 @@ F></code> describes a binary outer vector operation.</p>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4>Model of</h4>
|
||||
<p><a href="expression.htm#matrix_expression">Matrix Expression</a>
|
||||
<p><a href="expression_concept.htm#matrix_expression">Matrix Expression</a>
|
||||
.</p>
|
||||
<h4>Type requirements</h4>
|
||||
<p>None, except for those imposed by the requirements of <a href=
|
||||
"expression.htm#matrix_expression">Matrix Expression</a> .</p>
|
||||
"expression_concept.htm#matrix_expression">Matrix Expression</a> .</p>
|
||||
<h4>Public base classes</h4>
|
||||
<p><code>matrix_expression<vector_matrix_binary<E1, E2, F>
|
||||
></code></p>
|
||||
@@ -664,9 +592,9 @@ expressions.</p>
|
||||
<h4>Type requirements</h4>
|
||||
<ul>
|
||||
<li><code>E1</code> is a model of <a href=
|
||||
"expression.htm#vector_expression">Vector Expression</a> .</li>
|
||||
"expression_concept.htm#vector_expression">Vector Expression</a> .</li>
|
||||
<li><code>E2</code> is a model of <a href=
|
||||
"expression.htm#vector_expression">Vector Expression</a> .</li>
|
||||
"expression_concept.htm#vector_expression">Vector Expression</a> .</li>
|
||||
</ul>
|
||||
<h4>Preconditions</h4>
|
||||
<p>None.</p>
|
||||
@@ -720,11 +648,11 @@ vector.</p>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4>Model of</h4>
|
||||
<p><a href="expression.htm#vector_expression">Vector Expression</a>
|
||||
<p><a href="expression_concept.htm#vector_expression">Vector Expression</a>
|
||||
.</p>
|
||||
<h4>Type requirements</h4>
|
||||
<p>None, except for those imposed by the requirements of <a href=
|
||||
"expression.htm#vector_expression">Vector Expression</a> .</p>
|
||||
"expression_concept.htm#vector_expression">Vector Expression</a> .</p>
|
||||
<h4>Public base classes</h4>
|
||||
<p><code>vector_expression<vector_binary_scalar1<E1, E2,
|
||||
F> ></code> and
|
||||
@@ -822,9 +750,9 @@ with the reciprocal of the scalar.</p>
|
||||
<h4>Type requirements</h4>
|
||||
<ul>
|
||||
<li><code>T1/T2</code> is a model of <a href=
|
||||
"expression.htm#scalar_expression">Scalar Expression</a> .</li>
|
||||
"expression_concept.htm#scalar_expression">Scalar Expression</a> .</li>
|
||||
<li><code>E2/E1</code> is a model of <a href=
|
||||
"expression.htm#vector_expression">Vector Expression</a> .</li>
|
||||
"expression_concept.htm#vector_expression">Vector Expression</a> .</li>
|
||||
</ul>
|
||||
<h4>Preconditions</h4>
|
||||
<p>None.</p>
|
||||
|
||||
@@ -10,7 +10,7 @@
|
||||
<title>Vector Proxies</title>
|
||||
</head>
|
||||
<body>
|
||||
<h1><img src="../../../../boost.png" alt="boost.png" align="middle" />
|
||||
<h1><img src="c++boost.gif" alt="c++boost.gif" align="middle" />
|
||||
Vector Proxies</h1>
|
||||
<h2><a name="vector_range" id="vector_range"></a> Vector Range</h2>
|
||||
<h4>Description</h4>
|
||||
@@ -19,6 +19,7 @@ addressing a sub-range of a vector's element.</p>
|
||||
<h4>Example</h4>
|
||||
<pre>
|
||||
#include <boost/numeric/ublas/vector.hpp>
|
||||
#include <boost/numeric/ublas/vector_proxy.hpp>
|
||||
#include <boost/numeric/ublas/io.hpp>
|
||||
|
||||
int main () {
|
||||
@@ -48,7 +49,7 @@ int main () {
|
||||
</tbody>
|
||||
</table>
|
||||
<h4>Model of</h4>
|
||||
<p><a href="expression.htm#vector_expressio">Vector Expression</a>
|
||||
<p><a href="expression_concept.htm#vector_expressio">Vector Expression</a>
|
||||
.</p>
|
||||
<p>If the specified range falls outside that of the index range of
|
||||
the vector, then the <code>vector_range</code> is not a well formed
|
||||
@@ -56,7 +57,7 @@ Vector Expression. That is, access to an element which is outside
|
||||
of index range of the vector is <i>undefined</i>.</p>
|
||||
<h4>Type requirements</h4>
|
||||
<p>None, except for those imposed by the requirements of <a href=
|
||||
"expression.htm#vector_expression">Vector Expression</a> .</p>
|
||||
"expression_concept.htm#vector_expression">Vector Expression</a> .</p>
|
||||
<h4>Public base classes</h4>
|
||||
<p><code>vector_expression<vector_range<V> ></code></p>
|
||||
<h4>Members</h4>
|
||||
@@ -208,30 +209,33 @@ the reversed <code>vector_range</code>.</td>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Projections</h3>
|
||||
<h4>Description</h4>
|
||||
<p>The free <code>project</code> functions support the construction
|
||||
of vector ranges. Existing <code>matrix_rang</code>'s can be composed with a further range. The resulting range is computed using this existing range's <code>compose</code> function.</p>
|
||||
<h4>Prototypes</h4>
|
||||
<pre>
|
||||
<code>template<class V>
|
||||
<pre><code>
|
||||
template<class V>
|
||||
vector_range<V> project (V &data, const range &r);
|
||||
template<class V>
|
||||
const vector_range<const V> project (const V &data, const range &r);
|
||||
template<class V>
|
||||
vector_range<V> project (const vector_range<V> &data, const range &r);</code>
|
||||
</pre>
|
||||
<h4>Description</h4>
|
||||
<p>The free <code>project</code> functions support the construction
|
||||
of vector ranges.</p>
|
||||
vector_range<V> project (vector_range<V> &data, const range &r);
|
||||
template<class V>
|
||||
const vector_range<V> project (const vector_range<V> &data, const range &r);
|
||||
</code></pre>
|
||||
<h4>Definition</h4>
|
||||
<p>Defined in the header vector_proxy.hpp.</p>
|
||||
<h4>Type requirements</h4>
|
||||
<ul>
|
||||
<li><code>V</code> is a model of <a href=
|
||||
"expression.htm#vector_expression">Vector Expression</a> .</li>
|
||||
"expression_concept.htm#vector_expression">Vector Expression</a> .</li>
|
||||
</ul>
|
||||
<h4>Complexity</h4>
|
||||
<p>Linear depending from the size of the range.</p>
|
||||
<h4>Examples</h4>
|
||||
<pre>
|
||||
#include <boost/numeric/ublas/vector.hpp>
|
||||
#include <boost/numeric/ublas/vector_proxy.hpp>
|
||||
#include <boost/numeric/ublas/io.hpp>
|
||||
|
||||
int main () {
|
||||
@@ -249,6 +253,7 @@ addressing a slice of a vector.</p>
|
||||
<h4>Example</h4>
|
||||
<pre>
|
||||
#include <boost/numeric/ublas/vector.hpp>
|
||||
#include <boost/numeric/ublas/vector_proxy.hpp>
|
||||
#include <boost/numeric/ublas/io.hpp>
|
||||
|
||||
int main () {
|
||||
@@ -278,7 +283,7 @@ int main () {
|
||||
</tbody>
|
||||
</table>
|
||||
<h4>Model of</h4>
|
||||
<p><a href="expression.htm#vector_expression">Vector Expression</a>
|
||||
<p><a href="expression_concept.htm#vector_expression">Vector Expression</a>
|
||||
.</p>
|
||||
<p>If the specified slice falls outside that of the index range of
|
||||
the vector, then the <code>vector_slice</code> is not a well formed
|
||||
@@ -286,7 +291,7 @@ Vector Expression. That is, access to an element which is outside
|
||||
of index range of the vector is <i>undefined</i>.</p>
|
||||
<h4>Type requirements</h4>
|
||||
<p>None, except for those imposed by the requirements of <a href=
|
||||
"expression.htm#vector_expression">Vector Expression</a> .</p>
|
||||
"expression_concept.htm#vector_expression">Vector Expression</a> .</p>
|
||||
<h4>Public base classes</h4>
|
||||
<p><code>vector_expression<vector_slice<V> ></code></p>
|
||||
<h4>Members</h4>
|
||||
@@ -434,32 +439,37 @@ the reversed <code>vector_slice</code>.</td>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Projections</h3>
|
||||
<h4>Description</h4>
|
||||
<p>The free <code>project</code> functions support the construction
|
||||
of vector slices. Existing <code>vector_slice</code>'s can be composed with a further range or slices. The resulting slice is computed using this existing slices's <code>compose</code> function.</p>
|
||||
<h4>Prototypes</h4>
|
||||
<pre>
|
||||
<code>template<class V>
|
||||
vector_slice<V> project (const vector_slice<V> &data, const range &r);
|
||||
<pre><code>
|
||||
template<class V>
|
||||
vector_slice<V> project (V &data, const slice &s);
|
||||
template<class V>
|
||||
const vector_slice<const V> project (const V &data, const slice &s);
|
||||
template<class V>
|
||||
vector_slice<V> project (const vector_slice<V> &data, const slice &s);</code>
|
||||
</pre>
|
||||
<h4>Description</h4>
|
||||
<p>The free <code>project</code> functions support the construction
|
||||
of vector slices.</p>
|
||||
vector_slice<V> project (vector_slice<V> &data, const range &r);
|
||||
template<class V>
|
||||
const vector_slice<V> project (const vector_slice<V> &data, const range &r);
|
||||
template<class V>
|
||||
vector_slice<V> project (vector_slice<V> &data, const slice &s);</code>
|
||||
template<class V>
|
||||
const vector_slice<V> project (const vector_slice<V> &data, const slice &s);
|
||||
</code></pre>
|
||||
<h4>Definition</h4>
|
||||
<p>Defined in the header vector_proxy.hpp.</p>
|
||||
<h4>Type requirements</h4>
|
||||
<ul>
|
||||
<li><code>V</code> is a model of <a href=
|
||||
"expression.htm#vector_expression">Vector Expression</a> .</li>
|
||||
"expression_concept.htm#vector_expression">Vector Expression</a> .</li>
|
||||
</ul>
|
||||
<h4>Complexity</h4>
|
||||
<p>Linear depending from the size of the slice.</p>
|
||||
<h4>Examples</h4>
|
||||
<pre>
|
||||
#include <boost/numeric/ublas/vector.hpp>
|
||||
#include <boost/numeric/ublas/vector_proxy.hpp>
|
||||
#include <boost/numeric/ublas/io.hpp>
|
||||
|
||||
int main () {
|
||||
|
||||
@@ -10,7 +10,7 @@
|
||||
<title>Sparse Vector</title>
|
||||
</head>
|
||||
<body>
|
||||
<h1><img src="../../../../boost.png" alt="boost.png" align="middle" />
|
||||
<h1><img src="c++boost.gif" alt="c++boost.gif" align="middle" />
|
||||
Sparse Vector</h1>
|
||||
<h2><a name="sparse_vector" id="sparse_vector"></a> Sparse
|
||||
Vector</h2>
|
||||
|
||||
Reference in New Issue
Block a user