mirror of
https://github.com/saitohirga/WSJT-X.git
synced 2026-06-25 04:53:17 -04:00
Squashed 'boost/' content from commit b4feb19f2
git-subtree-dir: boost git-subtree-split: b4feb19f287ee92d87a9624b5d36b7cf46aeadeb
This commit is contained in:
Bill Somerville
@@ -0,0 +1,580 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C/utf-8XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta name="generator" content=
|
||||
"HTML Tidy for Linux/x86 (vers 1st March 2004), see www.w3.org" />
|
||||
<meta http-equiv="Content-Type" content=
|
||||
"text/html; charset=us-ascii" />
|
||||
<link rel="stylesheet" href="../../../../boost.css" type="text/css"/>
|
||||
<link rel="stylesheet" href="ublas.css" type="text/css" />
|
||||
<script type="text/javascript" src="js/jquery-1.3.2.min.js" async="async" ></script>
|
||||
<script type="text/javascript" src="js/jquery.toc-gw.js" async="async" ></script>
|
||||
<title>Banded Matrix</title>
|
||||
</head>
|
||||
<body>
|
||||
<h1><img src="../../../../boost.png" align="middle" />Banded Matrix</h1>
|
||||
<div class="toc" id="toc"></div>
|
||||
<h2><a name="banded_matrix"></a>Banded Matrix</h2>
|
||||
<h4>Description</h4>
|
||||
<p>The templated class <code>banded_matrix<T, F, A></code> is
|
||||
the base container adaptor for banded matrices. For a <em>(m x
|
||||
n</em>)-dimensional banded matrix with <em>l</em> lower and
|
||||
<em>u</em> upper diagonals and <em>0 <= i < m</em>, <em>0
|
||||
<= j < n</em> holds <em>b</em><sub><em>i, j</em></sub> <em>=
|
||||
0</em>, if <em>i > j + l</em> or <em>i < j - u</em>. The
|
||||
storage of banded matrices is packed.</p>
|
||||
<h4>Example</h4>
|
||||
<pre>
|
||||
#include <boost/numeric/ublas/banded.hpp>
|
||||
#include <boost/numeric/ublas/io.hpp>
|
||||
|
||||
int main () {
|
||||
using namespace boost::numeric::ublas;
|
||||
banded_matrix<double> m (3, 3, 1, 1);
|
||||
for (signed i = 0; i < signed (m.size1 ()); ++ i)
|
||||
for (signed j = std::max (i - 1, 0); j < std::min (i + 2, signed (m.size2 ())); ++ j)
|
||||
m (i, j) = 3 * i + j;
|
||||
std::cout << m << std::endl;
|
||||
}
|
||||
</pre>
|
||||
<h4>Definition</h4>
|
||||
<p>Defined in the header banded.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 matrix.</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>F</code></td>
|
||||
<td>Functor describing the storage organization. <a href=
|
||||
"#banded_matrix_1">[1]</a></td>
|
||||
<td><code>row_major</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>A</code></td>
|
||||
<td>The type of the adapted array. <a href=
|
||||
"#banded_matrix_2">[2]</a></td>
|
||||
<td><code>unbounded_array<T></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4>Model of</h4>
|
||||
<p><a href="container_concept.html#matrix">Matrix</a> .</p>
|
||||
<h4>Type requirements</h4>
|
||||
<p>None, except for those imposed by the requirements of <a href=
|
||||
"container_concept.html#matrix">Matrix</a> .</p>
|
||||
<h4>Public base classes</h4>
|
||||
<p><code>matrix_container<banded_matrix<T, F, A>
|
||||
></code></p>
|
||||
<h4>Members</h4>
|
||||
<table border="1" summary="members">
|
||||
<tbody>
|
||||
<tr>
|
||||
<th>Member</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>banded_matrix ()</code></td>
|
||||
<td>Allocates an uninitialized <code>banded_matrix</code> that
|
||||
holds zero rows of zero elements.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>banded_matrix (size_type size1, size_type size2,
|
||||
size_type lower = 0, size_type upper = 0)</code></td>
|
||||
<td>Allocates an uninitialized <code>banded_matrix</code> that
|
||||
holds <code>(lower + 1 + upper)</code> diagonals around the main
|
||||
diagonal of a matrix with <code>size1</code> rows of
|
||||
<code>size2</code> elements.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>banded_matrix (const banded_matrix &m)</code></td>
|
||||
<td>The copy constructor.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
banded_matrix (const matrix_expression<AE>
|
||||
&ae)</code></td>
|
||||
<td>The extended copy constructor.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>void resize (size_type size1, size_type size2, size_type
|
||||
lower = 0, size_type upper = 0, bool preserve = true)</code></td>
|
||||
<td>Reallocates a <code>banded_matrix</code> to hold <code>(lower +
|
||||
1 + upper)</code> diagonals around the main diagonal of a matrix
|
||||
with <code>size1</code> rows of <code>size2</code> elements. The
|
||||
existing elements of the <code>banded_matrix</code> are preseved
|
||||
when specified.</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>size_type lower () const</code></td>
|
||||
<td>Returns the number of diagonals below the main diagonal.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>size_type upper () const</code></td>
|
||||
<td>Returns the number of diagonals above the main diagonal.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_reference operator () (size_type i, size_type j)
|
||||
const</code></td>
|
||||
<td>Returns a <code>const</code> reference of the <code>j</code>
|
||||
-th element in the <code>i</code>-th row.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>reference operator () (size_type i, size_type
|
||||
j)</code></td>
|
||||
<td>Returns a reference of the <code>j</code>-th element in the
|
||||
<code>i</code>-th row.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>banded_matrix &operator = (const banded_matrix
|
||||
&m)</code></td>
|
||||
<td>The assignment operator.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>banded_matrix &assign_temporary (banded_matrix
|
||||
&m)</code></td>
|
||||
<td>Assigns a temporary. May change the banded matrix
|
||||
<code>m</code> .</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
banded_matrix &operator = (const matrix_expression<AE>
|
||||
&ae)</code></td>
|
||||
<td>The extended assignment operator.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
banded_matrix &assign (const matrix_expression<AE>
|
||||
&ae)</code></td>
|
||||
<td>Assigns a matrix expression to the banded matrix. Left and
|
||||
right hand side of the assignment should be independent.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
banded_matrix &operator += (const matrix_expression<AE>
|
||||
&ae)</code></td>
|
||||
<td>A computed assignment operator. Adds the matrix expression to
|
||||
the banded matrix.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
banded_matrix &plus_assign (const matrix_expression<AE>
|
||||
&ae)</code></td>
|
||||
<td>Adds a matrix expression to the banded matrix. Left and right
|
||||
hand side of the assignment should be independent.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
banded_matrix &operator -= (const matrix_expression<AE>
|
||||
&ae)</code></td>
|
||||
<td>A computed assignment operator. Subtracts the matrix expression
|
||||
from the banded matrix.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
banded_matrix &minus_assign (const matrix_expression<AE>
|
||||
&ae)</code></td>
|
||||
<td>Subtracts a matrix expression from the banded matrix. Left and
|
||||
right hand side of the assignment should be independent.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AT><br />
|
||||
banded_matrix &operator *= (const AT &at)</code></td>
|
||||
<td>A computed assignment operator. Multiplies the banded matrix
|
||||
with a scalar.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AT><br />
|
||||
banded_matrix &operator /= (const AT &at)</code></td>
|
||||
<td>A computed assignment operator. Divides the banded matrix
|
||||
through a scalar.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>void swap (banded_matrix &m)</code></td>
|
||||
<td>Swaps the contents of the banded matrices.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>void insert (size_type i, size_type j, const_reference
|
||||
t)</code></td>
|
||||
<td>Inserts the value <code>t</code> at the <code>j</code>-th
|
||||
element of the <code>i</code>-th row.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>void erase (size_type i, size_type j)</code></td>
|
||||
<td>Erases the value at the <code>j</code>-th elemenst of the
|
||||
<code>i</code>-th row.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>void clear ()</code></td>
|
||||
<td>Clears the matrix.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_iterator1 begin1 () const</code></td>
|
||||
<td>Returns a <code>const_iterator1</code> pointing to the
|
||||
beginning of the <code>banded_matrix</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_iterator1 end1 () const</code></td>
|
||||
<td>Returns a <code>const_iterator1</code> pointing to the end of
|
||||
the <code>banded_matrix</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>iterator1 begin1 ()</code></td>
|
||||
<td>Returns a <code>iterator1</code> pointing to the beginning of
|
||||
the <code>banded_matrix</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>iterator1 end1 ()</code></td>
|
||||
<td>Returns a <code>iterator1</code> pointing to the end of the
|
||||
<code>banded_matrix</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_iterator2 begin2 () const</code></td>
|
||||
<td>Returns a <code>const_iterator2</code> pointing to the
|
||||
beginning of the <code>banded_matrix</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_iterator2 end2 () const</code></td>
|
||||
<td>Returns a <code>const_iterator2</code> pointing to the end of
|
||||
the <code>banded_matrix</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>iterator2 begin2 ()</code></td>
|
||||
<td>Returns a <code>iterator2</code> pointing to the beginning of
|
||||
the <code>banded_matrix</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>iterator2 end2 ()</code></td>
|
||||
<td>Returns a <code>iterator2</code> pointing to the end of the
|
||||
<code>banded_matrix</code>.</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 <code>banded_matrix</code>.</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 <code>banded_matrix</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>reverse_iterator1 rbegin1 ()</code></td>
|
||||
<td>Returns a <code>reverse_iterator1</code> pointing to the
|
||||
beginning of the reversed <code>banded_matrix</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>reverse_iterator1 rend1 ()</code></td>
|
||||
<td>Returns a <code>reverse_iterator1</code> pointing to the end of
|
||||
the reversed <code>banded_matrix</code>.</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 <code>banded_matrix</code>.</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 <code>banded_matrix</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>reverse_iterator2 rbegin2 ()</code></td>
|
||||
<td>Returns a <code>reverse_iterator2</code> pointing to the
|
||||
beginning of the reversed <code>banded_matrix</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>reverse_iterator2 rend2 ()</code></td>
|
||||
<td>Returns a <code>reverse_iterator2</code> pointing to the end of
|
||||
the reversed <code>banded_matrix</code>.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4>Notes</h4>
|
||||
<p><a name="banded_matrix_1" id="banded_matrix_1">[1]</a> Supported
|
||||
parameters for the storage organization are <code>row_major</code>
|
||||
and <code>column_major</code>.</p>
|
||||
<p><a name="banded_matrix_2" id="banded_matrix_2">[2]</a> Supported
|
||||
parameters for the adapted array are
|
||||
<code>unbounded_array<T></code> ,
|
||||
<code>bounded_array<T></code> and
|
||||
<code>std::vector<T></code> .</p>
|
||||
<h2><a name="banded_adaptor"></a>Banded Adaptor</h2>
|
||||
<h4>Description</h4>
|
||||
<p>The templated class <code>banded_adaptor<M></code> is a
|
||||
banded matrix adaptor for other matrices.</p>
|
||||
<h4>Example</h4>
|
||||
<pre>
|
||||
#include <boost/numeric/ublas/banded.hpp>
|
||||
#include <boost/numeric/ublas/io.hpp>
|
||||
|
||||
int main () {
|
||||
using namespace boost::numeric::ublas;
|
||||
matrix<double> m (3, 3);
|
||||
banded_adaptor<matrix<double> > ba (m, 1, 1);
|
||||
for (signed i = 0; i < signed (ba.size1 ()); ++ i)
|
||||
for (signed j = std::max (i - 1, 0); j < std::min (i + 2, signed (ba.size2 ())); ++ j)
|
||||
ba (i, j) = 3 * i + j;
|
||||
std::cout << ba << std::endl;
|
||||
}
|
||||
</pre>
|
||||
<h4>Definition</h4>
|
||||
<p>Defined in the header banded.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>M</code></td>
|
||||
<td>The type of the adapted matrix.</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4>Model of</h4>
|
||||
<p><a href="expression_concept.html#matrix_expression">Matrix Expression</a>
|
||||
.</p>
|
||||
<h4>Type requirements</h4>
|
||||
<p>None, except for those imposed by the requirements of <a href=
|
||||
"expression_concept.html#matrix_expression">Matrix Expression</a> .</p>
|
||||
<h4>Public base classes</h4>
|
||||
<p><code>matrix_expression<banded_adaptor<M>
|
||||
></code></p>
|
||||
<h4>Members</h4>
|
||||
<table border="1" summary="members">
|
||||
<tbody>
|
||||
<tr>
|
||||
<th>Member</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>banded_adaptor (matrix_type &data, size_type lower =
|
||||
0, size_type upper = 0)</code></td>
|
||||
<td>Constructs a <code>banded_adaptor</code> that holds
|
||||
<code>(lower + 1 + upper)</code> diagonals around the main diagonal
|
||||
of a matrix.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>banded_adaptor (const banded_adaptor &m)</code></td>
|
||||
<td>The copy constructor.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
banded_adaptor (const matrix_expression<AE>
|
||||
&ae)</code></td>
|
||||
<td>The extended copy constructor.</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>size_type lower () const</code></td>
|
||||
<td>Returns the number of diagonals below the main diagonal.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>size_type upper () const</code></td>
|
||||
<td>Returns the number of diagonals above the main diagonal.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_reference operator () (size_type i, size_type j)
|
||||
const</code></td>
|
||||
<td>Returns a <code>const</code> reference of the <code>j</code>
|
||||
-th element in the <code>i</code>-th row.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>reference operator () (size_type i, size_type
|
||||
j)</code></td>
|
||||
<td>Returns a reference of the <code>j</code>-th element in the
|
||||
<code>i</code>-th row.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>banded_adaptor &operator = (const banded_adaptor
|
||||
&m)</code></td>
|
||||
<td>The assignment operator.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>banded_adaptor &assign_temporary (banded_adaptor
|
||||
&m)</code></td>
|
||||
<td>Assigns a temporary. May change the banded adaptor
|
||||
<code>m</code> .</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
banded_adaptor &operator = (const matrix_expression<AE>
|
||||
&ae)</code></td>
|
||||
<td>The extended assignment operator.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
banded_adaptor &assign (const matrix_expression<AE>
|
||||
&ae)</code></td>
|
||||
<td>Assigns a matrix expression to the banded adaptor. Left and
|
||||
right hand side of the assignment should be independent.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
banded_adaptor &operator += (const matrix_expression<AE>
|
||||
&ae)</code></td>
|
||||
<td>A computed assignment operator. Adds the matrix expression to
|
||||
the banded adaptor.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
banded_adaptor &plus_assign (const matrix_expression<AE>
|
||||
&ae)</code></td>
|
||||
<td>Adds a matrix expression to the banded adaptor. Left and right
|
||||
hand side of the assignment should be independent.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
banded_adaptor &operator -= (const matrix_expression<AE>
|
||||
&ae)</code></td>
|
||||
<td>A computed assignment operator. Subtracts the matrix expression
|
||||
from the banded adaptor.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
banded_adaptor &minus_assign (const matrix_expression<AE>
|
||||
&ae)</code></td>
|
||||
<td>Subtracts a matrix expression from the banded adaptor. Left and
|
||||
right hand side of the assignment should be independent.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AT><br />
|
||||
banded_adaptor &operator *= (const AT &at)</code></td>
|
||||
<td>A computed assignment operator. Multiplies the banded adaptor
|
||||
with a scalar.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AT><br />
|
||||
banded_adaptor &operator /= (const AT &at)</code></td>
|
||||
<td>A computed assignment operator. Divides the banded adaptor
|
||||
through a scalar.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>void swap (banded_adaptor &m)</code></td>
|
||||
<td>Swaps the contents of the banded adaptors.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_iterator1 begin1 () const</code></td>
|
||||
<td>Returns a <code>const_iterator1</code> pointing to the
|
||||
beginning of the <code>banded_adaptor</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_iterator1 end1 () const</code></td>
|
||||
<td>Returns a <code>const_iterator1</code> pointing to the end of
|
||||
the <code>banded_adaptor</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>iterator1 begin1 ()</code></td>
|
||||
<td>Returns a <code>iterator1</code> pointing to the beginning of
|
||||
the <code>banded_adaptor</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>iterator1 end1 ()</code></td>
|
||||
<td>Returns a <code>iterator1</code> pointing to the end of the
|
||||
<code>banded_adaptor</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_iterator2 begin2 () const</code></td>
|
||||
<td>Returns a <code>const_iterator2</code> pointing to the
|
||||
beginning of the <code>banded_adaptor</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_iterator2 end2 () const</code></td>
|
||||
<td>Returns a <code>const_iterator2</code> pointing to the end of
|
||||
the <code>banded_adaptor</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>iterator2 begin2 ()</code></td>
|
||||
<td>Returns a <code>iterator2</code> pointing to the beginning of
|
||||
the <code>banded_adaptor</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>iterator2 end2 ()</code></td>
|
||||
<td>Returns a <code>iterator2</code> pointing to the end of the
|
||||
<code>banded_adaptor</code>.</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 <code>banded_adaptor</code>.</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 <code>banded_adaptor</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>reverse_iterator1 rbegin1 ()</code></td>
|
||||
<td>Returns a <code>reverse_iterator1</code> pointing to the
|
||||
beginning of the reversed <code>banded_adaptor</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>reverse_iterator1 rend1 ()</code></td>
|
||||
<td>Returns a <code>reverse_iterator1</code> pointing to the end of
|
||||
the reversed <code>banded_adaptor</code>.</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 <code>banded_adaptor</code>.</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 <code>banded_adaptor</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>reverse_iterator2 rbegin2 ()</code></td>
|
||||
<td>Returns a <code>reverse_iterator2</code> pointing to the
|
||||
beginning of the reversed <code>banded_adaptor</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>reverse_iterator2 rend2 ()</code></td>
|
||||
<td>Returns a <code>reverse_iterator2</code> pointing to the end of
|
||||
the reversed <code>banded_adaptor</code>.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<hr />
|
||||
<p>Copyright (©) 2000-2002 Joerg Walter, Mathias Koch<br />
|
||||
Use, modification and distribution are subject to the
|
||||
Boost Software License, Version 1.0.
|
||||
(See accompanying file LICENSE_1_0.txt
|
||||
or copy at <a href="http://www.boost.org/LICENSE_1_0.txt">
|
||||
http://www.boost.org/LICENSE_1_0.txt</a>).
|
||||
</p>
|
||||
<script type="text/javascript">
|
||||
(function($) {
|
||||
$('#toc').toc();
|
||||
})(jQuery);
|
||||
</script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,452 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!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>
|
||||
<title>BLAS</title>
|
||||
<meta name="GENERATOR" content="Quanta Plus" />
|
||||
<meta name="AUTHOR" content="Gunter Winkler" />
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
|
||||
<link rel="stylesheet" href="../../../../boost.css" type="text/css"/>
|
||||
<link rel="stylesheet" href="ublas.css" type="text/css" />
|
||||
<script type="text/javascript" src="js/jquery-1.3.2.min.js" async="async" ></script>
|
||||
<script type="text/javascript" src="js/jquery.toc-gw.js" async="async" ></script>
|
||||
</head>
|
||||
<body>
|
||||
|
||||
|
||||
<h1>Level 3 BLAS</h1>
|
||||
<div class="toc" id="toc"></div>
|
||||
<hr />
|
||||
<a name="_details"></a>
|
||||
|
||||
<table summary="" border=0 cellpadding=0 cellspacing=0>
|
||||
<tr><td></td></tr>
|
||||
<tr><td colspan=2><br /><h2>Functions</h2></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>template<class M1, class T, class M2, class M3> M1 & </td><td class="memItemRight" valign=bottom><a class="el" href="#ga0">boost::numeric::ublas::blas_3::tmm</a> (M1 &m1, const T &t, const M2 &m2, const M3 &m3)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">triangular matrix multiplication <a href="#ga0"></a><br /><br /></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>template<class M1, class T, class M2, class C> M1 & </td><td class="memItemRight" valign=bottom><a class="el" href="#ga1">boost::numeric::ublas::blas_3::tsm</a> (M1 &m1, const T &t, const M2 &m2, C)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">triangular solve <em>m2</em> * <em>x</em> = <em>t</em> * <em>m1</em> in place, <em>m2</em> is a triangular matrix <a href="#ga1"></a><br /><br /></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>template<class M1, class T1, class T2, class M2, class M3> M1 & </td><td class="memItemRight" valign=bottom><a class="el" href="#ga2">boost::numeric::ublas::blas_3::gmm</a> (M1 &m1, const T1 &t1, const T2 &t2, const M2 &m2, const M3 &m3)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">general matrix multiplication <a href="#ga2"></a><br /><br /></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>template<class M1, class T1, class T2, class M2> M1 & </td><td class="memItemRight" valign=bottom><a class="el" href="#ga3">boost::numeric::ublas::blas_3::srk</a> (M1 &m1, const T1 &t1, const T2 &t2, const M2 &m2)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">symmetric rank k update: <em>m1</em> = <em>t</em> * <em>m1</em> + <em>t2</em> * (<em>m2</em> * <em>m2<sup>T</sup></em>) <a href="#ga3"></a><br /><br /></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>template<class M1, class T1, class T2, class M2> M1 & </td><td class="memItemRight" valign=bottom><a class="el" href="#ga4">boost::numeric::ublas::blas_3::hrk</a> (M1 &m1, const T1 &t1, const T2 &t2, const M2 &m2)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">hermitian rank k update: <em>m1</em> = <em>t</em> * <em>m1</em> + <em>t2</em> * (<em>m2</em> * <em>m2<sup>H</sup></em>) <a href="#ga4"></a><br /><br /></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>template<class M1, class T1, class T2, class M2, class M3> M1 & </td><td class="memItemRight" valign=bottom><a class="el" href="#ga5">boost::numeric::ublas::blas_3::sr2k</a> (M1 &m1, const T1 &t1, const T2 &t2, const M2 &m2, const M3 &m3)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">generalized symmetric rank k update: <em>m1</em> = <em>t1</em> * <em>m1</em> + <em>t2</em> * (<em>m2</em> * <em>m3<sup>T</sup></em>) + <em>t2</em> * (<em>m3</em> * <em>m2<sup>T</sup></em>) <a href="#ga5"></a><br /><br /></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>template<class M1, class T1, class T2, class M2, class M3> M1 & </td><td class="memItemRight" valign=bottom><a class="el" href="#ga6">boost::numeric::ublas::blas_3::hr2k</a> (M1 &m1, const T1 &t1, const T2 &t2, const M2 &m2, const M3 &m3)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">generalized hermitian rank k update: <em>m1</em> = <em>t1</em> * <em>m1</em> + <em>t2</em> * (<em>m2</em> * <em>m3<sup>H</sup></em>) + (<em>m3</em> * (<em>t2</em> * <em>m2</em>)<sup>H</sup>) <a href="#ga6"></a><br /><br /></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>template<class M, class E1, class E2> BOOST_UBLAS_INLINE M & </td><td class="memItemRight" valign=bottom><a class="el" href="products.html#ga7">boost::numeric::ublas::axpy_prod</a> (const matrix_expression< E1 > &e1, const matrix_expression< E2 > &e2, M &m, bool init=true)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">computes <code>M += A X</code> or <code>M = A X</code> in an optimized fashion. <a href="products.html#ga7"></a><br /><br /></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>template<class M, class E1, class E2> BOOST_UBLAS_INLINE M & </td><td class="memItemRight" valign=bottom><a class="el" href="products.html#ga8">boost::numeric::ublas::opb_prod</a> (const matrix_expression< E1 > &e1, const matrix_expression< E2 > &e2, M &m, bool init=true)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">computes <code>M += A X</code> or <code>M = A X</code> in an optimized fashion. <a href="products.html#ga8"></a><br /><br /></td></tr>
|
||||
</table>
|
||||
|
||||
<hr />
|
||||
|
||||
<h2>Function Documentation</h2>
|
||||
|
||||
<a class="anchor" name="ga0" doxytag="boost::numeric::ublas::blas_3::tmm" ></a>
|
||||
<table summary="" class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
||||
<tr>
|
||||
<td class="mdRow">
|
||||
<table summary="" cellpadding="0" cellspacing="0" border="0">
|
||||
<tr>
|
||||
<td class="md" nowrap valign="top"> M1& tmm </td>
|
||||
<td class="md" valign="top">( </td>
|
||||
<td class="md" nowrap valign="top">M1 & </td>
|
||||
<td class="mdname" nowrap> <em>m1</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="md" nowrap align="right"></td>
|
||||
<td></td>
|
||||
<td class="md" nowrap>const T & </td>
|
||||
<td class="mdname" nowrap> <em>t</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="md" nowrap align="right"></td>
|
||||
<td></td>
|
||||
<td class="md" nowrap>const M2 & </td>
|
||||
<td class="mdname" nowrap> <em>m2</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="md" nowrap align="right"></td>
|
||||
<td></td>
|
||||
<td class="md" nowrap>const M3 & </td>
|
||||
<td class="mdname" nowrap> <em>m3</em></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td class="md">) </td>
|
||||
<td class="md" colspan="2"></td>
|
||||
</tr>
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<table summary="" cellspacing=5 cellpadding=0 border=0>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
<p>triangular matrix multiplication </p>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="ga1" doxytag="boost::numeric::ublas::blas_3::tsm" ></a>
|
||||
<table summary="" class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
||||
<tr>
|
||||
<td class="mdRow">
|
||||
<table summary="" cellpadding="0" cellspacing="0" border="0">
|
||||
<tr>
|
||||
<td class="md" nowrap valign="top"> M1& tsm </td>
|
||||
<td class="md" valign="top">( </td>
|
||||
<td class="md" nowrap valign="top">M1 & </td>
|
||||
<td class="mdname" nowrap> <em>m1</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="md" nowrap align="right"></td>
|
||||
<td></td>
|
||||
<td class="md" nowrap>const T & </td>
|
||||
<td class="mdname" nowrap> <em>t</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="md" nowrap align="right"></td>
|
||||
<td></td>
|
||||
<td class="md" nowrap>const M2 & </td>
|
||||
<td class="mdname" nowrap> <em>m2</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="md" nowrap align="right"></td>
|
||||
<td></td>
|
||||
<td class="md" nowrap>C </td>
|
||||
<td class="mdname" nowrap></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td class="md">) </td>
|
||||
<td class="md" colspan="2"></td>
|
||||
</tr>
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<table summary="" cellspacing=5 cellpadding=0 border=0>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
|
||||
<p>
|
||||
triangular solve <em>m2</em> * <em>x</em> = <em>t</em> * <em>m1</em> in place, <em>m2</em> is a triangular matrix
|
||||
</p>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="ga2" doxytag="boost::numeric::ublas::blas_3::gmm" ></a>
|
||||
<table summary="" class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
||||
<tr>
|
||||
<td class="mdRow">
|
||||
<table summary="" cellpadding="0" cellspacing="0" border="0">
|
||||
<tr>
|
||||
<td class="md" nowrap valign="top"> M1& gmm </td>
|
||||
<td class="md" valign="top">( </td>
|
||||
<td class="md" nowrap valign="top">M1 & </td>
|
||||
<td class="mdname" nowrap> <em>m1</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="md" nowrap align="right"></td>
|
||||
<td></td>
|
||||
<td class="md" nowrap>const T1 & </td>
|
||||
<td class="mdname" nowrap> <em>t1</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="md" nowrap align="right"></td>
|
||||
<td></td>
|
||||
<td class="md" nowrap>const T2 & </td>
|
||||
<td class="mdname" nowrap> <em>t2</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="md" nowrap align="right"></td>
|
||||
<td></td>
|
||||
<td class="md" nowrap>const M2 & </td>
|
||||
<td class="mdname" nowrap> <em>m2</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="md" nowrap align="right"></td>
|
||||
<td></td>
|
||||
<td class="md" nowrap>const M3 & </td>
|
||||
<td class="mdname" nowrap> <em>m3</em></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td class="md">) </td>
|
||||
<td class="md" colspan="2"></td>
|
||||
</tr>
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<table summary="" cellspacing=5 cellpadding=0 border=0>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
|
||||
<p>
|
||||
general matrix multiplication
|
||||
</p>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="ga3" doxytag="boost::numeric::ublas::blas_3::srk" ></a>
|
||||
<table summary="" class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
||||
<tr>
|
||||
<td class="mdRow">
|
||||
<table summary="" cellpadding="0" cellspacing="0" border="0">
|
||||
<tr>
|
||||
<td class="md" nowrap valign="top"> M1& srk </td>
|
||||
<td class="md" valign="top">( </td>
|
||||
<td class="md" nowrap valign="top">M1 & </td>
|
||||
<td class="mdname" nowrap> <em>m1</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="md" nowrap align="right"></td>
|
||||
<td></td>
|
||||
<td class="md" nowrap>const T1 & </td>
|
||||
<td class="mdname" nowrap> <em>t1</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="md" nowrap align="right"></td>
|
||||
<td></td>
|
||||
<td class="md" nowrap>const T2 & </td>
|
||||
<td class="mdname" nowrap> <em>t2</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="md" nowrap align="right"></td>
|
||||
<td></td>
|
||||
<td class="md" nowrap>const M2 & </td>
|
||||
<td class="mdname" nowrap> <em>m2</em></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td class="md">) </td>
|
||||
<td class="md" colspan="2"></td>
|
||||
</tr>
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<table summary="" cellspacing=5 cellpadding=0 border=0>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
|
||||
<p>
|
||||
symmetric rank k update: <em>m1</em> = <em>t</em> * <em>m1</em> + <em>t2</em> * (<em>m2</em> * <em>m2<sup>T</sup></em>)
|
||||
</p>
|
||||
<dl compact><dt><b>Todo:</b></dt><dd>use opb_prod() </dd></dl>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="ga4" doxytag="boost::numeric::ublas::blas_3::hrk" ></a>
|
||||
<table summary="" class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
||||
<tr>
|
||||
<td class="mdRow">
|
||||
<table summary="" cellpadding="0" cellspacing="0" border="0">
|
||||
<tr>
|
||||
<td class="md" nowrap valign="top"> M1& hrk </td>
|
||||
<td class="md" valign="top">( </td>
|
||||
<td class="md" nowrap valign="top">M1 & </td>
|
||||
<td class="mdname" nowrap> <em>m1</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="md" nowrap align="right"></td>
|
||||
<td></td>
|
||||
<td class="md" nowrap>const T1 & </td>
|
||||
<td class="mdname" nowrap> <em>t1</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="md" nowrap align="right"></td>
|
||||
<td></td>
|
||||
<td class="md" nowrap>const T2 & </td>
|
||||
<td class="mdname" nowrap> <em>t2</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="md" nowrap align="right"></td>
|
||||
<td></td>
|
||||
<td class="md" nowrap>const M2 & </td>
|
||||
<td class="mdname" nowrap> <em>m2</em></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td class="md">) </td>
|
||||
<td class="md" colspan="2"></td>
|
||||
</tr>
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<table summary="" cellspacing=5 cellpadding=0 border=0>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
|
||||
<p>
|
||||
hermitian rank k update: <em>m1</em> = <em>t</em> * <em>m1</em> + <em>t2</em> * (<em>m2</em> * <em>m2<sup>H</sup></em>)
|
||||
</p>
|
||||
<dl compact><dt><b>Todo:</b></dt><dd>use opb_prod()</dd></dl>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="ga5" doxytag="boost::numeric::ublas::blas_3::sr2k" ></a>
|
||||
<table summary="" class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
||||
<tr>
|
||||
<td class="mdRow">
|
||||
<table summary="" cellpadding="0" cellspacing="0" border="0">
|
||||
<tr>
|
||||
<td class="md" nowrap valign="top"> M1& sr2k </td>
|
||||
<td class="md" valign="top">( </td>
|
||||
<td class="md" nowrap valign="top">M1 & </td>
|
||||
<td class="mdname" nowrap> <em>m1</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="md" nowrap align="right"></td>
|
||||
<td></td>
|
||||
<td class="md" nowrap>const T1 & </td>
|
||||
<td class="mdname" nowrap> <em>t1</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="md" nowrap align="right"></td>
|
||||
<td></td>
|
||||
<td class="md" nowrap>const T2 & </td>
|
||||
<td class="mdname" nowrap> <em>t2</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="md" nowrap align="right"></td>
|
||||
<td></td>
|
||||
<td class="md" nowrap>const M2 & </td>
|
||||
<td class="mdname" nowrap> <em>m2</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="md" nowrap align="right"></td>
|
||||
<td></td>
|
||||
<td class="md" nowrap>const M3 & </td>
|
||||
<td class="mdname" nowrap> <em>m3</em></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td class="md">) </td>
|
||||
<td class="md" colspan="2"></td>
|
||||
</tr>
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<table summary="" cellspacing=5 cellpadding=0 border=0>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
|
||||
<p>
|
||||
generalized symmetric rank k update: <em>m1</em> = <em>t1</em> * <em>m1</em> + <em>t2</em> * (<em>m2</em> * <em>m3<sup>T</sup></em>) + <em>t2</em> * (<em>m3</em> * <em>m2<sup>T</sup></em>)
|
||||
</p>
|
||||
<dl compact><dt><b>Todo:</b></dt><dd>use opb_prod()</dd></dl>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="ga6" doxytag="boost::numeric::ublas::blas_3::hr2k" ></a>
|
||||
<table summary="" class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
||||
<tr>
|
||||
<td class="mdRow">
|
||||
<table summary="" cellpadding="0" cellspacing="0" border="0">
|
||||
<tr>
|
||||
<td class="md" nowrap valign="top"> M1& hr2k </td>
|
||||
<td class="md" valign="top">( </td>
|
||||
<td class="md" nowrap valign="top">M1 & </td>
|
||||
<td class="mdname" nowrap> <em>m1</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="md" nowrap align="right"></td>
|
||||
<td></td>
|
||||
<td class="md" nowrap>const T1 & </td>
|
||||
<td class="mdname" nowrap> <em>t1</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="md" nowrap align="right"></td>
|
||||
<td></td>
|
||||
<td class="md" nowrap>const T2 & </td>
|
||||
<td class="mdname" nowrap> <em>t2</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="md" nowrap align="right"></td>
|
||||
<td></td>
|
||||
<td class="md" nowrap>const M2 & </td>
|
||||
<td class="mdname" nowrap> <em>m2</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="md" nowrap align="right"></td>
|
||||
<td></td>
|
||||
<td class="md" nowrap>const M3 & </td>
|
||||
<td class="mdname" nowrap> <em>m3</em></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td class="md">) </td>
|
||||
<td class="md" colspan="2"></td>
|
||||
</tr>
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<table summary="" cellspacing=5 cellpadding=0 border=0>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
|
||||
<p>
|
||||
generalized hermitian rank k update: <em>m1</em> = <em>t1</em> * <em>m1</em> + <em>t2</em> * (<em>m2</em> * <em>m3<sup>H</sup></em>) + (<em>m3</em> * (<em>t2</em> * <em>m2</em>)<sup>H</sup>)
|
||||
</p>
|
||||
<dl compact><dt><b>Todo:</b></dt><dd>use opb_prod()</dd></dl>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
<hr />
|
||||
<p>Copyright (©) 2000-2004 Michael Stevens, Mathias Koch,
|
||||
Joerg Walter, Gunter Winkler<br />
|
||||
Use, modification and distribution are subject to the
|
||||
Boost Software License, Version 1.0.
|
||||
(See accompanying file LICENSE_1_0.txt
|
||||
or copy at <a href="http://www.boost.org/LICENSE_1_0.txt">
|
||||
http://www.boost.org/LICENSE_1_0.txt</a>).
|
||||
</p>
|
||||
<script type="text/javascript">
|
||||
(function($) {
|
||||
$('#toc').toc();
|
||||
})(jQuery);
|
||||
</script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,219 @@
|
||||
<!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 rel="stylesheet" href="../../../../boost.css" type="text/css"/>
|
||||
<link rel="stylesheet" href="ublas.css" type="text/css" />
|
||||
<script type="text/javascript" src="js/jquery-1.3.2.min.js" async="async" ></script>
|
||||
<script type="text/javascript" src="js/jquery.toc-gw.js" async="async" ></script>
|
||||
<title>Bounded Array;</title>
|
||||
</head>
|
||||
<body>
|
||||
<h1><img src="../../../../boost.png" align="middle" />Bounded Array Storage</h1>
|
||||
<div class="toc" id="toc"></div>
|
||||
<h2><a name="bounded_array"></a>Bounded Array</h2>
|
||||
<h4>Description</h4>
|
||||
<p>The templated class <code>bounded_array<T, N, ALLOC></code> implements a bounded storage array. The bounded array is similar to a C++ array type in that its maximum size is bounded by N and is allocated on the stack instead of the heap. Similarly a <code>bounded_array</code> requires no secondary storage and ALLOC is only used to specify <code>size_type</code> and <code>difference_type</code>.
|
||||
</p>
|
||||
<p>When resized <code>bounded_array</code> never reallocated the storage. It is therefore always efficient to resize a <code>bounded_array</code> but the size bound N must not be exceeded.</p>
|
||||
<h4>Example</h4>
|
||||
<pre>
|
||||
#include <boost/numeric/ublas/storage.hpp>
|
||||
|
||||
int main () {
|
||||
using namespace boost::numeric::ublas;
|
||||
bounded_array<double, 3> a (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>
|
||||
<tr>
|
||||
<td><code>N</code></td>
|
||||
<td>The allocation size of the array.</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>ALLOC</code></td>
|
||||
<td>An STL Allocator</td>
|
||||
<td>std::allocator</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4>Model of</h4>
|
||||
<p><a href="storage_concept.html">Storage</a></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>
|
||||
</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>bounded_array ()</code></td>
|
||||
<td><a href="storage_concept.html">Storage</a></td>
|
||||
<td>Creates an <code>unbounded_array</code> that holds <strong>zero</strong> elements.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>bounded_array (size_type size)</code></td>
|
||||
<td><a href="storage_concept.html">Storage</a></td>
|
||||
<td>Creates a uninitialized <code>bounded_array</code> that holds <code>size</code> elements. All the elements are default constructed.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>bounded_array (size_type size, const T& init)</code></td>
|
||||
<td><a href="storage_concept.html">Storage</a></td>
|
||||
<td>Creates an initialized <code>bounded_array</code> that holds <code>size</code> elements. All the elements are constructed from the <code>init</code> value.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>bounded_array (const bounded_array &c)</code></td>
|
||||
<td><a href="http://www.sgi.com/tech/stl/Container.html">Container</a></td>
|
||||
<td>The copy constructor.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>~bounded_array ()</code></td>
|
||||
<td><a href="http://www.sgi.com/tech/stl/Container.html">Container</a></td>
|
||||
<td>Deallocates the <code>bounded_array</code> itself.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>void resize (size_type size)</code></td>
|
||||
<td><a href="storage_concept.html">Storage</a>
|
||||
<td>Reallocates a <code>bounded_array</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.html">Storage</a>
|
||||
<td>Reallocates a <code>bounded_array</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>bounded_array</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>bounded_array &operator = (const bounded_array &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>bounded_array &assign_temporary (bounded_array &a)</code></font></td>
|
||||
<td></td>
|
||||
<td>Assigns a temporary. May change the array <code>a</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>void swap (bounded_array &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>bounded_array</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>bounded_array</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>bounded_array</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>bounded_array</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>bounded_array</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>bounded_array</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>bounded_array</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>bounded_array</code>.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<hr />
|
||||
<p>
|
||||
Copyright (©) 2000-2004 Michael Stevens, Mathias Koch,
|
||||
Joerg Walter, Gunter Winkler<br />
|
||||
Use, modification and distribution are subject to the
|
||||
Boost Software License, Version 1.0.
|
||||
(See accompanying file LICENSE_1_0.txt
|
||||
or copy at <a href="http://www.boost.org/LICENSE_1_0.txt">
|
||||
http://www.boost.org/LICENSE_1_0.txt
|
||||
</a>).
|
||||
</p>
|
||||
<script type="text/javascript">
|
||||
(function($) {
|
||||
$('#toc').toc();
|
||||
})(jQuery);
|
||||
</script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,424 @@
|
||||
<!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 name="generator" content=
|
||||
"HTML Tidy for Linux/x86 (vers 1st March 2004), see www.w3.org" />
|
||||
<meta http-equiv="Content-Type" content=
|
||||
"text/html; charset=us-ascii" />
|
||||
<link rel="stylesheet" href="../../../../boost.css" type="text/css"/>
|
||||
<link rel="stylesheet" href="ublas.css" type="text/css" />
|
||||
<script type="text/javascript" src="js/jquery-1.3.2.min.js" async="async" ></script>
|
||||
<script type="text/javascript" src="js/jquery.toc-gw.js" async="async" ></script>
|
||||
<title>Container Concepts</title>
|
||||
</head>
|
||||
<body>
|
||||
<h1><img src="../../../../boost.png" align="middle" />Container Concepts</h1>
|
||||
<div class="toc" id="toc"></div>
|
||||
<h2><a name="vector"></a>Vector</h2>
|
||||
<h4>Description</h4>
|
||||
<p>A Vector describes common aspects of dense, packed and sparse
|
||||
vectors.</p>
|
||||
<h4>Refinement of</h4>
|
||||
<p><a href="http://www.sgi.com/tech/stl/DefaultConstructible.html">DefaultConstructible</a>,
|
||||
<a href="expression_concept.html#vector_expression">Vector Expression</a>
|
||||
<a href="#vector_expression_note">[1]</a>.</p>
|
||||
<h4>Associated types</h4>
|
||||
<p>In addition to the types defined by <a href="expression_concept.html#vector_expression">Vector Expression</a></p>
|
||||
<table border="1" summary="types">
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>Public base</td>
|
||||
<td>vector_container<V></td>
|
||||
<td>V must be derived from this public base type.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Storage array</td>
|
||||
<td>V::array_type</td>
|
||||
<td>
|
||||
Dense Vector ONLY. The type of underlying storage array used to store the elements. The array_type must model the
|
||||
<a href="storage_concept.html"><b>Storage</b></a> concept.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4>Notation</h4>
|
||||
<table border="0" summary="notation">
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>V</code></td>
|
||||
<td>A type that is a model of Vector</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>v</code></td>
|
||||
<td>Objects of type <code>V</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>n, i</code></td>
|
||||
<td>Objects of a type convertible to <code>size_type</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>t</code></td>
|
||||
<td>Object of a type convertible to <code>value_type</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>p</code></td>
|
||||
<td>Object of a type convertible to <code>bool</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4>Definitions</h4>
|
||||
<h4>Valid expressions</h4>
|
||||
<p>In addition to the expressions defined in <a href="http://www.sgi.com/tech/stl/DefaultConstructible.html">DefaultConstructible</a>,
|
||||
<a href="expression_concept.html#vector_expression">Vector Expression</a> the following expressions must be valid.</p>
|
||||
<table border="1" summary="expressions">
|
||||
<tbody>
|
||||
<tr>
|
||||
<th>Name</th>
|
||||
<th>Expression</th>
|
||||
<th>Type requirements</th>
|
||||
<th>Return type</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Sizing constructor</td>
|
||||
<td><code>V v (n)</code></td>
|
||||
<td> </td>
|
||||
<td><code>V</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Insert</td>
|
||||
<td><code>v.insert_element (i, t)</code></td>
|
||||
<td><code>v</code> is mutable.</td>
|
||||
<td><code>void</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Erase</td>
|
||||
<td><code>v.erase_element (i)</code></td>
|
||||
<td><code>v</code> is mutable.</td>
|
||||
<td><code>void</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Clear</td>
|
||||
<td><code>v.clear ()</code></td>
|
||||
<td><code>v</code> is mutable.</td>
|
||||
<td><code>void</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Resize</td>
|
||||
<td><code>v.resize (n)</code><br />
|
||||
<code>v.resize (n, p)</code></td>
|
||||
<td><code>v</code> is mutable.</td>
|
||||
<td><code>void</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Storage</td>
|
||||
<td><code>v.data()</code></td>
|
||||
<td><code>v</code> is mutable and Dense.</td>
|
||||
<td><code>array_type&</code> if <code>v</code> is mutable, <code>const array_type&</code> otherwise</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4>Expression semantics</h4>
|
||||
<p>Semantics of an expression is defined only where it differs
|
||||
from, or is not defined in <a href=
|
||||
"expression_concept.html#vector_expression">Vector Expression</a> .</p>
|
||||
<table border="1" summary="semantics">
|
||||
<tr>
|
||||
<th>Name</th>
|
||||
<th>Expression</th>
|
||||
<th>Precondition</th>
|
||||
<th>Semantics</th>
|
||||
<th>Postcondition</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Sizing constructor</td>
|
||||
<td><code>V v (n)</code></td>
|
||||
<td><code>n >= 0</code></td>
|
||||
<td>Allocates a vector of<code>n</code> elements.</td>
|
||||
<td><code>v.size () == n</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Element access <a href="#element_access_note">[2]</a></td>
|
||||
<td><code>v[n]</code></td>
|
||||
<td><code>0<n>v.size()</code></td>
|
||||
<td>returns the n-th element in v</td>
|
||||
<td> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Insert</td>
|
||||
<td><code>v.insert_element (i, t)</code></td>
|
||||
<td><code>0 <= i < v.size ()</code>.</td>
|
||||
<td>Inserts an element at <code>v (i)</code> with value <code>t</code>.
|
||||
The storage requirement of the Vector may be increased.</td>
|
||||
<td><code>v (i)</code> is equal to <code>t</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Erase</td>
|
||||
<td><code>v.erase_element (i)</code></td>
|
||||
<td><code>0 <= i < v.size ()</code></td>
|
||||
<td>Destroys the element as <code>v (i)</code> and replaces it with the default
|
||||
<code>value_type ()</code>.
|
||||
The storage requirement of the Vector may be decreased.</td>
|
||||
<td><code>v (i)</code> is equal to <code>value_type ()</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Clear</td>
|
||||
<td><code>v.clear ()</code></td>
|
||||
<td> </td>
|
||||
<td>Equivalent to<br />
|
||||
<code>for (i = 0; i < v.size (); ++ i)</code><br />
|
||||
<code>v.erase_element (i);</code></td>
|
||||
<td> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Resize</td>
|
||||
<td><code>v.resize (n)
|
||||
<br />v.resize (n, p)</code></td>
|
||||
<td> </td>
|
||||
<td>Reallocates the vector so that it can hold <code>n</code>
|
||||
elements.<br />
|
||||
Erases or appends elements in order to bring the vector to the prescribed size. Appended elements copies of <code>value_type()</code>.
|
||||
<br />
|
||||
When <code>p == false</code> then existing elements are not preserved and elements will not appended as normal. Instead the vector is in the same state as that after an equivalent sizing constructor.</td>
|
||||
<td><code>v.size () == n</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Storage</td>
|
||||
<td><code>v.data()</code></td>
|
||||
<td></td>
|
||||
<td>Returns a reference to the underlying dense storage.</td>
|
||||
<td> </td>
|
||||
</tr>
|
||||
</table>
|
||||
<h4>Complexity guarantees</h4>
|
||||
<p>The run-time complexity of the sizing constructor is linear in
|
||||
the vector's size.</p>
|
||||
<p>The run-time complexity of insert_element and erase_element is specific for the
|
||||
Vector model and it depends on increases/decreases in storage requirements.</p>
|
||||
<p>The run-time complexity of resize is linear in the vector's
|
||||
size.</p>
|
||||
<h4>Invariants</h4>
|
||||
<h4>Models</h4>
|
||||
<ul>
|
||||
<li><code>vector</code>, <code>bounded_vector</code>, <code>c_vector</code></li>
|
||||
<li><code>unit_vector</code>, <code>zero_vector</code>, <code>scalar_vector</code></li>
|
||||
<li><code>mapped_vector;</code>, <code>compressed_vector</code>, <code>coordinate_vector</code></li>
|
||||
</ul>
|
||||
<h4>Notes</h4>
|
||||
<p><a name="vector_expression_note">[1]</a>
|
||||
As a user you need not care about <tt>Vector</tt> being a refinement of the VectorExpression. Being a refinement of the VectorExpression is only important for the template-expression engine but not the user.</p>
|
||||
<p><a name="element_access_note">[2]</a>
|
||||
The <code>operator[]</code> is added purely for convenience
|
||||
and compatibility with the <code>std::vector</code>. In uBLAS however,
|
||||
generally <code>operator()</code> is used for indexing because this can be
|
||||
used for both vectors and matrices.</p>
|
||||
<h2><a name="matrix"></a>Matrix</h2>
|
||||
<h4>Description</h4>
|
||||
<p>A Matrix describes common aspects of dense, packed and sparse
|
||||
matrices.</p>
|
||||
<h4>Refinement of</h4>
|
||||
<p><a href="http://www.sgi.com/tech/stl/DefaultConstructible.html">DefaultConstructible</a>,
|
||||
<a href="expression_concept.html#matrix_expression">Matrix Expression</a>
|
||||
<a href="#matrix_expression_note">[1]</a>
|
||||
.</p>
|
||||
<h4>Associated types</h4>
|
||||
<p>In addition to the types defined by <a href="expression_concept.html#matrix_expression">Matrix Expression</a></p>
|
||||
<table border="1" summary="types">
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>Public base</td>
|
||||
<td>matrix_container<M></td>
|
||||
<td>M must be derived from this public base type.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Storage array</td>
|
||||
<td>M::array_type</td>
|
||||
<td>Dense Matrix ONLY. The type of underlying storage array used to store the elements. The array_type must model
|
||||
the <a href="storage_concept.html"><b>Storage</b></a> concept.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4>Notation</h4>
|
||||
<table border="0" summary="notation">
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>M</code></td>
|
||||
<td>A type that is a model of Matrix</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>m</code></td>
|
||||
<td>Objects of type <code>M</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>n1, n2, i, j</code></td>
|
||||
<td>Objects of a type convertible to <code>size_type</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>t</code></td>
|
||||
<td>Object of a type convertible to <code>value_type</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>p</code></td>
|
||||
<td>Object of a type convertible to <code>bool</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4>Definitions</h4>
|
||||
<h4>Valid expressions</h4>
|
||||
<p>In addition to the expressions defined in <a href=
|
||||
"expression_concept.html#matrix_expression">Matrix Expression</a> the
|
||||
following expressions must be valid.</p>
|
||||
<table border="1" summary="expressions">
|
||||
<tbody>
|
||||
<tr>
|
||||
<th>Name</th>
|
||||
<th>Expression</th>
|
||||
<th>Type requirements</th>
|
||||
<th>Return type</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Sizing constructor</td>
|
||||
<td><code>M m (n1, n2)</code></td>
|
||||
<td> </td>
|
||||
<td><code>M</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Insert</td>
|
||||
<td><code>m.insert_element (i, j, t)</code></td>
|
||||
<td><code>m</code> is mutable.</td>
|
||||
<td><code>void</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Erase</td>
|
||||
<td><code>m.erase_element (i, j)</code></td>
|
||||
<td><code>m</code> is mutable.</td>
|
||||
<td><code>void</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Clear</td>
|
||||
<td><code>m.clear ()</code></td>
|
||||
<td><code>m</code> is mutable.</td>
|
||||
<td><code>void</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Resize</td>
|
||||
<td><code>m.resize (n1, n2)</code><br />
|
||||
<code>m.resize (n1, n2, p)</code></td>
|
||||
<td><code>m</code> is mutable.</td>
|
||||
<td><code>void</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Storage</td>
|
||||
<td><code>m.data()</code></td>
|
||||
<td><code>m</code> is mutable and Dense.</td>
|
||||
<td><code>array_type&</code> if <code>m</code> is mutable, <code>const array_type&</code> otherwise</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4>Expression semantics</h4>
|
||||
<p>Semantics of an expression is defined only where it differs
|
||||
from, or is not defined in <a href=
|
||||
"expression_concept.html#matrix_expression">Matrix Expression</a> .</p>
|
||||
<table border="1" summary="semantics">
|
||||
<tbody>
|
||||
<tr>
|
||||
<th>Name</th>
|
||||
<th>Expression</th>
|
||||
<th>Precondition</th>
|
||||
<th>Semantics</th>
|
||||
<th>Postcondition</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Sizing constructor</td>
|
||||
<td><code>M m (n1, n2)</code></td>
|
||||
<td><code>n1 >= 0</code> and <code>n2 >= 0</code></td>
|
||||
<td>Allocates a matrix of <code>n1</code> rows and <code>n2</code>
|
||||
columns.</td>
|
||||
<td><code>m.size1 () == n1</code> and <code>m.size2 () ==
|
||||
n2</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Insert</td>
|
||||
<td><code>m.insert_element (i, j, t)</code></td>
|
||||
<td><code>0 <= i < m.size1 ()</code>,<br />
|
||||
<code>0 <= j < m.size2 ()</code>.</td>
|
||||
<td>Inserts an element at <code>m (i, j)</code> with value <code>t</code>.
|
||||
The storage requirement of the Matrix may be increased.</td>
|
||||
<td><code>m (i, j)</code> is equal to <code>t</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Erase</td>
|
||||
<td><code>m.erase_element (i, j)</code></td>
|
||||
<td><code>0 <= i < m.size1 ()</code>and <code><br />
|
||||
0 <= j < m.size2</code></td>
|
||||
<td>Destroys the element as <code>m (i, j)</code> and replaces it with the default
|
||||
<code>value_type ()</code>.
|
||||
The storage requirement of the Matrix may be decreased.</td>
|
||||
<td><code>m (i, j)</code> is equal to <code>value_type ()</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Clear</td>
|
||||
<td><code>m.clear ()</code></td>
|
||||
<td> </td>
|
||||
<td>Equivalent to<br />
|
||||
<code>for (i = 0; i < m.size1 (); ++ i)</code><br />
|
||||
<code>for (j = 0; j < m.size2 (); ++ j)</code><br />
|
||||
<code>m.erase_element (i, j);</code></td>
|
||||
<td> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Resize</td>
|
||||
<td><code>m.resize (n1, n2)
|
||||
<br />
|
||||
m.resize (n1, n2, p)
|
||||
</code></td>
|
||||
<td> </td>
|
||||
<td>Reallocate the matrix so that it can hold <code>n1</code> rows
|
||||
and <code>n2</code> columns.<br />
|
||||
Erases or appends elements in order to bring the matrix to the
|
||||
prescribed size. Appended elements are <code>value_type()</code>
|
||||
copies.<br />
|
||||
When <code>p == false</code> then existing elements are not preserved and elements will not appended as normal. Instead the matrix is in the same state as that after an equivalent sizing constructor.</td>
|
||||
<td><code>m.size1 () == n1</code> and <code>m.size2 () == n2</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Storage</td>
|
||||
<td><code>m.data()</code></td>
|
||||
<td></td>
|
||||
<td>Returns a reference to the underlying dense storage.</td>
|
||||
<td> </td>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4>Complexity guarantees</h4>
|
||||
<p>The run-time complexity of the sizing constructor is quadratic
|
||||
in the matrix's size.</p>
|
||||
<p>The run-time complexity of insert_element and erase_element is specific for the
|
||||
Matrix model and it depends on increases/decreases in storage requirements.</p>
|
||||
<p>The run-time complexity of resize is quadratic in the matrix's
|
||||
size.</p>
|
||||
<h4>Invariants</h4>
|
||||
<h4>Models</h4>
|
||||
<ul>
|
||||
<li><code>matrix</code>, <code>bounded_matrix</code>, <code>c_matrix</code></li>
|
||||
<li><code>identity_matrix</code> , <code>zero_matrix</code> , <code>scalar_matrix</code></li>
|
||||
<li><code>triangular_matrix</code> , <code>symmetric_matrix</code> , <code>banded_matrix</code></li>
|
||||
<li><code>mapped_matrix</code> , <code>compressed_matrix</code> , <code>coordinate_matrix</code></li>
|
||||
</ul>
|
||||
<h4>Notes</h4>
|
||||
<p><a name="matrix_expression_note">[1]</a>
|
||||
As a user you need not care about <tt>Matrix</tt> being a refinement of the MatrixExpression. Being a refinement of the MatrixExpression is only important for the template-expression engine but not the user.</p>
|
||||
<hr />
|
||||
<p>Copyright (©) 2000-2002 Joerg Walter, Mathias Koch<br />
|
||||
Use, modification and distribution are subject to the
|
||||
Boost Software License, Version 1.0.
|
||||
(See accompanying file LICENSE_1_0.txt
|
||||
or copy at <a href="http://www.boost.org/LICENSE_1_0.txt">
|
||||
http://www.boost.org/LICENSE_1_0.txt
|
||||
</a>).
|
||||
</p>
|
||||
<script type="text/javascript">
|
||||
(function($) {
|
||||
$('#toc').toc();
|
||||
})(jQuery);
|
||||
</script>
|
||||
</body>
|
||||
</html>
|
||||
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,597 @@
|
||||
<!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 name="generator" content=
|
||||
"HTML Tidy for Linux/x86 (vers 1st March 2004), see www.w3.org" />
|
||||
<meta http-equiv="Content-Type" content=
|
||||
"text/html; charset=us-ascii" />
|
||||
<link rel="stylesheet" href="../../../../boost.css" type="text/css"/>
|
||||
<link rel="stylesheet" href="ublas.css" type="text/css" />
|
||||
<script type="text/javascript" src="js/jquery-1.3.2.min.js" async="async" ></script>
|
||||
<script type="text/javascript" src="js/jquery.toc-gw.js" async="async" ></script>
|
||||
<title>Hermitian Matrix</title>
|
||||
</head>
|
||||
<body>
|
||||
<h1><img src="../../../../boost.png" align="middle" />Hermitian Matrix</h1>
|
||||
<div class="toc" id="toc"></div>
|
||||
<h2><a name="hermitian_matrix"></a>Hermitian Matrix</h2>
|
||||
<h4>Description</h4>
|
||||
<p>The templated class <code>hermitian_matrix<T, F1, F2,
|
||||
A></code> is the base container adaptor for hermitian matrices.
|
||||
For a <em>(n x n</em> )-dimensional hermitian matrix and <em>0
|
||||
<= i < n</em>, <em>0 <= j < n</em> holds
|
||||
<em>h</em><sub><em>i, j</em></sub> <em>= h</em><sub><em>j,
|
||||
i</em></sub><sup><em>-</em></sup>. The storage of hermitian
|
||||
matrices is packed.</p>
|
||||
<h4>Example</h4>
|
||||
<pre>
|
||||
#include <boost/numeric/ublas/hermitian.hpp>
|
||||
#include <boost/numeric/ublas/io.hpp>
|
||||
|
||||
int main () {
|
||||
using namespace boost::numeric::ublas;
|
||||
hermitian_matrix<std::complex<double>, lower> ml (3, 3);
|
||||
for (unsigned i = 0; i < ml.size1 (); ++ i) {
|
||||
for (unsigned j = 0; j < i; ++ j)
|
||||
ml (i, j) = std::complex<double> (3 * i + j, 3 * i + j);
|
||||
ml (i, i) = std::complex<double> (4 * i, 0);
|
||||
}
|
||||
std::cout << ml << std::endl;
|
||||
hermitian_matrix<std::complex<double>, upper> mu (3, 3);
|
||||
for (unsigned i = 0; i < mu.size1 (); ++ i) {
|
||||
mu (i, i) = std::complex<double> (4 * i, 0);
|
||||
for (unsigned j = i + 1; j < mu.size2 (); ++ j)
|
||||
mu (i, j) = std::complex<double> (3 * i + j, 3 * i + j);
|
||||
}
|
||||
std::cout << mu << std::endl;
|
||||
}
|
||||
</pre>
|
||||
<h4>Definition</h4>
|
||||
<p>Defined in the header hermitian.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 matrix.</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>F1</code></td>
|
||||
<td>Functor describing the type of the hermitian matrix. <a href=
|
||||
"#hermitian_matrix_1">[1]</a></td>
|
||||
<td><code>lower</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>F2</code></td>
|
||||
<td>Functor describing the storage organization. <a href=
|
||||
"#hermitian_matrix_2">[2]</a></td>
|
||||
<td><code>row_major</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>A</code></td>
|
||||
<td>The type of the adapted array. <a href=
|
||||
"#hermitian_matrix_3">[3]</a></td>
|
||||
<td><code>unbounded_array<T></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4>Model of</h4>
|
||||
<p><a href="container_concept.html#matrix">Matrix</a> .</p>
|
||||
<h4>Type requirements</h4>
|
||||
<p>None, except for those imposed by the requirements of <a href=
|
||||
"container_concept.html#matrix">Matrix</a> .</p>
|
||||
<h4>Public base classes</h4>
|
||||
<p><code>matrix_container<hermitian_matrix<T, F1, F2, A>
|
||||
></code></p>
|
||||
<h4>Members</h4>
|
||||
<table border="1" summary="members">
|
||||
<tbody>
|
||||
<tr>
|
||||
<th>Member</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>hermitian_matrix ()</code></td>
|
||||
<td>Allocates an uninitialized <code>hermitian_matrix</code> that
|
||||
holds zero rows of zero elements.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>hermitian_matrix (size_type size)</code></td>
|
||||
<td>Allocates an uninitialized <code>hermitian_matrix</code> that
|
||||
holds <code>size</code> rows of <code>size</code> elements.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>hermitian_matrix (const hermitian_matrix
|
||||
&m)</code></td>
|
||||
<td>The copy constructor.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
hermitian_matrix (const matrix_expression<AE>
|
||||
&ae)</code></td>
|
||||
<td>The extended copy constructor.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>void resize (size_type size, bool preserve =
|
||||
true)</code></td>
|
||||
<td>Reallocates a <code>hermitian_matrix</code> to hold
|
||||
<code>size</code> rows of <code>size</code> elements. The existing
|
||||
elements of the <code>hermitian_matrix</code> are preseved when
|
||||
specified.</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 a <code>const</code> reference of the <code>j</code>
|
||||
-th element in the <code>i</code>-th row.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>reference operator () (size_type i, size_type
|
||||
j)</code></td>
|
||||
<td>Returns a reference of the <code>j</code>-th element in the
|
||||
<code>i</code>-th row.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>hermitian_matrix &operator = (const hermitian_matrix
|
||||
&m)</code></td>
|
||||
<td>The assignment operator.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>hermitian_matrix &assign_temporary (hermitian_matrix
|
||||
&m)</code></td>
|
||||
<td>Assigns a temporary. May change the hermitian matrix
|
||||
<code>m</code> .</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
hermitian_matrix &operator = (const matrix_expression<AE>
|
||||
&ae)</code></td>
|
||||
<td>The extended assignment operator.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
hermitian_matrix &assign (const matrix_expression<AE>
|
||||
&ae)</code></td>
|
||||
<td>Assigns a matrix expression to the hermitian matrix. Left and
|
||||
right hand side of the assignment should be independent.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
hermitian_matrix &operator += (const
|
||||
matrix_expression<AE> &ae)</code></td>
|
||||
<td>A computed assignment operator. Adds the matrix expression to
|
||||
the hermitian matrix.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
hermitian_matrix &plus_assign (const
|
||||
matrix_expression<AE> &ae)</code></td>
|
||||
<td>Adds a matrix expression to the hermitian matrix. Left and
|
||||
right hand side of the assignment should be independent.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
hermitian_matrix &operator -= (const
|
||||
matrix_expression<AE> &ae)</code></td>
|
||||
<td>A computed assignment operator. Subtracts the matrix expression
|
||||
from the hermitian matrix.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
hermitian_matrix &minus_assign (const
|
||||
matrix_expression<AE> &ae)</code></td>
|
||||
<td>Subtracts a matrix expression from the hermitian matrix. Left
|
||||
and right hand side of the assignment should be independent.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AT><br />
|
||||
hermitian_matrix &operator *= (const AT &at)</code></td>
|
||||
<td>A computed assignment operator. Multiplies the hermitian matrix
|
||||
with a scalar.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AT><br />
|
||||
hermitian_matrix &operator /= (const AT &at)</code></td>
|
||||
<td>A computed assignment operator. Divides the hermitian matrix
|
||||
through a scalar.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>void swap (hermitian_matrix &m)</code></td>
|
||||
<td>Swaps the contents of the hermitian matrices.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>void insert (size_type i, size_type j, const_reference
|
||||
t)</code></td>
|
||||
<td>Inserts the value <code>t</code> at the <code>j</code>-th
|
||||
element of the <code>i</code>-th row.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>void erase (size_type i, size_type j)</code></td>
|
||||
<td>Erases the value at the <code>j</code>-th elemenst of the
|
||||
<code>i</code>-th row.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>void clear ()</code></td>
|
||||
<td>Clears the matrix.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_iterator1 begin1 () const</code></td>
|
||||
<td>Returns a <code>const_iterator1</code> pointing to the
|
||||
beginning of the <code>hermitian_matrix</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_iterator1 end1 () const</code></td>
|
||||
<td>Returns a <code>const_iterator1</code> pointing to the end of
|
||||
the <code>hermitian_matrix</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>iterator1 begin1 ()</code></td>
|
||||
<td>Returns a <code>iterator1</code> pointing to the beginning of
|
||||
the <code>hermitian_matrix</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>iterator1 end1 ()</code></td>
|
||||
<td>Returns a <code>iterator1</code> pointing to the end of the
|
||||
<code>hermitian_matrix</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_iterator2 begin2 () const</code></td>
|
||||
<td>Returns a <code>const_iterator2</code> pointing to the
|
||||
beginning of the <code>hermitian_matrix</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_iterator2 end2 () const</code></td>
|
||||
<td>Returns a <code>const_iterator2</code> pointing to the end of
|
||||
the <code>hermitian_matrix</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>iterator2 begin2 ()</code></td>
|
||||
<td>Returns a <code>iterator2</code> pointing to the beginning of
|
||||
the <code>hermitian_matrix</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>iterator2 end2 ()</code></td>
|
||||
<td>Returns a <code>iterator2</code> pointing to the end of the
|
||||
<code>hermitian_matrix</code>.</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 <code>hermitian_matrix</code>.</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 <code>hermitian_matrix</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>reverse_iterator1 rbegin1 ()</code></td>
|
||||
<td>Returns a <code>reverse_iterator1</code> pointing to the
|
||||
beginning of the reversed <code>hermitian_matrix</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>reverse_iterator1 rend1 ()</code></td>
|
||||
<td>Returns a <code>reverse_iterator1</code> pointing to the end of
|
||||
the reversed <code>hermitian_matrix</code>.</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 <code>hermitian_matrix</code>.</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 <code>hermitian_matrix</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>reverse_iterator2 rbegin2 ()</code></td>
|
||||
<td>Returns a <code>reverse_iterator2</code> pointing to the
|
||||
beginning of the reversed <code>hermitian_matrix</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>reverse_iterator2 rend2 ()</code></td>
|
||||
<td>Returns a <code>reverse_iterator2</code> pointing to the end of
|
||||
the reversed <code>hermitian_matrix</code>.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4>Notes</h4>
|
||||
<p><a name="hermitian_matrix_1" id="hermitian_matrix_1">[1]</a>
|
||||
Supported parameters for the type of the hermitian matrix are
|
||||
<code>lower</code> and <code>upper</code>.</p>
|
||||
<p><a name="hermitian_matrix_2" id="hermitian_matrix_2">[2]</a>
|
||||
Supported parameters for the storage organization are
|
||||
<code>row_major</code> and <code>column_major</code>.</p>
|
||||
<p><a name="hermitian_matrix_3" id="hermitian_matrix_3">[3]</a>
|
||||
Supported parameters for the adapted array are
|
||||
<code>unbounded_array<T></code> ,
|
||||
<code>bounded_array<T></code> and
|
||||
<code>std::vector<T></code> .</p>
|
||||
<h2><a name="hermitian_adaptor"></a>Hermitian Adaptor</h2>
|
||||
<h4>Description</h4>
|
||||
<p>The templated class <code>hermitian_adaptor<M, F></code>
|
||||
is a hermitian matrix adaptor for other matrices.</p>
|
||||
<h4>Example</h4>
|
||||
<pre>
|
||||
#include <boost/numeric/ublas/hermitian.hpp>
|
||||
#include <boost/numeric/ublas/io.hpp>
|
||||
|
||||
int main () {
|
||||
using namespace boost::numeric::ublas;
|
||||
matrix<std::complex<double> > m (3, 3);
|
||||
hermitian_adaptor<matrix<std::complex<double> >, lower> hal (m);
|
||||
for (unsigned i = 0; i < hal.size1 (); ++ i) {
|
||||
for (unsigned j = 0; j < i; ++ j)
|
||||
hal (i, j) = std::complex<double> (3 * i + j, 3 * i + j);
|
||||
hal (i, i) = std::complex<double> (4 * i, 0);
|
||||
}
|
||||
std::cout << hal << std::endl;
|
||||
hermitian_adaptor<matrix<std::complex<double> >, upper> hau (m);
|
||||
for (unsigned i = 0; i < hau.size1 (); ++ i) {
|
||||
hau (i, i) = std::complex<double> (4 * i, 0);
|
||||
for (unsigned j = i + 1; j < hau.size2 (); ++ j)
|
||||
hau (i, j) = std::complex<double> (3 * i + j, 3 * i + j);
|
||||
}
|
||||
std::cout << hau << std::endl;
|
||||
}
|
||||
</pre>
|
||||
<h4>Definition</h4>
|
||||
<p>Defined in the header hermitian.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>M</code></td>
|
||||
<td>The type of the adapted matrix.</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>F</code></td>
|
||||
<td>Functor describing the type of the hermitian adaptor. <a href=
|
||||
"#hermitian_adaptor_1">[1]</a></td>
|
||||
<td><code>lower</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4>Model of</h4>
|
||||
<p><a href="expression_concept.html#matrix_expression">Matrix Expression</a>
|
||||
.</p>
|
||||
<h4>Type requirements</h4>
|
||||
<p>None, except for those imposed by the requirements of <a href=
|
||||
"expression_concept.html#matrix_expression">Matrix Expression</a> .</p>
|
||||
<h4>Public base classes</h4>
|
||||
<p><code>matrix_expression<hermitian_adaptor<M, F>
|
||||
></code></p>
|
||||
<h4>Members</h4>
|
||||
<table border="1" summary="members">
|
||||
<tbody>
|
||||
<tr>
|
||||
<th>Member</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>hermitian_adaptor (matrix_type &data)</code></td>
|
||||
<td>Constructs a <code>hermitian_adaptor</code> of a matrix.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>hermitian_adaptor (const hermitian_adaptor
|
||||
&m)</code></td>
|
||||
<td>The copy constructor.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
hermitian_adaptor (const matrix_expression<AE>
|
||||
&ae)</code></td>
|
||||
<td>The extended copy constructor.</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 a <code>const</code> reference of the <code>j</code>
|
||||
-th element in the <code>i</code>-th row.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>reference operator () (size_type i, size_type
|
||||
j)</code></td>
|
||||
<td>Returns a reference of the <code>j</code>-th element in the
|
||||
<code>i</code>-th row.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>hermitian_adaptor &operator = (const
|
||||
hermitian_adaptor &m)</code></td>
|
||||
<td>The assignment operator.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>hermitian_adaptor &assign_temporary
|
||||
(hermitian_adaptor &m)</code></td>
|
||||
<td>Assigns a temporary. May change the hermitian adaptor
|
||||
<code>m</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
hermitian_adaptor &operator = (const
|
||||
matrix_expression<AE> &ae)</code></td>
|
||||
<td>The extended assignment operator.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
hermitian_adaptor &assign (const matrix_expression<AE>
|
||||
&ae)</code></td>
|
||||
<td>Assigns a matrix expression to the hermitian adaptor. Left and
|
||||
right hand side of the assignment should be independent.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
hermitian_adaptor &operator += (const
|
||||
matrix_expression<AE> &ae)</code></td>
|
||||
<td>A computed assignment operator. Adds the matrix expression to
|
||||
the hermitian adaptor.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
hermitian_adaptor &plus_assign (const
|
||||
matrix_expression<AE> &ae)</code></td>
|
||||
<td>Adds a matrix expression to the hermitian adaptor. Left and
|
||||
right hand side of the assignment should be independent.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
hermitian_adaptor &operator -= (const
|
||||
matrix_expression<AE> &ae)</code></td>
|
||||
<td>A computed assignment operator. Subtracts the matrix expression
|
||||
from the hermitian adaptor.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
hermitian_adaptor &minus_assign (const
|
||||
matrix_expression<AE> &ae)</code></td>
|
||||
<td>Subtracts a matrix expression from the hermitian adaptor. Left
|
||||
and right hand side of the assignment should be independent.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AT><br />
|
||||
hermitian_adaptor &operator *= (const AT &at)</code></td>
|
||||
<td>A computed assignment operator. Multiplies the hermitian
|
||||
adaptor with a scalar.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AT><br />
|
||||
hermitian_adaptor &operator /= (const AT &at)</code></td>
|
||||
<td>A computed assignment operator. Divides the hermitian adaptor
|
||||
through a scalar.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>void swap (hermitian_adaptor &m)</code></td>
|
||||
<td>Swaps the contents of the hermitian adaptors.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_iterator1 begin1 () const</code></td>
|
||||
<td>Returns a <code>const_iterator1</code> pointing to the
|
||||
beginning of the <code>hermitian_adaptor</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_iterator1 end1 () const</code></td>
|
||||
<td>Returns a <code>const_iterator1</code> pointing to the end of
|
||||
the <code>hermitian_adaptor</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>iterator1 begin1 ()</code></td>
|
||||
<td>Returns a <code>iterator1</code> pointing to the beginning of
|
||||
the <code>hermitian_adaptor</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>iterator1 end1 ()</code></td>
|
||||
<td>Returns a <code>iterator1</code> pointing to the end of the
|
||||
<code>hermitian_adaptor</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_iterator2 begin2 () const</code></td>
|
||||
<td>Returns a <code>const_iterator2</code> pointing to the
|
||||
beginning of the <code>hermitian_adaptor</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_iterator2 end2 () const</code></td>
|
||||
<td>Returns a <code>const_iterator2</code> pointing to the end of
|
||||
the <code>hermitian_adaptor</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>iterator2 begin2 ()</code></td>
|
||||
<td>Returns a <code>iterator2</code> pointing to the beginning of
|
||||
the <code>hermitian_adaptor</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>iterator2 end2 ()</code></td>
|
||||
<td>Returns a <code>iterator2</code> pointing to the end of the
|
||||
<code>hermitian_adaptor</code>.</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 <code>hermitian_adaptor</code>.</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 <code>hermitian_adaptor</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>reverse_iterator1 rbegin1 ()</code></td>
|
||||
<td>Returns a <code>reverse_iterator1</code> pointing to the
|
||||
beginning of the reversed <code>hermitian_adaptor</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>reverse_iterator1 rend1 ()</code></td>
|
||||
<td>Returns a <code>reverse_iterator1</code> pointing to the end of
|
||||
the reversed <code>hermitian_adaptor</code>.</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 <code>hermitian_adaptor</code>.</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 <code>hermitian_adaptor</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>reverse_iterator2 rbegin2 ()</code></td>
|
||||
<td>Returns a <code>reverse_iterator2</code> pointing to the
|
||||
beginning of the reversed <code>hermitian_adaptor</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>reverse_iterator2 rend2 ()</code></td>
|
||||
<td>Returns a <code>reverse_iterator2</code> pointing to the end of
|
||||
the reversed <code>hermitian_adaptor</code>.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4>Notes</h4>
|
||||
<p><a name="hermitian_adaptor_1" id="hermitian_adaptor_1">[1]</a>
|
||||
Supported parameters for the type of the hermitian adaptor are
|
||||
<code>lower</code> and <code>upper</code>.</p>
|
||||
<hr />
|
||||
<p>Copyright (©) 2000-2002 Joerg Walter, Mathias Koch<br />
|
||||
Use, modification and distribution are subject to the
|
||||
Boost Software License, Version 1.0.
|
||||
(See accompanying file LICENSE_1_0.txt
|
||||
or copy at <a href="http://www.boost.org/LICENSE_1_0.txt">
|
||||
http://www.boost.org/LICENSE_1_0.txt
|
||||
</a>).
|
||||
</p>
|
||||
<script type="text/javascript">
|
||||
(function($) {
|
||||
$('#toc').toc();
|
||||
})(jQuery);
|
||||
</script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,391 @@
|
||||
<!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 rel="stylesheet" href="../../../../boost.css" type="text/css"/>
|
||||
<link rel="stylesheet" href="ublas.css" type="text/css" />
|
||||
<script type="text/javascript" src="js/jquery-1.3.2.min.js" async="async" ></script>
|
||||
<script type="text/javascript" src="js/jquery.toc-gw.js" async="async" ></script>
|
||||
<title>Boost Basic Linear Algebra</title>
|
||||
</head>
|
||||
<body>
|
||||
<h1><img src="../../../../boost.png" align="middle" alt="logo"/>Basic Linear Algebra Library</h1>
|
||||
<div class="toc" id="toc"></div>
|
||||
|
||||
<p>uBLAS is a C++ template class library that provides <a href="http://www.netlib.org/blas">BLAS</a> level 1, 2, 3
|
||||
functionality for dense, packed and sparse matrices. The design and implementation unify mathematical notation via
|
||||
operator overloading and efficient code generation via expression templates.</p>
|
||||
|
||||
<h2>Functionality</h2>
|
||||
|
||||
<p>uBLAS provides templated C++ classes for dense, unit and sparse vectors, dense, identity, triangular, banded,
|
||||
symmetric, hermitian and sparse matrices. Views into vectors and matrices can be constructed via ranges, slices,
|
||||
adaptor classes and indirect arrays. The library covers the usual basic linear algebra operations on vectors and matrices: reductions like
|
||||
different norms, addition and subtraction of vectors and matrices and multiplication with a scalar, inner and outer
|
||||
products of vectors, matrix vector and matrix matrix products and triangular solver. The glue between containers, views
|
||||
and expression templated operations is a mostly <a href="http://www.sgi.com/tech/stl">STL</a> conforming iterator interface.</p>
|
||||
|
||||
<h2>Documentation</h2>
|
||||
|
||||
<ul>
|
||||
<li><big><a href="overview.html">Overview</a></big>
|
||||
<ul>
|
||||
<li><a href="overview.html#rationale">Rationale</a>
|
||||
</li>
|
||||
|
||||
<li><a href="overview.html#functionality">Functionality</a>
|
||||
</li>
|
||||
|
||||
<li><a href="types_overview.html">Overview of Matrix- and Vector-Types</a>
|
||||
</li>
|
||||
|
||||
<li><a href="operations_overview.html">Overview of Matrix and Vector Operations</a>
|
||||
</li>
|
||||
|
||||
<li><a href="#further_information">Effective uBLAS and further information</a>
|
||||
</li>
|
||||
|
||||
<li><a href="options.html">Macros and Preprocessor Options</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
<li><a href="vector.html">Vector</a>
|
||||
<ul>
|
||||
<li><a href="vector.html#vector">Vector</a>
|
||||
</li>
|
||||
|
||||
<li><a href="vector.html#unit_vector">Unit Vector</a>
|
||||
</li>
|
||||
|
||||
<li><a href="vector.html#zero_vector">Zero Vector</a>
|
||||
</li>
|
||||
|
||||
<li><a href="vector.html#scalar_vector">Scalar Vector</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
<li><a href="vector_sparse.html">Sparse Vector</a>
|
||||
<ul>
|
||||
<li><a href="vector_sparse.html#mapped_vector">Mapped Vector</a>
|
||||
</li>
|
||||
|
||||
<li><a href="vector_sparse.html#compressed_vector">Compressed Vector</a>
|
||||
</li>
|
||||
|
||||
<li><a href="vector_sparse.html#coordinate_vector">Coordinate Vector</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
<li><a href="vector_proxy.html">Vector Proxies</a>
|
||||
<ul>
|
||||
<li><a href="vector_proxy.html#vector_range">Vector Range</a>
|
||||
</li>
|
||||
|
||||
<li><a href="vector_proxy.html#vector_slice">Vector Slice</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
<li><a href="vector_expression.html">Vector Expressions</a>
|
||||
<ul>
|
||||
<li><a href="vector_expression.html#vector_expression">Vector Expression</a>
|
||||
</li>
|
||||
|
||||
<li><a href="vector_expression.html#vector_references">Vector References</a>
|
||||
</li>
|
||||
|
||||
<li><a href="vector_expression.html#vector_operations">Vector Operations</a>
|
||||
</li>
|
||||
|
||||
<li><a href="vector_expression.html#vector_reductions">Vector Reductions</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
<li><a href="matrix.html">Matrix</a>
|
||||
<ul>
|
||||
<li><a href="matrix.html#matrix">Matrix</a>
|
||||
</li>
|
||||
|
||||
<li><a href="matrix.html#identity_matrix">Identity Matrix</a>
|
||||
</li>
|
||||
|
||||
<li><a href="matrix.html#zero_matrix">Zero Matrix</a>
|
||||
</li>
|
||||
|
||||
<li><a href="matrix.html#scalar_matrix">Scalar Matrix</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
<li><a href="triangular.html">Triangular Matrix</a>
|
||||
<ul>
|
||||
<li><a href="triangular.html#triangular_matrix">Triangular Matrix</a>
|
||||
</li>
|
||||
|
||||
<li><a href="triangular.html#triangular_adaptor">Triangular Adaptor</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
<li><a href="symmetric.html">Symmetric Matrix</a>
|
||||
<ul>
|
||||
<li><a href="symmetric.html#symmetric_matrix">Symmetric Matrix</a>
|
||||
</li>
|
||||
|
||||
<li><a href="symmetric.html#symmetric_adaptor">Symmetric Adaptor</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
<li><a href="hermitian.html">Hermitian Matrix</a>
|
||||
<ul>
|
||||
<li><a href="hermitian.html#hermitian_matrix">Hermitian Matrix</a>
|
||||
</li>
|
||||
|
||||
<li><a href="hermitian.html#hermitian_adaptor">Hermitian Adaptor</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
<li><a href="banded.html">Banded Matrix</a>
|
||||
<ul>
|
||||
<li><a href="banded.html#banded_matrix">Banded Matrix</a>
|
||||
</li>
|
||||
|
||||
<li><a href="banded.html#banded_adaptor">Banded Adaptor</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
<li><a href="matrix_sparse.html">Sparse Matrix</a>
|
||||
<ul>
|
||||
<li><a href="matrix_sparse.html#mapped_matrix">Mapped Matrix</a>
|
||||
</li>
|
||||
|
||||
<li><a href="matrix_sparse.html#compressed_matrix">Compressed Matrix</a>
|
||||
</li>
|
||||
|
||||
<li><a href="matrix_sparse.html#coordinate_matrix">Coordinate Matrix</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
<li><a href="matrix_proxy.html">Matrix Proxies</a>
|
||||
<ul>
|
||||
<li><a href="matrix_proxy.html#matrix_row">Matrix Row</a>
|
||||
</li>
|
||||
|
||||
<li><a href="matrix_proxy.html#matrix_column">Matrix Column</a>
|
||||
</li>
|
||||
|
||||
<li><a href="matrix_proxy.html#vector_range">Vector Range</a>
|
||||
</li>
|
||||
|
||||
<li><a href="matrix_proxy.html#vector_slice">Vector Slice</a>
|
||||
</li>
|
||||
|
||||
<li><a href="matrix_proxy.html#matrix_range">Matrix Range</a>
|
||||
</li>
|
||||
|
||||
<li><a href="matrix_proxy.html#matrix_slice">Matrix Slice</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
<li><a href="matrix_expression.html">Matrix Expressions</a>
|
||||
<ul>
|
||||
<li><a href="matrix_expression.html#matrix_expression">Matrix Expression</a>
|
||||
</li>
|
||||
|
||||
<li><a href="matrix_expression.html#matrix_references">Matrix References</a>
|
||||
</li>
|
||||
|
||||
<li><a href="matrix_expression.html#matrix_operations">Matrix Operations</a>
|
||||
</li>
|
||||
|
||||
<li><a href="matrix_expression.html#matrix_vector_operations">Matrix Vector Operations</a>
|
||||
</li>
|
||||
|
||||
<li><a href="matrix_expression.html#matrix_matrix_operations">Matrix Matrix Operations</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
<li>Storage and special containers
|
||||
|
||||
<ul>
|
||||
<li><a href="unbounded_array.html">Unbounded Array</a>
|
||||
</li>
|
||||
|
||||
<li><a href="bounded_array.html">Bounded Array</a>
|
||||
</li>
|
||||
|
||||
<li><a href="range.html#range">Range</a>
|
||||
</li>
|
||||
|
||||
<li><a href="range.html#slice">Slice</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
|
||||
<li><a href="storage_sparse.html">Sparse Storage</a>
|
||||
<ul>
|
||||
<li><a href="storage_sparse.html#map_std">Default Standard Map</a>
|
||||
</li>
|
||||
|
||||
<li><a href="storage_sparse.html#map_array">Map Array</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
<li>Operations & Functions
|
||||
|
||||
<ul>
|
||||
<li><a href="products.html">Special Products</a>
|
||||
</li>
|
||||
|
||||
<li><a href="blas.html">BLAS</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
|
||||
<li>uBLAS Concept definitions
|
||||
|
||||
<ul>
|
||||
<li><a href="container_concept.html">Container Concepts</a>
|
||||
<ul>
|
||||
<li><a href="container_concept.html#vector">Vector</a>
|
||||
</li>
|
||||
|
||||
<li><a href="container_concept.html#matrix">Matrix</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
<li><a href="expression_concept.html">Expression Concepts</a>
|
||||
<ul>
|
||||
<li><a href="expression_concept.html#scalar_expression">Scalar Expression</a>
|
||||
</li>
|
||||
|
||||
<li><a href="expression_concept.html#vector_expression">Vector Expression</a>
|
||||
</li>
|
||||
|
||||
<li><a href="expression_concept.html#matrix_expression">Matrix Expression</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
<li><a href="storage_concept.html">Storage Concept</a>
|
||||
</li>
|
||||
|
||||
<li><a href="iterator_concept.html">Iterator Concepts</a>
|
||||
<ul>
|
||||
<li><a href="iterator_concept.html#indexed_bidirectional_iterator">Indexed Bidirectional Iterator</a>
|
||||
</li>
|
||||
|
||||
<li><a href="iterator_concept.html#indexed_random_access_iterator">Indexed Random Access Iterator</a>
|
||||
</li>
|
||||
|
||||
<li><a href="iterator_concept.html#indexed_bidirectional_cr_iterator">Indexed Bidirectional Column/Row Iterator</a>
|
||||
</li>
|
||||
|
||||
<li><a href="iterator_concept.html#indexed_random_access_cr_iterator">Indexed Random Access Column/Row Iterator</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<a name="further_information" id="further_information"></a>
|
||||
<h2>Known limitations:</h2>
|
||||
|
||||
<ul type="disc">
|
||||
<li>The implementation assumes a linear memory address model.</li>
|
||||
|
||||
<li>Tuning was focussed on dense matrices.</li>
|
||||
</ul>
|
||||
|
||||
<h2>Further Information</h2>
|
||||
|
||||
<h3>Project Location and Download</h3>
|
||||
|
||||
<p>The latest stable release of uBLAS is part of the <a href="http://www.boost.org">Boost</a> libraries.</p>
|
||||
|
||||
<h3>Documentation and Discussion</h3>
|
||||
|
||||
<p>Visit the <a href="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 user and
|
||||
development questions are answered.</p>
|
||||
|
||||
<h3>uBLAS and Boost Project</h3>
|
||||
|
||||
<p>There is also an active uBLAS <a href="http://lists.boost.org/">mailing list</a> where uBLAS specific from the
|
||||
latest uBLAS project code. You can <a href="http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/boost">view</a> the Boost
|
||||
CVS archive directly. You will find the library <a href=
|
||||
"http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/boost/boost/boost/numeric/ublas/">here</a>. Documentation and test
|
||||
programs reside <a href="http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/boost/boost/libs/numeric/ublas/">here</a>.</p>
|
||||
|
||||
<h2>Authors and Credits</h2>
|
||||
|
||||
<p>uBLAS initially was written by Joerg Walter and Mathias Koch. We would like to thank all, which supported and
|
||||
contributed to the development of this library: David Abrahams, Ed Brey, Fernando Cacciola, Juan Jose Gomez Cadenas,
|
||||
Beman Dawes, Matt Davies, Bob Fletcher, Kresimir Fresl, Joachim Kessel, Patrick Kowalzick, Toon Knapen, Hendrik Kueck,
|
||||
John Maddock, Jens Maurer, Alexei Novakov, Gary Powell, Joachim Pyras, Peter Schmitteckert, Jeremy Siek, Markus Steffl,
|
||||
Michael Stevens, Benedikt Weber, Martin Weiser, Gunter Winkler, Marc Zimmermann, Marco Guazzone, Nasos Iliopoulus, the members of <a href="http://www.boost.org">Boost</a> and all others contributors around the world. I promise I will try to add their names to this list.</p>
|
||||
<p>
|
||||
This library is currently maintained by <a="mailto:david.bellot@gmail.com">David Bellot</a>.
|
||||
<h2>Frequently Asked Questions</h2>
|
||||
|
||||
<p>Q: Should I use uBLAS for new projects?<br/>
|
||||
A: At the time of writing (09/2012) there are a lot of good matrix libraries available, e.g.,
|
||||
<a href="http://www.simunova.com" target="_blank">MTL4</a>,
|
||||
<a href="http://arma.sourceforge.net" target="_blank">armadillo</a>,
|
||||
<a href="http://eigen.tuxfamily.org" target="_blank">eigen</a>. uBLAS offers a stable, well tested set of vector and
|
||||
matrix classes, the typical operations for linear algebra and solvers for triangular systems of equations. uBLAS offers
|
||||
dense, structured and sparse matrices - all using similar interfaces. And finally uBLAS offers good (but not outstanding)
|
||||
performance. On the other side, the last major improvement of uBLAS was in 2008 and no significant change was committed
|
||||
since 2009. So one should ask himself some questions to aid the decision: <i>Availability?</i> uBLAS is part of boost
|
||||
and thus available in many environments. <i>Easy to use?</i> uBLAS is easy to use for simple things, but needs decent
|
||||
C++ knowledge when you leave the path. <i>Performance?</i> There are faster alternatives. <i>Cutting edge?</i> uBLAS
|
||||
is more than 10 years old and missed all new stuff from C++11. </p>
|
||||
|
||||
<p>Q: I'm running the uBLAS dense vector and matrix benchmarks. Why do I see a significant performance difference
|
||||
between the native C and library implementations?<br />
|
||||
A: uBLAS distinguishes debug mode (size and type conformance checks enabled, expression templates disabled) and release
|
||||
mode (size and type conformance checks disabled, expression templates enabled). Please check, if the preprocessor
|
||||
symbol <code>NDEBUG</code> of <code>cassert</code> is defined. <code>NDEBUG</code> enables release mode, which in turn
|
||||
uses expression templates. You can optionally define <code>BOOST_UBLAS_NDEBUG</code> to disable all bounds, structure
|
||||
and similar checks of uBLAS.</p>
|
||||
|
||||
<p>Q: I've written some uBLAS tests, which try to incorrectly assign different matrix types or overrun vector and
|
||||
matrix dimensions. Why don't I get a compile time or runtime diagnostic?<br />
|
||||
A: uBLAS distinguishes debug mode (size and type conformance checks enabled, expression templates disabled) and release
|
||||
mode (size and type conformance checks disabled, expression templates enabled). Please check, if the preprocessor
|
||||
symbol <code>NDEBUG</code> of <code>cassert</code> is defined. <code>NDEBUG</code> disables debug mode, which is needed
|
||||
to get size and type conformance checks.</p>
|
||||
|
||||
<p>Q: I've written some uBLAS benchmarks to measure the performance of matrix chain multiplications like <code>prod (A,
|
||||
prod (B, C))</code> and see a significant performance penalty due to the use of expression templates. How can I disable
|
||||
expression templates?<br />
|
||||
A: You do not need to disable expression templates. Please try reintroducing temporaries using either <code>prod
|
||||
(A,</code> <code><em>matrix_type</em></code> <code>(prod (B, C)))</code> or <code>prod (A,
|
||||
prod<</code><code><em>matrix_type</em></code> <code>> (B, C))</code>.</p>
|
||||
|
||||
<hr />
|
||||
|
||||
<p>Copyright (©) 2000-2011 Joerg Walter, Mathias Koch, Gunter Winkler, David Bellot<br />
|
||||
Use, modification and distribution are subject to the Boost Software License, Version 1.0. (See accompanying file
|
||||
LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt">http://www.boost.org/LICENSE_1_0.txt</a>
|
||||
).</p>
|
||||
<script type="text/javascript">
|
||||
(function($) {
|
||||
$('#toc').toc();
|
||||
})(jQuery);
|
||||
</script>
|
||||
</body>
|
||||
</html>
|
||||
File diff suppressed because it is too large
Load Diff
+19
File diff suppressed because one or more lines are too long
@@ -0,0 +1,166 @@
|
||||
/*!
|
||||
* jQuery TOC Plugin v1.1.x based on
|
||||
* samaxesJS JavaScript Library
|
||||
* http://code.google.com/p/samaxesjs/
|
||||
*
|
||||
* Copyright (c) 2008 samaxes.com
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*
|
||||
* 2009-10-04, guwi17: modified and extended to meet uBLAS' needs
|
||||
*/
|
||||
|
||||
(function($) {
|
||||
/*
|
||||
* The TOC plugin dynamically builds a table of contents from the headings in
|
||||
* a document and prepends legal-style section numbers to each of the headings.
|
||||
*/
|
||||
$.fn.toc = function(options) {
|
||||
var opts = $.extend({}, $.fn.toc.defaults, options);
|
||||
|
||||
return this.each(function() {
|
||||
var toc = $(this).append('<ul></ul>').children('ul');
|
||||
var headers = {h1: 0, h2: 0, h3: 0, h4: 0, h5: 0, h6: 0};
|
||||
var index = 0;
|
||||
var indexes = {
|
||||
h1: (opts.exclude.match('h1') == null && $('h1').length > 0) ? ++index : 0,
|
||||
h2: (opts.exclude.match('h2') == null && $('h2').length > 0) ? ++index : 0,
|
||||
h3: (opts.exclude.match('h3') == null && $('h3').length > 0) ? ++index : 0,
|
||||
h4: (opts.exclude.match('h4') == null && $('h4').length > 0) ? ++index : 0,
|
||||
h5: (opts.exclude.match('h5') == null && $('h5').length > 0) ? ++index : 0,
|
||||
h6: (opts.exclude.match('h6') == null && $('h6').length > 0) ? ++index : 0
|
||||
};
|
||||
|
||||
$(':header').not(opts.exclude).each(function() {
|
||||
var linkId = "";
|
||||
if ($(this).is('h6')) {
|
||||
checkContainer(headers.h6, toc);
|
||||
updateNumeration(headers, 'h6');
|
||||
$(this).text(addNumeration(headers, 'h6', $(this).text()));
|
||||
linkId = fixAnchor($(this));
|
||||
appendToTOC(toc, indexes.h6, linkId, $(this).text(), headers);
|
||||
} else if ($(this).is('h5')) {
|
||||
checkContainer(headers.h5, toc);
|
||||
updateNumeration(headers, 'h5');
|
||||
$(this).text(addNumeration(headers, 'h5', $(this).text()));
|
||||
linkId = fixAnchor($(this));
|
||||
appendToTOC(toc, indexes.h5, linkId, $(this).text(), headers);
|
||||
} else if ($(this).is('h4')) {
|
||||
checkContainer(headers.h4, toc);
|
||||
updateNumeration(headers, 'h4');
|
||||
$(this).text(addNumeration(headers, 'h4', $(this).text()));
|
||||
linkId = fixAnchor($(this));
|
||||
appendToTOC(toc, indexes.h4, linkId, $(this).text(), headers);
|
||||
} else if ($(this).is('h3')) {
|
||||
checkContainer(headers.h3, toc);
|
||||
updateNumeration(headers, 'h3');
|
||||
$(this).text(addNumeration(headers, 'h3', $(this).text()));
|
||||
linkId = fixAnchor($(this));
|
||||
appendToTOC(toc, indexes.h3, linkId, $(this).text(), headers);
|
||||
} else if ($(this).is('h2')) {
|
||||
checkContainer(headers.h2, toc);
|
||||
updateNumeration(headers, 'h2');
|
||||
$(this).text(addNumeration(headers, 'h2', $(this).text()));
|
||||
linkId = fixAnchor($(this));
|
||||
appendToTOC(toc, indexes.h2, linkId, $(this).text(), headers);
|
||||
} else if ($(this).is('h1')) {
|
||||
updateNumeration(headers, 'h1');
|
||||
$(this).text(addNumeration(headers, 'h1', $(this).text()));
|
||||
linkId = fixAnchor($(this));
|
||||
appendToTOC(toc, indexes.h1, linkId, $(this).text(), headers);
|
||||
}
|
||||
});
|
||||
});
|
||||
};
|
||||
|
||||
/*
|
||||
* Checks if the last node is an 'ul' element.
|
||||
* If not, a new one is created.
|
||||
*/
|
||||
function checkContainer(header, toc) {
|
||||
if (header == 0 && !toc.find(':last').is('ul')) {
|
||||
toc.find('li:last').append('<ul></ul>');
|
||||
}
|
||||
};
|
||||
|
||||
/*
|
||||
* Updates headers numeration.
|
||||
*/
|
||||
function updateNumeration(headers, header) {
|
||||
$.each(headers, function(i, val) {
|
||||
if (i == header) {
|
||||
++headers[i];
|
||||
} else if (i > header) {
|
||||
headers[i] = 0;
|
||||
}
|
||||
});
|
||||
};
|
||||
|
||||
/*
|
||||
* Prepends the numeration to a heading.
|
||||
*/
|
||||
function addNumeration(headers, header, text) {
|
||||
var numeration = '';
|
||||
|
||||
$.each(headers, function(i, val) {
|
||||
if (i <= header && headers[i] > 0) {
|
||||
numeration += headers[i] + '.';
|
||||
}
|
||||
});
|
||||
|
||||
return removeFinalDot(numeration) + ' ' + text;
|
||||
};
|
||||
|
||||
function removeFinalDot(text) {
|
||||
return (text||"").replace(/\.$/g, "" )
|
||||
}
|
||||
|
||||
function fixAnchor(element) {
|
||||
// use existing id by default
|
||||
var linkId = element.attr('id');
|
||||
// next, look for an anchor and use its id or name
|
||||
if ( !linkId ) {
|
||||
element.find('> a:first').each( function() {
|
||||
linkId = $(this).attr('id') || $(this).attr('name');
|
||||
});
|
||||
}
|
||||
// next, use the text content as last resort
|
||||
if ( !linkId ) {
|
||||
linkId = (element.text()||"unknown").replace(/[^a-zA-Z0-9]/g,"");
|
||||
}
|
||||
|
||||
element.attr('id',linkId);
|
||||
return linkId;
|
||||
}
|
||||
|
||||
/*
|
||||
* Appends a new node to the TOC.
|
||||
*/
|
||||
function appendToTOC(toc, index, id, text, headers) {
|
||||
var parent = toc;
|
||||
|
||||
for (var i = 1; i < index; i++) {
|
||||
if (parent.find('> li:last > ul').length == 0) {
|
||||
parent = parent.append('<li><ul></ul></li>');
|
||||
}
|
||||
parent = parent.find('> li:last > ul');
|
||||
}
|
||||
if (id) {
|
||||
parent.append('<li><a href="#' + id + '">' + text + '</a></li>');
|
||||
} else {
|
||||
parent.append('<li>' + text + '</li>');
|
||||
}
|
||||
};
|
||||
|
||||
$.fn.toc.defaults = {exclude: 'h1, h5, h6'}
|
||||
})(jQuery);
|
||||
@@ -0,0 +1,768 @@
|
||||
<!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 name="generator" content=
|
||||
"HTML Tidy for Linux/x86 (vers 1st March 2004), see www.w3.org" />
|
||||
<meta http-equiv="Content-Type" content=
|
||||
"text/html; charset=us-ascii" />
|
||||
<link rel="stylesheet" href="../../../../boost.css" type="text/css"/>
|
||||
<link rel="stylesheet" href="ublas.css" type="text/css" />
|
||||
<script type="text/javascript" src="js/jquery-1.3.2.min.js" async="async" ></script>
|
||||
<script type="text/javascript" src="js/jquery.toc-gw.js" async="async" ></script>
|
||||
<title>Matrix</title>
|
||||
</head>
|
||||
<body>
|
||||
<h1><img src="../../../../boost.png" align="middle" />Matrix</h1>
|
||||
<div class="toc" id="toc"></div>
|
||||
<h2><a name="matrix"></a>Matrix</h2>
|
||||
<h4>Description</h4>
|
||||
<p>The templated class <code>matrix<T, F, A></code> is the
|
||||
base container adaptor for dense matrices. For a <em>(m x
|
||||
n</em>)-dimensional matrix and <em>0 <= i < m</em>, <em>0
|
||||
<= j < n</em> every element <em>m</em><sub><em>i,
|
||||
j</em></sub> is mapped to the <em>(i x n + j)-</em>th element of
|
||||
the container for row major orientation or the <em>(i + j x
|
||||
m)-</em>th element of the container for column major
|
||||
orientation.</p>
|
||||
<h4>Example</h4>
|
||||
<pre>
|
||||
#include <boost/numeric/ublas/matrix.hpp>
|
||||
#include <boost/numeric/ublas/io.hpp>
|
||||
|
||||
int main () {
|
||||
using namespace boost::numeric::ublas;
|
||||
matrix<double> m (3, 3);
|
||||
for (unsigned i = 0; i < m.size1 (); ++ i)
|
||||
for (unsigned j = 0; j < m.size2 (); ++ j)
|
||||
m (i, j) = 3 * i + j;
|
||||
std::cout << m << std::endl;
|
||||
}
|
||||
</pre>
|
||||
<h4>Definition</h4>
|
||||
<p>Defined in the header matrix.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 matrix.</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>F</code></td>
|
||||
<td>Functor describing the storage organization. <a href=
|
||||
"#matrix_1">[1]</a></td>
|
||||
<td><code>row_major</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>A</code></td>
|
||||
<td>The type of the <a href="storage_concept.html">Storage</a> array. <a href="#matrix_2">[2]</a></td>
|
||||
<td><code>unbounded_array<T></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4>Model of</h4>
|
||||
<p><a href="container_concept.html#matrix">Matrix</a> .</p>
|
||||
<h4>Type requirements</h4>
|
||||
<p>None, except for those imposed by the requirements of <a href=
|
||||
"container_concept.html#matrix">Matrix</a> .</p>
|
||||
<h4>Public base classes</h4>
|
||||
<p><code>matrix_container<matrix<T, F, A> ></code></p>
|
||||
<h4>Members</h4>
|
||||
<table border="1" summary="members">
|
||||
<tbody>
|
||||
<tr>
|
||||
<th>Member</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>matrix ()</code></td>
|
||||
<td>Allocates an uninitialized <code>matrix</code> that holds zero
|
||||
rows of zero elements.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>matrix (size_type size1, size_type size2)</code></td>
|
||||
<td>Allocates an uninitialized <code>matrix</code> that holds
|
||||
<code>size1</code> rows of <code>size2</code> elements.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>matrix (const matrix &m)</code></td>
|
||||
<td>The copy constructor.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
matrix (const matrix_expression<AE> &ae)</code></td>
|
||||
<td>The extended copy constructor.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>void resize (size_type size1, size_type size2, bool
|
||||
preserve = true)</code></td>
|
||||
<td>Reallocates a <code>matrix</code> to hold <code>size1</code>
|
||||
rows of <code>size2</code> elements. The existing elements of the
|
||||
<code>matrix</code> are preseved when specified.</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 array_type& data () const</code></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>array_type& data ()</code></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_reference operator () (size_type i, size_type j)
|
||||
const</code></td>
|
||||
<td>Returns a <code>const</code> reference of the <code>j</code>
|
||||
-th element in the <code>i</code>-th row.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>reference operator () (size_type i, size_type
|
||||
j)</code></td>
|
||||
<td>Returns a reference of the <code>j</code>-th element in the
|
||||
<code>i</code>-th row.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>matrix &operator = (const matrix &m)</code></td>
|
||||
<td>The assignment operator.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>matrix &assign_temporary (matrix &m)</code></td>
|
||||
<td>Assigns a temporary. May change the matrix <code>m</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
matrix &operator = (const matrix_expression<AE>
|
||||
&ae)</code></td>
|
||||
<td>The extended assignment operator.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
matrix &assign (const matrix_expression<AE>
|
||||
&ae)</code></td>
|
||||
<td>Assigns a matrix expression to the matrix. Left and right hand
|
||||
side of the assignment should be independent.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
matrix &operator += (const matrix_expression<AE>
|
||||
&ae)</code></td>
|
||||
<td>A computed assignment operator. Adds the matrix expression to
|
||||
the matrix.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
matrix &plus_assign (const matrix_expression<AE>
|
||||
&ae)</code></td>
|
||||
<td>Adds a matrix expression to the matrix. Left and right hand
|
||||
side of the assignment should be independent.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
matrix &operator -= (const matrix_expression<AE>
|
||||
&ae)</code></td>
|
||||
<td>A computed assignment operator. Subtracts the matrix expression
|
||||
from the matrix.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
matrix &minus_assign (const matrix_expression<AE>
|
||||
&ae)</code></td>
|
||||
<td>Subtracts a matrix expression from the matrix. Left and right
|
||||
hand side of the assignment should be independent.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AT><br />
|
||||
matrix &operator *= (const AT &at)</code></td>
|
||||
<td>A computed assignment operator. Multiplies the matrix with a
|
||||
scalar.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AT><br />
|
||||
matrix &operator /= (const AT &at)</code></td>
|
||||
<td>A computed assignment operator. Divides the matrix through a
|
||||
scalar.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>void swap (matrix &m)</code></td>
|
||||
<td>Swaps the contents of the matrices.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>void insert_element (size_type i, size_type j, const_reference
|
||||
t)</code></td>
|
||||
<td>Inserts the value <code>t</code> at the <code>j</code>-th
|
||||
element of the <code>i</code>-th row.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>void erase_element (size_type i, size_type j)</code></td>
|
||||
<td>Erases the value at the <code>j</code>-th element of the
|
||||
<code>i</code>-th row.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>void clear ()</code></td>
|
||||
<td>Clears the matrix.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_iterator1 begin1 () const</code></td>
|
||||
<td>Returns a <code>const_iterator1</code> pointing to the
|
||||
beginning of the <code>matrix</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_iterator1 end1 () const</code></td>
|
||||
<td>Returns a <code>const_iterator1</code> pointing to the end of
|
||||
the <code>matrix</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>iterator1 begin1 ()</code></td>
|
||||
<td>Returns a <code>iterator1</code> pointing to the beginning of
|
||||
the <code>matrix</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>iterator1 end1 ()</code></td>
|
||||
<td>Returns a <code>iterator1</code> pointing to the end of the
|
||||
<code>matrix</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_iterator2 begin2 () const</code></td>
|
||||
<td>Returns a <code>const_iterator2</code> pointing to the
|
||||
beginning of the <code>matrix</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_iterator2 end2 () const</code></td>
|
||||
<td>Returns a <code>const_iterator2</code> pointing to the end of
|
||||
the <code>matrix</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>iterator2 begin2 ()</code></td>
|
||||
<td>Returns a <code>iterator2</code> pointing to the beginning of
|
||||
the <code>matrix</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>iterator2 end2 ()</code></td>
|
||||
<td>Returns a <code>iterator2</code> pointing to the end of the
|
||||
<code>matrix</code>.</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 <code>matrix</code>.</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 <code>matrix</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>reverse_iterator1 rbegin1 ()</code></td>
|
||||
<td>Returns a <code>reverse_iterator1</code> pointing to the
|
||||
beginning of the reversed <code>matrix</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>reverse_iterator1 rend1 ()</code></td>
|
||||
<td>Returns a <code>reverse_iterator1</code> pointing to the end of
|
||||
the reversed <code>matrix</code>.</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 <code>matrix</code>.</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 <code>matrix</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>reverse_iterator2 rbegin2 ()</code></td>
|
||||
<td>Returns a <code>reverse_iterator2</code> pointing to the
|
||||
beginning of the reversed <code>matrix</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>reverse_iterator2 rend2 ()</code></td>
|
||||
<td>Returns a <code>reverse_iterator2</code> pointing to the end of
|
||||
the reversed <code>matrix</code>.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4>Notes</h4>
|
||||
<p><a name="matrix_1">[1]</a> Supported parameters
|
||||
for the storage organization are <code>row_major</code> and
|
||||
<code>column_major</code>.</p>
|
||||
<p><a name="matrix_2">[2]</a> Common parameters
|
||||
for the storage array are <code>unbounded_array<T></code> ,
|
||||
<code>bounded_array<T></code> and
|
||||
<code>std::vector<T></code> .</p>
|
||||
<h2><a name="identity_matrix"></a>Identity Matrix</h2>
|
||||
<h4>Description</h4>
|
||||
<p>The templated class <code>identity_matrix<T, ALLOC></code>
|
||||
represents identity matrices. For a <em>(m x n</em>)-dimensional
|
||||
identity matrix and <em>0 <= i < m</em>, <em>0 <= j <
|
||||
n</em> holds <em>id</em><sub><em>i, j</em></sub> <em>= 0</em>, if
|
||||
<em>i <> j</em>, and <em>id</em><sub><em>i, i</em></sub><em>=
|
||||
1</em>.</p>
|
||||
<h4>Example</h4>
|
||||
<pre>
|
||||
#include <boost/numeric/ublas/matrix.hpp>
|
||||
#include <boost/numeric/ublas/io.hpp>
|
||||
|
||||
int main () {
|
||||
using namespace boost::numeric::ublas;
|
||||
identity_matrix<double> m (3);
|
||||
std::cout << m << std::endl;
|
||||
}
|
||||
</pre>
|
||||
<h4>Definition</h4>
|
||||
<p>Defined in the header matrix.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 matrix.</td>
|
||||
<td><code>int</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>ALLOC</code></td>
|
||||
<td>An STL Allocator for size_type and difference_type.</td>
|
||||
<td>std::allocator</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4>Model of</h4>
|
||||
<p><a href="container_concept.html#matrix">Matrix</a> .</p>
|
||||
<h4>Type requirements</h4>
|
||||
<p>None, except for those imposed by the requirements of
|
||||
<a href="container_concept.html#matrix">Matrix</a> .</p>
|
||||
<h4>Public base classes</h4>
|
||||
<p><code>matrix_container<identity_matrix<T>
|
||||
></code></p>
|
||||
<h4>Members</h4>
|
||||
<table border="1" summary="members">
|
||||
<tbody>
|
||||
<tr>
|
||||
<th>Member</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>identity_matrix ()</code></td>
|
||||
<td>Constructs an <code>identity_matrix</code> that holds zero rows
|
||||
of zero elements.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>identity_matrix (size_type size)</code></td>
|
||||
<td>Constructs an <code>identity_matrix</code> that holds
|
||||
<code>size</code> rows of <code>size</code> elements.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>identity_matrix (const identity_matrix
|
||||
&m)</code></td>
|
||||
<td>The copy constructor.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>void resize (size_type size, bool preserve =
|
||||
true)</code></td>
|
||||
<td>Resizes a <code>identity_matrix</code> to hold
|
||||
<code>size</code> rows of <code>size</code> elements. Therefore the
|
||||
existing elements of the <code>itendity_matrix</code> are always
|
||||
preseved.</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>identity_matrix &operator = (const identity_matrix
|
||||
&m)</code></td>
|
||||
<td>The assignment operator.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>identity_matrix &assign_temporary (identity_matrix
|
||||
&m)</code></td>
|
||||
<td>Assigns a temporary. May change the identity matrix
|
||||
<code>m</code> .</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>void swap (identity_matrix &m)</code></td>
|
||||
<td>Swaps the contents of the identity matrices.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_iterator1 begin1 () const</code></td>
|
||||
<td>Returns a <code>const_iterator1</code> pointing to the
|
||||
beginning of the <code>identity_matrix</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_iterator1 end1 () const</code></td>
|
||||
<td>Returns a <code>const_iterator1</code> pointing to the end of
|
||||
the <code>identity_matrix</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_iterator2 begin2 () const</code></td>
|
||||
<td>Returns a <code>const_iterator2</code> pointing to the
|
||||
beginning of the <code>identity_matrix</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_iterator2 end2 () const</code></td>
|
||||
<td>Returns a <code>const_iterator2</code> pointing to the end of
|
||||
the <code>identity_matrix</code>.</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 <code>identity_matrix</code>.</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 <code>identity_matrix</code>.</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 <code>identity_matrix</code>.</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 <code>identity_matrix</code>.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a name="zero_matrix"></a>Zero Matrix</h2>
|
||||
<h4>Description</h4>
|
||||
<p>The templated class <code>zero_matrix<T, ALLOC></code> represents
|
||||
zero matrices. For a <em>(m x n</em>)-dimensional zero matrix and
|
||||
<em>0 <= i < m</em>, <em>0 <= j < n</em> holds
|
||||
<em>z</em><sub><em>i, j</em></sub> <em>= 0</em>.</p>
|
||||
<h4>Example</h4>
|
||||
<pre>
|
||||
#include <boost/numeric/ublas/matrix.hpp>
|
||||
#include <boost/numeric/ublas/io.hpp>
|
||||
|
||||
int main () {
|
||||
using namespace boost::numeric::ublas;
|
||||
zero_matrix<double> m (3, 3);
|
||||
std::cout << m << std::endl;
|
||||
}
|
||||
</pre>
|
||||
<h4>Definition</h4>
|
||||
<p>Defined in the header matrix.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 matrix.</td>
|
||||
<td><code>int</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>ALLOC</code></td>
|
||||
<td>An STL Allocator for size_type and difference_type.</td>
|
||||
<td>std::allocator</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4>Model of</h4>
|
||||
<p><a href="container_concept.html#matrix">Matrix</a> .</p>
|
||||
<h4>Type requirements</h4>
|
||||
<p>None, except for those imposed by the requirements of
|
||||
<a href="container_concept.html#matrix">Matrix</a> .</p>
|
||||
<h4>Public base classes</h4>
|
||||
<p><code>matrix_container<zero_matrix<T> ></code></p>
|
||||
<h4>Members</h4>
|
||||
<table border="1" summary="members">
|
||||
<tbody>
|
||||
<tr>
|
||||
<th>Member</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>zero_matrix ()</code></td>
|
||||
<td>Constructs a <code>zero_matrix</code> that holds zero rows of
|
||||
zero elements.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>zero_matrix (size_type size1, size_type
|
||||
size2)</code></td>
|
||||
<td>Constructs a <code>zero_matrix</code> that holds
|
||||
<code>size1</code> rows of <code>size2</code> elements.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>zero_matrix (const zero_matrix &m)</code></td>
|
||||
<td>The copy constructor.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>void resize (size_type size1, size_type size2, bool
|
||||
preserve = true)</code></td>
|
||||
<td>Resizes a <code>zero_matrix</code> to hold <code>size1</code>
|
||||
rows of <code>size2</code> elements. Therefore the existing
|
||||
elements of the <code>zero_matrix</code> are always preseved.</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>zero_matrix &operator = (const zero_matrix
|
||||
&m)</code></td>
|
||||
<td>The assignment operator.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>zero_matrix &assign_temporary (zero_matrix
|
||||
&m)</code></td>
|
||||
<td>Assigns a temporary. May change the zero matrix <code>m</code>
|
||||
.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>void swap (zero_matrix &m)</code></td>
|
||||
<td>Swaps the contents of the zero matrices.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_iterator1 begin1 () const</code></td>
|
||||
<td>Returns a <code>const_iterator1</code> pointing to the
|
||||
beginning of the <code>zero_matrix</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_iterator1 end1 () const</code></td>
|
||||
<td>Returns a <code>const_iterator1</code> pointing to the end of
|
||||
the <code>zero_matrix</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_iterator2 begin2 () const</code></td>
|
||||
<td>Returns a <code>const_iterator2</code> pointing to the
|
||||
beginning of the <code>zero_matrix</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_iterator2 end2 () const</code></td>
|
||||
<td>Returns a <code>const_iterator2</code> pointing to the end of
|
||||
the <code>zero_matrix</code>.</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 <code>zero_matrix</code>.</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 <code>zero_matrix</code>.</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 <code>zero_matrix</code>.</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 <code>zero_matrix</code>.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a name="scalar_matrix"></a>Scalar Matrix</h2>
|
||||
<h4>Description</h4>
|
||||
<p>The templated class <code>scalar_matrix<T, ALLOC></code>
|
||||
represents scalar matrices. For a <em>(m x n</em>)-dimensional
|
||||
scalar matrix and <em>0 <= i < m</em>, <em>0 <= j <
|
||||
n</em> holds <em>z</em><sub><em>i, j</em></sub> <em>= s</em>.</p>
|
||||
<h4>Example</h4>
|
||||
<pre>
|
||||
#include <boost/numeric/ublas/matrix.hpp>
|
||||
#include <boost/numeric/ublas/io.hpp>
|
||||
|
||||
int main () {
|
||||
using namespace boost::numeric::ublas;
|
||||
scalar_matrix<double> m (3, 3);
|
||||
std::cout << m << std::endl;
|
||||
}
|
||||
</pre>
|
||||
<h4>Definition</h4>
|
||||
<p>Defined in the header matrix.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 matrix.</td>
|
||||
<td><code>int</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>ALLOC</code></td>
|
||||
<td>An STL Allocator for size_type and difference_type.</td>
|
||||
<td>std::allocator</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4>Model of</h4>
|
||||
<p><a href="container_concept.html#matrix">Matrix</a> .</p>
|
||||
<h4>Type requirements</h4>
|
||||
<p>None, except for those imposed by the requirements of
|
||||
<a href="container_concept.html#matrix">Matrix</a> .</p>
|
||||
<h4>Public base classes</h4>
|
||||
<p><code>matrix_container<scalar_matrix<T>
|
||||
></code></p>
|
||||
<h4>Members</h4>
|
||||
<table border="1" summary="members">
|
||||
<tbody>
|
||||
<tr>
|
||||
<th>Member</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>scalar_matrix ()</code></td>
|
||||
<td>Constructs a <code>scalar_matrix</code> that holds scalar rows
|
||||
of zero elements.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>scalar_matrix (size_type size1, size_type size2, const
|
||||
value_type &value)</code></td>
|
||||
<td>Constructs a <code>scalar_matrix</code> that holds
|
||||
<code>size1</code> rows of <code>size2</code> elements each of the
|
||||
specified value.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>scalar_matrix (const scalar_matrix &m)</code></td>
|
||||
<td>The copy constructor.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>void resize (size_type size1, size_type size2, bool
|
||||
preserve = true)</code></td>
|
||||
<td>Resizes a <code>scalar_matrix</code> to hold <code>size1</code>
|
||||
rows of <code>size2</code> elements. Therefore the existing
|
||||
elements of the <code>scalar_matrix</code> are always
|
||||
preseved.</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>scalar_matrix &operator = (const scalar_matrix
|
||||
&m)</code></td>
|
||||
<td>The assignment operator.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>scalar_matrix &assign_temporary (scalar_matrix
|
||||
&m)</code></td>
|
||||
<td>Assigns a temporary. May change the scalar matrix
|
||||
<code>m</code> .</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>void swap (scalar_matrix &m)</code></td>
|
||||
<td>Swaps the contents of the scalar matrices.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_iterator1 begin1 () const</code></td>
|
||||
<td>Returns a <code>const_iterator1</code> pointing to the
|
||||
beginning of the <code>scalar_matrix</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_iterator1 end1 () const</code></td>
|
||||
<td>Returns a <code>const_iterator1</code> pointing to the end of
|
||||
the <code>scalar_matrix</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_iterator2 begin2 () const</code></td>
|
||||
<td>Returns a <code>const_iterator2</code> pointing to the
|
||||
beginning of the <code>scalar_matrix</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_iterator2 end2 () const</code></td>
|
||||
<td>Returns a <code>const_iterator2</code> pointing to the end of
|
||||
the <code>scalar_matrix</code>.</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 <code>scalar_matrix</code>.</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 <code>scalar_matrix</code>.</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 <code>scalar_matrix</code>.</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 <code>scalar_matrix</code>.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<hr />
|
||||
<p>Copyright (©) 2000-2002 Joerg Walter, Mathias Koch<br />
|
||||
Use, modification and distribution are subject to the
|
||||
Boost Software License, Version 1.0.
|
||||
(See accompanying file LICENSE_1_0.txt
|
||||
or copy at <a href="http://www.boost.org/LICENSE_1_0.txt">
|
||||
http://www.boost.org/LICENSE_1_0.txt
|
||||
</a>).
|
||||
</p>
|
||||
<script type="text/javascript">
|
||||
(function($) {
|
||||
$('#toc').toc();
|
||||
})(jQuery);
|
||||
</script>
|
||||
</body>
|
||||
</html>
|
||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,983 @@
|
||||
<!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 name="generator" content=
|
||||
"HTML Tidy for Linux/x86 (vers 1st March 2004), see www.w3.org" />
|
||||
<meta http-equiv="Content-Type" content=
|
||||
"text/html; charset=us-ascii" />
|
||||
<link rel="stylesheet" href="../../../../boost.css" type="text/css"/>
|
||||
<link rel="stylesheet" href="ublas.css" type="text/css" />
|
||||
<script type="text/javascript" src="js/jquery-1.3.2.min.js" async="async" ></script>
|
||||
<script type="text/javascript" src="js/jquery.toc-gw.js" async="async" ></script>
|
||||
<title>Sparse Matrix</title>
|
||||
</head>
|
||||
<body>
|
||||
<h1><img src="../../../../boost.png" align="middle" />Sparse Matricies</h1>
|
||||
<div class="toc" id="toc"></div>
|
||||
<h2><a name="mapped_matrix"></a>Mapped Matrix</h2>
|
||||
<h4>Description</h4>
|
||||
<p>The templated class <code>mapped_matrix<T, F, A></code> is
|
||||
the base container adaptor for sparse matricies using element maps.
|
||||
For a <em>(m xn</em>)-dimensional sparse matrix and <em>0 <= i < m</em>,
|
||||
<em>0 <= j < n</em> the non-zero elements
|
||||
<em>m</em><sub><em>i, j</em></sub> are mapped via <em>(i x n +
|
||||
j)</em> for row major orientation or via <em>(i + j x m)</em> for
|
||||
column major orientation to consecutive elements of the associative
|
||||
container, i.e. for elements <em>k</em> =
|
||||
<em>m</em><sub><em>i</em></sub><sub><sub><em>1</em></sub></sub><sub>
|
||||
<em>,j</em></sub><sub><sub><em>1</em></sub></sub>and <em>k + 1 =
|
||||
m</em><sub><em>i</em></sub><sub><sub><em>2</em></sub></sub><sub><em>
|
||||
,j</em></sub><sub><sub><em>2</em></sub></sub>of the container holds
|
||||
<em>i</em><sub><em>1</em></sub> <em><
|
||||
i</em><sub><em>2</em></sub> or <em>(i</em><sub><em>1</em></sub>
|
||||
<em>= i</em><sub><em>2</em></sub> and
|
||||
<em>j</em><sub><em>1</em></sub> <em><
|
||||
j</em><sub><em>2</em></sub><em>)</em> with row major orientation or
|
||||
<em>j</em><sub><em>1</em></sub> <em><
|
||||
j</em><sub><em>2</em></sub> or <em>(j</em><sub><em>1</em></sub>
|
||||
<em>= j</em><sub><em>2</em></sub> and
|
||||
<em>i</em><sub><em>1</em></sub> <em><
|
||||
i</em><sub><em>2</em></sub><em>)</em> with column major
|
||||
orientation.</p>
|
||||
<h4>Example</h4>
|
||||
<pre>
|
||||
#include <boost/numeric/ublas/matrix_sparse.hpp>
|
||||
#include <boost/numeric/ublas/io.hpp>
|
||||
|
||||
int main () {
|
||||
using namespace boost::numeric::ublas;
|
||||
mapped_matrix<double> m (3, 3, 3 * 3);
|
||||
for (unsigned i = 0; i < m.size1 (); ++ i)
|
||||
for (unsigned j = 0; j < m.size2 (); ++ j)
|
||||
m (i, j) = 3 * i + j;
|
||||
std::cout << m << std::endl;
|
||||
}
|
||||
</pre>
|
||||
<h4>Definition</h4>
|
||||
<p>Defined in the header matrix_sparse.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 mapped matrix.</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>F</code></td>
|
||||
<td>Functor describing the storage organization. <a href=
|
||||
"#mapped_matrix_1">[1]</a></td>
|
||||
<td><code>row_major</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>A</code></td>
|
||||
<td>The type of the adapted array. <a href=
|
||||
"#mapped_matrix_2">[2]</a></td>
|
||||
<td><code>map_std<std::size_t, T></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4>Model of</h4>
|
||||
<p><a href="container_concept.html#matrix">Matrix</a> .</p>
|
||||
<h4>Type requirements</h4>
|
||||
<p>None, except for those imposed by the requirements of <a href=
|
||||
"container_concept.html#matrix">Matrix</a> .</p>
|
||||
<h4>Public base classes</h4>
|
||||
<p><code>matrix_container<mapped_matrix<T, F, A>
|
||||
></code></p>
|
||||
<h4>Members</h4>
|
||||
<table border="1" summary="members">
|
||||
<tbody>
|
||||
<tr>
|
||||
<th>Member</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>mapped_matrix ()</code></td>
|
||||
<td>Allocates a <code>mapped_matrix</code> that holds at most zero
|
||||
rows of zero elements.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>mapped_matrix (size_type size1, size_type2, size_type non_zeros = 0)</code></td>
|
||||
<td>Allocates a <code>mapped_matrix</code> that holds at most
|
||||
<code>size1</code> rows of <code>size2</code> elements.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>mapped_matrix (const mapped_matrix &m)</code></td>
|
||||
<td>The copy constructor.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
mapped_matrix (size_type non_zeros, const
|
||||
matrix_expression<AE> &ae)</code></td>
|
||||
<td>The extended copy constructor.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>void resize (size_type size1, size_type size2, bool preserve = true)</code></td>
|
||||
<td>Reallocates a <code>mapped_matrix</code> to hold at most
|
||||
<code>size1</code> rows of <code>size2</code> elements. The
|
||||
existing elements of the <code>mapped_matrix</code> are preseved
|
||||
when specified.</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>reference operator () (size_type i, size_type
|
||||
j)</code></td>
|
||||
<td>Returns a reference of the <code>j</code>-th element in the
|
||||
<code>i</code>-th row.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>mapped_matrix &operator = (const mapped_matrix
|
||||
&m)</code></td>
|
||||
<td>The assignment operator.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>mapped_matrix &assign_temporary (mapped_matrix
|
||||
&m)</code></td>
|
||||
<td>Assigns a temporary. May change the mapped matrix
|
||||
<code>m</code> .</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
mapped_matrix &operator = (const matrix_expression<AE>
|
||||
&ae)</code></td>
|
||||
<td>The extended assignment operator.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
mapped_matrix &assign (const matrix_expression<AE>
|
||||
&ae)</code></td>
|
||||
<td>Assigns a matrix expression to the mapped matrix. Left and
|
||||
right hand side of the assignment should be independent.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
mapped_matrix &operator += (const matrix_expression<AE>
|
||||
&ae)</code></td>
|
||||
<td>A computed assignment operator. Adds the matrix expression to
|
||||
the mapped matrix.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
mapped_matrix &plus_assign (const matrix_expression<AE>
|
||||
&ae)</code></td>
|
||||
<td>Adds a matrix expression to the mapped matrix. Left and right
|
||||
hand side of the assignment should be independent.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
mapped_matrix &operator -= (const matrix_expression<AE>
|
||||
&ae)</code></td>
|
||||
<td>A computed assignment operator. Subtracts the matrix expression
|
||||
from the mapped matrix.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
mapped_matrix &minus_assign (const matrix_expression<AE>
|
||||
&ae)</code></td>
|
||||
<td>Subtracts a matrix expression from the mapped matrix. Left and
|
||||
right hand side of the assignment should be independent.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AT><br />
|
||||
mapped_matrix &operator *= (const AT &at)</code></td>
|
||||
<td>A computed assignment operator. Multiplies the mapped matrix
|
||||
with a scalar.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AT><br />
|
||||
mapped_matrix &operator /= (const AT &at)</code></td>
|
||||
<td>A computed assignment operator. Divides the mapped matrix
|
||||
through a scalar.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>void swap (mapped_matrix &m)</code></td>
|
||||
<td>Swaps the contents of the mapped matrices.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>true_refrence insert_element (size_type i, size_type j, const_reference
|
||||
t)</code></td>
|
||||
<td>Inserts the value <code>t</code> at the <code>j</code>-th
|
||||
element of the <code>i</code>-th row. Duplicates elements are not allowed.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>void erase_element (size_type i, size_type j)</code></td>
|
||||
<td>Erases the value at the <code>j</code>-th element of the
|
||||
<code>i</code>-th row.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>void clear ()</code></td>
|
||||
<td>Clears the mapped matrix.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_iterator1 begin1 () const</code></td>
|
||||
<td>Returns a <code>const_iterator1</code> pointing to the
|
||||
beginning of the <code>mapped_matrix</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_iterator1 end1 () const</code></td>
|
||||
<td>Returns a <code>const_iterator1</code> pointing to the end of
|
||||
the <code>mapped_matrix</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>iterator1 begin1 ()</code></td>
|
||||
<td>Returns a <code>iterator1</code> pointing to the beginning of
|
||||
the <code>mapped_matrix</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>iterator1 end1 ()</code></td>
|
||||
<td>Returns a <code>iterator1</code> pointing to the end of the
|
||||
<code>mapped_matrix</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_iterator2 begin2 () const</code></td>
|
||||
<td>Returns a <code>const_iterator2</code> pointing to the
|
||||
beginning of the <code>mapped_matrix</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_iterator2 end2 () const</code></td>
|
||||
<td>Returns a <code>const_iterator2</code> pointing to the end of
|
||||
the <code>mapped_matrix</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>iterator2 begin2 ()</code></td>
|
||||
<td>Returns a <code>iterator2</code> pointing to the beginning of
|
||||
the <code>mapped_matrix</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>iterator2 end2 ()</code></td>
|
||||
<td>Returns a <code>iterator2</code> pointing to the end of the
|
||||
<code>mapped_matrix</code>.</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 <code>mapped_matrix</code>.</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 <code>mapped_matrix</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>reverse_iterator1 rbegin1 ()</code></td>
|
||||
<td>Returns a <code>reverse_iterator1</code> pointing to the
|
||||
beginning of the reversed <code>mapped_matrix</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>reverse_iterator1 rend1 ()</code></td>
|
||||
<td>Returns a <code>reverse_iterator1</code> pointing to the end of
|
||||
the reversed <code>mapped_matrix</code>.</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 <code>mapped_matrix</code>.</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 <code>mapped_matrix</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>reverse_iterator2 rbegin2 ()</code></td>
|
||||
<td>Returns a <code>reverse_iterator2</code> pointing to the
|
||||
beginning of the reversed <code>mapped_matrix</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>reverse_iterator2 rend2 ()</code></td>
|
||||
<td>Returns a <code>reverse_iterator2</code> pointing to the end of
|
||||
the reversed <code>mapped_matrix</code>.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4>Notes</h4>
|
||||
<p><a name="mapped_matrix_1">[1]</a> Supported
|
||||
parameters for the storage organization are <code>row_major</code>
|
||||
and <code>column_major</code>.</p>
|
||||
<p><a name="mapped_matrix_2">[2]</a> Supported
|
||||
parameters for the adapted array are
|
||||
<code>map_array<std::size_t, T></code> and
|
||||
<code>map_std<std::size_t, T></code>. The latter is
|
||||
equivalent to <code>std::map<std::size_t, T></code>.</p>
|
||||
<h2><a name="compressed_matrix"></a>Compressed Matrix</h2>
|
||||
<h4>Description</h4>
|
||||
<p>The templated class <code>compressed_matrix<T, F, IB, IA,
|
||||
TA></code> is the base container adaptor for compressed
|
||||
matrices. For a <em>(m x n</em> )-dimensional compressed matrix and
|
||||
<em>0 <= i < m</em>, <em>0 <= j < n</em> the non-zero
|
||||
elements <em>m</em><sub><em>i, j</em></sub> are mapped via <em>(i x
|
||||
n + j)</em> for row major orientation or via <em>(i + j x m)</em>
|
||||
for column major orientation to consecutive elements of the index
|
||||
and value containers, i.e. for elements <em>k</em> =
|
||||
<em>m</em><sub><em>i</em></sub><sub><sub><em>1</em></sub></sub><sub>
|
||||
<em>,j</em></sub><sub><sub><em>1</em></sub></sub>and <em>k + 1 =
|
||||
m</em><sub><em>i</em></sub><sub><sub><em>2</em></sub></sub><sub><em>
|
||||
,j</em></sub><sub><sub><em>2</em></sub></sub>of the container holds
|
||||
<em>i</em><sub><em>1</em></sub> <em><
|
||||
i</em><sub><em>2</em></sub> or <em>(i</em><sub><em>1</em></sub>
|
||||
<em>= i</em><sub><em>2</em></sub> and
|
||||
<em>j</em><sub><em>1</em></sub> <em><
|
||||
j</em><sub><em>2</em></sub><em>)</em> with row major orientation or
|
||||
<em>j</em><sub><em>1</em></sub> <em><
|
||||
j</em><sub><em>2</em></sub> or <em>(j</em><sub><em>1</em></sub>
|
||||
<em>= j</em><sub><em>2</em></sub> and
|
||||
<em>i</em><sub><em>1</em></sub> <em><
|
||||
i</em><sub><em>2</em></sub><em>)</em> with column major
|
||||
orientation.</p>
|
||||
<h4>Example</h4>
|
||||
<pre>
|
||||
#include <boost/numeric/ublas/matrix_sparse.hpp>
|
||||
#include <boost/numeric/ublas/io.hpp>
|
||||
|
||||
int main () {
|
||||
using namespace boost::numeric::ublas;
|
||||
compressed_matrix<double> m (3, 3, 3 * 3);
|
||||
for (unsigned i = 0; i < m.size1 (); ++ i)
|
||||
for (unsigned j = 0; j < m.size2 (); ++ j)
|
||||
m (i, j) = 3 * i + j;
|
||||
std::cout << m << std::endl;
|
||||
}
|
||||
</pre>
|
||||
<h4>Definition</h4>
|
||||
<p>Defined in the header matrix_sparse.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 compressed matrix.</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>F</code></td>
|
||||
<td>Functor describing the storage organization. <a href=
|
||||
"#compressed_matrix_1">[1]</a></td>
|
||||
<td><code>row_major</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>IB</code></td>
|
||||
<td>The index base of the compressed vector. <a href=
|
||||
"#compressed_matrix_2">[2]</a></td>
|
||||
<td><code>0</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>IA</code></td>
|
||||
<td>The type of the adapted array for indices. <a href=
|
||||
"#compressed_matrix_3">[3]</a></td>
|
||||
<td><code>unbounded_array<std::size_t></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>TA</code></td>
|
||||
<td>The type of the adapted array for values. <a href=
|
||||
"#compressed_matrix_3">[3]</a></td>
|
||||
<td><code>unbounded_array<T></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4>Model of</h4>
|
||||
<p><a href="container_concept.html#matrix">Matrix</a> .</p>
|
||||
<h4>Type requirements</h4>
|
||||
<p>None, except for those imposed by the requirements of <a href=
|
||||
"container_concept.html#matrix">Matrix</a> .</p>
|
||||
<h4>Public base classes</h4>
|
||||
<p><code>matrix_container<compressed_matrix<T, F, IB, IA,
|
||||
TA> ></code></p>
|
||||
<h4>Members</h4>
|
||||
<table border="1" summary="members">
|
||||
<tbody>
|
||||
<tr>
|
||||
<th>Member</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>compressed_matrix ()</code></td>
|
||||
<td>Allocates a <code>compressed_matrix</code> that holds at most
|
||||
zero rows of zero elements.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>compressed_matrix (size_type size1, size_type2, size_type non_zeros = 0)</code></td>
|
||||
<td>Allocates a <code>compressed_matrix</code> that holds at most
|
||||
<code>size1</code> rows of <code>size2</code> elements.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>compressed_matrix (const compressed_matrix
|
||||
&m)</code></td>
|
||||
<td>The copy constructor.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
compressed_matrix (size_type non_zeros, const
|
||||
matrix_expression<AE> &ae)</code></td>
|
||||
<td>The extended copy constructor.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>void resize (size_type size1, size_type size2, bool preserve = true)</code></td>
|
||||
<td>Reallocates a <code>compressed_matrix</code> to hold at most
|
||||
<code>size1</code> rows of <code>size2</code> elements. The
|
||||
existing elements of the <code>compressed_matrix</code> are
|
||||
preseved when specified.</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>reference operator () (size_type i, size_type
|
||||
j)</code></td>
|
||||
<td>Returns a reference of the <code>j</code>-th element in the
|
||||
<code>i</code>-th row.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>compressed_matrix &operator = (const
|
||||
compressed_matrix &m)</code></td>
|
||||
<td>The assignment operator.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>compressed_matrix &assign_temporary
|
||||
(compressed_matrix &m)</code></td>
|
||||
<td>Assigns a temporary. May change the compressed matrix
|
||||
<code>m</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
compressed_matrix &operator = (const
|
||||
matrix_expression<AE> &ae)</code></td>
|
||||
<td>The extended assignment operator.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
compressed_matrix &assign (const matrix_expression<AE>
|
||||
&ae)</code></td>
|
||||
<td>Assigns a matrix expression to the compressed matrix. Left and
|
||||
right hand side of the assignment should be independent.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
compressed_matrix &operator += (const
|
||||
matrix_expression<AE> &ae)</code></td>
|
||||
<td>A computed assignment operator. Adds the matrix expression to
|
||||
the compressed matrix.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
compressed_matrix &plus_assign (const
|
||||
matrix_expression<AE> &ae)</code></td>
|
||||
<td>Adds a matrix expression to the compressed matrix. Left and
|
||||
right hand side of the assignment should be independent.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
compressed_matrix &operator -= (const
|
||||
matrix_expression<AE> &ae)</code></td>
|
||||
<td>A computed assignment operator. Subtracts the matrix expression
|
||||
from the compressed matrix.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
compressed_matrix &minus_assign (const
|
||||
matrix_expression<AE> &ae)</code></td>
|
||||
<td>Subtracts a matrix expression from the compressed matrix. Left
|
||||
and right hand side of the assignment should be independent.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AT><br />
|
||||
compressed_matrix &operator *= (const AT &at)</code></td>
|
||||
<td>A computed assignment operator. Multiplies the compressed
|
||||
matrix with a scalar.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AT><br />
|
||||
compressed_matrix &operator /= (const AT &at)</code></td>
|
||||
<td>A computed assignment operator. Divides the compressed matrix
|
||||
through a scalar.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>void swap (compressed_matrix &m)</code></td>
|
||||
<td>Swaps the contents of the compressed matrices.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>true_reference insert_element (size_type i, size_type j, const_reference
|
||||
t)</code></td>
|
||||
<td>Inserts the value <code>t</code> at the <code>j</code>-th
|
||||
element of the <code>i</code>-th row. Duplicates elements are not allowed.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>void erase_element (size_type i, size_type j)</code></td>
|
||||
<td>Erases the value at the <code>j</code>-th element of the
|
||||
<code>i</code>-th row.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>void clear ()</code></td>
|
||||
<td>Clears the compressed matrix.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_iterator1 begin1 () const</code></td>
|
||||
<td>Returns a <code>const_iterator1</code> pointing to the
|
||||
beginning of the <code>compressed_matrix</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_iterator1 end1 () const</code></td>
|
||||
<td>Returns a <code>const_iterator1</code> pointing to the end of
|
||||
the <code>compressed_matrix</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>iterator1 begin1 ()</code></td>
|
||||
<td>Returns a <code>iterator1</code> pointing to the beginning of
|
||||
the <code>compressed_matrix</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>iterator1 end1 ()</code></td>
|
||||
<td>Returns a <code>iterator1</code> pointing to the end of the
|
||||
<code>compressed_matrix</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_iterator2 begin2 () const</code></td>
|
||||
<td>Returns a <code>const_iterator2</code> pointing to the
|
||||
beginning of the <code>compressed_matrix</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_iterator2 end2 () const</code></td>
|
||||
<td>Returns a <code>const_iterator2</code> pointing to the end of
|
||||
the <code>compressed_matrix</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>iterator2 begin2 ()</code></td>
|
||||
<td>Returns a <code>iterator2</code> pointing to the beginning of
|
||||
the <code>compressed_matrix</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>iterator2 end2 ()</code></td>
|
||||
<td>Returns a <code>iterator2</code> pointing to the end of the
|
||||
<code>compressed_matrix</code>.</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 <code>compressed_matrix</code>.</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 <code>compressed_matrix</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>reverse_iterator1 rbegin1 ()</code></td>
|
||||
<td>Returns a <code>reverse_iterator1</code> pointing to the
|
||||
beginning of the reversed <code>compressed_matrix</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>reverse_iterator1 rend1 ()</code></td>
|
||||
<td>Returns a <code>reverse_iterator1</code> pointing to the end of
|
||||
the reversed <code>compressed_matrix</code>.</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 <code>compressed_matrix</code>.</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 <code>compressed_matrix</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>reverse_iterator2 rbegin2 ()</code></td>
|
||||
<td>Returns a <code>reverse_iterator2</code> pointing to the
|
||||
beginning of the reversed <code>compressed_matrix</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>reverse_iterator2 rend2 ()</code></td>
|
||||
<td>Returns a <code>reverse_iterator2</code> pointing to the end of
|
||||
the reversed <code>compressed_matrix</code>.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4>Notes</h4>
|
||||
<p><a name="compressed_matrix_1">[1]</a>
|
||||
Supported parameters for the storage organization are
|
||||
<code>row_major</code> and <code>column_major</code>.</p>
|
||||
<p><a name="compressed_matrix_2">[2]</a>
|
||||
Supported parameters for the index base are <code>0</code> and
|
||||
<code>1</code> at least.</p>
|
||||
<p><a name="compressed_matrix_3">[3]</a>
|
||||
Supported parameters for the adapted array are
|
||||
<code>unbounded_array<></code> ,
|
||||
<code>bounded_array<></code> and
|
||||
<code>std::vector<></code> .</p>
|
||||
<h2><a name="coordinate_matrix"></a>Coordinate Matrix</h2>
|
||||
<h4>Description</h4>
|
||||
<p>The templated class <code>coordinate_matrix<T, F, IB, IA,
|
||||
TA></code> is the base container adaptor for compressed
|
||||
matrices. For a <em>(m x n</em> )-dimensional sorted coordinate
|
||||
matrix and <em>0 <= i < m</em>, <em>0 <= j < n</em> the
|
||||
non-zero elements <em>m</em><sub><em>i, j</em></sub> are mapped via
|
||||
<em>(i x n + j)</em> for row major orientation or via <em>(i + j x
|
||||
m)</em> for column major orientation to consecutive elements of the
|
||||
index and value containers, i.e. for elements <em>k</em> =
|
||||
<em>m</em><sub><em>i</em></sub><sub><sub><em>1</em></sub></sub><sub>
|
||||
<em>,j</em></sub><sub><sub><em>1</em></sub></sub>and <em>k + 1 =
|
||||
m</em><sub><em>i</em></sub><sub><sub><em>2</em></sub></sub><sub><em>
|
||||
,j</em></sub><sub><sub><em>2</em></sub></sub>of the container holds
|
||||
<em>i</em><sub><em>1</em></sub> <em><
|
||||
i</em><sub><em>2</em></sub> or <em>(i</em><sub><em>1</em></sub>
|
||||
<em>= i</em><sub><em>2</em></sub> and
|
||||
<em>j</em><sub><em>1</em></sub> <em><
|
||||
j</em><sub><em>2</em></sub><em>)</em> with row major orientation or
|
||||
<em>j</em><sub><em>1</em></sub> <em><
|
||||
j</em><sub><em>2</em></sub> or <em>(j</em><sub><em>1</em></sub>
|
||||
<em>= j</em><sub><em>2</em></sub> and
|
||||
<em>i</em><sub><em>1</em></sub> <em><
|
||||
i</em><sub><em>2</em></sub><em>)</em> with column major
|
||||
orientation.</p>
|
||||
<h4>Example</h4>
|
||||
<pre>
|
||||
#include <boost/numeric/ublas/matrix_sparse.hpp>
|
||||
#include <boost/numeric/ublas/io.hpp>
|
||||
|
||||
int main () {
|
||||
using namespace boost::numeric::ublas;
|
||||
coordinate_matrix<double> m (3, 3, 3 * 3);
|
||||
for (unsigned i = 0; i < m.size1 (); ++ i)
|
||||
for (unsigned j = 0; j < m.size2 (); ++ j)
|
||||
m (i, j) = 3 * i + j;
|
||||
std::cout << m << std::endl;
|
||||
}
|
||||
</pre>
|
||||
<h4>Definition</h4>
|
||||
<p>Defined in the header matrix_sparse.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 coordinate matrix.</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>F</code></td>
|
||||
<td>Functor describing the storage organization. <a href=
|
||||
"#coordinate_matrix_1">[1]</a></td>
|
||||
<td><code>row_major</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>IB</code></td>
|
||||
<td>The index base of the coordinate vector. <a href=
|
||||
"#coordinate_matrix_2">[2]</a></td>
|
||||
<td><code>0</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>IA</code></td>
|
||||
<td>The type of the adapted array for indices. <a href=
|
||||
"#coordinate_matrix_3">[3]</a></td>
|
||||
<td><code>unbounded_array<std::size_t></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>TA</code></td>
|
||||
<td>The type of the adapted array for values. <a href=
|
||||
"#coordinate_matrix_3">[3]</a></td>
|
||||
<td><code>unbounded_array<T></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4>Model of</h4>
|
||||
<p><a href="container_concept.html#matrix">Matrix</a> .</p>
|
||||
<h4>Type requirements</h4>
|
||||
<p>None, except for those imposed by the requirements of <a href=
|
||||
"container_concept.html#matrix">Matrix</a> .</p>
|
||||
<h4>Public base classes</h4>
|
||||
<p><code>matrix_container<coordinate_matrix<T, F, IB, IA,
|
||||
TA> ></code></p>
|
||||
<h4>Members</h4>
|
||||
<table border="1" summary="members">
|
||||
<tbody>
|
||||
<tr>
|
||||
<th>Member</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>coordinate_matrix ()</code></td>
|
||||
<td>Allocates a <code>coordinate_matrix</code> that holds at most
|
||||
zero rows of zero elements.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>coordinate_matrix (size_type size1, size_type2, size_type non_zeros = 0)</code></td>
|
||||
<td>Allocates a <code>coordinate_matrix</code> that holds at most
|
||||
<code>size1</code> rows of <code>size2</code> elements.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>coordinate_matrix (const coordinate_matrix
|
||||
&m)</code></td>
|
||||
<td>The copy constructor.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
coordinate_matrix (size_type non_zeros, const
|
||||
matrix_expression<AE> &ae)</code></td>
|
||||
<td>The extended copy constructor.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>void resize (size_type size1, size_type size2, bool preserve = true)</code></td>
|
||||
<td>Reallocates a <code>coordinate_matrix</code> to hold at most
|
||||
<code>size1</code> rows of <code>size2</code> elements. The
|
||||
existing elements of the <code>coordinate_matrix</code> are
|
||||
preseved when specified.</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>reference operator () (size_type i, size_type
|
||||
j)</code></td>
|
||||
<td>Returns a reference of the <code>j</code>-th element in the
|
||||
<code>i</code>-th row.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>coordinate_matrix &operator = (const
|
||||
coordinate_matrix &m)</code></td>
|
||||
<td>The assignment operator.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>coordinate_matrix &assign_temporary
|
||||
(coordinate_matrix &m)</code></td>
|
||||
<td>Assigns a temporary. May change the coordinate matrix
|
||||
<code>m</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
coordinate_matrix &operator = (const
|
||||
matrix_expression<AE> &ae)</code></td>
|
||||
<td>The extended assignment operator.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
coordinate_matrix &assign (const matrix_expression<AE>
|
||||
&ae)</code></td>
|
||||
<td>Assigns a matrix expression to the coordinate matrix. Left and
|
||||
right hand side of the assignment should be independent.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
coordinate_matrix &operator += (const
|
||||
matrix_expression<AE> &ae)</code></td>
|
||||
<td>A computed assignment operator. Adds the matrix expression to
|
||||
the coordinate matrix.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
coordinate_matrix &plus_assign (const
|
||||
matrix_expression<AE> &ae)</code></td>
|
||||
<td>Adds a matrix expression to the coordinate matrix. Left and
|
||||
right hand side of the assignment should be independent.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
coordinate_matrix &operator -= (const
|
||||
matrix_expression<AE> &ae)</code></td>
|
||||
<td>A computed assignment operator. Subtracts the matrix expression
|
||||
from the coordinate matrix.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
coordinate_matrix &minus_assign (const
|
||||
matrix_expression<AE> &ae)</code></td>
|
||||
<td>Subtracts a matrix expression from the coordinate matrix. Left
|
||||
and right hand side of the assignment should be independent.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AT><br />
|
||||
coordinate_matrix &operator *= (const AT &at)</code></td>
|
||||
<td>A computed assignment operator. Multiplies the coordinate
|
||||
matrix with a scalar.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AT><br />
|
||||
coordinate_matrix &operator /= (const AT &at)</code></td>
|
||||
<td>A computed assignment operator. Divides the coordinate matrix
|
||||
through a scalar.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>void swap (coordinate_matrix &m)</code></td>
|
||||
<td>Swaps the contents of the coordinate matrices.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>true_reference insert_element (size_type i, size_type j, const_reference
|
||||
t)</code></td>
|
||||
<td>Inserts the value <code>t</code> at the <code>j</code>-th
|
||||
element of the <code>i</code>-th row. Duplicates elements are not allowed.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>void append_element (size_type i, size_type j, const_reference t)</code></td>
|
||||
<td>Appends the value <code>t</code> at the <code>j</code>-th element of the <code>i</code>-th row.
|
||||
Duplicate elements can be appended to a <code>coordinate_matrix</code>. They are merged into a single
|
||||
arithmetically summed element by the <code>sort</code> function.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>void erase_element (size_type i, size_type j)</code></td>
|
||||
<td>Erases the value at the <code>j</code>-th element of the
|
||||
<code>i</code>-th row.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>void clear ()</code></td>
|
||||
<td>Clears the coordinate matrix.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_iterator1 begin1 () const</code></td>
|
||||
<td>Returns a <code>const_iterator1</code> pointing to the
|
||||
beginning of the <code>coordinate_matrix</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_iterator1 end1 () const</code></td>
|
||||
<td>Returns a <code>const_iterator1</code> pointing to the end of
|
||||
the <code>coordinate_matrix</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>iterator1 begin1 ()</code></td>
|
||||
<td>Returns a <code>iterator1</code> pointing to the beginning of
|
||||
the <code>coordinate_matrix</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>iterator1 end1 ()</code></td>
|
||||
<td>Returns a <code>iterator1</code> pointing to the end of the
|
||||
<code>coordinate_matrix</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_iterator2 begin2 () const</code></td>
|
||||
<td>Returns a <code>const_iterator2</code> pointing to the
|
||||
beginning of the <code>coordinate_matrix</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_iterator2 end2 () const</code></td>
|
||||
<td>Returns a <code>const_iterator2</code> pointing to the end of
|
||||
the <code>coordinate_matrix</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>iterator2 begin2 ()</code></td>
|
||||
<td>Returns a <code>iterator2</code> pointing to the beginning of
|
||||
the <code>coordinate_matrix</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>iterator2 end2 ()</code></td>
|
||||
<td>Returns a <code>iterator2</code> pointing to the end of the
|
||||
<code>coordinate_matrix</code>.</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 <code>coordinate_matrix</code>.</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 <code>coordinate_matrix</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>reverse_iterator1 rbegin1 ()</code></td>
|
||||
<td>Returns a <code>reverse_iterator1</code> pointing to the
|
||||
beginning of the reversed <code>coordinate_matrix</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>reverse_iterator1 rend1 ()</code></td>
|
||||
<td>Returns a <code>reverse_iterator1</code> pointing to the end of
|
||||
the reversed <code>coordinate_matrix</code>.</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 <code>coordinate_matrix</code>.</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 <code>coordinate_matrix</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>reverse_iterator2 rbegin2 ()</code></td>
|
||||
<td>Returns a <code>reverse_iterator2</code> pointing to the
|
||||
beginning of the reversed <code>coordinate_matrix</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>reverse_iterator2 rend2 ()</code></td>
|
||||
<td>Returns a <code>reverse_iterator2</code> pointing to the end of
|
||||
the reversed <code>coordinate_matrix</code>.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4>Notes</h4>
|
||||
<p><a name="coordinate_matrix_1">[1]</a>
|
||||
Supported parameters for the storage organization are
|
||||
<code>row_major</code> and <code>column_major</code>.</p>
|
||||
<p><a name="coordinate_matrix_2">[2]</a>
|
||||
Supported parameters for the index base are <code>0</code> and
|
||||
<code>1</code> at least.</p>
|
||||
<p><a name="coordinate_matrix_3">[3]</a>
|
||||
Supported parameters for the adapted array are
|
||||
<code>unbounded_array<></code> ,
|
||||
<code>bounded_array<></code> and
|
||||
<code>std::vector<></code> .</p>
|
||||
<hr />
|
||||
<p>Copyright (©) 2000-2002 Joerg Walter, Mathias Koch<br />
|
||||
Use, modification and distribution are subject to the
|
||||
Boost Software License, Version 1.0.
|
||||
(See accompanying file LICENSE_1_0.txt
|
||||
or copy at <a href="http://www.boost.org/LICENSE_1_0.txt">
|
||||
http://www.boost.org/LICENSE_1_0.txt
|
||||
</a>).
|
||||
</p>
|
||||
<script type="text/javascript">
|
||||
(function($) {
|
||||
$('#toc').toc();
|
||||
})(jQuery);
|
||||
</script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,261 @@
|
||||
<!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 name="generator" content=
|
||||
"HTML Tidy for Linux/x86 (vers 1st March 2004), see www.w3.org" />
|
||||
<meta name="GENERATOR" content="Quanta Plus" />
|
||||
<meta http-equiv="Content-Type" content=
|
||||
"text/html; charset=us-ascii" />
|
||||
<link rel="stylesheet" href="../../../../boost.css" type="text/css"/>
|
||||
<link rel="stylesheet" href="ublas.css" type="text/css" />
|
||||
<script type="text/javascript" src="js/jquery-1.3.2.min.js" async="async" ></script>
|
||||
<script type="text/javascript" src="js/jquery.toc-gw.js" async="async" ></script>
|
||||
<title>uBLAS operations overview</title>
|
||||
</head>
|
||||
<body>
|
||||
<h1><img src="../../../../boost.png" align="middle" />Overview of Matrix and Vector Operations</h1>
|
||||
<div class="toc" id="toc"></div>
|
||||
|
||||
<dl>
|
||||
<dt>Contents:</dt>
|
||||
<dd><a href="#blas">Basic Linear Algebra</a></dd>
|
||||
<dd><a href="#advanced">Advanced Functions</a></dd>
|
||||
<dd><a href="#sub">Submatrices, Subvectors</a></dd>
|
||||
<dd><a href="#speed">Speed Improvements</a></dd>
|
||||
</dl>
|
||||
|
||||
<h2>Definitions</h2>
|
||||
|
||||
<table style="" summary="notation">
|
||||
<tr><td><code>A, B, C</code></td>
|
||||
<td> are matrices</td></tr>
|
||||
<tr><td><code>u, v, w</code></td>
|
||||
<td>are vectors</td></tr>
|
||||
<tr><td><code>i, j, k</code></td>
|
||||
<td>are integer values</td></tr>
|
||||
<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="range.html">ranges</a>, e.g. <code>range(0, 3)</code></td></tr>
|
||||
<tr><td><code>s, s1, s2</code></td>
|
||||
<td>are <a href="range.html#slice">slices</a>, e.g. <code>slice(0, 1, 3)</code></td></tr>
|
||||
</table>
|
||||
|
||||
<h2><a name="blas">Basic Linear Algebra</a></h2>
|
||||
|
||||
<h3>standard operations: addition, subtraction, multiplication by a
|
||||
scalar</h3>
|
||||
|
||||
<pre><code>
|
||||
C = A + B; C = A - B; C = -A;
|
||||
w = u + v; w = u - v; w = -u;
|
||||
C = t * A; C = A * t; C = A / t;
|
||||
w = t * u; w = u * t; w = u / t;
|
||||
</code></pre>
|
||||
|
||||
<h3>computed assignments</h3>
|
||||
|
||||
<pre><code>
|
||||
C += A; C -= A;
|
||||
w += u; w -= u;
|
||||
C *= t; C /= t;
|
||||
w *= t; w /= t;
|
||||
</code></pre>
|
||||
|
||||
<h3>inner, outer and other products</h3>
|
||||
|
||||
<pre><code>
|
||||
t = inner_prod(u, v);
|
||||
C = outer_prod(u, v);
|
||||
w = prod(A, u); w = prod(u, A); w = prec_prod(A, u); w = prec_prod(u, A);
|
||||
C = prod(A, B); C = prec_prod(A, B);
|
||||
w = element_prod(u, v); w = element_div(u, v);
|
||||
C = element_prod(A, B); C = element_div(A, B);
|
||||
</code></pre>
|
||||
|
||||
<h3>transformations</h3>
|
||||
|
||||
<pre><code>
|
||||
w = conj(u); w = real(u); w = imag(u);
|
||||
C = trans(A); C = conj(A); C = herm(A); C = real(A); C = imag(A);
|
||||
</code></pre>
|
||||
|
||||
<h2><a name="advanced">Advanced functions</a></h2>
|
||||
|
||||
<h3>norms</h3>
|
||||
|
||||
<pre><code>
|
||||
t = norm_inf(v); i = index_norm_inf(v);
|
||||
t = norm_1(v); t = norm_2(v);
|
||||
t = norm_inf(A); i = index_norm_inf(A);
|
||||
t = norm_1(A); t = norm_frobenius(A);
|
||||
</code></pre>
|
||||
|
||||
<h3>products</h3>
|
||||
|
||||
<pre><code>
|
||||
axpy_prod(A, u, w, true); // w = A * u
|
||||
axpy_prod(A, u, w, false); // w += A * u
|
||||
axpy_prod(u, A, w, true); // w = trans(A) * u
|
||||
axpy_prod(u, A, w, false); // w += trans(A) * u
|
||||
axpy_prod(A, B, C, true); // C = A * B
|
||||
axpy_prod(A, B, C, false); // C += A * B
|
||||
</code></pre>
|
||||
<p><em>Note:</em> The last argument (<code>bool init</code>) of
|
||||
<code>axpy_prod</code> is optional. Currently it defaults to
|
||||
<code>true</code>, but this may change in the future. Setting the
|
||||
<code>init</code> to <code>true</code> is equivalent to calling
|
||||
<code>w.clear()</code> before <code>axpy_prod</code>.
|
||||
There are some specialisation for products of compressed matrices that give a
|
||||
large speed up compared to <code>prod</code>.</p>
|
||||
<pre><code>
|
||||
w = block_prod<matrix_type, 64> (A, u); // w = A * u
|
||||
w = block_prod<matrix_type, 64> (u, A); // w = trans(A) * u
|
||||
C = block_prod<matrix_type, 64> (A, B); // C = A * B
|
||||
</code></pre>
|
||||
<p><em>Note:</em> The blocksize can be any integer. However, the
|
||||
actual speed depends very significantly on the combination of blocksize,
|
||||
CPU and compiler. The function <code>block_prod</code> is designed
|
||||
for large dense matrices.</p>
|
||||
<h3>rank-k updates</h3>
|
||||
<pre><code>
|
||||
opb_prod(A, B, C, true); // C = A * B
|
||||
opb_prod(A, B, C, false); // C += A * B
|
||||
</code></pre>
|
||||
<p><em>Note:</em> The last argument (<code>bool init</code>) of
|
||||
<code>opb_prod</code> is optional. Currently it defaults to
|
||||
<code>true</code>, but this may change in the future. This function
|
||||
may give a speedup if <code>A</code> has less columns than rows,
|
||||
because the product is computed as a sum of outer products.</p>
|
||||
|
||||
<h2><a name="sub">Submatrices, Subvectors</a></h2>
|
||||
<p>Accessing submatrices and subvectors via <b>proxies</b> using <code>project</code> functions:</p>
|
||||
<pre><code>
|
||||
w = project(u, r); // the subvector of u specifed by the index range r
|
||||
w = project(u, s); // the subvector of u specifed by the index slice s
|
||||
C = project(A, r1, r2); // the submatrix of A specified by the two index ranges r1 and r2
|
||||
C = project(A, s1, s2); // the submatrix of A specified by the two index slices s1 and s2
|
||||
w = row(A, i); w = column(A, j); // a row or column of matrix as a vector
|
||||
</code></pre>
|
||||
<p>Assigning to submatrices and subvectors via <b>proxies</b> using <code>project</code> functions:</p>
|
||||
<pre><code>
|
||||
project(u, r) = w; // assign the subvector of u specifed by the index range r
|
||||
project(u, s) = w; // assign the subvector of u specifed by the index slice s
|
||||
project(A, r1, r2) = C; // assign the submatrix of A specified by the two index ranges r1 and r2
|
||||
project(A, s1, s2) = C; // assign the submatrix of A specified by the two index slices s1 and s2
|
||||
row(A, i) = w; column(A, j) = w; // a row or column of matrix as a vector
|
||||
</code></pre>
|
||||
<p><em>Note:</em> A range <code>r = range(start, stop)</code>
|
||||
contains all indices <code>i</code> with <code>start <= i <
|
||||
stop</code>. A slice is something more general. The slice
|
||||
<code>s = slice(start, stride, size)</code> contains the indices
|
||||
<code>start, start+stride, ..., start+(size-1)*stride</code>. The
|
||||
stride can be 0 or negative! If <code>start >= stop</code> for a range
|
||||
or <code>size == 0</code> for a slice then it contains no elements.</p>
|
||||
<p>Sub-ranges and sub-slices of vectors and matrices can be created directly with the <code>subrange</code> and <code>sublice</code> functions:</p>
|
||||
<pre><code>
|
||||
w = subrange(u, 0, 2); // the 2 element subvector of u
|
||||
w = subslice(u, 0, 1, 2); // the 2 element subvector of u
|
||||
C = subrange(A, 0,2, 0,3); // the 2x3 element submatrix of A
|
||||
C = subslice(A, 0,1,2, 0,1,3); // the 2x3 element submatrix of A
|
||||
subrange(u, 0, 2) = w; // assign the 2 element subvector of u
|
||||
subslice(u, 0, 1, 2) = w; // assign the 2 element subvector of u
|
||||
subrange(A, 0,2, 0,3) = C; // assign the 2x3 element submatrix of A
|
||||
subrange(A, 0,1,2, 0,1,3) = C; // assigne the 2x3 element submatrix of A
|
||||
</code></pre>
|
||||
<p>There are to more ways to access some matrix elements as a
|
||||
vector:</p>
|
||||
<pre><code>matrix_vector_range<matrix_type> (A, r1, r2);
|
||||
matrix_vector_slice<matrix_type> (A, s1, s2);
|
||||
</code></pre>
|
||||
<p><em>Note:</em> These matrix proxies take a sequence of elements
|
||||
of a matrix and allow you to access these as a vector. In
|
||||
particular <code>matrix_vector_slice</code> can do this in a very
|
||||
general way. <code>matrix_vector_range</code> is less useful as the
|
||||
elements must lie along a diagonal.</p>
|
||||
<p><em>Example:</em> To access the first two elements of a sub
|
||||
column of a matrix we access the row with a slice with stride 1 and
|
||||
the column with a slice with stride 0 thus:<br />
|
||||
<code>matrix_vector_slice<matrix_type> (A, slice(0,1,2),
|
||||
slice(0,0,2));
|
||||
</code></p>
|
||||
|
||||
<h2><a name="speed">Speed improvements</a></h2>
|
||||
<h3><a name='noalias'>Matrix / Vector assignment</a></h3>
|
||||
<p>If you know for sure that the left hand expression and the right
|
||||
hand expression have no common storage, then assignment has
|
||||
no <em>aliasing</em>. A more efficient assignment can be specified
|
||||
in this case:</p>
|
||||
<pre><code>noalias(C) = prod(A, B);
|
||||
</code></pre>
|
||||
<p>This avoids the creation of a temporary matrix that is required in a normal assignment.
|
||||
'noalias' assignment requires that the left and right hand side be size conformant.</p>
|
||||
|
||||
<h3>Sparse element access</h3>
|
||||
<p>The matrix element access function <code>A(i1,i2)</code> or the equivalent vector
|
||||
element access functions (<code>v(i) or v[i]</code>) usually create 'sparse element proxies'
|
||||
when applied to a sparse matrix or vector. These <em>proxies</em> allow access to elements
|
||||
without having to worry about nasty C++ issues where references are invalidated.</p>
|
||||
<p>These 'sparse element proxies' can be implemented more efficiently when applied to <code>const</code>
|
||||
objects.
|
||||
Sadly in C++ there is no way to distinguish between an element access on the left and right hand side of
|
||||
an assignment. Most often elements on the right hand side will not be changed and therefore it would
|
||||
be better to use the <code>const</code> proxies. We can do this by making the matrix or vector
|
||||
<code>const</code> before accessing it's elements. For example:</p>
|
||||
<pre><code>value = const_cast<const VEC>(v)[i]; // VEC is the type of V
|
||||
</code></pre>
|
||||
<p>If more then one element needs to be accessed <code>const_iterator</code>'s should be used
|
||||
in preference to <code>iterator</code>'s for the same reason. For the more daring 'sparse element proxies'
|
||||
can be completely turned off in uBLAS by defining the configuration macro <code>BOOST_UBLAS_NO_ELEMENT_PROXIES</code>.
|
||||
</p>
|
||||
|
||||
|
||||
<h3>Controlling the complexity of nested products</h3>
|
||||
|
||||
<p>What is the complexity (the number of add and multiply operations) required to compute the following?
|
||||
</p>
|
||||
<pre>
|
||||
R = prod(A, prod(B,C));
|
||||
</pre>
|
||||
<p>Firstly the complexity depends on matrix size. Also since prod is transitive (not commutative)
|
||||
the bracket order affects the complexity.
|
||||
</p>
|
||||
<p>uBLAS evaluates expressions without matrix or vector temporaries and honours
|
||||
the bracketing structure. However avoiding temporaries for nested product unnecessarly increases the complexity.
|
||||
Conversly by explictly using temporary matrices the complexity of a nested product can be reduced.
|
||||
</p>
|
||||
<p>uBLAS provides 3 alternative syntaxes for this purpose:
|
||||
</p>
|
||||
<pre>
|
||||
temp_type T = prod(B,C); R = prod(A,T); // Preferable if T is preallocated
|
||||
</pre>
|
||||
<pre>
|
||||
prod(A, temp_type(prod(B,C));
|
||||
</pre>
|
||||
<pre>
|
||||
prod(A, prod<temp_type>(B,C));
|
||||
</pre>
|
||||
<p>The 'temp_type' is important. Given A,B,C are all of the same type. Say
|
||||
matrix<float>, the choice is easy. However if the value_type is mixed (int with float or double)
|
||||
or the matrix type is mixed (sparse with symmetric) the best solution is not so obvious. It is up to you! It
|
||||
depends on numerical properties of A and the result of the prod(B,C).
|
||||
</p>
|
||||
|
||||
<hr />
|
||||
<p>Copyright (©) 2000-2007 Joerg Walter, Mathias Koch, Gunter
|
||||
Winkler, Michael Stevens<br />
|
||||
Use, modification and distribution are subject to the
|
||||
Boost Software License, Version 1.0.
|
||||
(See accompanying file LICENSE_1_0.txt
|
||||
or copy at <a href="http://www.boost.org/LICENSE_1_0.txt">
|
||||
http://www.boost.org/LICENSE_1_0.txt
|
||||
</a>).
|
||||
</p>
|
||||
<script type="text/javascript">
|
||||
(function($) {
|
||||
$('#toc').toc();
|
||||
})(jQuery);
|
||||
</script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,247 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" >
|
||||
<head>
|
||||
<meta name="generator" content="HTML Tidy for Linux (vers 6 November 2007), see www.w3.org" />
|
||||
<!-- tidy options: -w 120 -asxhtml -clean - - vertical-space yes -f index.html.err -m index.html -->
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii" />
|
||||
<link rel="stylesheet" href="../../../../boost.css" type="text/css"/>
|
||||
<link rel="stylesheet" href="ublas.css" type="text/css" />
|
||||
<script type="text/javascript" src="js/jquery-1.3.2.min.js" async="async" ></script>
|
||||
<script type="text/javascript" src="js/jquery.toc-gw.js" async="async" ></script>
|
||||
<title>Boost Basic Linear Algebra - Configuration Options</title>
|
||||
</head>
|
||||
<body>
|
||||
<h1><img src="../../../../boost.png" align="middle" alt="logo"/>Boost Basic Linear Algebra - Configuration Options</h1>
|
||||
<div class="toc" id="toc"></div>
|
||||
|
||||
<div class="navigation">
|
||||
<a href="index.html">back to uBLAS home</a>
|
||||
</div>
|
||||
|
||||
<h2>NDEBUG</h2>
|
||||
|
||||
<p><strong>Make sure you define NDEBUG</strong> The only way uBLAS
|
||||
knows you want a release configuration is to check if you have defined
|
||||
NDEBUG. If you don't it assumes you want a debug configuration and
|
||||
adds a lot of very useful runtime check. However these are very slow!
|
||||
</p>
|
||||
|
||||
|
||||
<h2>BOOST_UBLAS_MOVE_SEMANTICS</h2>
|
||||
|
||||
<p class="credit">The patch and description was provided by Nasos Iliopoulos.</p>
|
||||
|
||||
<p>An immediate effect of this option is the elimination of the need
|
||||
for noalias in types <tt>vector<T></tt> and <tt>matrix<T></tt>,
|
||||
when assigned to the same type. This option doesn't have an effect on
|
||||
bounded and c types. Although it is rare, not all compilers support copy
|
||||
elision (that allows for move semantics), so a test must be performed to
|
||||
make sure that there is a benefit when it is enabled. A small
|
||||
demonstration and test can be found in
|
||||
<a href="../test/manual/test_move_semantics.cpp"><tt>test_move_semantics.cpp</tt></a></p>
|
||||
|
||||
<p>
|
||||
In the <a href="../test/manual/test_move_semantics.cpp">test
|
||||
example</a> two tests are defined, one for vectors and one for
|
||||
matrices. The aim of this example is to print the pointers of the
|
||||
storage of each of the containers, before and after the assignment to
|
||||
a temporary object. When move semantics are enabled, the
|
||||
<tt>vector<T></tt> and <tt>matrix<T></tt> storage is moved
|
||||
from the temporary and no copy is performed.
|
||||
</p>
|
||||
|
||||
<p>
|
||||
If move semantics are supported by your compiler you will get an output like the following:
|
||||
</p>
|
||||
<pre class="screen">
|
||||
matrix<double> --------------------------------------------------------------------
|
||||
Temporary pointer r: 0x94790c0
|
||||
Pointer (must be equal to temp. pointer if move semantics are enabled) : 0x94790c0
|
||||
</pre>
|
||||
|
||||
<p>Notes:</p>
|
||||
<ul>
|
||||
<li>It should be no surprise to see matrices and vectors been passed
|
||||
by VALUE, the compiler takes care and either moves (if the underlying
|
||||
code does not modify the object), or copies (if the underlying code
|
||||
modifies the object).
|
||||
</li>
|
||||
<li>There might be some space for some improvements (like clearing the
|
||||
data, before swaping)
|
||||
</li>
|
||||
<li>Move semantics don't eliminate temporaries. They rather move their
|
||||
storage around so no copies are performed.
|
||||
</li>
|
||||
<li>MSVC does no implement Named Return Value Optimization in debug
|
||||
mode. So if you build in debug with this compiler you might get <a
|
||||
href="https://connect.microsoft.com/VisualStudio/feedback/ViewFeedback.aspx?FeedbackID=483229"
|
||||
target="_blank">different behaviour</a> than a release build.
|
||||
</li>
|
||||
<li>Enabling move semantics is done via #define BOOST_UBLAS_MOVE_SEMANTICS.
|
||||
</li>
|
||||
<li>There is plenty of room for optimizations when c++0x standard is
|
||||
out, taking advantage of rvalue references. (I have a sweet vector
|
||||
implementation using that).
|
||||
</li>
|
||||
<li>If you enable move semantics and your compiler does not support
|
||||
them, the operation will just be as passing by const reference.
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<p>Interesting links</p>
|
||||
<ul>
|
||||
<li> <a href="http://cpp-next.com/archive/2009/08/want-speed-pass-by-value/" target="_blank">Want Speed? Pass by Value.</a>
|
||||
</li>
|
||||
<li> <a href="http://blogs.msdn.com/vcblog/archive/2009/02/03/rvalue-references-c-0x-features-in-vc10-part-2.aspx" target="_blank">Rvalue References: C++0x Features in VC10, Part 2</a>
|
||||
</li>
|
||||
<li> <a href="http://cpp-next.com/archive/2009/09/move-it-with-rvalue-references/" target="_blank">Move It With Rvalue References</a>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h2>BOOST_UBLAS_CHECK_ENABLE</h2>
|
||||
|
||||
<p>When BOOST_UBLAS_CHECK_ENABLE is defined then all index and
|
||||
parameter checks are enabled. This is enabled in debug mode and
|
||||
disabled in release mode.
|
||||
</p>
|
||||
|
||||
<h2>BOOST_UBLAS_TYPE_CHECK</h2>
|
||||
|
||||
<p>When BOOST_UBLAS_TYPE_CHECK is enabled then all possibly expensive
|
||||
structure checks are enabled. If this is not desireable then use
|
||||
<tt>#define BOOST_UBLAS_TYPE_CHECK 0</tt> before including any uBLAS
|
||||
header. The define BOOST_UBLAS_TYPE_CHECK_EPSILON can be used to
|
||||
control the acceptable tolerance, see
|
||||
<tt>detail/matrix_assign.hpp</tt> for implementation details of this
|
||||
check.
|
||||
</p>
|
||||
|
||||
<h2>BOOST_UBLAS_USE_LONG_DOUBLE</h2>
|
||||
|
||||
<p>Enable uBLAS expressions that involve containers of 'long double'</p>
|
||||
|
||||
<h2>BOOST_UBLAS_USE_INTERVAL</h2>
|
||||
|
||||
<p>Enable uBLAS expressions that involve containers of 'boost::numeric::interval' types</p>
|
||||
|
||||
<h2>Configuring uBLAS with Macros</h2>
|
||||
|
||||
<p>Many macro's appear in ublas/config.hpp and elsewhere. Hopefully in the future some of these will disappear!
|
||||
They fall into 4 groups:
|
||||
</p>
|
||||
<ul>
|
||||
<li> Automatically set by 'boost/numeric/ublas/config.hpp' based on
|
||||
NDEBUG. Makes the distinction between debug (safe) and release (fast)
|
||||
mode. Similar to STLport
|
||||
<ul>
|
||||
<li> <i>Release</i> mode (NDEBUG defined)
|
||||
<ul>
|
||||
<li> BOOST_UBLAS_INLINE <i>Compiler dependant definition to control
|
||||
function inlining.</i> </li><li> BOOST_UBLAS_USE_FAST_SAME </li></ul>
|
||||
</li><li> <i>Debug</i> mode
|
||||
<ul>
|
||||
<li> BOOST_UBLAS_CHECK_ENABLE <i>Enable checking of indexs, iterators
|
||||
and parameters. Prevents out of bound access etc.</i> </li><li>
|
||||
BOOST_UBLAS_TYPE_CHECK <i>Enable additional checks for the results of
|
||||
expressions using non dense types. Picks up runtime error such as the
|
||||
assignment of a numerically non-symmetric matrix to
|
||||
symmertic_matrix. Use <tt>#define BOOST_UBLAS_TYPE_CHECK 0</tt> to
|
||||
disable expensive numeric type checks.</i> (Note: "structure check"
|
||||
would be a much better name.) </li><li>
|
||||
BOOST_UBLAS_TYPE_CHECK_EPSILON <i>default: sqrt(epsilon), controls how
|
||||
large the difference between the expected result and the computed
|
||||
result may become. Increase this value if you are going to use near
|
||||
singular or badly scaled matrices. Please, refer to
|
||||
<tt>detail/matrix_assign.hpp</tt> for implementation of these type
|
||||
checks.</i> </li></ul> </li></ul>
|
||||
</li>
|
||||
<li> Automatically set by 'boost/numeric/ublas/config.hpp' based on
|
||||
compiler and boost/config.hpp macro's. Augments the compiler
|
||||
deficiency workarounds already supplied by boost/config.hpp
|
||||
<ul>
|
||||
<li> BOOST_UBLAS_NO_NESTED_CLASS_RELATION <i>A particularly nasty
|
||||
problem with VC7.1 Requires that uBLAS and the user use begin(it)
|
||||
rather then it.begin()</i> </li><li> BOOST_UBLAS_NO_SMART_PROXIES
|
||||
<i>Disable the automatic propagation of 'constantness' to
|
||||
proxies. Smart proxies automatically determine if the underling
|
||||
container they reference is constant or not. They adjust there
|
||||
definition of iterators and container access to reflect this
|
||||
constantness.</i> </li></ul>
|
||||
</li>
|
||||
<li> For use by uBLAS authors to test implementation methods. Preset
|
||||
in config.hpp
|
||||
<ul>
|
||||
<li> BOOST_UBLAS_USE_INVARIANT_HOISTING </li><li>
|
||||
BOOST_UBLAS_USE_INDEXING </li><li> BOOST_UBLAS_USE_INDEXED_ITERATOR
|
||||
</li><li> BOOST_UBLAS_NON_CONFORMANT_PROXIES <i>Gappy containers may
|
||||
be non-conformant, that is contain elements at different
|
||||
indices. Assigning between proxies (vector ranges for example) of
|
||||
these containers is difficult as the LHS may need insert new
|
||||
elements. This is slow.</i> </li><li> BOOST_UBLAS_USE_DUFF_DEVICE
|
||||
<i>Near useless on all platforms (see GCC's -funroll-loops)</i>
|
||||
|
||||
</li></ul>
|
||||
</li>
|
||||
<li> User options. Can be predefined by user before including any
|
||||
uBLAS headers. They may also be automatically defined for some
|
||||
compilers to work around compile bugs.
|
||||
<ul>
|
||||
<li> BOOST_UBLAS_USE_LONG_DOUBLE <i>Enable uBLAS expressions that
|
||||
involve containers of 'long double'</i> </li><li>
|
||||
BOOST_UBLAS_USE_INTERVAL <i>Enable uBLAS expressions that involve
|
||||
containers of 'boost::numeric::interval' types</i> </li><li>
|
||||
BOOST_UBLAS_SIMPLE_ET_DEBUG <i>In order to simplify debugging is is
|
||||
possible to simplify expression templateso they are restricted to a
|
||||
single operation</i>
|
||||
|
||||
</li><li> BOOST_UBLAS_ENABLE_PROXY_SHORTCUTS <i> enable automatic
|
||||
conversion from proxy class to matrix expression </i> </li><li>
|
||||
BOOST_UBLAS_NO_ELEMENT_PROXIES <i>Disables the use of element proxies
|
||||
for gappy types.</i> </li><li> <i>The Gappy types (sparse, coordinate,
|
||||
compressed) store non-zero elements in their own containers. When new
|
||||
non-zero elements are assigned they must rearrange these
|
||||
containers. This invalidates references, iterators or pointers to
|
||||
these elements. This can happen at some surprising times such as the
|
||||
expression "a [1] = a [0] = 1;". Element proxies guarantee all such
|
||||
expressions will work as expected. However they bring their own
|
||||
restrictions and efficiency problems. For example as of Boost 1.30.0
|
||||
they prevent the assignment of elements between different types.</i>
|
||||
</li>
|
||||
<li> BOOST_UBLAS_REFERENCE_CONST_MEMBER <i>Enable to allow refernces
|
||||
to be returned to fixed (zero or one) elements of triangular or banded
|
||||
matrices</i>
|
||||
|
||||
</li><li> BOOST_UBLAS_NO_EXCEPTIONS <i>Disable the use exceptions of
|
||||
uBLAS internal checks and error conditions. BOOST_NO_EXCEPTIONS has
|
||||
same effect.</i>
|
||||
</li>
|
||||
<li> BOOST_UBLAS_SINGULAR_CHECK <i>Check the for singularity in triangular solve() functions</i></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<hr />
|
||||
<div id="copyright">
|
||||
<p>Copyright (©) 2000-2009 Joerg Walter, Mathias Koch, Gunter Winkler<br />
|
||||
Use, modification and distribution are subject to the Boost Software License, Version 1.0.
|
||||
(See accompanying file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt">
|
||||
http://www.boost.org/LICENSE_1_0.txt
|
||||
</a>).
|
||||
</p>
|
||||
</div>
|
||||
<div id="revision">
|
||||
<p>
|
||||
<!-- Created: Wed Sep 16 21:19:20 CEST 2009 -->
|
||||
<!-- hhmts start -->
|
||||
Last modified: Wed Sep 16 23:16:45 CEST 2009
|
||||
<!-- hhmts end -->
|
||||
</p>
|
||||
</div>
|
||||
<script type="text/javascript">
|
||||
(function($) {
|
||||
$('#toc').toc();
|
||||
})(jQuery);
|
||||
</script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,965 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!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 name="generator" content="HTML Tidy for Linux/x86 (vers 1st March 2004), see www.w3.org" />
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii" />
|
||||
<link rel="stylesheet" href="../../../../boost.css" type="text/css"/>
|
||||
<link rel="stylesheet" href="ublas.css" type="text/css" />
|
||||
<script type="text/javascript" src="js/jquery-1.3.2.min.js" async="async" ></script>
|
||||
<script type="text/javascript" src="js/jquery.toc-gw.js" async="async" ></script>
|
||||
<title>uBLAS Overview</title>
|
||||
</head>
|
||||
<body>
|
||||
<h1><img src="../../../../boost.png" align="middle" alt="logo"/>uBLAS Overview</h1>
|
||||
<div class="toc" id="toc"></div>
|
||||
<h2><a name="rationale">Rationale</h2>
|
||||
<p><cite>It would be nice if every kind of numeric software could
|
||||
be written in C++ without loss of efficiency, but unless something
|
||||
can be found that achieves this without compromising the C++ type
|
||||
system it may be preferable to rely on Fortran, assembler or
|
||||
architecture-specific extensions (Bjarne Stroustrup).</cite></p>
|
||||
<p>This C++ library is directed towards scientific computing on the
|
||||
level of basic linear algebra constructions with matrices and
|
||||
vectors and their corresponding abstract operations. The primary
|
||||
design goals were:</p>
|
||||
<ul type="disc">
|
||||
<li>mathematical notation</li>
|
||||
<li>efficiency</li>
|
||||
<li>functionality</li>
|
||||
<li>compatibility</li>
|
||||
</ul>
|
||||
<p>Another intention was to evaluate, if the abstraction penalty
|
||||
resulting from the use of such matrix and vector classes is
|
||||
acceptable.</p>
|
||||
<h2>Resources</h2>
|
||||
<p>The development of this library was guided by a couple of
|
||||
similar efforts:</p>
|
||||
<ul type="disc">
|
||||
<li><a href="http://www.netlib.org/blas/index.html">BLAS</a> by
|
||||
Jack Dongarra et al.</li>
|
||||
<li><a href="http://www.oonumerics.org/blitz/">Blitz++</a> by Todd
|
||||
Veldhuizen</li>
|
||||
<li><a href="http://acts.nersc.gov/pooma/">POOMA</a> by Scott
|
||||
Haney et al.</li>
|
||||
<li><a href="http://www.lsc.nd.edu/research/mtl/">MTL</a> by Jeremy
|
||||
Siek et al.</li>
|
||||
</ul>
|
||||
<p>BLAS seems to be the most widely used library for basic linear
|
||||
algebra constructions, so it could be called a de-facto standard.
|
||||
Its interface is procedural, the individual functions are somewhat
|
||||
abstracted from simple linear algebra operations. Due to the fact
|
||||
that is has been implemented using Fortran and its optimizations,
|
||||
it also seems to be one of the fastest libraries available. As we
|
||||
decided to design and implement our library in an object-oriented
|
||||
way, the technical approaches are distinct. However anyone should
|
||||
be able to express BLAS abstractions in terms of our library
|
||||
operators and to compare the efficiency of the implementations.</p>
|
||||
<p>Blitz++ is an impressive library implemented in C++. Its main
|
||||
design seems to be oriented towards multidimensional arrays and
|
||||
their associated operators including tensors. The author of Blitz++
|
||||
states, that the library achieves performance on par or better than
|
||||
corresponding Fortran code due to his implementation technique
|
||||
using expression templates and template metaprograms. However we
|
||||
see some reasons, to develop an own design and implementation
|
||||
approach. We do not know whether anybody tries to implement
|
||||
traditional linear algebra and other numerical algorithms using
|
||||
Blitz++. We also presume that even today Blitz++ needs the most
|
||||
advanced C++ compiler technology due to its implementation idioms.
|
||||
On the other hand, Blitz++ convinced us, that the use of expression
|
||||
templates is mandatory to reduce the abstraction penalty to an
|
||||
acceptable limit.</p>
|
||||
<p>POOMA's design goals seem to parallel Blitz++'s in many parts .
|
||||
It extends Blitz++'s concepts with classes from the domains of
|
||||
partial differential equations and theoretical physics. The
|
||||
implementation supports even parallel architectures.</p>
|
||||
<p>MTL is another approach supporting basic linear algebra
|
||||
operations in C++. Its design mainly seems to be influenced by BLAS
|
||||
and the C++ Standard Template Library. We share the insight that a
|
||||
linear algebra library has to provide functionality comparable to
|
||||
BLAS. On the other hand we think, that the concepts of the C++
|
||||
standard library have not yet been proven to support numerical
|
||||
computations as needed. As another difference MTL currently does
|
||||
not seem to use expression templates. This may result in one of two
|
||||
consequences: a possible loss of expressiveness or a possible loss
|
||||
of performance.</p>
|
||||
<h2>Concepts</h2>
|
||||
<h3>Mathematical Notation</h3>
|
||||
<p>The usage of mathematical notation may ease the development of
|
||||
scientific algorithms. So a C++ library implementing basic linear
|
||||
algebra concepts carefully should overload selected C++ operators
|
||||
on matrix and vector classes.</p>
|
||||
<p>We decided to use operator overloading for the following
|
||||
primitives:</p>
|
||||
<table border="1" summary="operators">
|
||||
<tbody>
|
||||
<tr>
|
||||
<th align="left">Description</th>
|
||||
<th align="left">Operator</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Indexing of vectors and matrices</td>
|
||||
<td><code>vector::operator(size_t i);<br />
|
||||
matrix::operator(size_t i, size_t j);</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Assignment of vectors and matrices</td>
|
||||
<td><code>vector::operator = (const vector_expression &);<br />
|
||||
vector::operator += (const vector_expression &);<br />
|
||||
vector::operator -= (const vector_expression &);<br />
|
||||
vector::operator *= (const scalar_expression &);<br />
|
||||
matrix::operator = (const matrix_expression &);<br />
|
||||
matrix::operator += (const matrix_expression &);<br />
|
||||
matrix::operator -= (const matrix_expression &);<br />
|
||||
matrix::operator *= (const scalar_expression &);</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Unary operations on vectors and matrices</td>
|
||||
<td><code>vector_expression operator - (const vector_expression
|
||||
&);<br />
|
||||
matrix_expression operator - (const matrix_expression
|
||||
&);</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Binary operations on vectors and matrices</td>
|
||||
<td><code>vector_expression operator + (const vector_expression
|
||||
&, const vector_expression &);<br />
|
||||
vector_expression operator - (const vector_expression &, const
|
||||
vector_expression &);<br />
|
||||
matrix_expression operator + (const matrix_expression &, const
|
||||
matrix_expression &);<br />
|
||||
matrix_expression operator - (const matrix_expression &, const
|
||||
matrix_expression &);</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Multiplication of vectors and matrices with a scalar</td>
|
||||
<td><code>vector_expression operator * (const scalar_expression
|
||||
&, const vector_expression &);<br />
|
||||
vector_expression operator * (const vector_expression &, const
|
||||
scalar_expression &);<br />
|
||||
matrix_expression operator * (const scalar_expression &, const
|
||||
matrix_expression &);<br />
|
||||
matrix_expression operator * (const matrix_expression &, const
|
||||
scalar_expression &);</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<p>We decided to use no operator overloading for the following
|
||||
other primitives:</p>
|
||||
<table border="1" summary="functions">
|
||||
<tbody>
|
||||
<tr>
|
||||
<th align="left">Description</th>
|
||||
<th align="left">Function</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Left multiplication of vectors with a matrix</td>
|
||||
<td><code>vector_expression
|
||||
prod<</code><code><em>vector_type</em></code> <code>> (const
|
||||
matrix_expression &, const vector_expression &);<br />
|
||||
vector_expression prod (const matrix_expression &, const
|
||||
vector_expression &);</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Right multiplication of vectors with a matrix</td>
|
||||
<td><code>vector_expression
|
||||
prod<</code><code><em>vector_type</em></code> <code>> (const
|
||||
vector_expression &, const matrix_expression &);<br />
|
||||
vector_expression prod (const vector_expression &, const
|
||||
matrix_expression &);<br /></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Multiplication of matrices</td>
|
||||
<td><code>matrix_expression
|
||||
prod<</code><code><em>matrix_type</em></code> <code>> (const
|
||||
matrix_expression &, const matrix_expression &);<br />
|
||||
matrix_expression prod (const matrix_expression &, const
|
||||
matrix_expression &);</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Inner product of vectors</td>
|
||||
<td><code>scalar_expression inner_prod (const vector_expression
|
||||
&, const vector_expression &);</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Outer product of vectors</td>
|
||||
<td><code>matrix_expression outer_prod (const vector_expression
|
||||
&, const vector_expression &);</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Transpose of a matrix</td>
|
||||
<td><code>matrix_expression trans (const matrix_expression
|
||||
&);</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Efficiency</h3>
|
||||
<p>To achieve the goal of efficiency for numerical computing, one
|
||||
has to overcome two difficulties in formulating abstractions with
|
||||
C++, namely temporaries and virtual function calls. Expression
|
||||
templates solve these problems, but tend to slow down compilation
|
||||
times.</p>
|
||||
<h4>Eliminating Temporaries</h4>
|
||||
<p>Abstract formulas on vectors and matrices normally compose a
|
||||
couple of unary and binary operations. The conventional way of
|
||||
evaluating such a formula is first to evaluate every leaf operation
|
||||
of a composition into a temporary and next to evaluate the
|
||||
composite resulting in another temporary. This method is expensive
|
||||
in terms of time especially for small and space especially for
|
||||
large vectors and matrices. The approach to solve this problem is
|
||||
to use lazy evaluation as known from modern functional programming
|
||||
languages. The principle of this approach is to evaluate a complex
|
||||
expression element wise and to assign it directly to the
|
||||
target.</p>
|
||||
<p>Two interesting and dangerous facts result:</p>
|
||||
<h4>Aliases</h4>
|
||||
<p>One may get serious side effects using element wise
|
||||
evaluation on vectors or matrices. Consider the matrix vector
|
||||
product <em>x = A x</em>. Evaluation of
|
||||
<em>A</em><sub><em>1</em></sub><em>x</em> and assignment to
|
||||
<em>x</em><sub><em>1</em></sub> changes the right hand side, so
|
||||
that the evaluation of <em>A</em><sub><em>2</em></sub><em>x</em>
|
||||
returns a wrong result. In this case there are <strong>aliases</strong> of the elements
|
||||
<em>x</em><sub><em>n</em></sub> on both the left and right hand side of the assignment.</p>
|
||||
<p>Our solution for this problem is to
|
||||
evaluate the right hand side of an assignment into a temporary and
|
||||
then to assign this temporary to the left hand side. To allow
|
||||
further optimizations, we provide a corresponding member function
|
||||
for every assignment operator and also a
|
||||
<a href="operations_overview.html#noalias"> <code>noalias</code> syntax.</a>
|
||||
By using this syntax a programmer can confirm, that the left and right hand sides of an
|
||||
assignment are independent, so that element wise evaluation and
|
||||
direct assignment to the target is safe.</p>
|
||||
<h4>Complexity</h4>
|
||||
<p>The computational complexity may be unexpectedly large under certain
|
||||
cirumstances. Consider the chained matrix vector product <em>A (B
|
||||
x)</em>. Conventional evaluation of <em>A (B x)</em> is quadratic.
|
||||
Deferred evaluation of <em>B x</em><sub><em>i</em></sub> is linear.
|
||||
As every element <em>B x</em><sub><em>i</em></sub> is needed
|
||||
linearly depending of the size, a completely deferred evaluation of
|
||||
the chained matrix vector product <em>A (B x)</em> is cubic. In
|
||||
such cases one needs to reintroduce temporaries in the
|
||||
expression.</p>
|
||||
<h4>Eliminating Virtual Function Calls</h4>
|
||||
<p>Lazy expression evaluation normally leads to the definition of a
|
||||
class hierarchy of terms. This results in the usage of dynamic
|
||||
polymorphism to access single elements of vectors and matrices,
|
||||
which is also known to be expensive in terms of time. A solution
|
||||
was found a couple of years ago independently by David Vandervoorde
|
||||
and Todd Veldhuizen and is commonly called expression templates.
|
||||
Expression templates contain lazy evaluation and replace dynamic
|
||||
polymorphism with static, i.e. compile time polymorphism.
|
||||
Expression templates heavily depend on the famous Barton-Nackman
|
||||
trick, also coined 'curiously defined recursive templates' by Jim
|
||||
Coplien.</p>
|
||||
<p>Expression templates form the base of our implementation.</p>
|
||||
<h4>Compilation times</h4>
|
||||
<p>It is also a well known fact, that expression templates
|
||||
challenge currently available compilers. We were able to
|
||||
significantly reduce the amount of needed expression templates
|
||||
using the Barton-Nackman trick consequently.</p>
|
||||
<p>We also decided to support a dual conventional implementation
|
||||
(i.e. not using expression templates) with extensive bounds and
|
||||
type checking of vector and matrix operations to support the
|
||||
development cycle. Switching from debug mode to release mode is
|
||||
controlled by the <code>NDEBUG</code> preprocessor symbol of
|
||||
<code><cassert></code>.</p>
|
||||
|
||||
<h2><a name="functionality">Functionality</h2>
|
||||
|
||||
<p>Every C++ library supporting linear algebra will be measured
|
||||
against the long-standing Fortran package BLAS. We now describe how
|
||||
BLAS calls may be mapped onto our classes.</p>
|
||||
|
||||
<p>The page <a href="operations_overview.html">Overview of Matrix and Vector Operations</a>
|
||||
gives a short summary of the most used operations on vectors and
|
||||
matrices.</p>
|
||||
|
||||
<h4>Blas Level 1</h4>
|
||||
<table border="1" summary="level 1 blas">
|
||||
<tbody>
|
||||
<tr>
|
||||
<th align="left">BLAS Call</th>
|
||||
<th align="left">Mapped Library Expression</th>
|
||||
<th align="left">Mathematical Description</th>
|
||||
<th align="left">Comment</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>sasum</code> OR <code>dasum</code></td>
|
||||
<td><code>norm_1 (x)</code></td>
|
||||
<td><em>sum |x<sub>i</sub>|</em></td>
|
||||
<td>Computes the <em>l<sub>1</sub></em> (sum) norm of a real vector.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>scasum</code> OR <code>dzasum</code></td>
|
||||
<td><em><code>real (sum (v)) + imag (sum (v))</code></em></td>
|
||||
<td><em>sum re(x<sub>i</sub>) + sum im(x<sub>i</sub>)</em></td>
|
||||
<td>Computes the sum of elements of a complex vector.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>_nrm2</code></td>
|
||||
<td><code>norm_2 (x)</code></td>
|
||||
<td><em>sqrt (sum
|
||||
|x</em><sub><em>i</em></sub>|<sup><em>2</em></sup> <em>)</em></td>
|
||||
<td>Computes the <em>l<sub>2</sub></em> (euclidean) norm of a vector.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>i_amax</code></td>
|
||||
<td><code>norm_inf (x)<br />
|
||||
index_norm_inf (x)</code></td>
|
||||
<td><em>max |x</em><sub><em>i</em></sub><em>|</em></td>
|
||||
<td>Computes the <em>l<sub>inf</sub></em> (maximum) norm of a vector.<br />
|
||||
BLAS computes the index of the first element having this
|
||||
value.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>_dot<br />
|
||||
_dotu<br />
|
||||
_dotc</code></td>
|
||||
<td><code>inner_prod (x, y)</code>or<code><br />
|
||||
inner_prod (conj (x), y)</code></td>
|
||||
<td><em>x</em><sup><em>T</em></sup> <em>y</em> or<br />
|
||||
<em>x</em><sup><em>H</em></sup> <em>y</em></td>
|
||||
<td>Computes the inner product of two vectors.<br />
|
||||
BLAS implements certain loop unrollment.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>dsdot<br />
|
||||
sdsdot</code></td>
|
||||
<td><code>a + prec_inner_prod (x, y)</code></td>
|
||||
<td><em>a + x</em><sup><em>T</em></sup> <em>y</em></td>
|
||||
<td>Computes the inner product in double precision.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>_copy</code></td>
|
||||
<td><code>x = y<br />
|
||||
y.assign (x)</code></td>
|
||||
<td><em>x <- y</em></td>
|
||||
<td>Copies one vector to another.<br />
|
||||
BLAS implements certain loop unrollment.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>_swap</code></td>
|
||||
<td><code>swap (x, y)</code></td>
|
||||
<td><em>x <-> y</em></td>
|
||||
<td>Swaps two vectors.<br />
|
||||
BLAS implements certain loop unrollment.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>_scal<br />
|
||||
csscal<br />
|
||||
zdscal</code></td>
|
||||
<td><code>x *= a</code></td>
|
||||
<td><em>x <- a x</em></td>
|
||||
<td>Scales a vector.<br />
|
||||
BLAS implements certain loop unrollment.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>_axpy</code></td>
|
||||
<td><code>y += a * x</code></td>
|
||||
<td><em>y <- a x + y</em></td>
|
||||
<td>Adds a scaled vector.<br />
|
||||
BLAS implements certain loop unrollment.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>_rot<br />
|
||||
_rotm<br />
|
||||
csrot<br />
|
||||
zdrot</code></td>
|
||||
<td><code>t.assign (a * x + b * y),<br />
|
||||
y.assign (- b * x + a * y),<br />
|
||||
x.assign (t)</code></td>
|
||||
<td><em>(x, y) <- (a x + b y, -b x + a y)</em></td>
|
||||
<td>Applies a plane rotation.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>_rotg<br />
|
||||
_rotmg</code></td>
|
||||
<td> </td>
|
||||
<td><em>(a, b) <-<br />
|
||||
(? a / sqrt (a</em><sup><em>2</em></sup> +
|
||||
<em>b</em><sup><em>2</em></sup><em>),<br />
|
||||
? b / sqrt (a</em><sup><em>2</em></sup> +
|
||||
<em>b</em><sup><em>2</em></sup><em>))</em> or<em><br />
|
||||
(1, 0) <- (0, 0)</em></td>
|
||||
<td>Constructs a plane rotation.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4>Blas Level 2</h4>
|
||||
<table border="1" summary="level 2 blas">
|
||||
<tbody>
|
||||
<tr>
|
||||
<th align="left">BLAS Call</th>
|
||||
<th align="left">Mapped Library Expression</th>
|
||||
<th align="left">Mathematical Description</th>
|
||||
<th align="left">Comment</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>_t_mv</code></td>
|
||||
<td><code>x = prod (A, x)</code> or<code><br />
|
||||
x = prod (trans (A), x)</code> or<code><br />
|
||||
x = prod (herm (A), x)</code></td>
|
||||
<td><em>x <- A x</em> or<em><br />
|
||||
x <- A</em><sup><em>T</em></sup> <em>x</em> or<em><br />
|
||||
x <- A</em><sup><em>H</em></sup> <em>x</em></td>
|
||||
<td>Computes the product of a matrix with a vector.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>_t_sv</code></td>
|
||||
<td><code>y = solve (A, x, tag)</code> or<br />
|
||||
<code>inplace_solve (A, x, tag)</code> or<br />
|
||||
<code>y = solve (trans (A), x, tag)</code> or<br />
|
||||
<code>inplace_solve (trans (A), x, tag)</code> or<br />
|
||||
<code>y = solve (herm (A), x, tag)</code>or<br />
|
||||
<code>inplace_solve (herm (A), x, tag)</code></td>
|
||||
<!-- TODO: replace nested sub/sup -->
|
||||
<td><em>y <- A</em><sup><em>-1</em></sup> <em>x</em>
|
||||
or<em><br />
|
||||
x <- A</em><sup><em>-1</em></sup> <em>x</em> or<em><br />
|
||||
y <-
|
||||
A</em><sup><em>T</em></sup><sup><sup><em>-1</em></sup></sup>
|
||||
<em>x</em> or<em><br />
|
||||
x <-
|
||||
A</em><sup><em>T</em></sup><sup><sup><em>-1</em></sup></sup>
|
||||
<em>x</em> or<em><br />
|
||||
y <-
|
||||
A</em><sup><em>H</em></sup><sup><sup><em>-1</em></sup></sup>
|
||||
<em>x</em> or<em><br />
|
||||
x <-
|
||||
A</em><sup><em>H</em></sup><sup><sup><em>-1</em></sup></sup>
|
||||
<em>x</em></td>
|
||||
<td>Solves a system of linear equations with triangular form, i.e.
|
||||
<em>A</em> is triangular.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>_g_mv<br />
|
||||
_s_mv<br />
|
||||
_h_mv</code></td>
|
||||
<td><code>y = a * prod (A, x) + b * y</code> or<code><br />
|
||||
y = a * prod (trans (A), x) + b * y</code> or<code><br />
|
||||
y = a * prod (herm (A), x) + b * y</code></td>
|
||||
<td><em>y <- a A x + b y</em> or<em><br />
|
||||
y <- a A</em><sup><em>T</em></sup> <em>x + b y<br />
|
||||
y <- a A</em><sup><em>H</em></sup> <em>x + b y</em></td>
|
||||
<td>Adds the scaled product of a matrix with a vector.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>_g_r<br />
|
||||
_g_ru<br />
|
||||
_g_rc</code></td>
|
||||
<td><code>A += a * outer_prod (x, y)</code> or<code><br />
|
||||
A += a * outer_prod (x, conj (y))</code></td>
|
||||
<td><em>A <- a x y</em><sup><em>T</em></sup> <em>+ A</em>
|
||||
or<em><br />
|
||||
A <- a x y</em><sup><em>H</em></sup> <em>+ A</em></td>
|
||||
<td>Performs a rank <em>1</em> update.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>_s_r<br />
|
||||
_h_r</code></td>
|
||||
<td><code>A += a * outer_prod (x, x)</code> or<code><br />
|
||||
A += a * outer_prod (x, conj (x))</code></td>
|
||||
<td><em>A <- a x x</em><sup><em>T</em></sup> <em>+ A</em>
|
||||
or<em><br />
|
||||
A <- a x x</em><sup><em>H</em></sup> <em>+ A</em></td>
|
||||
<td>Performs a symmetric or hermitian rank <em>1</em> update.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>_s_r2<br />
|
||||
_h_r2</code></td>
|
||||
<td><code>A += a * outer_prod (x, y) +<br />
|
||||
a * outer_prod (y, x))</code> or<code><br />
|
||||
A += a * outer_prod (x, conj (y)) +<br />
|
||||
conj (a) * outer_prod (y, conj (x)))</code></td>
|
||||
<td><em>A <- a x y</em><sup><em>T</em></sup> <em>+ a y
|
||||
x</em><sup><em>T</em></sup> <em>+ A</em> or<em><br />
|
||||
A <- a x y</em><sup><em>H</em></sup> <em>+
|
||||
a</em><sup><em>-</em></sup> <em>y x</em><sup><em>H</em></sup> <em>+
|
||||
A</em></td>
|
||||
<td>Performs a symmetric or hermitian rank <em>2</em> update.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4>Blas Level 3</h4>
|
||||
<table border="1" summary="level 3 blas">
|
||||
<tbody>
|
||||
<tr>
|
||||
<th align="left">BLAS Call</th>
|
||||
<th align="left">Mapped Library Expression</th>
|
||||
<th align="left">Mathematical Description</th>
|
||||
<th align="left">Comment</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>_t_mm</code></td>
|
||||
<td><code>B = a * prod (A, B)</code> or<br />
|
||||
<code>B = a * prod (trans (A), B)</code> or<br />
|
||||
<code>B = a * prod (A, trans (B))</code> or<br />
|
||||
<code>B = a * prod (trans (A), trans (B))</code> or<br />
|
||||
<code>B = a * prod (herm (A), B)</code> or<br />
|
||||
<code>B = a * prod (A, herm (B))</code> or<br />
|
||||
<code>B = a * prod (herm (A), trans (B))</code> or<br />
|
||||
<code>B = a * prod (trans (A), herm (B))</code> or<br />
|
||||
<code>B = a * prod (herm (A), herm (B))</code></td>
|
||||
<td><em>B <- a op (A) op (B)</em> with<br />
|
||||
<em>op (X) = X</em> or<br />
|
||||
<em>op (X) = X</em><sup><em>T</em></sup> or<br />
|
||||
<em>op (X) = X</em><sup><em>H</em></sup></td>
|
||||
<td>Computes the scaled product of two matrices.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>_t_sm</code></td>
|
||||
<td><code>C = solve (A, B, tag)</code> or<br />
|
||||
<code>inplace_solve (A, B, tag)</code> or<br />
|
||||
<code>C = solve (trans (A), B, tag)</code> or<code><br />
|
||||
inplace_solve (trans (A), B, tag)</code> or<code><br />
|
||||
C = solve (herm (A), B, tag)</code> or<code><br />
|
||||
inplace_solve (herm (A), B, tag)</code></td>
|
||||
<td><em>C <- A</em><sup><em>-1</em></sup> <em>B</em>
|
||||
or<em><br />
|
||||
B <- A</em><sup><em>-1</em></sup> <em>B</em> or<em><br />
|
||||
C <-
|
||||
A</em><sup><em>T</em></sup><sup><sup><em>-1</em></sup></sup>
|
||||
<em>B</em> or<em><br />
|
||||
B <- A</em><sup><em>-1</em></sup> <em>B</em> or<em><br />
|
||||
C <-
|
||||
A</em><sup><em>H</em></sup><sup><sup><em>-1</em></sup></sup>
|
||||
<em>B</em> or<em><br />
|
||||
B <-
|
||||
A</em><sup><em>H</em></sup><sup><sup><em>-1</em></sup></sup>
|
||||
<em>B</em></td>
|
||||
<td>Solves a system of linear equations with triangular form, i.e.
|
||||
<em>A</em> is triangular.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>_g_mm<br />
|
||||
_s_mm<br />
|
||||
_h_mm</code></td>
|
||||
<td><code>C = a * prod (A, B) + b * C</code> or<br />
|
||||
<code>C = a * prod (trans (A), B) + b * C</code> or<br />
|
||||
<code>C = a * prod (A, trans (B)) + b * C</code> or<br />
|
||||
<code>C = a * prod (trans (A), trans (B)) + b * C</code> or<br />
|
||||
<code>C = a * prod (herm (A), B) + b * C</code> or<br />
|
||||
<code>C = a * prod (A, herm (B)) + b * C</code> or<br />
|
||||
<code>C = a * prod (herm (A), trans (B)) + b * C</code> or<br />
|
||||
<code>C = a * prod (trans (A), herm (B)) + b * C</code> or<br />
|
||||
<code>C = a * prod (herm (A), herm (B)) + b * C</code></td>
|
||||
<td><em>C <- a op (A) op (B) + b C</em> with<br />
|
||||
<em>op (X) = X</em> or<br />
|
||||
<em>op (X) = X</em><sup><em>T</em></sup> or<br />
|
||||
<em>op (X) = X</em><sup><em>H</em></sup></td>
|
||||
<td>Adds the scaled product of two matrices.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>_s_rk<br />
|
||||
_h_rk</code></td>
|
||||
<td><code>B = a * prod (A, trans (A)) + b * B</code> or<br />
|
||||
<code>B = a * prod (trans (A), A) + b * B</code> or<br />
|
||||
<code>B = a * prod (A, herm (A)) + b * B</code> or<br />
|
||||
<code>B = a * prod (herm (A), A) + b * B</code></td>
|
||||
<td><em>B <- a A A</em><sup><em>T</em></sup> <em>+ b B</em>
|
||||
or<em><br />
|
||||
B <- a A</em><sup><em>T</em></sup> <em>A + b B</em> or<br />
|
||||
<em>B <- a A A</em><sup><em>H</em></sup> <em>+ b B</em>
|
||||
or<em><br />
|
||||
B <- a A</em><sup><em>H</em></sup> <em>A + b B</em></td>
|
||||
<td>Performs a symmetric or hermitian rank <em>k</em> update.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>_s_r2k<br />
|
||||
_h_r2k</code></td>
|
||||
<td><code>C = a * prod (A, trans (B)) +<br />
|
||||
a * prod (B, trans (A)) + b * C</code> or<br />
|
||||
<code>C = a * prod (trans (A), B) +<br />
|
||||
a * prod (trans (B), A) + b * C</code> or<br />
|
||||
<code>C = a * prod (A, herm (B)) +<br />
|
||||
conj (a) * prod (B, herm (A)) + b * C</code> or<br />
|
||||
<code>C = a * prod (herm (A), B) +<br />
|
||||
conj (a) * prod (herm (B), A) + b * C</code></td>
|
||||
<td><em>C <- a A B</em><sup><em>T</em></sup> <em>+ a B
|
||||
A</em><sup><em>T</em></sup> <em>+ b C</em> or<em><br />
|
||||
C <- a A</em><sup><em>T</em></sup> <em>B + a
|
||||
B</em><sup><em>T</em></sup> <em>A + b C</em> or<em><br />
|
||||
C <- a A B</em><sup><em>H</em></sup> <em>+
|
||||
a</em><sup><em>-</em></sup> <em>B A</em><sup><em>H</em></sup> <em>+
|
||||
b C</em> or<em><br />
|
||||
C <- a A</em><sup><em>H</em></sup> <em>B +
|
||||
a</em><sup><em>-</em></sup> <em>B</em><sup><em>H</em></sup> <em>A +
|
||||
b C</em></td>
|
||||
<td>Performs a symmetric or hermitian rank <em>2 k</em>
|
||||
update.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
<h2>Storage Layout</h2>
|
||||
|
||||
<p>uBLAS supports many different storage layouts. The full details can be
|
||||
found at the <a href="types_overview.html">Overview of Types</a>. Most types like
|
||||
<code>vector<double></code> and <code>matrix<double></code> are
|
||||
by default compatible to C arrays, but can also be configured to contain
|
||||
FORTAN compatible data.
|
||||
</p>
|
||||
|
||||
<h2>Compatibility</h2>
|
||||
<p>For compatibility reasons we provide array like indexing for vectors and matrices. For some types (hermitian, sparse etc) this can be expensive for matrices due to the needed temporary proxy objects.</p>
|
||||
<p>uBLAS uses STL compatible allocators for the allocation of the storage required for it's containers.</p>
|
||||
<h2>Benchmark Results</h2>
|
||||
<p>The following tables contain results of one of our benchmarks.
|
||||
This benchmark compares a native C implementation ('C array') and
|
||||
some library based implementations. The safe variants based on the
|
||||
library assume aliasing, the fast variants do not use temporaries
|
||||
and are functionally equivalent to the native C implementation.
|
||||
Besides the generic vector and matrix classes the benchmark
|
||||
utilizes special classes <code>c_vector</code> and
|
||||
<code>c_matrix</code>, which are intended to avoid every overhead
|
||||
through genericity.</p>
|
||||
<p>The benchmark program <strong>bench1</strong> was compiled with GCC 4.0 and run on an Athlon 64 3000+. Times are scales for reasonable precision by running <strong>bench1 100</strong>.</p>
|
||||
<p>First we comment the results for double vectors and matrices of dimension 3 and 3 x 3, respectively.</p>
|
||||
<table border="1" summary="1st benchmark">
|
||||
<tbody>
|
||||
<tr>
|
||||
<th align="left">Comment</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td rowspan="3">inner_prod</td>
|
||||
<td>C array</td>
|
||||
<td align="right">0.61</td>
|
||||
<td align="right">782</td>
|
||||
<td rowspan="3">Some abstraction penalty</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>c_vector</td>
|
||||
<td align="right">0.86</td>
|
||||
<td align="right">554</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>vector<unbounded_array></td>
|
||||
<td align="right">1.02</td>
|
||||
<td align="right">467</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td rowspan="5">vector + vector</td>
|
||||
<td>C array</td>
|
||||
<td align="right">0.51</td>
|
||||
<td align="right">1122</td>
|
||||
<td rowspan="5">Abstraction penalty: factor 2</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>c_vector fast</td>
|
||||
<td align="right">1.17</td>
|
||||
<td align="right">489</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>vector<unbounded_array> fast</td>
|
||||
<td align="right">1.32</td>
|
||||
<td align="right">433</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>c_vector safe</td>
|
||||
<td align="right">2.02</td>
|
||||
<td align="right">283</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>vector<unbounded_array> safe</td>
|
||||
<td align="right">6.95</td>
|
||||
<td align="right">82</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td rowspan="5">outer_prod</td>
|
||||
<td>C array</td>
|
||||
<td align="right">0.59</td>
|
||||
<td align="right">872</td>
|
||||
<td rowspan="5">Some abstraction penalty</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>c_matrix, c_vector fast</td>
|
||||
<td align="right">0.88</td>
|
||||
<td align="right">585</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>matrix<unbounded_array>, vector<unbounded_array> fast</td>
|
||||
<td align="right">0.90</td>
|
||||
<td align="right">572</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>c_matrix, c_vector safe</td>
|
||||
<td align="right">1.66</td>
|
||||
<td align="right">310</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>matrix<unbounded_array>, vector<unbounded_array> safe</td>
|
||||
<td align="right">2.95</td>
|
||||
<td align="right">175</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td rowspan="5">prod (matrix, vector)</td>
|
||||
<td>C array</td>
|
||||
<td align="right">0.64</td>
|
||||
<td align="right">671</td>
|
||||
<td rowspan="5">No significant abstraction penalty</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>c_matrix, c_vector fast</td>
|
||||
<td align="right">0.70</td>
|
||||
<td align="right">613</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>matrix<unbounded_array>, vector<unbounded_array> fast</td>
|
||||
<td align="right">0.79</td>
|
||||
<td align="right">543</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>c_matrix, c_vector safe</td>
|
||||
<td align="right">0.95</td>
|
||||
<td align="right">452</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>matrix<unbounded_array>, vector<unbounded_array> safe</td>
|
||||
<td align="right">2.61</td>
|
||||
<td align="right">164</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td rowspan="5">matrix + matrix</td>
|
||||
<td>C array</td>
|
||||
<td align="right">0.75</td>
|
||||
<td align="right">686</td>
|
||||
<td rowspan="5">No significant abstraction penalty</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>c_matrix fast</td>
|
||||
<td align="right">0.99</td>
|
||||
<td align="right">520</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>matrix<unbounded_array> fast</td>
|
||||
<td align="right">1.29</td>
|
||||
<td align="right">399</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>c_matrix safe</td>
|
||||
<td align="right">1.7</td>
|
||||
<td align="right">303</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>matrix<unbounded_array> safe</td>
|
||||
<td align="right">3.14</td>
|
||||
<td align="right">164</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td rowspan="5">prod (matrix, matrix)</td>
|
||||
<td>C array</td>
|
||||
<td align="right">0.94</td>
|
||||
<td align="right">457</td>
|
||||
<td rowspan="5">No significant abstraction penalty</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>c_matrix fast</td>
|
||||
<td align="right">1.17</td>
|
||||
<td align="right">367</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>matrix<unbounded_array> fast</td>
|
||||
<td align="right">1.34</td>
|
||||
<td align="right">320</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>c_matrix safe</td>
|
||||
<td align="right">1.56</td>
|
||||
<td align="right">275</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>matrix<unbounded_array> safe</td>
|
||||
<td align="right">2.06</td>
|
||||
<td align="right">208</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<p>We notice a two fold performance loss for small vectors and matrices: first the general abstraction penalty for using classes, and then a small loss when using the generic vector and matrix classes. The difference w.r.t. alias assumptions is also significant.</p>
|
||||
<p>Next we comment the results for double vectors and matrices of
|
||||
dimension 100 and 100 x 100, respectively.</p>
|
||||
<table border="1" summary="2nd benchmark">
|
||||
<tbody>
|
||||
<tr>
|
||||
<th align="left">Operation</th>
|
||||
<th align="left">Implementation</th>
|
||||
<th align="left">Elapsed [s]</th>
|
||||
<th align="left">MFLOP/s</th>
|
||||
<th align="left">Comment</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td rowspan="3">inner_prod</td>
|
||||
<td>C array</td>
|
||||
<td align="right">0.64</td>
|
||||
<td align="right">889</td>
|
||||
<td rowspan="3">No significant abstraction penalty</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>c_vector</td>
|
||||
<td align="right">0.66</td>
|
||||
<td align="right">862</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>vector<unbounded_array></td>
|
||||
<td align="right">0.66</td>
|
||||
<td align="right">862</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td rowspan="5">vector + vector</td>
|
||||
<td>C array</td>
|
||||
<td align="right">0.64</td>
|
||||
<td align="right">894</td>
|
||||
<td rowspan="5">No significant abstraction penalty</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>c_vector fast</td>
|
||||
<td align="right">0.66</td>
|
||||
<td align="right">867</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>vector<unbounded_array> fast</td>
|
||||
<td align="right">0.66</td>
|
||||
<td align="right">867</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>c_vector safe</td>
|
||||
<td align="right">1.14</td>
|
||||
<td align="right">501</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>vector<unbounded_array> safe</td>
|
||||
<td align="right">1.23</td>
|
||||
<td align="right">465</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td rowspan="5">outer_prod</td>
|
||||
<td>C array</td>
|
||||
<td align="right">0.50</td>
|
||||
<td align="right">1144</td>
|
||||
<td rowspan="5">No significant abstraction penalty</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>c_matrix, c_vector fast</td>
|
||||
<td align="right">0.71</td>
|
||||
<td align="right">806</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>matrix<unbounded_array>, vector<unbounded_array> fast</td>
|
||||
<td align="right">0.57</td>
|
||||
<td align="right">1004</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>c_matrix, c_vector safe</td>
|
||||
<td align="right">1.91</td>
|
||||
<td align="right">300</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>matrix<unbounded_array>, vector<unbounded_array> safe</td>
|
||||
<td align="right">0.89</td>
|
||||
<td align="right">643</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td rowspan="5">prod (matrix, vector)</td>
|
||||
<td>C array</td>
|
||||
<td align="right">0.65</td>
|
||||
<td align="right">876</td>
|
||||
<td rowspan="5">No significant abstraction penalty</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>c_matrix, c_vector fast</td>
|
||||
<td align="right">0.65</td>
|
||||
<td align="right">876</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>matrix<unbounded_array>, vector<unbounded_array>
|
||||
fast</td>
|
||||
<td align="right">0.66</td>
|
||||
<td align="right">863</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>c_matrix, c_vector safe</td>
|
||||
<td align="right">0.66</td>
|
||||
<td align="right">863</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>matrix<unbounded_array>, vector<unbounded_array>
|
||||
safe</td>
|
||||
<td align="right">0.66</td>
|
||||
<td align="right">863</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td rowspan="5">matrix + matrix</td>
|
||||
<td>C array</td>
|
||||
<td align="right">0.96</td>
|
||||
<td align="right">596</td>
|
||||
<td rowspan="5">No significant abstraction penalty</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>c_matrix fast</td>
|
||||
<td align="right">1.21</td>
|
||||
<td align="right">473</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>matrix<unbounded_array> fast</td>
|
||||
<td align="right">1.00</td>
|
||||
<td align="right">572</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>c_matrix safe</td>
|
||||
<td align="right">2.44</td>
|
||||
<td align="right">235</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>matrix<unbounded_array> safe</td>
|
||||
<td align="right">1.30</td>
|
||||
<td align="right">440</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td rowspan="5">prod (matrix, matrix)</td>
|
||||
<td>C array</td>
|
||||
<td align="right">0.70</td>
|
||||
<td align="right">813</td>
|
||||
<td rowspan="5">No significant abstraction penalty</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>c_matrix fast</td>
|
||||
<td align="right">0.73</td>
|
||||
<td align="right">780</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>matrix<unbounded_array> fast</td>
|
||||
<td align="right">0.76</td>
|
||||
<td align="right">749</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>c_matrix safe</td>
|
||||
<td align="right">0.75</td>
|
||||
<td align="right">759</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>matrix<unbounded_array> safe</td>
|
||||
<td align="right">0.76</td>
|
||||
<td align="right">749</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<p>For larger vectors and matrices the general abstraction penalty
|
||||
for using classes seems to decrease, the small loss when using
|
||||
generic vector and matrix classes seems to remain. The difference
|
||||
w.r.t. alias assumptions remains visible, too.</p>
|
||||
<hr />
|
||||
<p>Copyright (©) 2000-2002 Joerg Walter, Mathias Koch<br />
|
||||
Use, modification and distribution are subject to the
|
||||
Boost Software License, Version 1.0.
|
||||
(See accompanying file LICENSE_1_0.txt
|
||||
or copy at <a href="http://www.boost.org/LICENSE_1_0.txt">
|
||||
http://www.boost.org/LICENSE_1_0.txt
|
||||
</a>).
|
||||
</p>
|
||||
<script type="text/javascript">
|
||||
(function($) {
|
||||
$('#toc').toc();
|
||||
})(jQuery);
|
||||
</script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,318 @@
|
||||
?xml version="1.0" encoding="UTF-8"?>
|
||||
<!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>
|
||||
<title>Special Products</title>
|
||||
<meta name="GENERATOR" content="Quanta Plus" />
|
||||
<meta name="AUTHOR" content="Gunter Winkler" />
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
|
||||
<link rel="stylesheet" href="../../../../boost.css" type="text/css"/>
|
||||
<link rel="stylesheet" href="ublas.css" type="text/css" />
|
||||
<script type="text/javascript" src="js/jquery-1.3.2.min.js" async="async" ></script>
|
||||
<script type="text/javascript" src="js/jquery.toc-gw.js" async="async" ></script>
|
||||
</head>
|
||||
<body>
|
||||
|
||||
<h1><img src="../../../../boost.png" align="middle" />Special Products </h1>
|
||||
<div class="toc" id="toc"></div>
|
||||
|
||||
<h2>Functions</h2>
|
||||
|
||||
<table summary="" border=0 cellpadding=0 cellspacing=0>
|
||||
<tr>
|
||||
<td class="memItemLeft" nowrap align=right valign=top>template<class V, class E1, class E2> BOOST_UBLAS_INLINE V & </td>
|
||||
<td class="memItemRight" valign=bottom><a class="el" href="#ga8">axpy_prod</a> (const matrix_expression< E1 > &e1, const vector_expression< E2 > &e2, V &v, bool init=true)</td></tr>
|
||||
|
||||
<tr>
|
||||
<td class="mdescLeft"> </td>
|
||||
<td class="mdescRight">computes <code>v += A x</code> or <code>v = A x</code> in an optimized fashion. <a href="#ga8"></a><br /><br /></td></tr>
|
||||
<tr>
|
||||
<td class="memItemLeft" nowrap align=right valign=top>template<class V, class E1, class E2> BOOST_UBLAS_INLINE V & </td>
|
||||
<td class="memItemRight" valign=bottom><a class="el" href="#ga9">axpy_prod</a> (const vector_expression< E1 > &e1, const matrix_expression< E2 > &e2, V &v, bool init=true)</td></tr>
|
||||
|
||||
<tr>
|
||||
<td class="mdescLeft"> </td>
|
||||
<td class="mdescRight">computes <code>v += A<sup>T</sup> x</code> or <code>v = A<sup>T</sup> x</code> in an optimized fashion. <a href="#ga9"></a><br /><br /></td></tr>
|
||||
<tr>
|
||||
<td class="memItemLeft" nowrap align=right valign=top>template<class M, class E1, class E2> BOOST_UBLAS_INLINE M & </td>
|
||||
<td class="memItemRight" valign=bottom><a class="el" href="#ga7">axpy_prod</a> (const matrix_expression< E1 > &e1, const matrix_expression< E2 > &e2, M &m, bool init=true)</td></tr>
|
||||
|
||||
<tr>
|
||||
<td class="mdescLeft"> </td>
|
||||
<td class="mdescRight">computes <code>M += A X</code> or <code>M = A X</code> in an optimized fashion. <a href="#ga7"></a><br /><br /></td></tr>
|
||||
<tr>
|
||||
<td class="memItemLeft" nowrap align=right valign=top>template<class M, class E1, class E2> BOOST_UBLAS_INLINE M & </td>
|
||||
<td class="memItemRight" valign=bottom><a class="el" href="#ga6">opb_prod</a> (const matrix_expression< E1 > &e1, const matrix_expression< E2 > &e2, M &m, bool init=true)</td></tr>
|
||||
|
||||
<tr>
|
||||
<td class="mdescLeft"> </td>
|
||||
<td class="mdescRight">computes <code>M += A X</code> or <code>M = A X</code> in an optimized fashion. <a href="#ga6"></a><br /><br /></td></tr>
|
||||
</table>
|
||||
|
||||
<hr />
|
||||
|
||||
<a class="anchor" name="ga8" doxytag="boost::numeric::ublas::axpy_prod" ></a>
|
||||
<table summary="" class="mdTable" width="95%" cellpadding="2" cellspacing="0">
|
||||
<tr>
|
||||
<td class="mdRow">
|
||||
<table summary="" cellpadding="0" cellspacing="0" border="0">
|
||||
<tr>
|
||||
<td class="md" nowrap valign="top"> BOOST_UBLAS_INLINE V& axpy_prod </td>
|
||||
<td class="md" valign="top">( </td>
|
||||
<td class="md" nowrap valign="top">const matrix_expression< E1 > & </td>
|
||||
<td class="mdname" nowrap> <em>e1</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="md" nowrap align="right"></td>
|
||||
<td></td>
|
||||
<td class="md" nowrap>const vector_expression< E2 > & </td>
|
||||
<td class="mdname" nowrap> <em>e2</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="md" nowrap align="right"></td>
|
||||
<td></td>
|
||||
<td class="md" nowrap>V & </td>
|
||||
<td class="mdname" nowrap> <em>v</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="md" nowrap align="right"></td>
|
||||
<td></td>
|
||||
<td class="md" nowrap>bool </td>
|
||||
<td class="mdname" nowrap> <em>init</em> = <code>true</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td class="md">) </td>
|
||||
<td class="md" colspan="2"></td>
|
||||
</tr>
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<table summary="" cellspacing=5 cellpadding=0 border=0>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
|
||||
<p>
|
||||
computes <code>v += A x</code> or <code>v = A x</code> in an optimized fashion.
|
||||
</p>
|
||||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||||
<table summary="" border="0" cellspacing="2" cellpadding="0">
|
||||
<tr><td></td><td valign=top><em>e1</em> </td><td>the matrix expression <code>A</code> </td></tr>
|
||||
<tr><td></td><td valign=top><em>e2</em> </td><td>the vector expression <code>x</code> </td></tr>
|
||||
<tr><td></td><td valign=top><em>v</em> </td><td>the result vector <code>v</code> </td></tr>
|
||||
<tr><td></td><td valign=top><em>init</em> </td><td>a boolean parameter</td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
<code>axpy_prod(A, x, v, init)</code> implements the well known axpy-product. Setting <em>init</em> to <code>true</code> is equivalent to call <code>v.clear()</code> before <code>axpy_prod</code>. Currently <em>init</em> defaults to <code>true</code>, but this may change in the future.<p>
|
||||
Up to now there are some specialisation for compressed matrices that give a large speed up compared to prod. </td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
<a class="anchor" name="ga9" doxytag="boost::numeric::ublas::axpy_prod" ></a>
|
||||
<table summary="" class="mdTable" width="95%" cellpadding="2" cellspacing="0">
|
||||
<tr>
|
||||
<td class="mdRow">
|
||||
<table summary="" cellpadding="0" cellspacing="0" border="0">
|
||||
<tr>
|
||||
<td class="md" nowrap valign="top"> BOOST_UBLAS_INLINE V& axpy_prod </td>
|
||||
<td class="md" valign="top">( </td>
|
||||
<td class="md" nowrap valign="top">const vector_expression< E1 > & </td>
|
||||
<td class="mdname" nowrap> <em>e1</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="md" nowrap align="right"></td>
|
||||
<td></td>
|
||||
<td class="md" nowrap>const matrix_expression< E2 > & </td>
|
||||
<td class="mdname" nowrap> <em>e2</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="md" nowrap align="right"></td>
|
||||
<td></td>
|
||||
<td class="md" nowrap>V & </td>
|
||||
<td class="mdname" nowrap> <em>v</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="md" nowrap align="right"></td>
|
||||
<td></td>
|
||||
<td class="md" nowrap>bool </td>
|
||||
<td class="mdname" nowrap> <em>init</em> = <code>true</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td class="md">) </td>
|
||||
<td class="md" colspan="2"></td>
|
||||
</tr>
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<table summary="" cellspacing=5 cellpadding=0 border=0>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
|
||||
<p>
|
||||
computes <code>v += A<sup>T</sup> x</code> or <code>v = A<sup>T</sup> x</code> in an optimized fashion.
|
||||
</p>
|
||||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||||
<table summary="" border="0" cellspacing="2" cellpadding="0">
|
||||
<tr><td></td><td valign=top><em>e1</em> </td><td>the vector expression <code>x</code> </td></tr>
|
||||
<tr><td></td><td valign=top><em>e2</em> </td><td>the matrix expression <code>A</code> </td></tr>
|
||||
<tr><td></td><td valign=top><em>v</em> </td><td>the result vector <code>v</code> </td></tr>
|
||||
<tr><td></td><td valign=top><em>init</em> </td><td>a boolean parameter</td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
<code>axpy_prod(x, A, v, init)</code> implements the well known axpy-product. Setting <em>init</em> to <code>true</code> is equivalent to call <code>v.clear()</code> before <code>axpy_prod</code>. Currently <em>init</em> defaults to <code>true</code>, but this may change in the future.<p>
|
||||
Up to now there are some specialisation for compressed matrices that give a large speed up compared to prod. </td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<a class="anchor" name="ga7" doxytag="boost::numeric::ublas::axpy_prod" ></a>
|
||||
<table summary="" class="mdTable" width="95%" cellpadding="2" cellspacing="0">
|
||||
<tr>
|
||||
<td class="mdRow">
|
||||
<table summary="" cellpadding="0" cellspacing="0" border="0">
|
||||
<tr>
|
||||
<td class="md" nowrap valign="top"> BOOST_UBLAS_INLINE M& axpy_prod </td>
|
||||
<td class="md" valign="top">( </td>
|
||||
<td class="md" nowrap valign="top">const matrix_expression< E1 > & </td>
|
||||
<td class="mdname" nowrap> <em>e1</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="md" nowrap align="right"></td>
|
||||
<td></td>
|
||||
<td class="md" nowrap>const matrix_expression< E2 > & </td>
|
||||
<td class="mdname" nowrap> <em>e2</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="md" nowrap align="right"></td>
|
||||
<td></td>
|
||||
<td class="md" nowrap>M & </td>
|
||||
<td class="mdname" nowrap> <em>m</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="md" nowrap align="right"></td>
|
||||
<td></td>
|
||||
<td class="md" nowrap>bool </td>
|
||||
<td class="mdname" nowrap> <em>init</em> = <code>true</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td class="md">) </td>
|
||||
<td class="md" colspan="2"></td>
|
||||
</tr>
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<table summary="" cellspacing=5 cellpadding=0 border=0>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
|
||||
<p>
|
||||
computes <code>M += A X</code> or <code>M = A X</code> in an optimized fashion.
|
||||
</p>
|
||||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||||
<table summary="" border="0" cellspacing="2" cellpadding="0">
|
||||
<tr><td></td><td valign=top><em>e1</em> </td><td>the matrix expression <code>A</code> </td></tr>
|
||||
<tr><td></td><td valign=top><em>e2</em> </td><td>the matrix expression <code>X</code> </td></tr>
|
||||
<tr><td></td><td valign=top><em>m</em> </td><td>the result matrix <code>M</code> </td></tr>
|
||||
<tr><td></td><td valign=top><em>init</em> </td><td>a boolean parameter</td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
<code>axpy_prod(A, X, M, init)</code> implements the well known axpy-product. Setting <em>init</em> to <code>true</code> is equivalent to call <code>M.clear()</code> before <code>axpy_prod</code>. Currently <em>init</em> defaults to <code>true</code>, but this may change in the future.<p>
|
||||
Up to now there are no specialisations. </td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<a class="anchor" name="ga6" doxytag="boost::numeric::ublas::opb_prod" ></a>
|
||||
|
||||
<table summary="" class="mdTable" width="95%" cellpadding="2" cellspacing="0">
|
||||
<tr>
|
||||
<td class="mdRow">
|
||||
<table summary="" cellpadding="0" cellspacing="0" border="0">
|
||||
<tr>
|
||||
<td class="md" nowrap valign="top"> BOOST_UBLAS_INLINE M& opb_prod </td>
|
||||
<td class="md" valign="top">( </td>
|
||||
<td class="md" nowrap valign="top">const matrix_expression< E1 > & </td>
|
||||
<td class="mdname" nowrap> <em>e1</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="md" nowrap align="right"></td>
|
||||
<td></td>
|
||||
<td class="md" nowrap>const matrix_expression< E2 > & </td>
|
||||
<td class="mdname" nowrap> <em>e2</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="md" nowrap align="right"></td>
|
||||
<td></td>
|
||||
<td class="md" nowrap>M & </td>
|
||||
<td class="mdname" nowrap> <em>m</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="md" nowrap align="right"></td>
|
||||
<td></td>
|
||||
<td class="md" nowrap>bool </td>
|
||||
<td class="mdname" nowrap> <em>init</em> = <code>true</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td class="md">) </td>
|
||||
<td class="md" colspan="2"></td>
|
||||
</tr>
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<table summary="" cellspacing=5 cellpadding=0 border=0>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
|
||||
<p>
|
||||
computes <code>M += A X</code> or <code>M = A X</code> in an optimized fashion.
|
||||
</p>
|
||||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||||
<table summary="" border="0" cellspacing="2" cellpadding="0">
|
||||
<tr><td></td><td valign=top><em>e1</em> </td><td>the matrix expression <code>A</code> </td></tr>
|
||||
<tr><td></td><td valign=top><em>e2</em> </td><td>the matrix expression <code>X</code> </td></tr>
|
||||
<tr><td></td><td valign=top><em>m</em> </td><td>the result matrix <code>M</code> </td></tr>
|
||||
<tr><td></td><td valign=top><em>init</em> </td><td>a boolean parameter</td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
<code>opb_prod(A, X, M, init)</code> implements the well known axpy-product. Setting <em>init</em> to <code>true</code> is equivalent to call <code>M.clear()</code> before <code>opb_prod</code>. Currently <em>init</em> defaults to <code>true</code>, but this may change in the future.<p>
|
||||
This function may give a speedup if <code>A</code> has less columns than rows, because the product is computed as a sum of outer products. </td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
<hr />
|
||||
<p>Copyright (©) 2000-2004 Michael Stevens, Mathias Koch,
|
||||
Joerg Walter, Gunter Winkler<br />
|
||||
Use, modification and distribution are subject to the
|
||||
Boost Software License, Version 1.0.
|
||||
(See accompanying file LICENSE_1_0.txt
|
||||
or copy at <a href="http://www.boost.org/LICENSE_1_0.txt">
|
||||
http://www.boost.org/LICENSE_1_0.txt
|
||||
</a>).
|
||||
</p>
|
||||
<script type="text/javascript">
|
||||
(function($) {
|
||||
$('#toc').toc();
|
||||
})(jQuery);
|
||||
</script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,229 @@
|
||||
<!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 rel="stylesheet" href="../../../../boost.css" type="text/css"/>
|
||||
<link rel="stylesheet" href="ublas.css" type="text/css" />
|
||||
<script type="text/javascript" src="js/jquery-1.3.2.min.js" async="async" ></script>
|
||||
<script type="text/javascript" src="js/jquery.toc-gw.js" async="async" ></script>
|
||||
<title>Range and slice</title>
|
||||
</head>
|
||||
<body>
|
||||
<h1><img src="../../../../boost.png" align="middle" />Range and Slice Storage</h1>
|
||||
<div class="toc" id="toc"></div>
|
||||
<h2><a name="range"></a>Range<SizeType,DistanceType></h2>
|
||||
<h4>Description</h4>
|
||||
<p>The class <code>range</code> specifies a range of indicies. The range is a sequence of indices
|
||||
from a start value to stop value. The indices increase by one and exlude the stop value.
|
||||
<code>range</code> can therefore be used to specify ranges of elements from vectors and matrices.</p>
|
||||
<h4>Example</h4>
|
||||
<pre>
|
||||
#include <boost/numeric/ublas/storage.hpp>
|
||||
|
||||
int main () {
|
||||
using namespace boost::numeric::ublas;
|
||||
range r (0, 3);
|
||||
for (unsigned i = 0; i < r.size (); ++ i) {
|
||||
std::cout << r (i) << std::endl;
|
||||
}
|
||||
}
|
||||
</pre>
|
||||
<h4>Definition</h4>
|
||||
<p>Defined in the header storage.hpp.</p>
|
||||
<h4>Model of</h4>
|
||||
<p>Reversible Container.</p>
|
||||
<h4>Type requirements</h4>
|
||||
<p>None, except for those imposed by the requirements of Reversible
|
||||
Container.</p>
|
||||
<h4>Public base classes</h4>
|
||||
<p>None.</p>
|
||||
<h4>Members</h4>
|
||||
<table border="1" summary="members">
|
||||
<tbody>
|
||||
<tr>
|
||||
<th>Member</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>range (size_type start, size_type stop)</code></td>
|
||||
<td>Constructs a range of indicies from <code>start</code> to <code>stop (excluded)</code>
|
||||
.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>size_type start () const</code></td>
|
||||
<td>Returns the beginning of the <code>range</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>size_type size () const</code></td>
|
||||
<td>Returns the size of the <code>range</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_reference operator [] (size_type i)
|
||||
const</code></td>
|
||||
<td>Returns the value <code>start + i</code> of the <code>i</code>
|
||||
-th element.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>range compose (const range &r) const</code></td>
|
||||
<td>Returns the composite range from <code>start + r.start
|
||||
()</code> to <code>start + r.start () + r.size ()</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>bool operator == (const range &r) const</code></td>
|
||||
<td>Tests two ranges for equality.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>bool operator != (const range &r) const</code></td>
|
||||
<td>Tests two ranges for inequality.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_iterator begin () const</code></td>
|
||||
<td>Returns a <code>const_iterator</code> pointing to the beginning
|
||||
of the <code>range</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_iterator end () const</code></td>
|
||||
<td>Returns a <code>const_iterator</code> pointing to the end of
|
||||
the <code>range</code>.</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 <code>range</code>.</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 <code>range</code>.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4>Preconditions</h4>
|
||||
<ul>
|
||||
<li><code>start () <= stop ()</code></li>
|
||||
</ul>
|
||||
|
||||
<h2><a name="slice"></a>Slice<SizeType,DistanceType></h2>
|
||||
<h4>Description</h4>
|
||||
<p>The class <code>slice</code> specifies a 'slice' of indicies. Slices are more general
|
||||
then ranges, the stride allows the sequence of indicies to increase and decrease by the specified amount between element.
|
||||
<code>slice</code> can therefore be used to specify slices of element from vectors and matrices.</p>
|
||||
<h4>Example</h4>
|
||||
<pre>
|
||||
#include <boost/numeric/ublas/storage.hpp>
|
||||
|
||||
int main () {
|
||||
using namespace boost::numeric::ublas;
|
||||
slice s (0, 1, 3);
|
||||
for (unsigned i = 0; i < s.size (); ++ i) {
|
||||
std::cout << s (i) << std::endl;
|
||||
}
|
||||
}
|
||||
</pre>
|
||||
<h4>Definition</h4>
|
||||
<p>Defined in the header storage.hpp.</p>
|
||||
<h4>Model of</h4>
|
||||
<p>Reversible Container.</p>
|
||||
<h4>Type requirements</h4>
|
||||
<p>None, except for those imposed by the requirements of Reversible
|
||||
Container.</p>
|
||||
<h4>Public base classes</h4>
|
||||
<p>None.</p>
|
||||
<h4>Members</h4>
|
||||
<table border="1" summary="members">
|
||||
<tbody>
|
||||
<tr>
|
||||
<th>Member</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>slice (size_type start, size_type stride, size_type
|
||||
size)</code></td>
|
||||
<td>Constructs a slice <code>start,start+stride,start+2*stride...</code> with
|
||||
<code>size</code> elements.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>size_type start () const</code></td>
|
||||
<td>Returns the beginning of the <code>slice</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>size_type stride () const</code></td>
|
||||
<td>Returns the stride of the <code>slice</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>size_type size () const</code></td>
|
||||
<td>Returns the size of the <code>slice</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_reference operator [] (size_type i)
|
||||
const</code></td>
|
||||
<td>Returns the value <code>start + i * stride</code> of the
|
||||
<code>i</code>-th element.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>slice compose (const range &r) const</code></td>
|
||||
<td>Returns the composite slice from <code>start + stride * r.start
|
||||
()</code> to <code>start + stride * (r.start () + r.size ())</code>
|
||||
with stride <code>stride</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>slice compose (const slice &s) const</code></td>
|
||||
<td>Returns the composite slice from <code>start + stride * s.start
|
||||
()</code> to <code>start + stride * s.stride () * (s.start () +
|
||||
s.size ())</code> with stride <code>stride * s.stride ()</code>
|
||||
.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>bool operator == (const slice &s) const</code></td>
|
||||
<td>Tests two slices for equality.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>bool operator != (const slice &s) const</code></td>
|
||||
<td>Tests two slices for inequality.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_iterator begin () const</code></td>
|
||||
<td>Returns a <code>const_iterator</code> pointing to the beginning
|
||||
of the <code>slice</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_iterator end () const</code></td>
|
||||
<td>Returns a <code>const_iterator</code> pointing to the end of
|
||||
the <code>slice</code>.</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 <code>slice</code>.</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 <code>slice</code>.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4>Preconditions</h4>
|
||||
<ul>
|
||||
<li>None all strides are vaild. However when an index is returned or an iterator is dereferenced its
|
||||
value must be representable as the size_type.</li>
|
||||
</ul>
|
||||
<hr/>
|
||||
<p>
|
||||
Copyright (©) 2000-2004 Michael Stevens, Mathias Koch,
|
||||
Joerg Walter, Gunter Winkler<br />
|
||||
Use, modification and distribution are subject to the
|
||||
Boost Software License, Version 1.0.
|
||||
(See accompanying file LICENSE_1_0.txt
|
||||
or copy at <a href="http://www.boost.org/LICENSE_1_0.txt">
|
||||
http://www.boost.org/LICENSE_1_0.txt
|
||||
</a>).
|
||||
</p>
|
||||
<script type="text/javascript">
|
||||
(function($) {
|
||||
$('#toc').toc();
|
||||
})(jQuery);
|
||||
</script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,101 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta name="generator" content="HTML Tidy for Linux (vers 6 November 2007), see www.w3.org" />
|
||||
<!-- tidy options: -w 120 -asxhtml -clean - - vertical-space yes -f index.html.err -m index.html -->
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii" />
|
||||
<link rel="stylesheet" href="../../../../boost.css" type="text/css"/>
|
||||
<link rel="stylesheet" href="ublas.css" type="text/css" />
|
||||
<script type="text/javascript" src="js/jquery-1.3.2.min.js" async="async" ></script>
|
||||
<script type="text/javascript" src="js/jquery.toc-gw.js" async="async" ></script>
|
||||
<title>Boost Basic Linear Algebra - Release Notes</title>
|
||||
</head>
|
||||
<body>
|
||||
<h1><img src="../../../../boost.png" align="middle" alt="logo"/>Boost Basic Linear Algebra - Release Notes</h1>
|
||||
|
||||
<div class="navigation">
|
||||
<a href="index.html">back to uBLAS home</a>
|
||||
</div>
|
||||
<div class="toc" id="toc"></div>
|
||||
|
||||
<h2>Release 1.52.0</h2>
|
||||
|
||||
<h3>improvements</h3>
|
||||
|
||||
<ul>
|
||||
<li><a href="https://svn.boost.org/trac/boost/ticket/4024">[4024]</a> improve performance of inplace_solve</li>
|
||||
<li><a href="https://svn.boost.org/trac/boost/ticket/6511">[6511]</a> Division by scalar should use enable_if<></li>
|
||||
<li><a href="https://svn.boost.org/trac/boost/ticket/7297">[7297]</a> Make the free functions 'num_columns' and 'num_rows' support the uBLAS traits system and better work with expression types</li>
|
||||
</ul>
|
||||
|
||||
<h3>bug fixes</h3>
|
||||
|
||||
<ul>
|
||||
<li><a href="https://svn.boost.org/trac/boost/ticket/7296">[7296]</a> fixes and improvements to test utility functions</li>
|
||||
<li><a href="https://svn.boost.org/trac/boost/ticket/7363">[7363]</a> fixed coordinate_matrix::sort() for gcc 4.7 and others</li>
|
||||
</ul>
|
||||
|
||||
<h2>Release 1.43.0</h2>
|
||||
|
||||
<h3>bug fixes</h3>
|
||||
|
||||
<ul>
|
||||
<li><a href="https://svn.boost.org/trac/boost/ticket/3968">[3968]</a> fixed coordinate_matrix sort problem on MSVC10
|
||||
</li>
|
||||
<li><a href="https://svn.boost.org/trac/boost/ticket/3539">[3539]</a>
|
||||
changed computation of <code>norm_inf</code> for complex types to match
|
||||
mathematical definition. <br />
|
||||
<b>Note:</b> This might cause a performance drop
|
||||
because now <code>std::abs(z)</code> is called for each vector element.
|
||||
The old implementation used <code>std::max(std::abs(real(z)),std::abs(imag(z))</code>.
|
||||
Further <code>norm_inf</code> and <code>norm_1</code> will now return
|
||||
the same values for complex vector.
|
||||
</li>
|
||||
<li><a href="https://svn.boost.org/trac/boost/ticket/3501">[3501]</a> Moved free functions in <code>concepts.hpp</code> into anonymous namespace.
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h2>Release 1.41.1</h2>
|
||||
|
||||
<h3>new features</h3>
|
||||
|
||||
<ul>
|
||||
<li>Move semantics of vector/matrix container assignments have been
|
||||
implemented. They can be enabled by setting
|
||||
BOOST_UBLAS_MOVE_SEMANTICS. More details are on the <a
|
||||
href="options.html">preprocessor options page</a>.
|
||||
</li>
|
||||
<li>Introduce new free functions. See <a href="https://svn.boost.org/trac/boost/ticket/3449" target="_blank">[3449]</a>,
|
||||
the new tests in <tt>libs/numeric/ublas/test</tt> and the inline documentation of the files in <tt>boost/numeric/ublas/operation/</tt>.
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>bug fixes</h3>
|
||||
|
||||
<ul>
|
||||
<li><a href="https://svn.boost.org/trac/boost/ticket/3293">[3293]</a> Fix resizing problem in <code>identity_matrix</code>
|
||||
</li>
|
||||
<li><a href="https://svn.boost.org/trac/boost/ticket/3499">[3499]</a> Add DefaultConstructible to concept checks
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h2>Release 1.40.0 and before</h2>
|
||||
<ul>
|
||||
<li>Release notes were not available in this form.</li>
|
||||
</ul>
|
||||
|
||||
<hr />
|
||||
<p>Copyright (©) 2000-2009 Joerg Walter, Mathias Koch, Gunter Winkler<br />
|
||||
Use, modification and distribution are subject to the Boost Software License, Version 1.0.
|
||||
(See accompanying file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt">
|
||||
http://www.boost.org/LICENSE_1_0.txt
|
||||
</a>).
|
||||
</p>
|
||||
<!-- Created: Sun Sep 13 00:57:13 CEST 2009 -->
|
||||
<script type="text/javascript">
|
||||
(function($) {
|
||||
$('#toc').toc();
|
||||
})(jQuery);
|
||||
</script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,228 @@
|
||||
# Copyright Michael Stevens 2004
|
||||
|
||||
# Use, modification, and distribution is subject to 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)
|
||||
# bring in rules for testing
|
||||
|
||||
# Boost uBLAS library documentation samples
|
||||
|
||||
# Project requirements
|
||||
project samples
|
||||
: requirements
|
||||
<toolset>borland:<cxxflags>"-w-8026 -w-8027 -w-8057 -w-8084 -w-8092"
|
||||
<toolset>kylix:<cxxflags>"-w-8026 -w-8027 -w-8057 -w-8084 -w-8092"
|
||||
;
|
||||
|
||||
exe unbounded_array
|
||||
: unbounded_array.cpp
|
||||
;
|
||||
|
||||
exe bounded_array
|
||||
: bounded_array.cpp
|
||||
;
|
||||
|
||||
exe range
|
||||
: range.cpp
|
||||
;
|
||||
|
||||
exe slice
|
||||
: slice.cpp
|
||||
;
|
||||
|
||||
exe map_array
|
||||
: map_array.cpp
|
||||
;
|
||||
|
||||
exe vector
|
||||
: vector.cpp
|
||||
;
|
||||
|
||||
exe unit_vector
|
||||
: unit_vector.cpp
|
||||
;
|
||||
|
||||
exe zero_vector
|
||||
: zero_vector.cpp
|
||||
;
|
||||
|
||||
exe mapped_vector
|
||||
: mapped_vector.cpp
|
||||
;
|
||||
|
||||
exe compressed_vector
|
||||
: compressed_vector.cpp
|
||||
;
|
||||
|
||||
exe coordinate_vector
|
||||
: coordinate_vector.cpp
|
||||
;
|
||||
|
||||
exe vector_range
|
||||
: vector_range.cpp
|
||||
;
|
||||
|
||||
exe vector_range_project
|
||||
: vector_range_project.cpp
|
||||
;
|
||||
|
||||
exe vector_slice
|
||||
: vector_slice.cpp
|
||||
;
|
||||
|
||||
exe vector_slice_project
|
||||
: vector_slice_project.cpp
|
||||
;
|
||||
|
||||
exe vector_unary
|
||||
: vector_unary.cpp
|
||||
;
|
||||
|
||||
exe vector_binary
|
||||
: vector_binary.cpp
|
||||
;
|
||||
|
||||
exe vector_binary_outer
|
||||
: vector_binary_outer.cpp
|
||||
;
|
||||
|
||||
exe vector_binary_scalar
|
||||
: vector_binary_scalar.cpp
|
||||
;
|
||||
|
||||
exe vector_unary_redux
|
||||
: vector_unary_redux.cpp
|
||||
;
|
||||
|
||||
exe vector_binary_redux
|
||||
: vector_binary_redux.cpp
|
||||
;
|
||||
|
||||
exe matrix
|
||||
: matrix.cpp
|
||||
;
|
||||
|
||||
exe identity_matrix
|
||||
: identity_matrix.cpp
|
||||
;
|
||||
|
||||
exe zero_matrix
|
||||
: zero_matrix.cpp
|
||||
;
|
||||
|
||||
exe mapped_matrix
|
||||
: mapped_matrix.cpp
|
||||
;
|
||||
|
||||
exe compressed_matrix
|
||||
: compressed_matrix.cpp
|
||||
;
|
||||
|
||||
exe coordinate_matrix
|
||||
: coordinate_matrix.cpp
|
||||
;
|
||||
|
||||
exe matrix_row
|
||||
: matrix_row.cpp
|
||||
;
|
||||
|
||||
exe matrix_row_project
|
||||
: matrix_row_project.cpp
|
||||
;
|
||||
|
||||
exe matrix_column
|
||||
: matrix_column.cpp
|
||||
;
|
||||
|
||||
exe matrix_column_project
|
||||
: matrix_column_project.cpp
|
||||
;
|
||||
|
||||
exe matrix_vector_range
|
||||
: matrix_vector_range.cpp
|
||||
;
|
||||
|
||||
exe matrix_vector_slice
|
||||
: matrix_vector_slice.cpp
|
||||
;
|
||||
|
||||
exe matrix_range
|
||||
: matrix_range.cpp
|
||||
;
|
||||
|
||||
exe matrix_range_project
|
||||
: matrix_range_project.cpp
|
||||
;
|
||||
|
||||
exe matrix_slice
|
||||
: matrix_slice.cpp
|
||||
;
|
||||
|
||||
exe matrix_slice_project
|
||||
: matrix_slice_project.cpp
|
||||
;
|
||||
|
||||
exe matrix_unary
|
||||
: matrix_unary.cpp
|
||||
;
|
||||
|
||||
exe matrix_binary
|
||||
: matrix_binary.cpp
|
||||
: <include>$(BOOST_ROOT)
|
||||
;
|
||||
|
||||
exe matrix_binary_scalar
|
||||
: matrix_binary_scalar.cpp
|
||||
;
|
||||
|
||||
exe matrix_vector_binary
|
||||
: matrix_vector_binary.cpp
|
||||
;
|
||||
|
||||
exe matrix_vector_solve
|
||||
: matrix_vector_solve.cpp
|
||||
;
|
||||
|
||||
exe matrix_matrix_binary
|
||||
: matrix_matrix_binary.cpp
|
||||
;
|
||||
|
||||
exe matrix_matrix_solve
|
||||
: matrix_matrix_solve.cpp
|
||||
;
|
||||
|
||||
exe banded_matrix
|
||||
: banded_matrix.cpp
|
||||
;
|
||||
|
||||
exe banded_adaptor
|
||||
: banded_adaptor.cpp
|
||||
;
|
||||
|
||||
exe hermitian_matrix
|
||||
: hermitian_matrix.cpp
|
||||
;
|
||||
|
||||
exe hermitian_adaptor
|
||||
: hermitian_adaptor.cpp
|
||||
;
|
||||
|
||||
exe symmetric_matrix
|
||||
: symmetric_matrix.cpp
|
||||
;
|
||||
|
||||
exe symmetric_adaptor
|
||||
: symmetric_adaptor.cpp
|
||||
;
|
||||
|
||||
exe triangular_matrix
|
||||
: triangular_matrix.cpp
|
||||
;
|
||||
|
||||
exe triangular_adaptor
|
||||
: triangular_adaptor.cpp
|
||||
;
|
||||
|
||||
exe ex_triangular
|
||||
: ex_triangular.cpp
|
||||
;
|
||||
@@ -0,0 +1,319 @@
|
||||
//
|
||||
// Copyright (c) 2010 Athanasios Iliopoulos
|
||||
//
|
||||
// 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)
|
||||
//
|
||||
|
||||
#include <boost/numeric/ublas/assignment.hpp>
|
||||
#include <boost/numeric/ublas/vector.hpp>
|
||||
#include <boost/numeric/ublas/vector_proxy.hpp>
|
||||
#include <boost/numeric/ublas/matrix_proxy.hpp>
|
||||
#include <boost/numeric/ublas/vector_sparse.hpp>
|
||||
#include <boost/numeric/ublas/matrix_sparse.hpp>
|
||||
#include <boost/numeric/ublas/io.hpp>
|
||||
#include <boost/numeric/ublas/matrix.hpp>
|
||||
|
||||
using namespace boost::numeric::ublas;
|
||||
|
||||
int main() {
|
||||
// Simple vector fill
|
||||
vector<double> a(3);
|
||||
a <<= 0, 1, 2;
|
||||
std::cout << a << std::endl;
|
||||
// [ 0 1 2]
|
||||
|
||||
// Vector from vector
|
||||
vector<double> b(7);
|
||||
b <<= a, 10, a;
|
||||
std::cout << b << std::endl;
|
||||
// [ 0 1 2 10 0 1 2]
|
||||
|
||||
// Simple matrix fill
|
||||
matrix<double> A(3,3);
|
||||
A <<= 0, 1, 2,
|
||||
3, 4, 5,
|
||||
6, 7, 8;
|
||||
std::cout << A << std::endl;
|
||||
// [ 0 1 2 ]
|
||||
// [ 3 4 5 ]
|
||||
// [ 6 7 8 ]
|
||||
|
||||
// Matrix from vector
|
||||
A <<= 0, 1, 2,
|
||||
3, 4, 5,
|
||||
a;
|
||||
std::cout << A << std::endl;
|
||||
// [ 0 1 2 ]
|
||||
// [ 3 4 5 ]
|
||||
// [ 0 1 2 ]
|
||||
|
||||
// Matrix from vector - column assignment
|
||||
A <<= move(0,2), traverse_policy::by_column(),
|
||||
a;
|
||||
std::cout << A << std::endl;
|
||||
// [ 0 1 0 ]
|
||||
// [ 3 4 1 ]
|
||||
// [ 0 1 2 ]
|
||||
|
||||
// Another matrix from vector example (watch the wraping);
|
||||
vector<double> c(9); c <<= 1, 2, 3, 4, 5, 6, 7, 8, 9;
|
||||
A <<= c;
|
||||
std::cout << A << std::endl;
|
||||
// [ 1 2 3 ]
|
||||
// [ 4 5 6 ]
|
||||
// [ 7 8 9 ]
|
||||
|
||||
// If for performance(Benchmarks are not definite about that) or consistency reasons you need to disable wraping:
|
||||
static next_row_manip endr; //This can be defined globally
|
||||
A <<= traverse_policy::by_row_no_wrap(),
|
||||
1, 2, 3, endr,
|
||||
4, 5, 6, endr,
|
||||
7, 8, 9, endr;
|
||||
// [ 1 2 3 ]
|
||||
// [ 4 5 6 ]
|
||||
// [ 7 8 9 ]
|
||||
// If by default you need to disable wraping define
|
||||
// BOOST_UBLAS_DEFAULT_NO_WRAP_POLICY, in the compilation options,
|
||||
// so that you avoid typing the "traverse_policy::by_row_no_wrap()".
|
||||
|
||||
// Plus and minus assign:
|
||||
A <<= fill_policy::index_plus_assign(),
|
||||
3,2,1;
|
||||
std::cout << A << std::endl;
|
||||
// [ 4 4 4 ]
|
||||
// [ 4 5 6 ]
|
||||
// [ 7 8 9 ]
|
||||
|
||||
// Matrix from proxy
|
||||
A <<= 0, 1, 2,
|
||||
project(b, range(3,6)),
|
||||
a;
|
||||
std::cout << A << std::endl;
|
||||
// [ 0 1 2 ]
|
||||
// [10 0 1 ]
|
||||
// [ 6 7 8 ]
|
||||
|
||||
// Matrix from matrix
|
||||
matrix<double> B(6,6);
|
||||
B <<= A, A,
|
||||
A, A;
|
||||
std::cout << B << std::endl;
|
||||
// [ A A ]
|
||||
// [ A A ]
|
||||
|
||||
// Matrix range (vector is similar)
|
||||
B = zero_matrix<double>(6,6);
|
||||
matrix_range<matrix<double> > mrB (B, range (1, 4), range (1, 4));
|
||||
mrB <<= 1,2,3,4,5,6,7,8,9;
|
||||
std::cout << B << std::endl;
|
||||
// [ 0 0 0 0 0 0]
|
||||
// [ 0 1 2 3 0 0]
|
||||
// [ 0 4 5 6 0 0]
|
||||
// [ 0 0 0 0 0 0]
|
||||
// [ 0 0 0 0 0 0]
|
||||
// [ 0 0 0 0 0 0]
|
||||
|
||||
// Horizontal concatenation can be achieved using this trick:
|
||||
matrix<double> BH(3,9);
|
||||
BH <<= A, A, A;
|
||||
std::cout << BH << std::endl;
|
||||
// [ A A A]
|
||||
|
||||
// Vertical concatenation can be achieved using this trick:
|
||||
matrix<double> BV(9,3);
|
||||
BV <<= A,
|
||||
A,
|
||||
A;
|
||||
std::cout << BV << std::endl;
|
||||
// [ A ]
|
||||
// [ A ]
|
||||
// [ A ]
|
||||
|
||||
// Watch the difference when assigning matrices for different traverse policies:
|
||||
matrix<double> BR(9,9, 0);
|
||||
BR <<= traverse_policy::by_row(), // This is the default, so this might as well be omitted.
|
||||
A, A, A;
|
||||
std::cout << BR << std::endl;
|
||||
// [ A A A]
|
||||
// [ 0 0 0]
|
||||
// [ 0 0 0]
|
||||
|
||||
matrix<double> BC(9,9, 0);
|
||||
BC <<= traverse_policy::by_column(),
|
||||
A, A, A;
|
||||
std::cout << BC << std::endl;
|
||||
// [ A 0 0]
|
||||
// [ A 0 0]
|
||||
// [ A 0 0]
|
||||
|
||||
// The following will throw a run-time exception in debug mode (matrix mid-assignment wrap is not allowed) :
|
||||
// matrix<double> C(7,7);
|
||||
// C <<= A, A, A;
|
||||
|
||||
// Matrix from matrix with index manipulators
|
||||
matrix<double> C(6,6,0);
|
||||
C <<= A, move(3,0), A;
|
||||
// [ A 0 ]
|
||||
// [ 0 A ]
|
||||
|
||||
// A faster way for to construct this dense matrix.
|
||||
matrix<double> D(6,6);
|
||||
D <<= A, zero_matrix<double>(3,3),
|
||||
zero_matrix<double>(3,3), A;
|
||||
// [ A 0 ]
|
||||
// [ 0 A ]
|
||||
|
||||
// The next_row and next_column index manipulators:
|
||||
// note: next_row and next_column functions return
|
||||
// a next_row_manip and and next_column_manip object.
|
||||
// This is the manipulator we used earlier when we disabled
|
||||
// wrapping.
|
||||
matrix<double> E(2,4,0);
|
||||
E <<= 1, 2, next_row(),
|
||||
3, 4, next_column(),5;
|
||||
std::cout << E << std::endl;
|
||||
// [ 1 2 0 5 ]
|
||||
// [ 3 4 0 0 ]
|
||||
|
||||
// The begin1 (moves to the begining of the column) index manipulator, begin2 does the same for the row:
|
||||
matrix<double> F(2,4,0);
|
||||
F <<= 1, 2, next_row(),
|
||||
3, 4, begin1(),5;
|
||||
std::cout << F << std::endl;
|
||||
// [ 1 2 5 0 ]
|
||||
// [ 3 4 0 0 ]
|
||||
|
||||
// The move (relative) and move_to(absolute) index manipulators (probably the most useful manipulators):
|
||||
matrix<double> G(2,4,0);
|
||||
G <<= 1, 2, move(0,1), 3,
|
||||
move_to(1,3), 4;
|
||||
std::cout << G << std::endl;
|
||||
// [ 1 2 0 3 ]
|
||||
// [ 0 0 0 4 ]
|
||||
|
||||
// Static equivallents (faster) when sizes are known at compile time:
|
||||
matrix<double> Gs(2,4,0);
|
||||
Gs <<= 1, 2, move<0,1>(), 3,
|
||||
move_to<1,3>(), 4;
|
||||
std::cout << Gs << std::endl;
|
||||
// [ 1 2 0 3 ]
|
||||
// [ 0 0 0 4 ]
|
||||
|
||||
// Choice of traverse policy (default is "row by row" traverse):
|
||||
|
||||
matrix<double> H(2,4,0);
|
||||
H <<= 1, 2, 3, 4,
|
||||
5, 6, 7, 8;
|
||||
std::cout << H << std::endl;
|
||||
// [ 1 2 3 4 ]
|
||||
// [ 5 6 7 8 ]
|
||||
|
||||
H <<= traverse_policy::by_column(),
|
||||
1, 2, 3, 4,
|
||||
5, 6, 7, 8;
|
||||
std::cout << H << std::endl;
|
||||
// [ 1 3 5 7 ]
|
||||
// [ 2 4 6 8 ]
|
||||
|
||||
// traverse policy can be changed mid assignment if desired.
|
||||
matrix<double> H1(4,4,0);
|
||||
H1 <<= 1, 2, 3, traverse_policy::by_column(), 1, 2, 3;
|
||||
|
||||
std::cout << H << std::endl;
|
||||
// [1 2 3 1]
|
||||
// [0 0 0 2]
|
||||
// [0 0 0 3]
|
||||
// [0 0 0 0]
|
||||
|
||||
// note: fill_policy and traverse_policy are namespaces, so you can use them
|
||||
// by a using statement.
|
||||
|
||||
// For compressed and coordinate matrix types a push_back or insert fill policy can be chosen for faster assginment:
|
||||
compressed_matrix<double> I(2, 2);
|
||||
I <<= fill_policy::sparse_push_back(),
|
||||
0, 1, 2, 3;
|
||||
std::cout << I << std::endl;
|
||||
// [ 0 1 ]
|
||||
// [ 2 3 ]
|
||||
|
||||
coordinate_matrix<double> J(2,2);
|
||||
J<<=fill_policy::sparse_insert(),
|
||||
1, 2, 3, 4;
|
||||
std::cout << J << std::endl;
|
||||
// [ 1 2 ]
|
||||
// [ 3 4 ]
|
||||
|
||||
// A sparse matrix from another matrix works as with other types.
|
||||
coordinate_matrix<double> K(3,3);
|
||||
K<<=fill_policy::sparse_insert(),
|
||||
J;
|
||||
std::cout << K << std::endl;
|
||||
// [ 1 2 0 ]
|
||||
// [ 3 4 0 ]
|
||||
// [ 0 0 0 ]
|
||||
|
||||
// Be careful this will not work:
|
||||
//compressed_matrix<double> J2(4,4);
|
||||
//J2<<=fill_policy::sparse_push_back(),
|
||||
// J,J;
|
||||
// That's because the second J2's elements
|
||||
// are attempted to be assigned at positions
|
||||
// that come before the elements already pushed.
|
||||
// Unfortunatelly that's the only thing you can do in this case
|
||||
// (or of course make a custom agorithm):
|
||||
compressed_matrix<double> J2(4,4);
|
||||
J2<<=fill_policy::sparse_push_back(),
|
||||
J, fill_policy::sparse_insert(),
|
||||
J;
|
||||
|
||||
std::cout << J2 << std::endl;
|
||||
// [ J J ]
|
||||
// [ 0 0 0 0 ]
|
||||
// [ 0 0 0 0 ]
|
||||
|
||||
// A different traverse policy doesn't change the result, only they order it is been assigned.
|
||||
coordinate_matrix<double> L(3,3);
|
||||
L<<=fill_policy::sparse_insert(), traverse_policy::by_column(),
|
||||
J;
|
||||
std::cout << L << std::endl;
|
||||
// (same as previous)
|
||||
// [ 1 2 0 ]
|
||||
// [ 3 4 0 ]
|
||||
// [ 0 0 0 ]
|
||||
|
||||
typedef coordinate_matrix<double>::size_type cmst;
|
||||
const cmst size = 30;
|
||||
//typedef fill_policy::sparse_push_back spb;
|
||||
// Although the above could have been used the following is may be faster if
|
||||
// you use the policy often and for relatively small containers.
|
||||
static fill_policy::sparse_push_back spb;
|
||||
|
||||
// A block diagonal sparse using a loop:
|
||||
compressed_matrix<double> M(size, size, 4*15);
|
||||
for (cmst i=0; i!=size; i+=J.size1())
|
||||
M <<= spb, move_to(i,i), J;
|
||||
|
||||
|
||||
// If typedef was used above the last expression should start
|
||||
// with M <<= spb()...
|
||||
|
||||
// Displaying so that blocks can be easily seen:
|
||||
for (unsigned int i=0; i!=M.size1(); i++) {
|
||||
std::cout << M(i,0);
|
||||
for (unsigned int j=1; j!=M.size2(); j++) std::cout << ", " << M(i,j);
|
||||
std::cout << "\n";
|
||||
}
|
||||
// [ J 0 0 0 ... 0]
|
||||
// [ 0 J 0 0 ... 0]
|
||||
// [ 0 . . . ... 0]
|
||||
// [ 0 0 ... 0 0 J]
|
||||
|
||||
|
||||
// A "repeat" trasverser may by provided so that this becomes faster and an on-liner like:
|
||||
// M <<= spb, repeat(0, size, J.size1(), 0, size, J.size1()), J;
|
||||
// An alternate would be to create a :repeater" matrix and vector expression that can be used in other places as well. The latter is probably better,
|
||||
return 0;
|
||||
}
|
||||
|
||||
@@ -0,0 +1,25 @@
|
||||
//
|
||||
// Copyright (c) 2000-2002
|
||||
// Joerg Walter, Mathias Koch
|
||||
//
|
||||
// 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)
|
||||
//
|
||||
// The authors gratefully acknowledge the support of
|
||||
// GeNeSys mbH & Co. KG in producing this work.
|
||||
//
|
||||
|
||||
#include <boost/numeric/ublas/banded.hpp>
|
||||
#include <boost/numeric/ublas/io.hpp>
|
||||
|
||||
int main () {
|
||||
using namespace boost::numeric::ublas;
|
||||
matrix<double> m (3, 3);
|
||||
banded_adaptor<matrix<double> > ba (m, 1, 1);
|
||||
for (signed i = 0; i < signed (ba.size1 ()); ++ i)
|
||||
for (signed j = (std::max) (i - 1, 0); j < (std::min) (i + 2, signed (ba.size2 ())); ++ j)
|
||||
ba (i, j) = 3 * i + j;
|
||||
std::cout << ba << std::endl;
|
||||
}
|
||||
|
||||
@@ -0,0 +1,24 @@
|
||||
//
|
||||
// Copyright (c) 2000-2002
|
||||
// Joerg Walter, Mathias Koch
|
||||
//
|
||||
// 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)
|
||||
//
|
||||
// The authors gratefully acknowledge the support of
|
||||
// GeNeSys mbH & Co. KG in producing this work.
|
||||
//
|
||||
|
||||
#include <boost/numeric/ublas/banded.hpp>
|
||||
#include <boost/numeric/ublas/io.hpp>
|
||||
|
||||
int main () {
|
||||
using namespace boost::numeric::ublas;
|
||||
banded_matrix<double> m (3, 3, 1, 1);
|
||||
for (signed i = 0; i < signed (m.size1 ()); ++ i)
|
||||
for (signed j = (std::max) (i - 1, 0); j < (std::min) (i + 2, signed (m.size2 ())); ++ j)
|
||||
m (i, j) = 3 * i + j;
|
||||
std::cout << m << std::endl;
|
||||
}
|
||||
|
||||
@@ -0,0 +1,23 @@
|
||||
//
|
||||
// Copyright (c) 2000-2002
|
||||
// Joerg Walter, Mathias Koch
|
||||
//
|
||||
// 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)
|
||||
//
|
||||
// The authors gratefully acknowledge the support of
|
||||
// GeNeSys mbH & Co. KG in producing this work.
|
||||
//
|
||||
|
||||
#include <boost/numeric/ublas/storage.hpp>
|
||||
|
||||
int main () {
|
||||
using namespace boost::numeric::ublas;
|
||||
bounded_array<double, 3> a (3);
|
||||
for (unsigned i = 0; i < a.size (); ++ i) {
|
||||
a [i] = i;
|
||||
std::cout << a [i] << std::endl;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -0,0 +1,24 @@
|
||||
//
|
||||
// Copyright (c) 2000-2002
|
||||
// Joerg Walter, Mathias Koch
|
||||
//
|
||||
// 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)
|
||||
//
|
||||
// The authors gratefully acknowledge the support of
|
||||
// GeNeSys mbH & Co. KG in producing this work.
|
||||
//
|
||||
|
||||
#include <boost/numeric/ublas/matrix_sparse.hpp>
|
||||
#include <boost/numeric/ublas/io.hpp>
|
||||
|
||||
int main () {
|
||||
using namespace boost::numeric::ublas;
|
||||
compressed_matrix<double> m (3, 3, 3 * 3);
|
||||
for (unsigned i = 0; i < m.size1 (); ++ i)
|
||||
for (unsigned j = 0; j < m.size2 (); ++ j)
|
||||
m (i, j) = 3 * i + j;
|
||||
std::cout << m << std::endl;
|
||||
}
|
||||
|
||||
@@ -0,0 +1,23 @@
|
||||
//
|
||||
// Copyright (c) 2000-2002
|
||||
// Joerg Walter, Mathias Koch
|
||||
//
|
||||
// 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)
|
||||
//
|
||||
// The authors gratefully acknowledge the support of
|
||||
// GeNeSys mbH & Co. KG in producing this work.
|
||||
//
|
||||
|
||||
#include <boost/numeric/ublas/vector_sparse.hpp>
|
||||
#include <boost/numeric/ublas/io.hpp>
|
||||
|
||||
int main () {
|
||||
using namespace boost::numeric::ublas;
|
||||
compressed_vector<double> v (3, 3);
|
||||
for (unsigned i = 0; i < v.size (); ++ i)
|
||||
v (i) = i;
|
||||
std::cout << v << std::endl;
|
||||
}
|
||||
|
||||
@@ -0,0 +1,24 @@
|
||||
//
|
||||
// Copyright (c) 2000-2002
|
||||
// Joerg Walter, Mathias Koch
|
||||
//
|
||||
// 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)
|
||||
//
|
||||
// The authors gratefully acknowledge the support of
|
||||
// GeNeSys mbH & Co. KG in producing this work.
|
||||
//
|
||||
|
||||
#include <boost/numeric/ublas/matrix_sparse.hpp>
|
||||
#include <boost/numeric/ublas/io.hpp>
|
||||
|
||||
int main () {
|
||||
using namespace boost::numeric::ublas;
|
||||
coordinate_matrix<double> m (3, 3, 3 * 3);
|
||||
for (unsigned i = 0; i < m.size1 (); ++ i)
|
||||
for (unsigned j = 0; j < m.size2 (); ++ j)
|
||||
m (i, j) = 3 * i + j;
|
||||
std::cout << m << std::endl;
|
||||
}
|
||||
|
||||
@@ -0,0 +1,23 @@
|
||||
//
|
||||
// Copyright (c) 2000-2002
|
||||
// Joerg Walter, Mathias Koch
|
||||
//
|
||||
// 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)
|
||||
//
|
||||
// The authors gratefully acknowledge the support of
|
||||
// GeNeSys mbH & Co. KG in producing this work.
|
||||
//
|
||||
|
||||
#include <boost/numeric/ublas/vector_sparse.hpp>
|
||||
#include <boost/numeric/ublas/io.hpp>
|
||||
|
||||
int main () {
|
||||
using namespace boost::numeric::ublas;
|
||||
coordinate_vector<double> v (3, 3);
|
||||
for (unsigned i = 0; i < v.size (); ++ i)
|
||||
v (i) = i;
|
||||
std::cout << v << std::endl;
|
||||
}
|
||||
|
||||
@@ -0,0 +1,58 @@
|
||||
// Copyright Gunter Winkler 2004 - 2009.
|
||||
// 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)
|
||||
|
||||
|
||||
#include <iostream>
|
||||
|
||||
#include <boost/numeric/ublas/matrix.hpp>
|
||||
#include <boost/numeric/ublas/triangular.hpp>
|
||||
|
||||
#include <boost/numeric/ublas/io.hpp>
|
||||
|
||||
using std::cout;
|
||||
using std::endl;
|
||||
|
||||
|
||||
|
||||
namespace ublas = boost::numeric::ublas;
|
||||
|
||||
|
||||
int main(int argc, char * argv[] ) {
|
||||
|
||||
ublas::matrix<double> M (3, 3);
|
||||
for (std::size_t i=0; i < M.data().size(); ++i) { M.data()[i] = 1+i ; }
|
||||
|
||||
std::cout << "full M = " << M << "\n" ;
|
||||
|
||||
ublas::triangular_matrix<double, ublas::lower> L;
|
||||
ublas::triangular_matrix<double, ublas::unit_lower> UL;
|
||||
ublas::triangular_matrix<double, ublas::strict_lower> SL;
|
||||
|
||||
L = ublas::triangular_adaptor<ublas::matrix<double>, ublas::lower> (M);
|
||||
SL = ublas::triangular_adaptor<ublas::matrix<double>, ublas::strict_lower> (M);
|
||||
UL = ublas::triangular_adaptor<ublas::matrix<double>, ublas::unit_lower> (M);
|
||||
|
||||
std::cout << "lower L = " << L << "\n"
|
||||
<< "strict lower SL = " << SL << "\n"
|
||||
<< "unit lower UL = " << UL << "\n" ;
|
||||
|
||||
ublas::triangular_matrix<double, ublas::upper> U;
|
||||
ublas::triangular_matrix<double, ublas::unit_upper> UU;
|
||||
ublas::triangular_matrix<double, ublas::strict_upper> SU;
|
||||
|
||||
U = ublas::triangular_adaptor<ublas::matrix<double>, ublas::upper> (M);
|
||||
SU = ublas::triangular_adaptor<ublas::matrix<double>, ublas::strict_upper> (M);
|
||||
UU = ublas::triangular_adaptor<ublas::matrix<double>, ublas::unit_upper> (M);
|
||||
|
||||
std::cout << "upper U = " << U << "\n"
|
||||
<< "strict upper SU = " << SU << "\n"
|
||||
<< "unit upper UU = " << UU << "\n" ;
|
||||
|
||||
std::cout << "M = L + SU ? " << ((norm_inf( M - (L + SU) ) == 0.0)?"ok":"failed") << "\n";
|
||||
std::cout << "M = U + SL ? " << ((norm_inf( M - (U + SL) ) == 0.0)?"ok":"failed") << "\n";
|
||||
|
||||
}
|
||||
|
||||
|
||||
@@ -0,0 +1,34 @@
|
||||
//
|
||||
// Copyright (c) 2000-2002
|
||||
// Joerg Walter, Mathias Koch
|
||||
//
|
||||
// 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)
|
||||
//
|
||||
// The authors gratefully acknowledge the support of
|
||||
// GeNeSys mbH & Co. KG in producing this work.
|
||||
//
|
||||
|
||||
#include <boost/numeric/ublas/hermitian.hpp>
|
||||
#include <boost/numeric/ublas/io.hpp>
|
||||
|
||||
int main () {
|
||||
using namespace boost::numeric::ublas;
|
||||
matrix<std::complex<double> > m (3, 3);
|
||||
hermitian_adaptor<matrix<std::complex<double> >, lower> hal (m);
|
||||
for (unsigned i = 0; i < hal.size1 (); ++ i) {
|
||||
for (unsigned j = 0; j < i; ++ j)
|
||||
hal (i, j) = std::complex<double> (3 * i + j, 3 * i + j);
|
||||
hal (i, i) = std::complex<double> (4 * i, 0);
|
||||
}
|
||||
std::cout << hal << std::endl;
|
||||
hermitian_adaptor<matrix<std::complex<double> >, upper> hau (m);
|
||||
for (unsigned i = 0; i < hau.size1 (); ++ i) {
|
||||
hau (i, i) = std::complex<double> (4 * i, 0);
|
||||
for (unsigned j = i + 1; j < hau.size2 (); ++ j)
|
||||
hau (i, j) = std::complex<double> (3 * i + j, 3 * i + j);
|
||||
}
|
||||
std::cout << hau << std::endl;
|
||||
}
|
||||
|
||||
@@ -0,0 +1,33 @@
|
||||
//
|
||||
// Copyright (c) 2000-2002
|
||||
// Joerg Walter, Mathias Koch
|
||||
//
|
||||
// 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)
|
||||
//
|
||||
// The authors gratefully acknowledge the support of
|
||||
// GeNeSys mbH & Co. KG in producing this work.
|
||||
//
|
||||
|
||||
#include <boost/numeric/ublas/hermitian.hpp>
|
||||
#include <boost/numeric/ublas/io.hpp>
|
||||
|
||||
int main () {
|
||||
using namespace boost::numeric::ublas;
|
||||
hermitian_matrix<std::complex<double>, lower> ml (3, 3);
|
||||
for (unsigned i = 0; i < ml.size1 (); ++ i) {
|
||||
for (unsigned j = 0; j < i; ++ j)
|
||||
ml (i, j) = std::complex<double> (3 * i + j, 3 * i + j);
|
||||
ml (i, i) = std::complex<double> (4 * i, 0);
|
||||
}
|
||||
std::cout << ml << std::endl;
|
||||
hermitian_matrix<std::complex<double>, upper> mu (3, 3);
|
||||
for (unsigned i = 0; i < mu.size1 (); ++ i) {
|
||||
mu (i, i) = std::complex<double> (4 * i, 0);
|
||||
for (unsigned j = i + 1; j < mu.size2 (); ++ j)
|
||||
mu (i, j) = std::complex<double> (3 * i + j, 3 * i + j);
|
||||
}
|
||||
std::cout << mu << std::endl;
|
||||
}
|
||||
|
||||
@@ -0,0 +1,21 @@
|
||||
//
|
||||
// Copyright (c) 2000-2002
|
||||
// Joerg Walter, Mathias Koch
|
||||
//
|
||||
// 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)
|
||||
//
|
||||
// The authors gratefully acknowledge the support of
|
||||
// GeNeSys mbH & Co. KG in producing this work.
|
||||
//
|
||||
|
||||
#include <boost/numeric/ublas/matrix.hpp>
|
||||
#include <boost/numeric/ublas/io.hpp>
|
||||
|
||||
int main () {
|
||||
using namespace boost::numeric::ublas;
|
||||
identity_matrix<double> m (3);
|
||||
std::cout << m << std::endl;
|
||||
}
|
||||
|
||||
@@ -0,0 +1,24 @@
|
||||
//
|
||||
// Copyright (c) 2000-2002
|
||||
// Joerg Walter, Mathias Koch
|
||||
//
|
||||
// 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)
|
||||
//
|
||||
// The authors gratefully acknowledge the support of
|
||||
// GeNeSys mbH & Co. KG in producing this work.
|
||||
//
|
||||
|
||||
#include <boost/numeric/ublas/storage_sparse.hpp>
|
||||
|
||||
int main () {
|
||||
using namespace boost::numeric::ublas;
|
||||
map_array<int, double> a;
|
||||
a.reserve (3);
|
||||
for (unsigned i = 0; i < 3; ++ i) {
|
||||
a [i] = i;
|
||||
std::cout << a [i] << std::endl;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -0,0 +1,24 @@
|
||||
//
|
||||
// Copyright (c) 2000-2002
|
||||
// Joerg Walter, Mathias Koch
|
||||
//
|
||||
// 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)
|
||||
//
|
||||
// The authors gratefully acknowledge the support of
|
||||
// GeNeSys mbH & Co. KG in producing this work.
|
||||
//
|
||||
|
||||
#include <boost/numeric/ublas/matrix_sparse.hpp>
|
||||
#include <boost/numeric/ublas/io.hpp>
|
||||
|
||||
int main () {
|
||||
using namespace boost::numeric::ublas;
|
||||
mapped_matrix<double> m (3, 3, 3 * 3);
|
||||
for (unsigned i = 0; i < m.size1 (); ++ i)
|
||||
for (unsigned j = 0; j < m.size2 (); ++ j)
|
||||
m (i, j) = 3 * i + j;
|
||||
std::cout << m << std::endl;
|
||||
}
|
||||
|
||||
@@ -0,0 +1,23 @@
|
||||
//
|
||||
// Copyright (c) 2000-2002
|
||||
// Joerg Walter, Mathias Koch
|
||||
//
|
||||
// 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)
|
||||
//
|
||||
// The authors gratefully acknowledge the support of
|
||||
// GeNeSys mbH & Co. KG in producing this work.
|
||||
//
|
||||
|
||||
#include <boost/numeric/ublas/vector_sparse.hpp>
|
||||
#include <boost/numeric/ublas/io.hpp>
|
||||
|
||||
int main () {
|
||||
using namespace boost::numeric::ublas;
|
||||
mapped_vector<double> v (3, 3);
|
||||
for (unsigned i = 0; i < v.size (); ++ i)
|
||||
v (i) = i;
|
||||
std::cout << v << std::endl;
|
||||
}
|
||||
|
||||
@@ -0,0 +1,24 @@
|
||||
//
|
||||
// Copyright (c) 2000-2002
|
||||
// Joerg Walter, Mathias Koch
|
||||
//
|
||||
// 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)
|
||||
//
|
||||
// The authors gratefully acknowledge the support of
|
||||
// GeNeSys mbH & Co. KG in producing this work.
|
||||
//
|
||||
|
||||
#include <boost/numeric/ublas/matrix.hpp>
|
||||
#include <boost/numeric/ublas/io.hpp>
|
||||
|
||||
int main () {
|
||||
using namespace boost::numeric::ublas;
|
||||
matrix<double> m (3, 3);
|
||||
for (unsigned i = 0; i < m.size1 (); ++ i)
|
||||
for (unsigned j = 0; j < m.size2 (); ++ j)
|
||||
m (i, j) = 3 * i + j;
|
||||
std::cout << m << std::endl;
|
||||
}
|
||||
|
||||
@@ -0,0 +1,26 @@
|
||||
//
|
||||
// Copyright (c) 2000-2002
|
||||
// Joerg Walter, Mathias Koch
|
||||
//
|
||||
// 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)
|
||||
//
|
||||
// The authors gratefully acknowledge the support of
|
||||
// GeNeSys mbH & Co. KG in producing this work.
|
||||
//
|
||||
|
||||
#include <boost/numeric/ublas/matrix.hpp>
|
||||
#include <boost/numeric/ublas/io.hpp>
|
||||
|
||||
int main () {
|
||||
using namespace boost::numeric::ublas;
|
||||
matrix<double> m1 (3, 3), m2 (3, 3);
|
||||
for (unsigned i = 0; i < (std::min) (m1.size1 (), m2.size1 ()); ++ i)
|
||||
for (unsigned j = 0; j < (std::min) (m1.size2 (), m2.size2 ()); ++ j)
|
||||
m1 (i, j) = m2 (i, j) = 3 * i + j;
|
||||
|
||||
std::cout << m1 + m2 << std::endl;
|
||||
std::cout << m1 - m2 << std::endl;
|
||||
}
|
||||
|
||||
@@ -0,0 +1,26 @@
|
||||
//
|
||||
// Copyright (c) 2000-2002
|
||||
// Joerg Walter, Mathias Koch
|
||||
//
|
||||
// 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)
|
||||
//
|
||||
// The authors gratefully acknowledge the support of
|
||||
// GeNeSys mbH & Co. KG in producing this work.
|
||||
//
|
||||
|
||||
#include <boost/numeric/ublas/matrix.hpp>
|
||||
#include <boost/numeric/ublas/io.hpp>
|
||||
|
||||
int main () {
|
||||
using namespace boost::numeric::ublas;
|
||||
matrix<double> m (3, 3);
|
||||
for (unsigned i = 0; i < m.size1 (); ++ i)
|
||||
for (unsigned j = 0; j < m.size2 (); ++ j)
|
||||
m (i, j) = 3 * i + j;
|
||||
|
||||
std::cout << 2.0 * m << std::endl;
|
||||
std::cout << m * 2.0 << std::endl;
|
||||
}
|
||||
|
||||
@@ -0,0 +1,27 @@
|
||||
//
|
||||
// Copyright (c) 2000-2002
|
||||
// Joerg Walter, Mathias Koch
|
||||
//
|
||||
// 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)
|
||||
//
|
||||
// The authors gratefully acknowledge the support of
|
||||
// GeNeSys mbH & Co. KG in producing this work.
|
||||
//
|
||||
|
||||
#include <boost/numeric/ublas/matrix.hpp>
|
||||
#include <boost/numeric/ublas/matrix_proxy.hpp>
|
||||
#include <boost/numeric/ublas/io.hpp>
|
||||
|
||||
int main () {
|
||||
using namespace boost::numeric::ublas;
|
||||
matrix<double> m (3, 3);
|
||||
for (unsigned j = 0; j < m.size2 (); ++ j) {
|
||||
matrix_column<matrix<double> > mc (m, j);
|
||||
for (unsigned i = 0; i < mc.size (); ++ i)
|
||||
mc (i) = 3 * i + j;
|
||||
std::cout << mc << std::endl;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -0,0 +1,26 @@
|
||||
//
|
||||
// Copyright (c) 2000-2002
|
||||
// Joerg Walter, Mathias Koch
|
||||
//
|
||||
// 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)
|
||||
//
|
||||
// The authors gratefully acknowledge the support of
|
||||
// GeNeSys mbH & Co. KG in producing this work.
|
||||
//
|
||||
|
||||
#include <boost/numeric/ublas/matrix.hpp>
|
||||
#include <boost/numeric/ublas/matrix_proxy.hpp>
|
||||
#include <boost/numeric/ublas/io.hpp>
|
||||
|
||||
int main () {
|
||||
using namespace boost::numeric::ublas;
|
||||
matrix<double> m (3, 3);
|
||||
for (unsigned j = 0; j < m.size2 (); ++ j) {
|
||||
for (unsigned i = 0; i < m.size1 (); ++ i)
|
||||
column (m, j) (i) = 3 * i + j;
|
||||
std::cout << column (m, j) << std::endl;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -0,0 +1,25 @@
|
||||
//
|
||||
// Copyright (c) 2000-2002
|
||||
// Joerg Walter, Mathias Koch
|
||||
//
|
||||
// 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)
|
||||
//
|
||||
// The authors gratefully acknowledge the support of
|
||||
// GeNeSys mbH & Co. KG in producing this work.
|
||||
//
|
||||
|
||||
#include <boost/numeric/ublas/matrix.hpp>
|
||||
#include <boost/numeric/ublas/io.hpp>
|
||||
|
||||
int main () {
|
||||
using namespace boost::numeric::ublas;
|
||||
matrix<double> m1 (3, 3), m2 (3, 3);
|
||||
for (unsigned i = 0; i < (std::min) (m1.size1 (), m2.size1 ()); ++ i)
|
||||
for (unsigned j = 0; j < (std::min) (m1.size2 (), m2.size2 ()); ++ j)
|
||||
m1 (i, j) = m2 (i, j) = 3 * i + j;
|
||||
|
||||
std::cout << prod (m1, m2) << std::endl;
|
||||
}
|
||||
|
||||
@@ -0,0 +1,25 @@
|
||||
//
|
||||
// Copyright (c) 2000-2002
|
||||
// Joerg Walter, Mathias Koch
|
||||
//
|
||||
// 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)
|
||||
//
|
||||
// The authors gratefully acknowledge the support of
|
||||
// GeNeSys mbH & Co. KG in producing this work.
|
||||
//
|
||||
|
||||
#include <boost/numeric/ublas/triangular.hpp>
|
||||
#include <boost/numeric/ublas/io.hpp>
|
||||
|
||||
int main () {
|
||||
using namespace boost::numeric::ublas;
|
||||
matrix<double> m1 (3, 3), m2 (3, 3);
|
||||
for (unsigned i = 0; i < (std::min) (m1.size1 (), m2.size1 ()); ++ i)
|
||||
for (unsigned j = 0; j <= i; ++ j)
|
||||
m1 (i, j) = m2 (i, j) = 3 * i + j + 1;
|
||||
|
||||
std::cout << solve (m1, m2, lower_tag ()) << std::endl;
|
||||
}
|
||||
|
||||
@@ -0,0 +1,26 @@
|
||||
//
|
||||
// Copyright (c) 2000-2002
|
||||
// Joerg Walter, Mathias Koch
|
||||
//
|
||||
// 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)
|
||||
//
|
||||
// The authors gratefully acknowledge the support of
|
||||
// GeNeSys mbH & Co. KG in producing this work.
|
||||
//
|
||||
|
||||
#include <boost/numeric/ublas/matrix.hpp>
|
||||
#include <boost/numeric/ublas/matrix_proxy.hpp>
|
||||
#include <boost/numeric/ublas/io.hpp>
|
||||
|
||||
int main () {
|
||||
using namespace boost::numeric::ublas;
|
||||
matrix<double> m (3, 3);
|
||||
matrix_range<matrix<double> > mr (m, range (0, 3), range (0, 3));
|
||||
for (unsigned i = 0; i < mr.size1 (); ++ i)
|
||||
for (unsigned j = 0; j < mr.size2 (); ++ j)
|
||||
mr (i, j) = 3 * i + j;
|
||||
std::cout << mr << std::endl;
|
||||
}
|
||||
|
||||
@@ -0,0 +1,25 @@
|
||||
//
|
||||
// Copyright (c) 2000-2002
|
||||
// Joerg Walter, Mathias Koch
|
||||
//
|
||||
// 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)
|
||||
//
|
||||
// The authors gratefully acknowledge the support of
|
||||
// GeNeSys mbH & Co. KG in producing this work.
|
||||
//
|
||||
|
||||
#include <boost/numeric/ublas/matrix.hpp>
|
||||
#include <boost/numeric/ublas/matrix_proxy.hpp>
|
||||
#include <boost/numeric/ublas/io.hpp>
|
||||
|
||||
int main () {
|
||||
using namespace boost::numeric::ublas;
|
||||
matrix<double> m (3, 3);
|
||||
for (unsigned i = 0; i < m.size1 (); ++ i)
|
||||
for (unsigned j = 0; j < m.size2 (); ++ j)
|
||||
project (m, range (0, 3), range (0, 3)) (i, j) = 3 * i + j;
|
||||
std::cout << project (m, range (0, 3), range (0, 3)) << std::endl;
|
||||
}
|
||||
|
||||
@@ -0,0 +1,27 @@
|
||||
//
|
||||
// Copyright (c) 2000-2002
|
||||
// Joerg Walter, Mathias Koch
|
||||
//
|
||||
// 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)
|
||||
//
|
||||
// The authors gratefully acknowledge the support of
|
||||
// GeNeSys mbH & Co. KG in producing this work.
|
||||
//
|
||||
|
||||
#include <boost/numeric/ublas/matrix.hpp>
|
||||
#include <boost/numeric/ublas/matrix_proxy.hpp>
|
||||
#include <boost/numeric/ublas/io.hpp>
|
||||
|
||||
int main () {
|
||||
using namespace boost::numeric::ublas;
|
||||
matrix<double> m (3, 3);
|
||||
for (unsigned i = 0; i < m.size1 (); ++ i) {
|
||||
matrix_row<matrix<double> > mr (m, i);
|
||||
for (unsigned j = 0; j < mr.size (); ++ j)
|
||||
mr (j) = 3 * i + j;
|
||||
std::cout << mr << std::endl;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -0,0 +1,26 @@
|
||||
//
|
||||
// Copyright (c) 2000-2002
|
||||
// Joerg Walter, Mathias Koch
|
||||
//
|
||||
// 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)
|
||||
//
|
||||
// The authors gratefully acknowledge the support of
|
||||
// GeNeSys mbH & Co. KG in producing this work.
|
||||
//
|
||||
|
||||
#include <boost/numeric/ublas/matrix.hpp>
|
||||
#include <boost/numeric/ublas/matrix_proxy.hpp>
|
||||
#include <boost/numeric/ublas/io.hpp>
|
||||
|
||||
int main () {
|
||||
using namespace boost::numeric::ublas;
|
||||
matrix<double> m (3, 3);
|
||||
for (unsigned i = 0; i < m.size1 (); ++ i) {
|
||||
for (unsigned j = 0; j < m.size2 (); ++ j)
|
||||
row (m, i) (j) = 3 * i + j;
|
||||
std::cout << row (m, i) << std::endl;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -0,0 +1,26 @@
|
||||
//
|
||||
// Copyright (c) 2000-2002
|
||||
// Joerg Walter, Mathias Koch
|
||||
//
|
||||
// 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)
|
||||
//
|
||||
// The authors gratefully acknowledge the support of
|
||||
// GeNeSys mbH & Co. KG in producing this work.
|
||||
//
|
||||
|
||||
#include <boost/numeric/ublas/matrix.hpp>
|
||||
#include <boost/numeric/ublas/matrix_proxy.hpp>
|
||||
#include <boost/numeric/ublas/io.hpp>
|
||||
|
||||
int main () {
|
||||
using namespace boost::numeric::ublas;
|
||||
matrix<double> m (3, 3);
|
||||
matrix_slice<matrix<double> > ms (m, slice (0, 1, 3), slice (0, 1, 3));
|
||||
for (unsigned i = 0; i < ms.size1 (); ++ i)
|
||||
for (unsigned j = 0; j < ms.size2 (); ++ j)
|
||||
ms (i, j) = 3 * i + j;
|
||||
std::cout << ms << std::endl;
|
||||
}
|
||||
|
||||
@@ -0,0 +1,25 @@
|
||||
//
|
||||
// Copyright (c) 2000-2002
|
||||
// Joerg Walter, Mathias Koch
|
||||
//
|
||||
// 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)
|
||||
//
|
||||
// The authors gratefully acknowledge the support of
|
||||
// GeNeSys mbH & Co. KG in producing this work.
|
||||
//
|
||||
|
||||
#include <boost/numeric/ublas/matrix.hpp>
|
||||
#include <boost/numeric/ublas/matrix_proxy.hpp>
|
||||
#include <boost/numeric/ublas/io.hpp>
|
||||
|
||||
int main () {
|
||||
using namespace boost::numeric::ublas;
|
||||
matrix<double> m (3, 3);
|
||||
for (unsigned i = 0; i < m.size1 (); ++ i)
|
||||
for (unsigned j = 0; j < m.size2 (); ++ j)
|
||||
project (m, slice (0, 1, 3), slice (0, 1, 3)) (i, j) = 3 * i + j;
|
||||
std::cout << project (m, slice (0, 1, 3), slice (0, 1, 3)) << std::endl;
|
||||
}
|
||||
|
||||
@@ -0,0 +1,30 @@
|
||||
//
|
||||
// Copyright (c) 2000-2002
|
||||
// Joerg Walter, Mathias Koch
|
||||
//
|
||||
// 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)
|
||||
//
|
||||
// The authors gratefully acknowledge the support of
|
||||
// GeNeSys mbH & Co. KG in producing this work.
|
||||
//
|
||||
|
||||
#include <boost/numeric/ublas/matrix.hpp>
|
||||
#include <boost/numeric/ublas/io.hpp>
|
||||
|
||||
int main () {
|
||||
using namespace boost::numeric::ublas;
|
||||
matrix<std::complex<double> > m (3, 3);
|
||||
for (unsigned i = 0; i < m.size1 (); ++ i)
|
||||
for (unsigned j = 0; j < m.size2 (); ++ j)
|
||||
m (i, j) = std::complex<double> (3 * i + j, 3 * i + j);
|
||||
|
||||
std::cout << - m << std::endl;
|
||||
std::cout << conj (m) << std::endl;
|
||||
std::cout << real (m) << std::endl;
|
||||
std::cout << imag (m) << std::endl;
|
||||
std::cout << trans (m) << std::endl;
|
||||
std::cout << herm (m) << std::endl;
|
||||
}
|
||||
|
||||
@@ -0,0 +1,29 @@
|
||||
//
|
||||
// Copyright (c) 2000-2002
|
||||
// Joerg Walter, Mathias Koch
|
||||
//
|
||||
// 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)
|
||||
//
|
||||
// The authors gratefully acknowledge the support of
|
||||
// GeNeSys mbH & Co. KG in producing this work.
|
||||
//
|
||||
|
||||
#include <boost/numeric/ublas/matrix.hpp>
|
||||
#include <boost/numeric/ublas/io.hpp>
|
||||
|
||||
int main () {
|
||||
using namespace boost::numeric::ublas;
|
||||
matrix<double> m (3, 3);
|
||||
vector<double> v (3);
|
||||
for (unsigned i = 0; i < (std::min) (m.size1 (), v.size ()); ++ i) {
|
||||
for (unsigned j = 0; j < m.size2 (); ++ j)
|
||||
m (i, j) = 3 * i + j;
|
||||
v (i) = i;
|
||||
}
|
||||
|
||||
std::cout << prod (m, v) << std::endl;
|
||||
std::cout << prod (v, m) << std::endl;
|
||||
}
|
||||
|
||||
@@ -0,0 +1,27 @@
|
||||
//
|
||||
// Copyright (c) 2000-2002
|
||||
// Joerg Walter, Mathias Koch
|
||||
//
|
||||
// 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)
|
||||
//
|
||||
// The authors gratefully acknowledge the support of
|
||||
// GeNeSys mbH & Co. KG in producing this work.
|
||||
//
|
||||
|
||||
#include <boost/numeric/ublas/matrix.hpp>
|
||||
#include <boost/numeric/ublas/matrix_proxy.hpp>
|
||||
#include <boost/numeric/ublas/io.hpp>
|
||||
|
||||
int main () {
|
||||
using namespace boost::numeric::ublas;
|
||||
matrix<double> m (3, 3);
|
||||
for (unsigned i = 0; i < m.size1 (); ++ i)
|
||||
for (unsigned j = 0; j < m.size2 (); ++ j)
|
||||
m (i, j) = 3 * i + j;
|
||||
|
||||
matrix_vector_range<matrix<double> > mvr (m, range (0, 3), range (0, 3));
|
||||
std::cout << mvr << std::endl;
|
||||
}
|
||||
|
||||
@@ -0,0 +1,27 @@
|
||||
//
|
||||
// Copyright (c) 2000-2002
|
||||
// Joerg Walter, Mathias Koch
|
||||
//
|
||||
// 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)
|
||||
//
|
||||
// The authors gratefully acknowledge the support of
|
||||
// GeNeSys mbH & Co. KG in producing this work.
|
||||
//
|
||||
|
||||
#include <boost/numeric/ublas/matrix.hpp>
|
||||
#include <boost/numeric/ublas/matrix_proxy.hpp>
|
||||
#include <boost/numeric/ublas/io.hpp>
|
||||
|
||||
int main () {
|
||||
using namespace boost::numeric::ublas;
|
||||
matrix<double> m (3, 3);
|
||||
for (unsigned i = 0; i < m.size1 (); ++ i)
|
||||
for (unsigned j = 0; j < m.size2 (); ++ j)
|
||||
m (i, j) = 3 * i + j;
|
||||
|
||||
matrix_vector_slice<matrix<double> > mvs (m, slice (0, 1, 3), slice (0, 1, 3));
|
||||
std::cout << mvs << std::endl;
|
||||
}
|
||||
|
||||
@@ -0,0 +1,29 @@
|
||||
//
|
||||
// Copyright (c) 2000-2002
|
||||
// Joerg Walter, Mathias Koch
|
||||
//
|
||||
// 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)
|
||||
//
|
||||
// The authors gratefully acknowledge the support of
|
||||
// GeNeSys mbH & Co. KG in producing this work.
|
||||
//
|
||||
|
||||
#include <boost/numeric/ublas/triangular.hpp>
|
||||
#include <boost/numeric/ublas/io.hpp>
|
||||
|
||||
int main () {
|
||||
using namespace boost::numeric::ublas;
|
||||
matrix<double> m (3, 3);
|
||||
vector<double> v (3);
|
||||
for (unsigned i = 0; i < (std::min) (m.size1 (), v.size ()); ++ i) {
|
||||
for (unsigned j = 0; j <= i; ++ j)
|
||||
m (i, j) = 3 * i + j + 1;
|
||||
v (i) = i;
|
||||
}
|
||||
|
||||
std::cout << solve (m, v, lower_tag ()) << std::endl;
|
||||
std::cout << solve (v, m, lower_tag ()) << std::endl;
|
||||
}
|
||||
|
||||
@@ -0,0 +1,22 @@
|
||||
//
|
||||
// Copyright (c) 2000-2002
|
||||
// Joerg Walter, Mathias Koch
|
||||
//
|
||||
// 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)
|
||||
//
|
||||
// The authors gratefully acknowledge the support of
|
||||
// GeNeSys mbH & Co. KG in producing this work.
|
||||
//
|
||||
|
||||
#include <boost/numeric/ublas/storage.hpp>
|
||||
|
||||
int main () {
|
||||
using namespace boost::numeric::ublas;
|
||||
range r (0, 3);
|
||||
for (unsigned i = 0; i < r.size (); ++ i) {
|
||||
std::cout << r (i) << std::endl;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -0,0 +1,22 @@
|
||||
//
|
||||
// Copyright (c) 2000-2002
|
||||
// Joerg Walter, Mathias Koch
|
||||
//
|
||||
// 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)
|
||||
//
|
||||
// The authors gratefully acknowledge the support of
|
||||
// GeNeSys mbH & Co. KG in producing this work.
|
||||
//
|
||||
|
||||
#include <boost/numeric/ublas/storage.hpp>
|
||||
|
||||
int main () {
|
||||
using namespace boost::numeric::ublas;
|
||||
slice s (0, 1, 3);
|
||||
for (unsigned i = 0; i < s.size (); ++ i) {
|
||||
std::cout << s (i) << std::endl;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -0,0 +1,30 @@
|
||||
//
|
||||
// Copyright (c) 2000-2002
|
||||
// Joerg Walter, Mathias Koch
|
||||
//
|
||||
// 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)
|
||||
//
|
||||
// The authors gratefully acknowledge the support of
|
||||
// GeNeSys mbH & Co. KG in producing this work.
|
||||
//
|
||||
|
||||
#include <boost/numeric/ublas/symmetric.hpp>
|
||||
#include <boost/numeric/ublas/io.hpp>
|
||||
|
||||
int main () {
|
||||
using namespace boost::numeric::ublas;
|
||||
matrix<double> m (3, 3);
|
||||
symmetric_adaptor<matrix<double>, lower> sal (m);
|
||||
for (unsigned i = 0; i < sal.size1 (); ++ i)
|
||||
for (unsigned j = 0; j <= i; ++ j)
|
||||
sal (i, j) = 3 * i + j;
|
||||
std::cout << sal << std::endl;
|
||||
symmetric_adaptor<matrix<double>, upper> sau (m);
|
||||
for (unsigned i = 0; i < sau.size1 (); ++ i)
|
||||
for (unsigned j = i; j < sau.size2 (); ++ j)
|
||||
sau (i, j) = 3 * i + j;
|
||||
std::cout << sau << std::endl;
|
||||
}
|
||||
|
||||
@@ -0,0 +1,29 @@
|
||||
//
|
||||
// Copyright (c) 2000-2002
|
||||
// Joerg Walter, Mathias Koch
|
||||
//
|
||||
// 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)
|
||||
//
|
||||
// The authors gratefully acknowledge the support of
|
||||
// GeNeSys mbH & Co. KG in producing this work.
|
||||
//
|
||||
|
||||
#include <boost/numeric/ublas/symmetric.hpp>
|
||||
#include <boost/numeric/ublas/io.hpp>
|
||||
|
||||
int main () {
|
||||
using namespace boost::numeric::ublas;
|
||||
symmetric_matrix<double, lower> ml (3, 3);
|
||||
for (unsigned i = 0; i < ml.size1 (); ++ i)
|
||||
for (unsigned j = 0; j <= i; ++ j)
|
||||
ml (i, j) = 3 * i + j;
|
||||
std::cout << ml << std::endl;
|
||||
symmetric_matrix<double, upper> mu (3, 3);
|
||||
for (unsigned i = 0; i < mu.size1 (); ++ i)
|
||||
for (unsigned j = i; j < mu.size2 (); ++ j)
|
||||
mu (i, j) = 3 * i + j;
|
||||
std::cout << mu << std::endl;
|
||||
}
|
||||
|
||||
@@ -0,0 +1,30 @@
|
||||
//
|
||||
// Copyright (c) 2000-2002
|
||||
// Joerg Walter, Mathias Koch
|
||||
//
|
||||
// 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)
|
||||
//
|
||||
// The authors gratefully acknowledge the support of
|
||||
// GeNeSys mbH & Co. KG in producing this work.
|
||||
//
|
||||
|
||||
#include <boost/numeric/ublas/triangular.hpp>
|
||||
#include <boost/numeric/ublas/io.hpp>
|
||||
|
||||
int main () {
|
||||
using namespace boost::numeric::ublas;
|
||||
matrix<double> m (3, 3);
|
||||
triangular_adaptor<matrix<double>, lower> tal (m);
|
||||
for (unsigned i = 0; i < tal.size1 (); ++ i)
|
||||
for (unsigned j = 0; j <= i; ++ j)
|
||||
tal (i, j) = 3 * i + j;
|
||||
std::cout << tal << std::endl;
|
||||
triangular_adaptor<matrix<double>, upper> tau (m);
|
||||
for (unsigned i = 0; i < tau.size1 (); ++ i)
|
||||
for (unsigned j = i; j < tau.size2 (); ++ j)
|
||||
tau (i, j) = 3 * i + j;
|
||||
std::cout << tau << std::endl;
|
||||
}
|
||||
|
||||
@@ -0,0 +1,29 @@
|
||||
//
|
||||
// Copyright (c) 2000-2002
|
||||
// Joerg Walter, Mathias Koch
|
||||
//
|
||||
// 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)
|
||||
//
|
||||
// The authors gratefully acknowledge the support of
|
||||
// GeNeSys mbH & Co. KG in producing this work.
|
||||
//
|
||||
|
||||
#include <boost/numeric/ublas/triangular.hpp>
|
||||
#include <boost/numeric/ublas/io.hpp>
|
||||
|
||||
int main () {
|
||||
using namespace boost::numeric::ublas;
|
||||
triangular_matrix<double, lower> ml (3, 3);
|
||||
for (unsigned i = 0; i < ml.size1 (); ++ i)
|
||||
for (unsigned j = 0; j <= i; ++ j)
|
||||
ml (i, j) = 3 * i + j;
|
||||
std::cout << ml << std::endl;
|
||||
triangular_matrix<double, upper> mu (3, 3);
|
||||
for (unsigned i = 0; i < mu.size1 (); ++ i)
|
||||
for (unsigned j = i; j < mu.size2 (); ++ j)
|
||||
mu (i, j) = 3 * i + j;
|
||||
std::cout << mu << std::endl;
|
||||
}
|
||||
|
||||
@@ -0,0 +1,23 @@
|
||||
//
|
||||
// Copyright (c) 2000-2002
|
||||
// Joerg Walter, Mathias Koch
|
||||
//
|
||||
// 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)
|
||||
//
|
||||
// The authors gratefully acknowledge the support of
|
||||
// GeNeSys mbH & Co. KG in producing this work.
|
||||
//
|
||||
|
||||
#include <boost/numeric/ublas/storage.hpp>
|
||||
|
||||
int main () {
|
||||
using namespace boost::numeric::ublas;
|
||||
unbounded_array<double> a (3);
|
||||
for (unsigned i = 0; i < a.size (); ++ i) {
|
||||
a [i] = i;
|
||||
std::cout << a [i] << std::endl;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -0,0 +1,23 @@
|
||||
//
|
||||
// Copyright (c) 2000-2002
|
||||
// Joerg Walter, Mathias Koch
|
||||
//
|
||||
// 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)
|
||||
//
|
||||
// The authors gratefully acknowledge the support of
|
||||
// GeNeSys mbH & Co. KG in producing this work.
|
||||
//
|
||||
|
||||
#include <boost/numeric/ublas/vector.hpp>
|
||||
#include <boost/numeric/ublas/io.hpp>
|
||||
|
||||
int main () {
|
||||
using namespace boost::numeric::ublas;
|
||||
for (int i = 0; i < 3; ++ i) {
|
||||
unit_vector<double> v (3, i);
|
||||
std::cout << v << std::endl;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -0,0 +1,23 @@
|
||||
//
|
||||
// Copyright (c) 2000-2002
|
||||
// Joerg Walter, Mathias Koch
|
||||
//
|
||||
// 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)
|
||||
//
|
||||
// The authors gratefully acknowledge the support of
|
||||
// GeNeSys mbH & Co. KG in producing this work.
|
||||
//
|
||||
|
||||
#include <boost/numeric/ublas/vector.hpp>
|
||||
#include <boost/numeric/ublas/io.hpp>
|
||||
|
||||
int main () {
|
||||
using namespace boost::numeric::ublas;
|
||||
vector<double> v (3);
|
||||
for (unsigned i = 0; i < v.size (); ++ i)
|
||||
v (i) = i;
|
||||
std::cout << v << std::endl;
|
||||
}
|
||||
|
||||
@@ -0,0 +1,25 @@
|
||||
//
|
||||
// Copyright (c) 2000-2002
|
||||
// Joerg Walter, Mathias Koch
|
||||
//
|
||||
// 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)
|
||||
//
|
||||
// The authors gratefully acknowledge the support of
|
||||
// GeNeSys mbH & Co. KG in producing this work.
|
||||
//
|
||||
|
||||
#include <boost/numeric/ublas/vector.hpp>
|
||||
#include <boost/numeric/ublas/io.hpp>
|
||||
|
||||
int main () {
|
||||
using namespace boost::numeric::ublas;
|
||||
vector<double> v1 (3), v2 (3);
|
||||
for (unsigned i = 0; i < (std::min) (v1.size (), v2.size ()); ++ i)
|
||||
v1 (i) = v2 (i) = i;
|
||||
|
||||
std::cout << v1 + v2 << std::endl;
|
||||
std::cout << v1 - v2 << std::endl;
|
||||
}
|
||||
|
||||
@@ -0,0 +1,24 @@
|
||||
//
|
||||
// Copyright (c) 2000-2002
|
||||
// Joerg Walter, Mathias Koch
|
||||
//
|
||||
// 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)
|
||||
//
|
||||
// The authors gratefully acknowledge the support of
|
||||
// GeNeSys mbH & Co. KG in producing this work.
|
||||
//
|
||||
|
||||
#include <boost/numeric/ublas/matrix.hpp>
|
||||
#include <boost/numeric/ublas/io.hpp>
|
||||
|
||||
int main () {
|
||||
using namespace boost::numeric::ublas;
|
||||
vector<double> v1 (3), v2 (3);
|
||||
for (unsigned i = 0; i < (std::min) (v1.size (), v2.size ()); ++ i)
|
||||
v1 (i) = v2 (i) = i;
|
||||
|
||||
std::cout << outer_prod (v1, v2) << std::endl;
|
||||
}
|
||||
|
||||
@@ -0,0 +1,23 @@
|
||||
//
|
||||
// Copyright (c) 2000-2002
|
||||
// Joerg Walter, Mathias Koch
|
||||
//
|
||||
// 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)
|
||||
//
|
||||
// The authors gratefully acknowledge the support of
|
||||
// GeNeSys mbH & Co. KG in producing this work.
|
||||
//
|
||||
|
||||
#include <boost/numeric/ublas/vector.hpp>
|
||||
|
||||
int main () {
|
||||
using namespace boost::numeric::ublas;
|
||||
vector<double> v1 (3), v2 (3);
|
||||
for (unsigned i = 0; i < (std::min) (v1.size (), v2.size ()); ++ i)
|
||||
v1 (i) = v2 (i) = i;
|
||||
|
||||
std::cout << inner_prod (v1, v2) << std::endl;
|
||||
}
|
||||
|
||||
@@ -0,0 +1,25 @@
|
||||
//
|
||||
// Copyright (c) 2000-2002
|
||||
// Joerg Walter, Mathias Koch
|
||||
//
|
||||
// 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)
|
||||
//
|
||||
// The authors gratefully acknowledge the support of
|
||||
// GeNeSys mbH & Co. KG in producing this work.
|
||||
//
|
||||
|
||||
#include <boost/numeric/ublas/vector.hpp>
|
||||
#include <boost/numeric/ublas/io.hpp>
|
||||
|
||||
int main () {
|
||||
using namespace boost::numeric::ublas;
|
||||
vector<double> v (3);
|
||||
for (unsigned i = 0; i < v.size (); ++ i)
|
||||
v (i) = i;
|
||||
|
||||
std::cout << 2.0 * v << std::endl;
|
||||
std::cout << v * 2.0 << std::endl;
|
||||
}
|
||||
|
||||
@@ -0,0 +1,25 @@
|
||||
//
|
||||
// Copyright (c) 2000-2002
|
||||
// Joerg Walter, Mathias Koch
|
||||
//
|
||||
// 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)
|
||||
//
|
||||
// The authors gratefully acknowledge the support of
|
||||
// GeNeSys mbH & Co. KG in producing this work.
|
||||
//
|
||||
|
||||
#include <boost/numeric/ublas/vector.hpp>
|
||||
#include <boost/numeric/ublas/vector_proxy.hpp>
|
||||
#include <boost/numeric/ublas/io.hpp>
|
||||
|
||||
int main () {
|
||||
using namespace boost::numeric::ublas;
|
||||
vector<double> v (3);
|
||||
vector_range<vector<double> > vr (v, range (0, 3));
|
||||
for (unsigned i = 0; i < vr.size (); ++ i)
|
||||
vr (i) = i;
|
||||
std::cout << vr << std::endl;
|
||||
}
|
||||
|
||||
@@ -0,0 +1,24 @@
|
||||
//
|
||||
// Copyright (c) 2000-2002
|
||||
// Joerg Walter, Mathias Koch
|
||||
//
|
||||
// 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)
|
||||
//
|
||||
// The authors gratefully acknowledge the support of
|
||||
// GeNeSys mbH & Co. KG in producing this work.
|
||||
//
|
||||
|
||||
#include <boost/numeric/ublas/vector.hpp>
|
||||
#include <boost/numeric/ublas/vector_proxy.hpp>
|
||||
#include <boost/numeric/ublas/io.hpp>
|
||||
|
||||
int main () {
|
||||
using namespace boost::numeric::ublas;
|
||||
vector<double> v (3);
|
||||
for (int i = 0; i < 3; ++ i)
|
||||
project (v, range (0, 3)) (i) = i;
|
||||
std::cout << project (v, range (0, 3)) << std::endl;
|
||||
}
|
||||
|
||||
@@ -0,0 +1,25 @@
|
||||
//
|
||||
// Copyright (c) 2000-2002
|
||||
// Joerg Walter, Mathias Koch
|
||||
//
|
||||
// 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)
|
||||
//
|
||||
// The authors gratefully acknowledge the support of
|
||||
// GeNeSys mbH & Co. KG in producing this work.
|
||||
//
|
||||
|
||||
#include <boost/numeric/ublas/vector.hpp>
|
||||
#include <boost/numeric/ublas/vector_proxy.hpp>
|
||||
#include <boost/numeric/ublas/io.hpp>
|
||||
|
||||
int main () {
|
||||
using namespace boost::numeric::ublas;
|
||||
vector<double> v (3);
|
||||
vector_slice<vector<double> > vs (v, slice (0, 1, 3));
|
||||
for (unsigned i = 0; i < vs.size (); ++ i)
|
||||
vs (i) = i;
|
||||
std::cout << vs << std::endl;
|
||||
}
|
||||
|
||||
@@ -0,0 +1,24 @@
|
||||
//
|
||||
// Copyright (c) 2000-2002
|
||||
// Joerg Walter, Mathias Koch
|
||||
//
|
||||
// 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)
|
||||
//
|
||||
// The authors gratefully acknowledge the support of
|
||||
// GeNeSys mbH & Co. KG in producing this work.
|
||||
//
|
||||
|
||||
#include <boost/numeric/ublas/vector.hpp>
|
||||
#include <boost/numeric/ublas/vector_proxy.hpp>
|
||||
#include <boost/numeric/ublas/io.hpp>
|
||||
|
||||
int main () {
|
||||
using namespace boost::numeric::ublas;
|
||||
vector<double> v (3);
|
||||
for (int i = 0; i < 3; ++ i)
|
||||
project (v, slice (0, 1, 3)) (i) = i;
|
||||
std::cout << project (v, slice (0, 1, 3)) << std::endl;
|
||||
}
|
||||
|
||||
@@ -0,0 +1,29 @@
|
||||
//
|
||||
// Copyright (c) 2000-2002
|
||||
// Joerg Walter, Mathias Koch
|
||||
//
|
||||
// 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)
|
||||
//
|
||||
// The authors gratefully acknowledge the support of
|
||||
// GeNeSys mbH & Co. KG in producing this work.
|
||||
//
|
||||
|
||||
#include <boost/numeric/ublas/vector.hpp>
|
||||
#include <boost/numeric/ublas/io.hpp>
|
||||
|
||||
int main () {
|
||||
using namespace boost::numeric::ublas;
|
||||
vector<std::complex<double> > v (3);
|
||||
for (unsigned i = 0; i < v.size (); ++ i)
|
||||
v (i) = std::complex<double> (i, i);
|
||||
|
||||
std::cout << - v << std::endl;
|
||||
std::cout << conj (v) << std::endl;
|
||||
std::cout << real (v) << std::endl;
|
||||
std::cout << imag (v) << std::endl;
|
||||
std::cout << trans (v) << std::endl;
|
||||
std::cout << herm (v) << std::endl;
|
||||
}
|
||||
|
||||
@@ -0,0 +1,27 @@
|
||||
//
|
||||
// Copyright (c) 2000-2002
|
||||
// Joerg Walter, Mathias Koch
|
||||
//
|
||||
// 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)
|
||||
//
|
||||
// The authors gratefully acknowledge the support of
|
||||
// GeNeSys mbH & Co. KG in producing this work.
|
||||
//
|
||||
|
||||
#include <boost/numeric/ublas/vector.hpp>
|
||||
|
||||
int main () {
|
||||
using namespace boost::numeric::ublas;
|
||||
vector<double> v (3);
|
||||
for (unsigned i = 0; i < v.size (); ++ i)
|
||||
v (i) = i;
|
||||
|
||||
std::cout << sum (v) << std::endl;
|
||||
std::cout << norm_1 (v) << std::endl;
|
||||
std::cout << norm_2 (v) << std::endl;
|
||||
std::cout << norm_inf (v) << std::endl;
|
||||
std::cout << index_norm_inf (v) << std::endl;
|
||||
}
|
||||
|
||||
@@ -0,0 +1,21 @@
|
||||
//
|
||||
// Copyright (c) 2000-2002
|
||||
// Joerg Walter, Mathias Koch
|
||||
//
|
||||
// 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)
|
||||
//
|
||||
// The authors gratefully acknowledge the support of
|
||||
// GeNeSys mbH & Co. KG in producing this work.
|
||||
//
|
||||
|
||||
#include <boost/numeric/ublas/matrix.hpp>
|
||||
#include <boost/numeric/ublas/io.hpp>
|
||||
|
||||
int main () {
|
||||
using namespace boost::numeric::ublas;
|
||||
zero_matrix<double> m (3, 3);
|
||||
std::cout << m << std::endl;
|
||||
}
|
||||
|
||||
@@ -0,0 +1,21 @@
|
||||
//
|
||||
// Copyright (c) 2000-2002
|
||||
// Joerg Walter, Mathias Koch
|
||||
//
|
||||
// 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)
|
||||
//
|
||||
// The authors gratefully acknowledge the support of
|
||||
// GeNeSys mbH & Co. KG in producing this work.
|
||||
//
|
||||
|
||||
#include <boost/numeric/ublas/vector.hpp>
|
||||
#include <boost/numeric/ublas/io.hpp>
|
||||
|
||||
int main () {
|
||||
using namespace boost::numeric::ublas;
|
||||
zero_vector<double> v (3);
|
||||
std::cout << v << std::endl;
|
||||
}
|
||||
|
||||
@@ -0,0 +1,157 @@
|
||||
<!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 name="generator" content=
|
||||
"HTML Tidy for Linux/x86 (vers 1st March 2004), see www.w3.org" />
|
||||
<meta http-equiv="Content-Type" content=
|
||||
"text/html; charset=us-ascii" />
|
||||
<link rel="stylesheet" href="../../../../boost.css" type="text/css"/>
|
||||
<link rel="stylesheet" href="ublas.css" type="text/css" />
|
||||
<script type="text/javascript" src="js/jquery-1.3.2.min.js" async="async" ></script>
|
||||
<script type="text/javascript" src="js/jquery.toc-gw.js" async="async" ></script>
|
||||
<title>Storage concept</title>
|
||||
</head>
|
||||
<body>
|
||||
<h1><img src="../../../../boost.png" align="middle" />Storage concept</h1>
|
||||
<div class="toc" id="toc"></div>
|
||||
<h2><a name="range"></a>Storage concept</h2>
|
||||
<h4>Description</h4>
|
||||
<p>Storage is a variable-size container whose elements are arranged in a strict linear order.
|
||||
<p>Storage extends the STL Container concept with some STL Sequence-like functionality. The main difference with
|
||||
the Sequence concept however is that the Storage concept does not require default-initialisation of its
|
||||
elements.
|
||||
<h4>Refinement of</h4>
|
||||
<a href="http://www.sgi.com/tech/stl/RandomAccessContainer.html">Random Access Container</a>
|
||||
and
|
||||
<a href="http://www.sgi.com/tech/stl/DefaultConstructible.html">Default Constructible</a>
|
||||
<h4>Associated types</h4>
|
||||
No additional types beyond those defined by
|
||||
<a href="http://www.sgi.com/tech/stl/RandomAccessContainer.html">Random Access Container</a>
|
||||
<h4>Notation</h4>
|
||||
<table summary="storage types">
|
||||
<tr><td><tt>X</tt></td><td>A type that is model of Storage</td></tr>
|
||||
<tr><td><tt>T</tt></td><td>The value_type of <tt>X</tt></td></tr>
|
||||
<tr><td><tt>t</tt></td><td>An object of type <tt>T</tt></td></tr>
|
||||
<tr><td><tt>n</tt></td><td>object of type convertible to <tt>X::size_type</tt></td></tr>
|
||||
</table>
|
||||
<h4>Definitions</h4>
|
||||
<h4>Valid expressions</h4>
|
||||
In addition to the expressions defined in
|
||||
<a href="http://www.sgi.com/tech/stl/RandomAccessContainer.html">Random Access Container</a>,
|
||||
and
|
||||
<a href="http://www.sgi.com/tech/stl/DefaultConstructible.html">Default Constructible</a>
|
||||
the following expressions must be valid:
|
||||
<table border="1" summary="type requirements">
|
||||
<TR><TH>Name</TH><TH>Expression</TH><TH>Type requirements</TH><TH>Return type</TH></TR>
|
||||
<TR>
|
||||
<td>Size constructor</td>
|
||||
<td><tt>X(n)</tt></td>
|
||||
<td>T is <a href="http://www.sgi.com/tech/stl/DefaultConstructible.html">DefaultConstructible</a></td>
|
||||
<td><tt>X</tt></td>
|
||||
</TR>
|
||||
<TR>
|
||||
<td>Fill constructor</td>
|
||||
<td><tt>X(n,t)</tt></td>
|
||||
<td></td>
|
||||
<td><tt>X</tt></td>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD>Range constructor</TD>
|
||||
<TD><tt>X(i, j)</tt></TD>
|
||||
<TD><tt>i</tt> and <tt>j</tt> are <A href="http://www.sgi.com/tech/stl/InputIterator.html">Input Iterators</A> whose value type is convertible to <tt>T</tt> </TD>
|
||||
<TD><tt>X</tt> </TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD>Resize</TD>
|
||||
<TD><tt>a.resize(n, t)</tt></TD>
|
||||
<TD><tt>a</tt> is mutable</TD>
|
||||
<TD><tt>void</tt></TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD>Resize</TD>
|
||||
<TD><tt>a.resize(n)</tt></TD>
|
||||
<TD><tt>a</tt> is mutable</TD>
|
||||
<TD><tt>void</tt></TD>
|
||||
</tr>
|
||||
</table>
|
||||
<h3>Expression semantics</h3>
|
||||
<table border="1" summary="expresisons">
|
||||
<tr><th>Name<th>Expression<th>Precondition<th>Semantics<th>Postcondition
|
||||
<tr>
|
||||
<td>Default-constructor</td>
|
||||
<td><tt>X()</tt>
|
||||
<td></td>
|
||||
<td>Creates 0 elements.
|
||||
</td>
|
||||
<td><tt>size()==0</tt></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Size-constructor</td>
|
||||
<td><tt>X(n)</tt>
|
||||
<td><tt>n>=0</tt></td>
|
||||
<td>Creates n elements. Elements are constructed without an initializer. That is
|
||||
if T is a (possibly cv-qualified) non-POD class type (or array thereof), the object is default
|
||||
initialized. Otherwise, the object created has indeterminate value. See the sentance
|
||||
"If new initializer is omitted" in section 5.3.4 paragraph 15 of the ISO C++ standard.
|
||||
</td>
|
||||
<td><tt>size()==n</tt></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Fill-constructor</td>
|
||||
<td><tt>X(n,t)</tt>
|
||||
<td><tt>n>=0</tt></td>
|
||||
<td>Creates n initialised element with copies of <code>t</code></td>
|
||||
<td><tt>size()==n</tt></td>
|
||||
</tr>
|
||||
<TR>
|
||||
<TD>Range constructor</TD>
|
||||
<TD><tt>X(i, j)</tt></TD>
|
||||
<TD><tt>[i,j)</tt> is a valid range.</TD>
|
||||
<TD>copies the range <tt>[i,j) to the storage</tt></TD>
|
||||
<TD><tt>size()</tt> is equal to the distance from <tt>i</tt> to <tt>j</tt>. Each element is a copy of the corresponding element in the range <tt>[i,j)</tt>.</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD>Resize</TD>
|
||||
<TD><tt>a.resize(n, t)</tt></TD>
|
||||
<TD><tt>n <= a.max_size()</tt></TD>
|
||||
<td>Modified the container so that it has exactly <tt>n</tt> elements.<br />
|
||||
The container may be reallocated if its size changes.
|
||||
Existing element values are preserved, additional elements are copies of <code>t</code>.</td>
|
||||
<TD><tt>a.size() == n</tt></TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD>Resize</TD>
|
||||
<TD><tt>a.resize(n)</tt></TD>
|
||||
<TD><tt>n <= a.max_size()</tt></TD>
|
||||
<TD>Modified the container so that it has exactly <tt>n</tt> elements.<br />
|
||||
The container may be reallocated if its size changes. Element values are uninitialised. That is,
|
||||
each element value may be a previously assigned value or default construced value for <code>T</code>.</TD>
|
||||
<TD><tt>a.size() == n</tt></TD>
|
||||
</tr>
|
||||
</table>
|
||||
<h4>Complexity guarantees</h4>
|
||||
<h4>Invariants</h4>
|
||||
<h4>Models</h4>
|
||||
<ul>
|
||||
<li><a href="unbounded_array.html">unbounded_array</a>
|
||||
<li><a href="bounded_array.html">bounded_array</a>
|
||||
</ul>
|
||||
<h4>Notes</h4>
|
||||
<hr />
|
||||
<p>Copyright (©) 2000-2002 Joerg Walter, Mathias Koch<br />
|
||||
Use, modification and distribution are subject to the
|
||||
Boost Software License, Version 1.0.
|
||||
(See accompanying file LICENSE_1_0.txt
|
||||
or copy at <a href="http://www.boost.org/LICENSE_1_0.txt">
|
||||
http://www.boost.org/LICENSE_1_0.txt
|
||||
</a>).
|
||||
</p>
|
||||
|
||||
<script type="text/javascript">
|
||||
(function($) {
|
||||
$('#toc').toc();
|
||||
})(jQuery);
|
||||
</script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,288 @@
|
||||
<!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 name="generator" content=
|
||||
"HTML Tidy for Linux/x86 (vers 1st March 2004), see www.w3.org" />
|
||||
<meta http-equiv="Content-Type" content=
|
||||
"text/html; charset=us-ascii" />
|
||||
<link rel="stylesheet" href="../../../../boost.css" type="text/css"/>
|
||||
<link rel="stylesheet" href="ublas.css" type="text/css" />
|
||||
<script type="text/javascript" src="js/jquery-1.3.2.min.js" async="async" ></script>
|
||||
<script type="text/javascript" src="js/jquery.toc-gw.js" async="async" ></script>
|
||||
<title>Sparse Storage</title>
|
||||
</head>
|
||||
<body>
|
||||
<h1><img src="../../../../boost.png" align="middle" />Sparse Storage</h1>
|
||||
<div class="toc" id="toc"></div>
|
||||
<h2><a name="map_std"></a>Default Standard Map</h2>
|
||||
<h4>Description</h4>
|
||||
<p>The templated class <code>map_std<I, T, ALLOC></code> provides a
|
||||
wrapper for the standard library associative container
|
||||
<code>std::map</code>. The wrapper has one simple purpose. It
|
||||
allows the definition of a default template parameter (for the
|
||||
adapted array) when declaring the sparse container types.</p>
|
||||
<h4>Example</h4>
|
||||
<pre>
|
||||
#include <boost/numeric/ublas/storage_sparse.hpp>
|
||||
|
||||
int main () {
|
||||
using namespace boost::numeric::ublas;
|
||||
map_std<int, double> a (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_sparse.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>I</code></td>
|
||||
<td>The type of index stored in the array.</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>T</code></td>
|
||||
<td>The type of object stored in the array.</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>ALLOC</code></td>
|
||||
<td>An STL Allocator</td>
|
||||
<td>std::allocator</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4>Model of</h4>
|
||||
<p>Reversible Container.</p>
|
||||
<h4>Type requirements</h4>
|
||||
<p>None, except for those imposed by the requirements of Reversible
|
||||
Container.</p>
|
||||
<h4>Public base classes</h4>
|
||||
<p>std::map</p>
|
||||
<h2><a name="map_array"></a>Map Array</h2>
|
||||
<h4>Description</h4>
|
||||
<p>The templated class <code>map_array<I, T, ALLOC></code> implements a <code>std::map</code> like associative container as a sorted array. It therefore some of the Associative Container interface without having the same semantics as an std::map.
|
||||
<p>At any time the <code>map_array</code> has a capacity up to which new element can be inserted.
|
||||
If <code>insert</code> would cause the size of the <code>map_array</code> to exceeds its capactity then it is <strong>reallocated</strong>. Iterators and reference are invalidated.
|
||||
The capacity can be directly control using the <code>reserve</code> member function.
|
||||
</p>
|
||||
<h4>Example</h4>
|
||||
<pre>
|
||||
#include <boost/numeric/ublas/storage_sparse.hpp>
|
||||
|
||||
int main () {
|
||||
using namespace boost::numeric::ublas;
|
||||
map_array<int, double> a (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_sparse.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>I</code></td>
|
||||
<td>The type of index stored in the array.</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>T</code></td>
|
||||
<td>The type of object stored in the array.</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>ALLOC</code></td>
|
||||
<td>An STL Allocator</td>
|
||||
<td>std::allocator</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4>Model of</h4>
|
||||
<p>Reversible Container.</p>
|
||||
<h4>Type requirements</h4>
|
||||
<p>None, except for those imposed by the requirements of Reversible
|
||||
Container.</p>
|
||||
<h4>Public base classes</h4>
|
||||
<p>None.</p>
|
||||
<h4>Members</h4>
|
||||
<table border="1" summary="members">
|
||||
<tbody>
|
||||
<tr>
|
||||
<th>Member</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>map_array (ALLOC &a = ALLOC())</code></td>
|
||||
<td>Allocates a <code>map_array</code> that holds at most zero
|
||||
elements.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>map_array (const map_array &c)</code></td>
|
||||
<td>The copy constructor.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>~map_array ()</code></td>
|
||||
<td>Deallocates the <code>map_array</code> itself.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>void reserve (size_type capacity)</code></td>
|
||||
<td>
|
||||
Changes the<code>map_array</code> capacity. It can hold at most<code>capacity</code> elements without reallocation. The capacity can be reduced such that <code>capacity >= size()</code>. The content of the<code>map_array</code> is preserved.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>size_type size () const</code></td>
|
||||
<td>Returns the size of the <code>map_array</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>size_type size () const</code></td>
|
||||
<td>Returns the capacity of the <code>map_array</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>data_reference operator [] (index_type i)</code></td>
|
||||
<td>Returns a reference of the element that is associated with a
|
||||
particular index. If the <code>map_array</code> does not already
|
||||
contain such an element, <code>operator[]</code> inserts the
|
||||
default <code>T ()</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>map_array &operator = (const map_array
|
||||
&a)</code></td>
|
||||
<td>The assignment operator.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>map_array &assign_temporary (map_array
|
||||
&a)</code></td>
|
||||
<td>Assigns a temporary. May change the array <code>a</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>void swap (map_array &a)</code></td>
|
||||
<td>Swaps the contents of the arrays.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>std::pair<iterator, bool> insert (const value_type
|
||||
&p)</code></td>
|
||||
<td>Inserts <code>p</code> into the array. The second part of the return value is <code>true</code>
|
||||
if <code>p</code> was inserted and <code>false</code> if was not inserted because it was aleady
|
||||
present.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>iterator insert (iterator it, const value_type
|
||||
&p)</code></td>
|
||||
<td>Inserts <code>p</code> into the array, using <code>it</code> as
|
||||
a hint to where it will be inserted.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>void erase (iterator it)</code></td>
|
||||
<td>Erases the value at <code>it</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>void clear ()</code></td>
|
||||
<td>Clears the array.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_iterator find (index_type i) const</code></td>
|
||||
<td>Finds an element whose index is <code>i</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>iterator find (index_type i)</code></td>
|
||||
<td>Finds an element whose index is <code>i</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_iterator lower_bound (index_type i)
|
||||
const</code></td>
|
||||
<td>Finds the first element whose index is not less than
|
||||
<code>i</code> .</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>iterator lower_bound (index_type i)</code></td>
|
||||
<td>Finds the first element whose index is not less than
|
||||
<code>i</code> .</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_iterator upper_bound (index_type i)
|
||||
const</code></td>
|
||||
<td>Finds the first element whose index is greater than
|
||||
<code>i</code> .</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>iterator upper_bound (index_type i)</code></td>
|
||||
<td>Finds the first element whose index is greater than
|
||||
<code>i</code> .</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_iterator begin () const</code></td>
|
||||
<td>Returns a <code>const_iterator</code> pointing to the beginning
|
||||
of the <code>map_array</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_iterator end () const</code></td>
|
||||
<td>Returns a <code>const_iterator</code> pointing to the end of
|
||||
the <code>map_array</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>iterator begin ()</code></td>
|
||||
<td>Returns a <code>iterator</code> pointing to the beginning of
|
||||
the <code>map_array</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>iterator end ()</code></td>
|
||||
<td>Returns a <code>iterator</code> pointing to the end of the
|
||||
<code>map_array</code>.</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 <code>map_array</code>.</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 <code>map_array</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>reverse_iterator rbegin ()</code></td>
|
||||
<td>Returns a <code>reverse_iterator</code> pointing to the
|
||||
beginning of the reversed <code>map_array</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>reverse_iterator rend ()</code></td>
|
||||
<td>Returns a <code>reverse_iterator</code> pointing to the end of
|
||||
the reversed <code>map_array</code>.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<hr />
|
||||
<p>Copyright (©) 2000-2002 Joerg Walter, Mathias Koch<br />
|
||||
Use, modification and distribution are subject to the
|
||||
Boost Software License, Version 1.0.
|
||||
(See accompanying file LICENSE_1_0.txt
|
||||
or copy at <a href="http://www.boost.org/LICENSE_1_0.txt">
|
||||
http://www.boost.org/LICENSE_1_0.txt
|
||||
</a>).
|
||||
</p>
|
||||
<script type="text/javascript">
|
||||
(function($) {
|
||||
$('#toc').toc();
|
||||
})(jQuery);
|
||||
</script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,588 @@
|
||||
<!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 name="generator" content=
|
||||
"HTML Tidy for Linux/x86 (vers 1st March 2004), see www.w3.org" />
|
||||
<meta http-equiv="Content-Type" content=
|
||||
"text/html; charset=us-ascii" />
|
||||
<link rel="stylesheet" href="../../../../boost.css" type="text/css"/>
|
||||
<link rel="stylesheet" href="ublas.css" type="text/css" />
|
||||
<script type="text/javascript" src="js/jquery-1.3.2.min.js" async="async" ></script>
|
||||
<script type="text/javascript" src="js/jquery.toc-gw.js" async="async" ></script>
|
||||
<title>Symmetric Matrix</title>
|
||||
</head>
|
||||
<body>
|
||||
<h1><img src="../../../../boost.png" align="middle" />Symmetric Matrix</h1>
|
||||
<div class="toc" id="toc"></div>
|
||||
<h2><a name="symmetric_matrix"></a>Symmetric Matrix</h2>
|
||||
<h4>Description</h4>
|
||||
<p>The templated class <code>symmetric_matrix<T, F1, F2,
|
||||
A></code> is the base container adaptor for symmetric matrices.
|
||||
For a <em>(n x n</em> )-dimensional symmetric matrix and <em>0
|
||||
<= i < n</em>, <em>0 <= j < n</em> holds
|
||||
<em>s</em><sub><em>i, j</em></sub> <em>= s</em><sub><em>j,
|
||||
i</em></sub>. The storage of symmetric matrices is packed.</p>
|
||||
<h4>Example</h4>
|
||||
<pre>
|
||||
#include <boost/numeric/ublas/symmetric.hpp>
|
||||
#include <boost/numeric/ublas/io.hpp>
|
||||
|
||||
int main () {
|
||||
using namespace boost::numeric::ublas;
|
||||
symmetric_matrix<double, lower> ml (3, 3);
|
||||
for (unsigned i = 0; i < ml.size1 (); ++ i)
|
||||
for (unsigned j = 0; j <= i; ++ j)
|
||||
ml (i, j) = 3 * i + j;
|
||||
std::cout << ml << std::endl;
|
||||
symmetric_matrix<double, upper> mu (3, 3);
|
||||
for (unsigned i = 0; i < mu.size1 (); ++ i)
|
||||
for (unsigned j = i; j < mu.size2 (); ++ j)
|
||||
mu (i, j) = 3 * i + j;
|
||||
std::cout << mu << std::endl;
|
||||
}
|
||||
</pre>
|
||||
<h4>Definition</h4>
|
||||
<p>Defined in the header symmetric.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 matrix.</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>F1</code></td>
|
||||
<td>Functor describing the type of the symmetric matrix. <a name=
|
||||
"#symmetric_matrix_1">[1]</a></td>
|
||||
<td><code>lower</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>F2</code></td>
|
||||
<td>Functor describing the storage organization. <a name=
|
||||
"#symmetric_matrix_2">[2]</a></td>
|
||||
<td><code>row_major</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>A</code></td>
|
||||
<td>The type of the adapted array. <a name="#symmetric_matrix_3"
|
||||
>[3]</a></td>
|
||||
<td><code>unbounded_array<T></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4>Model of</h4>
|
||||
<p><a href="container_concept.html#matrix">Matrix</a> .</p>
|
||||
<h4>Type requirements</h4>
|
||||
<p>None, except for those imposed by the requirements of <a href=
|
||||
"container_concept.html#matrix">Matrix</a> .</p>
|
||||
<h4>Public base classes</h4>
|
||||
<p><code>matrix_container<symmetric_matrix<T, F1, F2, A>
|
||||
></code></p>
|
||||
<h4>Members</h4>
|
||||
<table border="1" summary="members">
|
||||
<tbody>
|
||||
<tr>
|
||||
<th>Member</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>symmetric_matrix (size_type size)</code></td>
|
||||
<td>Allocates an uninitialized <code>symmetric_matrix</code> that
|
||||
holds <code>size</code> rows of <code>size</code> elements.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>symmetric_matrix (const symmetric_matrix
|
||||
&m)</code></td>
|
||||
<td>The copy constructor.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
symmetric_matrix (const matrix_expression<AE>
|
||||
&ae)</code></td>
|
||||
<td>The extended copy constructor.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>void resize (size_type size, bool preserve =
|
||||
true)</code></td>
|
||||
<td>Reallocates a <code>symmetric_matrix</code> to hold
|
||||
<code>size</code> rows of <code>size</code> elements. The existing
|
||||
elements of the <code>symmetric_matrix</code> are preseved when
|
||||
specified.</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 a <code>const</code> reference of the <code>j</code>
|
||||
-th element in the <code>i</code>-th row.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>reference operator () (size_type i, size_type
|
||||
j)</code></td>
|
||||
<td>Returns a reference of the <code>j</code>-th element in the
|
||||
<code>i</code>-th row.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>symmetric_matrix &operator = (const symmetric_matrix
|
||||
&m)</code></td>
|
||||
<td>The assignment operator.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>symmetric_matrix &assign_temporary (symmetric_matrix
|
||||
&m)</code></td>
|
||||
<td>Assigns a temporary. May change the symmetric matrix
|
||||
<code>m</code> .</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
symmetric_matrix &operator = (const matrix_expression<AE>
|
||||
&ae)</code></td>
|
||||
<td>The extended assignment operator.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
symmetric_matrix &assign (const matrix_expression<AE>
|
||||
&ae)</code></td>
|
||||
<td>Assigns a matrix expression to the symmetric matrix. Left and
|
||||
right hand side of the assignment should be independent.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
symmetric_matrix &operator += (const
|
||||
matrix_expression<AE> &ae)</code></td>
|
||||
<td>A computed assignment operator. Adds the matrix expression to
|
||||
the symmetric matrix.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
symmetric_matrix &plus_assign (const
|
||||
matrix_expression<AE> &ae)</code></td>
|
||||
<td>Adds a matrix expression to the symmetric matrix. Left and
|
||||
right hand side of the assignment should be independent.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
symmetric_matrix &operator -= (const
|
||||
matrix_expression<AE> &ae)</code></td>
|
||||
<td>A computed assignment operator. Subtracts the matrix expression
|
||||
from the symmetric matrix.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
symmetric_matrix &minus_assign (const
|
||||
matrix_expression<AE> &ae)</code></td>
|
||||
<td>Subtracts a matrix expression from the symmetric matrix. Left
|
||||
and right hand side of the assignment should be independent.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AT><br />
|
||||
symmetric_matrix &operator *= (const AT &at)</code></td>
|
||||
<td>A computed assignment operator. Multiplies the symmetric matrix
|
||||
with a scalar.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AT><br />
|
||||
symmetric_matrix &operator /= (const AT &at)</code></td>
|
||||
<td>A computed assignment operator. Divides the symmetric matrix
|
||||
through a scalar.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>void swap (symmetric_matrix &m)</code></td>
|
||||
<td>Swaps the contents of the symmetric matrices.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>void insert (size_type i, size_type j, const_reference
|
||||
t)</code></td>
|
||||
<td>Inserts the value <code>t</code> at the <code>j</code>-th
|
||||
element of the <code>i</code>-th row.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>void erase (size_type i, size_type j)</code></td>
|
||||
<td>Erases the value at the <code>j</code>-th elemenst of the
|
||||
<code>i</code>-th row.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>void clear ()</code></td>
|
||||
<td>Clears the matrix.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_iterator1 begin1 () const</code></td>
|
||||
<td>Returns a <code>const_iterator1</code> pointing to the
|
||||
beginning of the <code>symmetric_matrix</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_iterator1 end1 () const</code></td>
|
||||
<td>Returns a <code>const_iterator1</code> pointing to the end of
|
||||
the <code>symmetric_matrix</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>iterator1 begin1 ()</code></td>
|
||||
<td>Returns a <code>iterator1</code> pointing to the beginning of
|
||||
the <code>symmetric_matrix</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>iterator1 end1 ()</code></td>
|
||||
<td>Returns a <code>iterator1</code> pointing to the end of the
|
||||
<code>symmetric_matrix</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_iterator2 begin2 () const</code></td>
|
||||
<td>Returns a <code>const_iterator2</code> pointing to the
|
||||
beginning of the <code>symmetric_matrix</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_iterator2 end2 () const</code></td>
|
||||
<td>Returns a <code>const_iterator2</code> pointing to the end of
|
||||
the <code>symmetric_matrix</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>iterator2 begin2 ()</code></td>
|
||||
<td>Returns a <code>iterator2</code> pointing to the beginning of
|
||||
the <code>symmetric_matrix</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>iterator2 end2 ()</code></td>
|
||||
<td>Returns a <code>iterator2</code> pointing to the end of the
|
||||
<code>symmetric_matrix</code>.</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 <code>symmetric_matrix</code>.</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 <code>symmetric_matrix</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>reverse_iterator1 rbegin1 ()</code></td>
|
||||
<td>Returns a <code>reverse_iterator1</code> pointing to the
|
||||
beginning of the reversed <code>symmetric_matrix</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>reverse_iterator1 rend1 ()</code></td>
|
||||
<td>Returns a <code>reverse_iterator1</code> pointing to the end of
|
||||
the reversed <code>symmetric_matrix</code>.</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 <code>symmetric_matrix</code>.</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 <code>symmetric_matrix</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>reverse_iterator2 rbegin2 ()</code></td>
|
||||
<td>Returns a <code>reverse_iterator2</code> pointing to the
|
||||
beginning of the reversed <code>symmetric_matrix</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>reverse_iterator2 rend2 ()</code></td>
|
||||
<td>Returns a <code>reverse_iterator2</code> pointing to the end of
|
||||
the reversed <code>symmetric_matrix</code>.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4>Notes</h4>
|
||||
<p><a name="symmetric_matrix_1">[1]</a>
|
||||
Supported parameters for the type of the symmetric matrix are
|
||||
<code>lower</code> and <code>upper</code>.</p>
|
||||
<p><a name="symmetric_matrix_2">[2]</a>
|
||||
Supported parameters for the storage organization are
|
||||
<code>row_major</code> and <code>column_major</code>.</p>
|
||||
<p><a name="symmetric_matrix_3">[3]</a>
|
||||
Supported parameters for the adapted array are
|
||||
<code>unbounded_array<T></code> ,
|
||||
<code>bounded_array<T></code> and
|
||||
<code>std::vector<T></code> .</p>
|
||||
<h2><a name="symmetric_adaptor"></a>Symmetric Adaptor</h2>
|
||||
<h4>Description</h4>
|
||||
<p>The templated class <code>symmetric_adaptor<M, F></code>
|
||||
is a symmetric matrix adaptor for other matrices.</p>
|
||||
<h4>Example</h4>
|
||||
<pre>
|
||||
#include <boost/numeric/ublas/symmetric.hpp>
|
||||
#include <boost/numeric/ublas/io.hpp>
|
||||
|
||||
int main () {
|
||||
using namespace boost::numeric::ublas;
|
||||
matrix<double> m (3, 3);
|
||||
symmetric_adaptor<matrix<double>, lower> sal (m);
|
||||
for (unsigned i = 0; i < sal.size1 (); ++ i)
|
||||
for (unsigned j = 0; j <= i; ++ j)
|
||||
sal (i, j) = 3 * i + j;
|
||||
std::cout << sal << std::endl;
|
||||
symmetric_adaptor<matrix<double>, upper> sau (m);
|
||||
for (unsigned i = 0; i < sau.size1 (); ++ i)
|
||||
for (unsigned j = i; j < sau.size2 (); ++ j)
|
||||
sau (i, j) = 3 * i + j;
|
||||
std::cout << sau << std::endl;
|
||||
}
|
||||
</pre>
|
||||
<h4>Definition</h4>
|
||||
<p>Defined in the header symmetric.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>M</code></td>
|
||||
<td>The type of the adapted matrix.</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>F</code></td>
|
||||
<td>Functor describing the type of the symmetric adaptor. <a href=
|
||||
"#symmetric_adaptor_1">[1]</a></td>
|
||||
<td><code>lower</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4>Model of</h4>
|
||||
<p><a href="expression_concept.html#matrix_expression">Matrix Expression</a>
|
||||
.</p>
|
||||
<h4>Type requirements</h4>
|
||||
<p>None, except for those imposed by the requirements of <a href=
|
||||
"expression_concept.html#matrix_expression">Matrix Expression</a> .</p>
|
||||
<h4>Public base classes</h4>
|
||||
<p><code>matrix_expression<symmetric_adaptor<M, F>
|
||||
></code></p>
|
||||
<h4>Members</h4>
|
||||
<table border="1" summary="members">
|
||||
<tbody>
|
||||
<tr>
|
||||
<th>Member</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>symmetric_adaptor ()</code></td>
|
||||
<td>Constructs a <code>symmetric_adaptor</code> that holds zero
|
||||
rows of zero elements.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>symmetric_adaptor (matrix_type &data)</code></td>
|
||||
<td>Constructs a <code>symmetric_adaptor</code> of a matrix.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>symmetric_adaptor (const symmetric_adaptor
|
||||
&m)</code></td>
|
||||
<td>The copy constructor.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
symmetric_adaptor (const matrix_expression<AE>
|
||||
&ae)</code></td>
|
||||
<td>The extended copy constructor.</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 a <code>const</code> reference of the <code>j</code>
|
||||
-th element in the <code>i</code>-th row.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>reference operator () (size_type i, size_type
|
||||
j)</code></td>
|
||||
<td>Returns a reference of the <code>j</code>-th element in the
|
||||
<code>i</code>-th row.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>symmetric_adaptor &operator = (const
|
||||
symmetric_adaptor &m)</code></td>
|
||||
<td>The assignment operator.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>symmetric_adaptor &assign_temporary
|
||||
(symmetric_adaptor &m)</code></td>
|
||||
<td>Assigns a temporary. May change the symmetric adaptor
|
||||
<code>m</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
symmetric_adaptor &operator = (const
|
||||
matrix_expression<AE> &ae)</code></td>
|
||||
<td>The extended assignment operator.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
symmetric_adaptor &assign (const matrix_expression<AE>
|
||||
&ae)</code></td>
|
||||
<td>Assigns a matrix expression to the symmetric adaptor. Left and
|
||||
right hand side of the assignment should be independent.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
symmetric_adaptor &operator += (const
|
||||
matrix_expression<AE> &ae)</code></td>
|
||||
<td>A computed assignment operator. Adds the matrix expression to
|
||||
the symmetric adaptor.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
symmetric_adaptor &plus_assign (const
|
||||
matrix_expression<AE> &ae)</code></td>
|
||||
<td>Adds a matrix expression to the symmetric adaptor. Left and
|
||||
right hand side of the assignment should be independent.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
symmetric_adaptor &operator -= (const
|
||||
matrix_expression<AE> &ae)</code></td>
|
||||
<td>A computed assignment operator. Subtracts the matrix expression
|
||||
from the symmetric adaptor.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
symmetric_adaptor &minus_assign (const
|
||||
matrix_expression<AE> &ae)</code></td>
|
||||
<td>Subtracts a matrix expression from the symmetric adaptor. Left
|
||||
and right hand side of the assignment should be independent.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AT><br />
|
||||
symmetric_adaptor &operator *= (const AT &at)</code></td>
|
||||
<td>A computed assignment operator. Multiplies the symmetric
|
||||
adaptor with a scalar.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AT><br />
|
||||
symmetric_adaptor &operator /= (const AT &at)</code></td>
|
||||
<td>A computed assignment operator. Divides the symmetric adaptor
|
||||
through a scalar.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>void swap (symmetric_adaptor &m)</code></td>
|
||||
<td>Swaps the contents of the symmetric adaptors.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_iterator1 begin1 () const</code></td>
|
||||
<td>Returns a <code>const_iterator1</code> pointing to the
|
||||
beginning of the <code>symmetric_adaptor</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_iterator1 end1 () const</code></td>
|
||||
<td>Returns a <code>const_iterator1</code> pointing to the end of
|
||||
the <code>symmetric_adaptor</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>iterator1 begin1 ()</code></td>
|
||||
<td>Returns a <code>iterator1</code> pointing to the beginning of
|
||||
the <code>symmetric_adaptor</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>iterator1 end1 ()</code></td>
|
||||
<td>Returns a <code>iterator1</code> pointing to the end of the
|
||||
<code>symmetric_adaptor</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_iterator2 begin2 () const</code></td>
|
||||
<td>Returns a <code>const_iterator2</code> pointing to the
|
||||
beginning of the <code>symmetric_adaptor</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_iterator2 end2 () const</code></td>
|
||||
<td>Returns a <code>const_iterator2</code> pointing to the end of
|
||||
the <code>symmetric_adaptor</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>iterator2 begin2 ()</code></td>
|
||||
<td>Returns a <code>iterator2</code> pointing to the beginning of
|
||||
the <code>symmetric_adaptor</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>iterator2 end2 ()</code></td>
|
||||
<td>Returns a <code>iterator2</code> pointing to the end of the
|
||||
<code>symmetric_adaptor</code>.</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 <code>symmetric_adaptor</code>.</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 <code>symmetric_adaptor</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>reverse_iterator1 rbegin1 ()</code></td>
|
||||
<td>Returns a <code>reverse_iterator1</code> pointing to the
|
||||
beginning of the reversed <code>symmetric_adaptor</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>reverse_iterator1 rend1 ()</code></td>
|
||||
<td>Returns a <code>reverse_iterator1</code> pointing to the end of
|
||||
the reversed <code>symmetric_adaptor</code>.</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 <code>symmetric_adaptor</code>.</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 <code>symmetric_adaptor</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>reverse_iterator2 rbegin2 ()</code></td>
|
||||
<td>Returns a <code>reverse_iterator2</code> pointing to the
|
||||
beginning of the reversed <code>symmetric_adaptor</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>reverse_iterator2 rend2 ()</code></td>
|
||||
<td>Returns a <code>reverse_iterator2</code> pointing to the end of
|
||||
the reversed <code>symmetric_adaptor</code>.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4>Notes</h4>
|
||||
<p><a name="symmetric_adaptor_1">[1]</a>
|
||||
Supported parameters for the type of the symmetric adaptor are
|
||||
<code>lower</code> and <code>upper</code>.</p>
|
||||
<hr />
|
||||
<p>Copyright (©) 2000-2002 Joerg Walter, Mathias Koch<br />
|
||||
Use, modification and distribution are subject to the
|
||||
Boost Software License, Version 1.0.
|
||||
(See accompanying file LICENSE_1_0.txt
|
||||
or copy at <a href="http://www.boost.org/LICENSE_1_0.txt">
|
||||
http://www.boost.org/LICENSE_1_0.txt
|
||||
</a>).
|
||||
</p>
|
||||
<script type="text/javascript">
|
||||
(function($) {
|
||||
$('#toc').toc();
|
||||
})(jQuery);
|
||||
</script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,602 @@
|
||||
<!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 name="generator" content=
|
||||
"HTML Tidy for Linux/x86 (vers 1st March 2004), see www.w3.org" />
|
||||
<meta http-equiv="Content-Type" content=
|
||||
"text/html; charset=us-ascii" />
|
||||
<link rel="stylesheet" href="../../../../boost.css" type="text/css"/>
|
||||
<link rel="stylesheet" href="ublas.css" type="text/css" />
|
||||
<script type="text/javascript" src="js/jquery-1.3.2.min.js" async="async" ></script>
|
||||
<script type="text/javascript" src="js/jquery.toc-gw.js" async="async" ></script>
|
||||
<title>Triangular Matrix</title>
|
||||
</head>
|
||||
<body>
|
||||
<h1><img src="../../../../boost.png" align="middle" />Triangular Matrix</h1>
|
||||
<div class="toc" id="toc"></div>
|
||||
<h2><a name="triangular_matrix"></a>Triangular Matrix</h2>
|
||||
<h4>Description</h4>
|
||||
<p>The templated class <code>triangular_matrix<T, F1, F2,
|
||||
A></code> is the base container adaptor for triangular matrices.
|
||||
For a <em>(n x n</em> )-dimensional lower triangular matrix and
|
||||
<em>0 <= i < n</em>,<em>0 <= j < n</em> holds
|
||||
<em>t</em><sub><em>i, j</em></sub> <em>= 0</em> , if <em>i >
|
||||
j</em>. If furthermore holds t<sub><em>i, i</em></sub><em>= 1</em>
|
||||
the matrix is called unit lower triangular. For a <em>(n x n</em>
|
||||
)-dimensional lower triangular matrix and <em>0 <= i <
|
||||
n</em>,<em>0 <= j < n</em> holds <em>t</em><sub><em>i,
|
||||
j</em></sub> <em>= 0</em> , if <em>i < j</em>. If furthermore
|
||||
holds t<sub><em>i, i</em></sub><em>= 1</em> the matrix is called
|
||||
unit lower triangular. The storage of triangular matrices is
|
||||
packed.</p>
|
||||
<h4>Example</h4>
|
||||
<pre>
|
||||
#include <boost/numeric/ublas/triangular.hpp>
|
||||
#include <boost/numeric/ublas/io.hpp>
|
||||
|
||||
int main () {
|
||||
using namespace boost::numeric::ublas;
|
||||
triangular_matrix<double, lower> ml (3, 3);
|
||||
for (unsigned i = 0; i < ml.size1 (); ++ i)
|
||||
for (unsigned j = 0; j <= i; ++ j)
|
||||
ml (i, j) = 3 * i + j;
|
||||
std::cout << ml << std::endl;
|
||||
triangular_matrix<double, upper> mu (3, 3);
|
||||
for (unsigned i = 0; i < mu.size1 (); ++ i)
|
||||
for (unsigned j = i; j < mu.size2 (); ++ j)
|
||||
mu (i, j) = 3 * i + j;
|
||||
std::cout << mu << std::endl;
|
||||
}
|
||||
</pre>
|
||||
<p>Please read the <a href="samples/ex_triangular.cpp">full triangular example</a> for more details.</p>
|
||||
|
||||
<h4>Definition</h4>
|
||||
<p>Defined in the header triangular.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 matrix.</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>F1</code></td>
|
||||
<td>Functor describing the type of the triangular matrix. <a href=
|
||||
"#triangular_matrix_1">[1]</a></td>
|
||||
<td><code>lower</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>F2</code></td>
|
||||
<td>Functor describing the storage organization. <a href=
|
||||
"#triangular_matrix_2">[2]</a></td>
|
||||
<td><code>row_major</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>A</code></td>
|
||||
<td>The type of the adapted array. <a href=
|
||||
"#triangular_matrix_3">[3]</a></td>
|
||||
<td><code>unbounded_array<T></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4>Model of</h4>
|
||||
<p><a href="container_concept.html#matrix">Matrix</a> .</p>
|
||||
<h4>Type requirements</h4>
|
||||
<p>None, except for those imposed by the requirements of <a href=
|
||||
"container_concept.html#matrix">Matrix</a> .</p>
|
||||
<h4>Public base classes</h4>
|
||||
<p><code>matrix_container<triangular_matrix<T, F1, F2, A>
|
||||
></code></p>
|
||||
<h4>Members</h4>
|
||||
<table border="1" summary="members">
|
||||
<tbody>
|
||||
<tr>
|
||||
<th>Member</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>triangular_matrix ()</code></td>
|
||||
<td>Allocates an uninitialized <code>triangular_matrix</code> that
|
||||
holds zero rows of zero elements.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>triangular_matrix (size_type size1, size_type
|
||||
size2)</code></td>
|
||||
<td>Allocates an uninitialized <code>triangular_matrix</code> that
|
||||
holds <code>size1</code> rows of <code>size2</code> elements.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>triangular_matrix (const triangular_matrix
|
||||
&m)</code></td>
|
||||
<td>The copy constructor.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
triangular_matrix (const matrix_expression<AE>
|
||||
&ae)</code></td>
|
||||
<td>The extended copy constructor.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>void resize (size_type size1, size_type size2, bool
|
||||
preserve = true)</code></td>
|
||||
<td>Reallocates a <code>triangular_matrix</code> to hold
|
||||
<code>size1</code> rows of <code>size2</code> elements. The
|
||||
existing elements of the <code>triangular_matrix</code> are
|
||||
preseved when specified.</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 a <code>const</code> reference of the <code>j</code>
|
||||
-th element in the <code>i</code>-th row.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>reference operator () (size_type i, size_type
|
||||
j)</code></td>
|
||||
<td>Returns a reference of the <code>j</code>-th element in the
|
||||
<code>i</code>-th row.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>triangular_matrix &operator = (const
|
||||
triangular_matrix &m)</code></td>
|
||||
<td>The assignment operator.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>triangular_matrix &assign_temporary
|
||||
(triangular_matrix &m)</code></td>
|
||||
<td>Assigns a temporary. May change the triangular matrix
|
||||
<code>m</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
triangular_matrix &operator = (const
|
||||
matrix_expression<AE> &ae)</code></td>
|
||||
<td>The extended assignment operator.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
triangular_matrix &assign (const matrix_expression<AE>
|
||||
&ae)</code></td>
|
||||
<td>Assigns a matrix expression to the triangular matrix. Left and
|
||||
right hand side of the assignment should be independent.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
triangular_matrix &operator += (const
|
||||
matrix_expression<AE> &ae)</code></td>
|
||||
<td>A computed assignment operator. Adds the matrix expression to
|
||||
the triangular matrix.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
triangular_matrix &plus_assign (const
|
||||
matrix_expression<AE> &ae)</code></td>
|
||||
<td>Adds a matrix expression to the triangular matrix. Left and
|
||||
right hand side of the assignment should be independent.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
triangular_matrix &operator -= (const
|
||||
matrix_expression<AE> &ae)</code></td>
|
||||
<td>A computed assignment operator. Subtracts the matrix expression
|
||||
from the triangular matrix.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
triangular_matrix &minus_assign (const
|
||||
matrix_expression<AE> &ae)</code></td>
|
||||
<td>Subtracts a matrix expression from the triangular matrix. Left
|
||||
and right hand side of the assignment should be independent.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AT><br />
|
||||
triangular_matrix &operator *= (const AT &at)</code></td>
|
||||
<td>A computed assignment operator. Multiplies the triangular
|
||||
matrix with a scalar.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AT><br />
|
||||
triangular_matrix &operator /= (const AT &at)</code></td>
|
||||
<td>A computed assignment operator. Divides the triangular matrix
|
||||
through a scalar.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>void swap (triangular_matrix &m)</code></td>
|
||||
<td>Swaps the contents of the triangular matrices.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>void insert (size_type i, size_type j, const_reference
|
||||
t)</code></td>
|
||||
<td>Inserts the value <code>t</code> at the <code>j</code>-th
|
||||
element of the <code>i</code>-th row.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>void erase (size_type i, size_type j)</code></td>
|
||||
<td>Erases the value at the <code>j</code>-th elemenst of the
|
||||
<code>i</code>-th row.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>void clear ()</code></td>
|
||||
<td>Clears the matrix.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_iterator1 begin1 () const</code></td>
|
||||
<td>Returns a <code>const_iterator1</code> pointing to the
|
||||
beginning of the <code>triangular_matrix</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_iterator1 end1 () const</code></td>
|
||||
<td>Returns a <code>const_iterator1</code> pointing to the end of
|
||||
the <code>triangular_matrix</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>iterator1 begin1 ()</code></td>
|
||||
<td>Returns a <code>iterator1</code> pointing to the beginning of
|
||||
the <code>triangular_matrix</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>iterator1 end1 ()</code></td>
|
||||
<td>Returns a <code>iterator1</code> pointing to the end of the
|
||||
<code>triangular_matrix</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_iterator2 begin2 () const</code></td>
|
||||
<td>Returns a <code>const_iterator2</code> pointing to the
|
||||
beginning of the <code>triangular_matrix</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_iterator2 end2 () const</code></td>
|
||||
<td>Returns a <code>const_iterator2</code> pointing to the end of
|
||||
the <code>triangular_matrix</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>iterator2 begin2 ()</code></td>
|
||||
<td>Returns a <code>iterator2</code> pointing to the beginning of
|
||||
the <code>triangular_matrix</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>iterator2 end2 ()</code></td>
|
||||
<td>Returns a <code>iterator2</code> pointing to the end of the
|
||||
<code>triangular_matrix</code>.</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 <code>triangular_matrix</code>.</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 <code>triangular_matrix</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>reverse_iterator1 rbegin1 ()</code></td>
|
||||
<td>Returns a <code>reverse_iterator1</code> pointing to the
|
||||
beginning of the reversed <code>triangular_matrix</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>reverse_iterator1 rend1 ()</code></td>
|
||||
<td>Returns a <code>reverse_iterator1</code> pointing to the end of
|
||||
the reversed <code>triangular_matrix</code>.</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 <code>triangular_matrix</code>.</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 <code>triangular_matrix</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>reverse_iterator2 rbegin2 ()</code></td>
|
||||
<td>Returns a <code>reverse_iterator2</code> pointing to the
|
||||
beginning of the reversed <code>triangular_matrix</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>reverse_iterator2 rend2 ()</code></td>
|
||||
<td>Returns a <code>reverse_iterator2</code> pointing to the end of
|
||||
the reversed <code>triangular_matrix</code>.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4>Notes</h4>
|
||||
<p><a name="triangular_matrix_1">[1]</a>
|
||||
Supported parameters for the type of the triangular matrix are
|
||||
<code>lower</code> , <code>unit_lower</code>, <code>upper</code>
|
||||
and <code>unit_upper</code> .</p>
|
||||
<p><a name="triangular_matrix_2">[2]</a>
|
||||
Supported parameters for the storage organization are
|
||||
<code>row_major</code> and <code>column_major</code>.</p>
|
||||
<p><a name="triangular_matrix_3">[3]</a>
|
||||
Supported parameters for the adapted array are
|
||||
<code>unbounded_array<T></code> ,
|
||||
<code>bounded_array<T></code> and
|
||||
<code>std::vector<T></code> .</p>
|
||||
<h2><a name="triangular_adaptor"></a>Triangular Adaptor</h2>
|
||||
<h4>Description</h4>
|
||||
<p>The templated class <code>triangular_adaptor<M, F></code>
|
||||
is a triangular matrix adaptor for other matrices.</p>
|
||||
<h4>Example</h4>
|
||||
<pre>
|
||||
#include <boost/numeric/ublas/triangular.hpp>
|
||||
#include <boost/numeric/ublas/io.hpp>
|
||||
|
||||
int main () {
|
||||
using namespace boost::numeric::ublas;
|
||||
matrix<double> m (3, 3);
|
||||
triangular_adaptor<matrix<double>, lower> tal (m);
|
||||
for (unsigned i = 0; i < tal.size1 (); ++ i)
|
||||
for (unsigned j = 0; j <= i; ++ j)
|
||||
tal (i, j) = 3 * i + j;
|
||||
std::cout << tal << std::endl;
|
||||
triangular_adaptor<matrix<double>, upper> tau (m);
|
||||
for (unsigned i = 0; i < tau.size1 (); ++ i)
|
||||
for (unsigned j = i; j < tau.size2 (); ++ j)
|
||||
tau (i, j) = 3 * i + j;
|
||||
std::cout << tau << std::endl;
|
||||
}
|
||||
</pre>
|
||||
<p>Please read the <a href="samples/ex_triangular.cpp">full triangular example</a> for more details.</p>
|
||||
|
||||
<h4>Definition</h4>
|
||||
<p>Defined in the header triangular.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>M</code></td>
|
||||
<td>The type of the adapted matrix.</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>F</code></td>
|
||||
<td>Functor describing the type of the triangular adaptor. <a href=
|
||||
"#triangular_adaptor_1">[1]</a></td>
|
||||
<td><code>lower</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4>Model of</h4>
|
||||
<p><a href="expression_concept.html#matrix_expression">Matrix Expression</a>
|
||||
.</p>
|
||||
<h4>Type requirements</h4>
|
||||
<p>None, except for those imposed by the requirements of <a href=
|
||||
"expression_concept.html#matrix_expression">Matrix Expression</a> .</p>
|
||||
<h4>Public base classes</h4>
|
||||
<p><code>matrix_expression<triangular_adaptor<M, F>
|
||||
></code></p>
|
||||
<h4>Members</h4>
|
||||
<table border="1" summary="members">
|
||||
<tbody>
|
||||
<tr>
|
||||
<th>Member</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>triangular_adaptor (matrix_type &data)</code></td>
|
||||
<td>Constructs a <code>triangular_adaptor</code> of a matrix.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>triangular_adaptor (const triangular_adaptor
|
||||
&m)</code></td>
|
||||
<td>The copy constructor.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
triangular_adaptor (const matrix_expression<AE>
|
||||
&ae)</code></td>
|
||||
<td>The extended copy constructor.</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 a <code>const</code> reference of the <code>j</code>
|
||||
-th element in the <code>i</code>-th row.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>reference operator () (size_type i, size_type
|
||||
j)</code></td>
|
||||
<td>Returns a reference of the <code>j</code>-th element in the
|
||||
<code>i</code>-th row.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>triangular_adaptor &operator = (const
|
||||
triangular_adaptor &m)</code></td>
|
||||
<td>The assignment operator.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>triangular_adaptor &assign_temporary
|
||||
(triangular_adaptor &m)</code></td>
|
||||
<td>Assigns a temporary. May change the triangular adaptor
|
||||
<code>m</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
triangular_adaptor &operator = (const
|
||||
matrix_expression<AE> &ae)</code></td>
|
||||
<td>The extended assignment operator.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
triangular_adaptor &assign (const matrix_expression<AE>
|
||||
&ae)</code></td>
|
||||
<td>Assigns a matrix expression to the triangular adaptor. Left and
|
||||
right hand side of the assignment should be independent.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
triangular_adaptor &operator += (const
|
||||
matrix_expression<AE> &ae)</code></td>
|
||||
<td>A computed assignment operator. Adds the matrix expression to
|
||||
the triangular adaptor.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
triangular_adaptor &plus_assign (const
|
||||
matrix_expression<AE> &ae)</code></td>
|
||||
<td>Adds a matrix expression to the triangular adaptor. Left and
|
||||
right hand side of the assignment should be independent.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
triangular_adaptor &operator -= (const
|
||||
matrix_expression<AE> &ae)</code></td>
|
||||
<td>A computed assignment operator. Subtracts the matrix expression
|
||||
from the triangular adaptor.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
triangular_adaptor &minus_assign (const
|
||||
matrix_expression<AE> &ae)</code></td>
|
||||
<td>Subtracts a matrix expression from the triangular adaptor. Left
|
||||
and right hand side of the assignment should be independent.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AT><br />
|
||||
triangular_adaptor &operator *= (const AT &at)</code></td>
|
||||
<td>A computed assignment operator. Multiplies the triangular
|
||||
adaptor with a scalar.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AT><br />
|
||||
triangular_adaptor &operator /= (const AT &at)</code></td>
|
||||
<td>A computed assignment operator. Divides the triangular adaptor
|
||||
through a scalar.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>void swap (triangular_adaptor &m)</code></td>
|
||||
<td>Swaps the contents of the triangular adaptors.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_iterator1 begin1 () const</code></td>
|
||||
<td>Returns a <code>const_iterator1</code> pointing to the
|
||||
beginning of the <code>triangular_adaptor</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_iterator1 end1 () const</code></td>
|
||||
<td>Returns a <code>const_iterator1</code> pointing to the end of
|
||||
the <code>triangular_adaptor</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>iterator1 begin1 ()</code></td>
|
||||
<td>Returns a <code>iterator1</code> pointing to the beginning of
|
||||
the <code>triangular_adaptor</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>iterator1 end1 ()</code></td>
|
||||
<td>Returns a <code>iterator1</code> pointing to the end of the
|
||||
<code>triangular_adaptor</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_iterator2 begin2 () const</code></td>
|
||||
<td>Returns a <code>const_iterator2</code> pointing to the
|
||||
beginning of the <code>triangular_adaptor</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_iterator2 end2 () const</code></td>
|
||||
<td>Returns a <code>const_iterator2</code> pointing to the end of
|
||||
the <code>triangular_adaptor</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>iterator2 begin2 ()</code></td>
|
||||
<td>Returns a <code>iterator2</code> pointing to the beginning of
|
||||
the <code>triangular_adaptor</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>iterator2 end2 ()</code></td>
|
||||
<td>Returns a <code>iterator2</code> pointing to the end of the
|
||||
<code>triangular_adaptor</code>.</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 <code>triangular_adaptor</code>.</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 <code>triangular_adaptor</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>reverse_iterator1 rbegin1 ()</code></td>
|
||||
<td>Returns a <code>reverse_iterator1</code> pointing to the
|
||||
beginning of the reversed <code>triangular_adaptor</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>reverse_iterator1 rend1 ()</code></td>
|
||||
<td>Returns a <code>reverse_iterator1</code> pointing to the end of
|
||||
the reversed <code>triangular_adaptor</code>.</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 <code>triangular_adaptor</code>.</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 <code>triangular_adaptor</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>reverse_iterator2 rbegin2 ()</code></td>
|
||||
<td>Returns a <code>reverse_iterator2</code> pointing to the
|
||||
beginning of the reversed <code>triangular_adaptor</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>reverse_iterator2 rend2 ()</code></td>
|
||||
<td>Returns a <code>reverse_iterator2</code> pointing to the end of
|
||||
the reversed <code>triangular_adaptor</code>.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4>Notes</h4>
|
||||
<p><a name="triangular_adaptor_1">[1]</a>
|
||||
Supported parameters for the type of the triangular adaptor are
|
||||
<code>lower</code> , <code>unit_lower</code>, <code>upper</code>
|
||||
and <code>unit_upper</code> .</p>
|
||||
<hr />
|
||||
<p>Copyright (©) 2000-2002 Joerg Walter, Mathias Koch<br />
|
||||
Use, modification and distribution are subject to the
|
||||
Boost Software License, Version 1.0.
|
||||
(See accompanying file LICENSE_1_0.txt
|
||||
or copy at <a href="http://www.boost.org/LICENSE_1_0.txt">
|
||||
http://www.boost.org/LICENSE_1_0.txt
|
||||
</a>).
|
||||
</p>
|
||||
<script type="text/javascript">
|
||||
(function($) {
|
||||
$('#toc').toc();
|
||||
})(jQuery);
|
||||
</script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,580 @@
|
||||
<!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 name="generator" content=
|
||||
"HTML Tidy for Linux/x86 (vers 1st March 2004), see www.w3.org" />
|
||||
<meta name="GENERATOR" content="Quanta Plus" />
|
||||
<link rel="stylesheet" href="../../../../boost.css" type="text/css"/>
|
||||
<link rel="stylesheet" href="ublas.css" type="text/css" />
|
||||
<script type="text/javascript" src="js/jquery-1.3.2.min.js" async="async" ></script>
|
||||
<script type="text/javascript" src="js/jquery.toc-gw.js" async="async" ></script>
|
||||
<title>Types Overview</title>
|
||||
</head>
|
||||
<body>
|
||||
<h1><img src="../../../../boost.png" align="middle" />Overview of Matrix- and Vector-Types </h1>
|
||||
<div class="toc" id="toc"></div>
|
||||
|
||||
<dl>
|
||||
<dt>Contents:</dt>
|
||||
<dd><a href="#vectors">Vectors</a></dd>
|
||||
<dd><a href="#vector_proxies">Vector Proxies</a></dd>
|
||||
<dd><a href="#matrices">Matrices</a></dd>
|
||||
<dd><a href="#matrix_proxies">Matrix Proxies</a></dd>
|
||||
<dd><a href="#storage_layout">Special Storage Layouts</a></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
<h2>Notation</h2>
|
||||
|
||||
<table style="border: none;" summary="notation">
|
||||
<tr><td><code>T</code></td>
|
||||
<td>is the data type. For general linear algebra operations this will be a real type e.g. <code>double</code>, ...</td></tr>
|
||||
<tr><td><code>F</code></td>
|
||||
<td>is the orientation type (functor), either
|
||||
<code>row_major</code> or <code>column_major</code></td></tr>
|
||||
<tr><td><code>A, IA, TA</code></td> <td>is an array storage type, e.g. <code>std::vector,
|
||||
bounded_array, unbounded_array, ...</code></td></tr>
|
||||
<tr><td><code>TRI</code></td>
|
||||
<td>is a triangular functor: <code>lower,
|
||||
unit_lower, strict_lower, upper, unit_upper,
|
||||
strict_upper</code></td></tr>
|
||||
<tr><td><code>M, N</code></td>
|
||||
<td>are unsigned integer sizes
|
||||
(<code>std::size_t</code>)</td></tr>
|
||||
<tr><td><code>IB</code></td>
|
||||
<td>is an index base
|
||||
(<code>std::size_t</code>)</td></tr>
|
||||
<tr><td><code>VEC</code></td>
|
||||
<td>is any vector type</td></tr>
|
||||
<tr><td><code>MAT</code> </td>
|
||||
<td>is any matrix type</td></tr>
|
||||
<tr><td><code>[...]</code></td>
|
||||
<td>denote optional arguments - for more details
|
||||
look at the section "storage layout".</td></tr>
|
||||
</table>
|
||||
|
||||
<h2><a id="vectors">Vectors</a></h2>
|
||||
<table border="1" summary="vector types">
|
||||
<thead>
|
||||
<tr>
|
||||
<th width="30%">Definition</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>vector<T [, A]><br /> v(size);</code></td>
|
||||
<td>a dense vector of values of type <code>T</code> of variable
|
||||
size. A storage type <code>A</code> can be specified
|
||||
which defaults to <code>unbounded_array</code>.
|
||||
Elements are constructed by <code>A</code>, which need not initialise their value.</td>
|
||||
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>bounded_vector<T, N><br /> v;</code></td>
|
||||
<td>a dense vector of values of type <code>T</code> of variable size but with maximum
|
||||
<code>N</code>. The default constructor creates <code>v</code>
|
||||
with size <code>N</code>.
|
||||
Elements are constructed by the storage type <code>bounded_array</code>, which need not initialise their value.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>c_vector<T, M><br /> v(size);</code></td>
|
||||
<td>a dense vector of values of type <code>T</code> with the given size.
|
||||
The data is stored as an ordinary C++ array <code>T
|
||||
data_[M]</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>zero_vector<T><br /> v(size);</code></td>
|
||||
<td>the zero vector of type <code>T</code> with the given
|
||||
size.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>unit_vector<T><br /> v(size, index);</code></td>
|
||||
<td>the unit vector of type <code>T</code> with the given size. The
|
||||
vector is zero other then a single specified element.
|
||||
<br/><code>index</code> should be less than <code>size</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>mapped_vector<T [, S]><br /> v(size);</code></td>
|
||||
<td>a sparse vector of values of type <code>T</code> of variable
|
||||
size. The sparse storage type <code>S</code> can be <code>std::map<size_t,
|
||||
T></code> or <code>map_array<size_t, T></code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>compressed_vector<T [,IB, IA, TA]><br /> v(size);</code></td>
|
||||
<td>a sparse vector of values of type <code>T</code> of variable
|
||||
size. The non zero values are stored as two seperate arrays - an
|
||||
index array and a value array. The index array is always sorted and
|
||||
there is at most one entry for each index.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>coordinate_vector<T [,IB, IA, TA]><br /> v(size);</code></td>
|
||||
<td>a sparse vector of values of type <code>T</code> of variable
|
||||
size. The non zero values are stored as two seperate arrays - an
|
||||
index array and a value array. The arrays may be out of order with
|
||||
multiple entries for each vector element. If there are multiple
|
||||
values for the same index the sum of these values is the real
|
||||
value.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<p><em>Note:</em> the default types are defined in
|
||||
<code>boost/numeric/ublas/fwd.hpp</code>.</p>
|
||||
|
||||
<h2><a id="vector_proxies">Vector Proxies</a></h2>
|
||||
|
||||
<table border="1" summary="vector proxies">
|
||||
<thead>
|
||||
<tr>
|
||||
<th width="30%">Definition</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>vector_range<VEC><br /> vr(v, range);</code></td>
|
||||
<td>a vector referencing a continuous subvector of elements of
|
||||
vector <code>v</code> containing all elements specified by
|
||||
<code>range</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>vector_slice<VEC><br /> vs(v, slice);</code></td>
|
||||
<td>a vector referencing a non continuous subvector of elements of
|
||||
vector <code>v</code> containing all elements specified by
|
||||
<code>slice</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>matrix_row<MAT><br /> vr(m, index);</code></td>
|
||||
<td>a vector referencing the <code>index</code>-th row of matrix
|
||||
<code>m</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>matrix_column<MAT><br /> vc(m, index);</code></td>
|
||||
<td>a vector referencing the <code>index</code>-th column of matrix
|
||||
<code>m</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
<h2><a id="matrices">Matrices</a></h2>
|
||||
|
||||
<table border="1" summary="matrix types">
|
||||
<thead>
|
||||
<tr>
|
||||
<th width="30%">Definition</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>matrix<T [, F, A]><br /> m(size1, size2);</code></td>
|
||||
<td>a dense matrix of values of type <code>T</code> of variable
|
||||
size. A storage type <code>A</code> can be specified
|
||||
which defaults to <code>unbounded_array</code>.
|
||||
The orientation functor <code>F</code> defaults to
|
||||
<code>row_major</code>.
|
||||
Elements are constructed by <code>A</code>, which need not initialise their value.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>bounded_matrix<T, M, N [, F]><br /> m;</code></td>
|
||||
<td>a dense matrix of type <code>T</code> with variable size with maximum <code>M</code>-by-<code>N</code>. The orientation functor <code>F</code>
|
||||
defaults to <code>row_major</code>. The default constructor creates
|
||||
<code>m</code> with size <code>M</code>-by-<code>N</code>.
|
||||
Elements are constructed by the storage type <code>bounded_array</code>, which need not initialise their value.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>c_matrix<T, M, N><br /> m(size1, size2);</code></td>
|
||||
<td>a dense matrix of values of type <code>T</code> with the given size.
|
||||
The data is stored as an ordinary C++ array <code>T
|
||||
data_[N][M]</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>vector_of_vector<T [, F, A]><br /> m(size1,
|
||||
size2);</code></td>
|
||||
<td>a dense matrix of values of type <code>T</code> with the given size.
|
||||
The data is stored as a vector of vectors. The orientation
|
||||
<code>F</code> defaults to <code>row_major</code>. The storage
|
||||
type <code>S</code> defaults to
|
||||
<code>unbounded_array<unbounded_array<T> ></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>zero_matrix<T><br /> m(size1, size2);</code></td>
|
||||
<td>a zero matrix of type <code>T</code> with the given size.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>identity_matrix<T><br /> m(size1, size2);</code></td>
|
||||
<td>an identity matrix of type <code>T</code> with the given size.
|
||||
The values are <code>v(i,j) = (i==j)?T(1):T()</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>scalar_matrix<T><br /> m(size1, size2,
|
||||
value);</code></td>
|
||||
<td>a matrix of type <code>T</code> with the given size that has the
|
||||
value <code>value</code> everywhere.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>triangular_matrix<T [, TRI, F, A]><br />
|
||||
m(size);</code></td>
|
||||
<td>a triangular matrix of values of type <code>T</code> of
|
||||
variable size. Only the nonzero elements are stored in the given
|
||||
order <code>F</code>. ("triangular packed storage") The triangular
|
||||
type <code>F</code> defaults to <code>lower</code>, the orientation
|
||||
type <code>F</code> defaults to <code>row_major</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>banded_matrix<T [, F, A]><br /> m(size1, size2, n_lower,
|
||||
n_upper);</code></td>
|
||||
<td>a banded matrix of values of type <code>T</code> of variable
|
||||
size with <code>n_lower</code> sub diagonals and
|
||||
<code>n_upper</code> super diagonals. Only the nonzero elements are
|
||||
stored in the given order <code>F</code>. ("packed storage")</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>symmetric_matrix<T [, TRI, F, A]><br />
|
||||
m(size);</code></td>
|
||||
<td>a symmetric matrix of values of type <code>T</code> of
|
||||
variable size. Only the given triangular matrix is stored in the
|
||||
given order <code>F</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>hermitian_matrix<T [, TRI, F, A]><br />
|
||||
m(size);</code></td>
|
||||
<td>a hermitian matrix of values of type <code>T</code> of
|
||||
variable size. Only the given triangular matrix is stored using
|
||||
the order <code>F</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>mapped_matrix<T, [F, S]><br /> m(size1, size2 [,
|
||||
non_zeros]);</code></td>
|
||||
<td>a sparse matrix of values of type <code>T</code> of variable
|
||||
size. The sparse storage type <code>S</code> can be either <code>std::map<size_t,
|
||||
std::map<size_t, T> ></code> or
|
||||
<code>map_array<size_t, map_array<size_t,
|
||||
T> ></code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>sparse_vector_of_sparse_vector<T, [F, C]><br /> m(size1,
|
||||
size2 [, non_zeros]);</code></td>
|
||||
<td>a sparse matrix of values of type <code>T</code> of variable
|
||||
size.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>compressed_matrix<T, [F, IB, IA, TA]><br /> m(size1,
|
||||
size2 [, non_zeros]);</code></td>
|
||||
<td>a sparse matrix of values of type <code>T</code> of variable
|
||||
size. The values are stored in compressed row/column storage.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>coordinate_matrix<T, [F, IB, IA, TA]><br /> m(size1,
|
||||
size2 [, non_zeros]);</code></td>
|
||||
<td>a sparse matrix of values of type <code>T</code> of variable
|
||||
size. The values are stored in 3 parallel array as triples (i, j,
|
||||
value). More than one value for each pair of indices is possible,
|
||||
the real value is the sum of all.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>generalized_vector_of_vector<T, F, A><br /> m(size1,
|
||||
size2 [, non_zeros]);</code></td>
|
||||
<td>a sparse matrix of values of type <code>T</code> of variable
|
||||
size. The values are stored as a vector of sparse vectors, e.g.
|
||||
<code>generalized_vector_of_vector<double, row_major,
|
||||
unbounded_array<coordinate_vector<double> > ></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<p><em>Note:</em> the default types are defined in
|
||||
<code>boost/numeric/ublas/fwd.hpp</code>.</p>
|
||||
|
||||
<h2><a id="matrix_proxies">Matrix Proxies</a></h2>
|
||||
|
||||
<table border="1" summary="matrix proxies">
|
||||
<thead>
|
||||
<tr>
|
||||
<th width="30%">Definition</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>triangular_adaptor<MAT, TRI><br /> ta(m);</code></td>
|
||||
<td>a triangular matrix referencing a selection of elements of the
|
||||
matrix <code>m</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>symmetric_adaptor<MAT, TRI><br /> sa(m);</code></td>
|
||||
<td>a symmetric matrix referencing a selection of elements of the
|
||||
matrix <code>m</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>hermitian_adaptor<MAT, TRI><br /> ha(m);</code></td>
|
||||
<td>a hermitian matrix referencing a selection of elements of the
|
||||
matrix <code>m</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>banded_adaptor<MAT><br /> ba(m, n_lower,
|
||||
n_upper);</code></td>
|
||||
<td>a banded matrix referencing a selection of elements of the
|
||||
matrix <code>m</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>matrix_range<MAT, TRI><br /> mr(m, range1,
|
||||
range2);</code></td>
|
||||
<td>a matrix referencing a submatrix of elements in the matrix
|
||||
<code>m</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>matrix_slice<MAT, TRI><br /> ms(m, slice1,
|
||||
slice2);</code></td>
|
||||
<td>a matrix referencing a non continues submatrix of elements in
|
||||
the matrix <code>m</code>.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
<h2><a id="storage_layout">Special Storage Layouts</a></h2>
|
||||
|
||||
|
||||
<p>The library supports conventional dense, packed and basic sparse
|
||||
vector and matrix storage layouts. The description of the most
|
||||
common constructions of vectors and matrices comes next.</p>
|
||||
|
||||
<table border="1" summary="storage layouts">
|
||||
<tbody>
|
||||
<tr>
|
||||
<th width="30%">Construction</th>
|
||||
<th>Comment</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>vector<T,<br />
|
||||
std::vector<T> ><br />
|
||||
v (size)</code></td>
|
||||
<td>a dense vector, storage is provided by a standard
|
||||
vector.<br />
|
||||
The storage layout usually is BLAS compliant.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>vector<T,<br />
|
||||
unbounded_array<T> ><br />
|
||||
v (size)</code></td>
|
||||
<td>a dense vector, storage is provided by a heap-based
|
||||
array.<br />
|
||||
The storage layout usually is BLAS compliant.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>vector<T,<br />
|
||||
bounded_array<T, N> ><br />
|
||||
v (size)</code></td>
|
||||
<td>a dense vector, storage is provided by a stack-based
|
||||
array.<br />
|
||||
The storage layout usually is BLAS compliant.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>mapped_vector<T,<br />
|
||||
std::map<std::size_t, T> ><br />
|
||||
v (size, non_zeros)</code></td>
|
||||
<td>a sparse vector, storage is provided by a standard
|
||||
map.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>mapped_vector<T,<br />
|
||||
map_array<std::size_t, T> ><br />
|
||||
v (size, non_zeros)</code></td>
|
||||
<td>a sparse vector, storage is provided by a map
|
||||
array.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>matrix<T,<br />
|
||||
row_major,<br />
|
||||
std::vector<T> ><br />
|
||||
m (size1, size2)</code></td>
|
||||
<td>a dense matrix, orientation is row major, storage is
|
||||
provided by a standard vector.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>matrix<T,<br />
|
||||
column_major,<br />
|
||||
std::vector<T> ><br />
|
||||
m (size1, size2)</code></td>
|
||||
<td>a dense matrix, orientation is column major, storage
|
||||
is provided by a standard vector.<br />
|
||||
The storage layout usually is BLAS compliant.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>matrix<T,<br />
|
||||
row_major,<br />
|
||||
unbounded_array<T> ><br />
|
||||
m (size1, size2)</code></td>
|
||||
<td>a dense matrix, orientation is row major, storage is
|
||||
provided by a heap-based array.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>matrix<T,<br />
|
||||
column_major,<br />
|
||||
unbounded_array<T> ><br />
|
||||
m (size1, size2)</code></td>
|
||||
<td>a dense matrix, orientation is column major, storage
|
||||
is provided by a heap-based array.<br />
|
||||
The storage layout usually is BLAS compliant.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>matrix<T,<br />
|
||||
row_major,<br />
|
||||
bounded_array<T, N1 * N2> ><br />
|
||||
m (size1, size2)</code></td>
|
||||
<td>a dense matrix, orientation is row major, storage is
|
||||
provided by a stack-based array.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>matrix<T,<br />
|
||||
column_major,<br />
|
||||
bounded_array<T, N1 * N2> ><br />
|
||||
m (size1, size2)</code></td>
|
||||
<td>a dense matrix, orientation is column major, storage
|
||||
is provided by a stack-based array.<br />
|
||||
The storage layout usually is BLAS compliant.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>triangular_matrix<T,<br />
|
||||
row_major, F, A><br />
|
||||
m (size)</code></td>
|
||||
<td>a packed triangular matrix, orientation is row
|
||||
major.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>triangular_matrix<T,<br />
|
||||
column_major, F, A><br />
|
||||
m (size)</code></td>
|
||||
<td>a packed triangular matrix, orientation is column
|
||||
major.<br />
|
||||
The storage layout usually is BLAS compliant.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>banded_matrix<T,<br />
|
||||
row_major, A><br />
|
||||
m (size1, size2, lower, upper)</code></td>
|
||||
<td>a packed banded matrix, orientation is row
|
||||
major.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>banded_matrix<T,<br />
|
||||
column_major, A><br />
|
||||
m (size1, size2, lower, upper)</code></td>
|
||||
<td>a packed banded matrix, orientation is column
|
||||
major.<br />
|
||||
The storage layout usually is BLAS compliant.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>symmetric_matrix<T,<br />
|
||||
row_major, F, A><br />
|
||||
m (size)</code></td>
|
||||
<td>a packed symmetric matrix, orientation is row
|
||||
major.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>symmetric_matrix<T,<br />
|
||||
column_major, F, A><br />
|
||||
m (size)</code></td>
|
||||
<td>a packed symmetric matrix, orientation is column
|
||||
major.<br />
|
||||
The storage layout usually is BLAS compliant.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>hermitian_matrix<T,<br />
|
||||
row_major, F, A><br />
|
||||
m (size)</code></td>
|
||||
<td>a packed hermitian matrix, orientation is row
|
||||
major.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>hermitian_matrix<T,<br />
|
||||
column_major, F, A><br />
|
||||
m (size)</code></td>
|
||||
<td>a packed hermitian matrix, orientation is column
|
||||
major.<br />
|
||||
The storage layout usually is BLAS compliant.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>mapped_matrix<T,<br />
|
||||
row_major,<br />
|
||||
std::map<std::size_t, T> ><br />
|
||||
m (size1, size2, non_zeros)</code></td>
|
||||
<td>a sparse matrix, orientation is row major, storage
|
||||
is provided by a standard map.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>mapped_matrix<T,<br />
|
||||
column_major,<br />
|
||||
std::map<std::size_t, T> ><br />
|
||||
m (size1, size2, non_zeros)</code></td>
|
||||
<td>a sparse matrix, orientation is column major,
|
||||
storage is provided by a standard map.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>mapped_matrix<T,<br />
|
||||
row_major,<br />
|
||||
map_array<std::size_t, T> ><br />
|
||||
m (size1, size2, non_zeros)</code></td>
|
||||
<td>a sparse matrix, orientation is row major, storage
|
||||
is provided by a map array.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>mapped_matrix<T,<br />
|
||||
column_major,<br />
|
||||
map_array<std::size_t, T> ><br />
|
||||
m (size1, size2, non_zeros)</code></td>
|
||||
<td>a sparse matrix, orientation is column major,
|
||||
storage is provided by a map array.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>compressed_matrix<T,<br />
|
||||
row_major><br />
|
||||
m (size1, size2, non_zeros)</code></td>
|
||||
<td>a compressed matrix, orientation is row major.<br />
|
||||
The storage layout usually is BLAS compliant.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>compressed_matrix<T,<br />
|
||||
column_major><br />
|
||||
m (size1, size2, non_zeros)</code></td>
|
||||
<td>a compressed matrix, orientation is column
|
||||
major.<br />
|
||||
The storage layout usually is BLAS compliant.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>coordinate_matrix<T,<br />
|
||||
row_major><br />
|
||||
m (size1, size2, non_zeros)</code></td>
|
||||
<td>a coordinate matrix, orientation is row major.<br />
|
||||
The storage layout usually is BLAS compliant.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>coordinate_matrix<T,<br />
|
||||
column_major><br />
|
||||
m (size1, size2, non_zeros)</code></td>
|
||||
<td>a coordinate matrix, orientation is column
|
||||
major.<br />
|
||||
The storage layout usually is BLAS compliant.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
<hr />
|
||||
<p>Copyright (©) 2000-2004 Joerg Walter, Mathias Koch, Gunter
|
||||
Winkler, Michael Stevens<br />
|
||||
Use, modification and distribution are subject to the
|
||||
Boost Software License, Version 1.0.
|
||||
(See accompanying file LICENSE_1_0.txt
|
||||
or copy at <a href="http://www.boost.org/LICENSE_1_0.txt">
|
||||
http://www.boost.org/LICENSE_1_0.txt
|
||||
</a>).
|
||||
</p>
|
||||
<script type="text/javascript">
|
||||
(function($) {
|
||||
$('#toc').toc();
|
||||
})(jQuery);
|
||||
</script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,59 @@
|
||||
/*
|
||||
* Copyright 2000-2009 Michael Stevens, Mathias Koch,
|
||||
* Joerg Walter, Gunter Winkler.
|
||||
*
|
||||
* Use, modification and distribution are subject to 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).
|
||||
*/
|
||||
table {
|
||||
border-width: medium;
|
||||
background-color: #F8F8F8;
|
||||
margin: 1em;
|
||||
}
|
||||
|
||||
td {
|
||||
padding-left: 0.5em;
|
||||
padding-right: 0.5em;
|
||||
}
|
||||
|
||||
th {
|
||||
text-align: left;
|
||||
}
|
||||
|
||||
pre.screen {
|
||||
border: 1px solid #DCDCDC;
|
||||
display: block;
|
||||
font-size: 9pt;
|
||||
margin: 1pc 4% 0;
|
||||
padding: 0.5pc;
|
||||
}
|
||||
|
||||
p.credit {
|
||||
font-style: italic;
|
||||
}
|
||||
|
||||
@media print {
|
||||
div.toc { display: none; }
|
||||
}
|
||||
|
||||
div.toc {
|
||||
margin: 10px;
|
||||
padding: 3px;
|
||||
}
|
||||
|
||||
div#toc ul {
|
||||
list-style: none;
|
||||
margin: 1px;
|
||||
padding-left: 1em;
|
||||
margin-bottom: 0.25em;
|
||||
}
|
||||
|
||||
div#toc ul li ul {
|
||||
margin-bottom: 0.25em;
|
||||
}
|
||||
|
||||
div#toc ul li ul li ul {
|
||||
margin-bottom: 0.25em;
|
||||
}
|
||||
@@ -0,0 +1,219 @@
|
||||
<!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 rel="stylesheet" href="../../../../boost.css" type="text/css"/>
|
||||
<link rel="stylesheet" href="ublas.css" type="text/css" />
|
||||
<script type="text/javascript" src="js/jquery-1.3.2.min.js" async="async" ></script>
|
||||
<script type="text/javascript" src="js/jquery.toc-gw.js" async="async" ></script>
|
||||
<title>Unbounded array</title>
|
||||
</head>
|
||||
<body>
|
||||
<h1><img src="../../../../boost.png" align="middle" />Unbounded Array Storage</h1>
|
||||
<div class="toc" id="toc"></div>
|
||||
<h2><a name="unbounded_array"></a>Unbounded Array</h2>
|
||||
<h4>Description</h4>
|
||||
<p>The templated class <code>unbounded_array<T, ALLOC></code> implements a unbounded storage array using an allocator.
|
||||
The unbounded array is similar to a <code>std::vector</code> in that in can grow in size beyond any fixed bound.
|
||||
However <code>unbounded_array</code> is aimed at optimal performance. Therefore <code>unbounded_array</code> does not model a
|
||||
<code>Sequence</code> like <code>std::vector</code> does.
|
||||
<p>When resized <code>unbounded_array</code> will reallocate it's storage even if the new size requirement is smaller. It is therefore inefficient to resize a <code>unbounded_array</code></p>
|
||||
<h4>Example</h4>
|
||||
<pre>
|
||||
#include <boost/numeric/ublas/storage.hpp>
|
||||
|
||||
int main () {
|
||||
using namespace boost::numeric::ublas;
|
||||
unbounded_array<double> a (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>
|
||||
<tr>
|
||||
<td><code>ALLOC</code></td>
|
||||
<td>An STL Allocator</td>
|
||||
<td>std::allocator</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4>Model of</h4>
|
||||
<p><a href="storage_concept.html">Storage</a></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>
|
||||
</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><font color="blue">allocator_type</font></td><td></td><td>Defined as ALLOC</td></tr>
|
||||
<tr>
|
||||
<td><code><em>explicit</em> unbounded_array (<em>ALLOC &a = ALLOC()</em>)</code></td>
|
||||
<td><a href="storage_concept.html">Storage</a></td>
|
||||
<td>Creates an <code>unbounded_array</code> that holds zero elements, using a specified allocator.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code><em>explicit</em> unbounded_array (size_type size<em>, ALLOC &a = ALLOC()</em>)</code></td>
|
||||
<td><a href="storage_concept.html">Storage</a></td>
|
||||
<td>Creates a uninitialized <code>unbounded_array</code> that holds <code>size</code> elements, using a specified allocator. All the elements are default constructed.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>unbounded_array (size_type size, const T& init<em>, ALLOC& a = ALLOC()</em>)</code></td>
|
||||
<td><a href="storage_concept.html">Storage</a></td>
|
||||
<td>Creates an initialized <code>unbounded_array</code> that holds <code>size</code> elements, using a specified allocator. All the elements are constructed from the <code>init</code> value.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>unbounded_array (const unbounded_array &a)</code></td>
|
||||
<td><a href="http://www.sgi.com/tech/stl/Container.html">Container</a></td>
|
||||
<td>The copy constructor.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>~unbounded_array ()</code></td>
|
||||
<td><a href="http://www.sgi.com/tech/stl/Container.html">Container</a></td>
|
||||
<td>Deallocates the <code>unbounded_array</code> itself.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>void resize (size_type n)</code></td>
|
||||
<td><a href="storage_concept.html">Storage</a></td>
|
||||
<td>Reallocates an <code>unbounded_array</code> to hold <code>n</code> elements. Values are uninitialised.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>void resize(size_type n, const T& t)</code></td>
|
||||
<td><a href="storage_concept.html">Storage</a></td>
|
||||
<td>Reallocates an <code>unbounded_array</code> to hold <code>n</code> elements. Values are copies of <code>t</code>
|
||||
</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>unbounded_array</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>unbounded_array &operator = (const unbounded_array &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>unbounded_array &assign_temporary (unbounded_array &a)</code></font></td>
|
||||
<td></td>
|
||||
<td>Assigns a temporary. May change the array <code>a</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>void swap (unbounded_array &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>unbounded_array</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>unbounded_array</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>unbounded_array</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>unbounded_array</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>unbounded_array</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>unbounded_array</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>unbounded_array</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>unbounded_array</code>.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<hr />
|
||||
<p>Copyright (©) 2000-2002 Joerg Walter, Mathias Koch<br />
|
||||
Use, modification and distribution are subject to the
|
||||
Boost Software License, Version 1.0.
|
||||
(See accompanying file LICENSE_1_0.txt
|
||||
or copy at <a href="http://www.boost.org/LICENSE_1_0.txt">
|
||||
http://www.boost.org/LICENSE_1_0.txt
|
||||
</a>).
|
||||
</p>
|
||||
<script type="text/javascript">
|
||||
(function($) {
|
||||
$('#toc').toc();
|
||||
})(jQuery);
|
||||
</script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,755 @@
|
||||
<!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 name="generator" content=
|
||||
"HTML Tidy for Linux/x86 (vers 1st March 2004), see www.w3.org" />
|
||||
<meta http-equiv="Content-Type" content=
|
||||
"text/html; charset=us-ascii" />
|
||||
<link rel="stylesheet" href="../../../../boost.css" type="text/css"/>
|
||||
<link rel="stylesheet" href="ublas.css" type="text/css" />
|
||||
<script type="text/javascript" src="js/jquery-1.3.2.min.js" async="async" ></script>
|
||||
<script type="text/javascript" src="js/jquery.toc-gw.js" async="async" ></script>
|
||||
<title>Vector</title>
|
||||
</head>
|
||||
<body>
|
||||
<h1><img src="../../../../boost.png" align="middle" />Vector</h1>
|
||||
<div class="toc" id="toc"></div>
|
||||
<h2><a name="vector"></a>Vector</h2>
|
||||
<h4>Description</h4>
|
||||
<p>The templated class <code>vector<T, A></code> is the base
|
||||
container adaptor for dense vectors. For a <em>n</em>-dimensional
|
||||
vector and <em>0 <= i < n</em> every element
|
||||
<em>v</em><sub><em>i</em></sub> is mapped to the <em>i-</em>th
|
||||
element of the container.</p>
|
||||
<h4>Example</h4>
|
||||
<pre>
|
||||
#include <boost/numeric/ublas/vector.hpp>
|
||||
#include <boost/numeric/ublas/io.hpp>
|
||||
|
||||
int main () {
|
||||
using namespace boost::numeric::ublas;
|
||||
vector<double> v (3);
|
||||
for (unsigned i = 0; i < v.size (); ++ i)
|
||||
v (i) = i;
|
||||
std::cout << v << std::endl;
|
||||
}
|
||||
</pre>
|
||||
<h4>Definition</h4>
|
||||
<p>Defined in the header vector.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 vector.</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>A</code></td>
|
||||
<td>The type of the <a href="storage_concept.html">Storage</a> array. <a href="#vector_1">[1]</a></td>
|
||||
<td><code>unbounded_array<T></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4>Model of</h4>
|
||||
<p><a href="container_concept.html#vector">Vector</a>,
|
||||
<a href="http://www.sgi.com/tech/stl/RandomAccessContainer.html">RandomAccessContainer</a>
|
||||
</p>
|
||||
<h4>Type requirements</h4>
|
||||
<p>None, except for those imposed by the requirements of <a href=
|
||||
"container_concept.html#vector">Vector</a>
|
||||
and <a href="http://www.sgi.com/tech/stl/RandomAccessContainer.html">RandomAccessContainer</a>.</p>
|
||||
<h4>Public base classes</h4>
|
||||
<p><code>vector_container<vector<T, A> ></code></p>
|
||||
<h4>Members</h4>
|
||||
<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><a href="expression_concept.html#vector_expression">VectorExpression</a></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>reference</code>
|
||||
<td><a href="expression_concept.html#vector_expression">VectorExpression</a></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_reference</code>
|
||||
<td><a href="expression_concept.html#vector_expression">VectorExpression</a></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>size_type</code>
|
||||
<td><a href="expression_concept.html#vector_expression">VectorExpression</a></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>difference_type</code>
|
||||
<td><a href="expression_concept.html#vector_expression">VectorExpression</a></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_iterator</code>
|
||||
<td><a href="expression_concept.html#vector_expression">VectorExpression</a></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>iterator</code>
|
||||
<td><a href="expression_concept.html#vector_expression">VectorExpression</a></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_reverse_iterator</code>
|
||||
<td><a href="expression_concept.html#vector_expression">VectorExpression</a></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>reverse_iterator</code>
|
||||
<td><a href="expression_concept.html#vector_expression">VectorExpression</a></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>array_type</code>
|
||||
<td><a href="container_concept.html#vector">Vector</a></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>vector ()</code></td>
|
||||
<td><a href="expression_concept.html#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.html#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.html#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.html#vector_expression">VectorExpression</a></td>
|
||||
<td>Returns the size of the <code>vector</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>size_type max_size () const</code></td>
|
||||
<td><a href="http://www.sgi.com/tech/stl/RandomAccessContainer.html">RandomAccessContainer</a></td>
|
||||
<td>Returns the upper bound on the size of the <code>vector</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>bool empty () const</code></td>
|
||||
<td><a href="http://www.sgi.com/tech/stl/RandomAccessContainer.html">RandomAccessContainer</a></td>
|
||||
<td>Equivilent to <code>size () == 0</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const array_type& data () const</code></td>
|
||||
<td><a href="container_concept.html#vector">Vector</a></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>array_type& data ()</code></td>
|
||||
<td><a href="container_concept.html#vector">Vector</a></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_reference operator () (size_type i)
|
||||
const</code></td>
|
||||
<td><a href="expression_concept.html#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.html#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><a href="container_concept.html#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.html#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.html#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.html#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.html#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.html#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>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
vector &operator += (const vector_expression<AE>
|
||||
&ae)</code></td>
|
||||
<td><a href="expression_concept.html#vector_expression">VectorExpression</a></td>
|
||||
<td>A computed assignment operator. Adds the vector expression to
|
||||
the vector.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
vector &plus_assign (const vector_expression<AE>
|
||||
&ae)</code></td>
|
||||
<td><a href="expression_concept.html#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>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
vector &operator -= (const vector_expression<AE>
|
||||
&ae)</code></td>
|
||||
<td><a href="expression_concept.html#vector_expression">VectorExpression</a></td>
|
||||
<td>A computed assignment operator. Subtracts the vector expression
|
||||
from the vector.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
vector &minus_assign (const vector_expression<AE>
|
||||
&ae)</code></td>
|
||||
<td><a href="expression_concept.html#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.html#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.html#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.html#vector_expression">VectorExpression</a></td>
|
||||
<td>Swaps the contents of the vectors.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>void insert_element (size_type i, const_reference t)</code></td>
|
||||
<td><a href="container_concept.html#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_element (size_type i)</code></td>
|
||||
<td><a href="container_concept.html#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.html#vector">Vector</a></td>
|
||||
<td>Clears the vector.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_iterator begin () const</code></td>
|
||||
<td><a href="expression_concept.html#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.html#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.html#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.html#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.html#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.html#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.html#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.html#vector_expression">VectorExpression</a></td>
|
||||
<td>Returns a <code>reverse_iterator</code> pointing to the end of
|
||||
the reversed <code>vector</code>.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4>Notes</h4>
|
||||
<p><a name="vector_1">[1]</a> Common parameters
|
||||
for the Storage array are <code>unbounded_array<T></code> ,
|
||||
<code>bounded_array<T></code> and
|
||||
<code>std::vector<T></code> .</p>
|
||||
<h2><a name="unit_vector"></a>Unit Vector</h2>
|
||||
<h4>Description</h4>
|
||||
<p>The templated class <code>unit_vector<T, ALLOC></code> represents
|
||||
canonical unit vectors. For the <em>k</em>-th
|
||||
<em>n</em>-dimensional canonical unit vector and <em>0 <= i <
|
||||
n</em> holds <em>u</em><sup><em>k</em></sup><sub><em>i</em></sub>
|
||||
<em>= 0</em>, if <em>i <> k</em>, and
|
||||
<em>u</em><sup><em>k</em></sup><sub><em>i</em></sub> <em>=
|
||||
1</em>.</p>
|
||||
<h4>Example</h4>
|
||||
<pre>
|
||||
#include <boost/numeric/ublas/vector.hpp>
|
||||
#include <boost/numeric/ublas/io.hpp>
|
||||
|
||||
int main () {
|
||||
using namespace boost::numeric::ublas;
|
||||
for (int i = 0; i < 3; ++ i) {
|
||||
unit_vector<double> v (3, i);
|
||||
std::cout << v << std::endl;
|
||||
}
|
||||
}
|
||||
</pre>
|
||||
<h4>Definition</h4>
|
||||
<p>Defined in the header vector.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 vector.</td>
|
||||
<td><code>int</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>ALLOC</code></td>
|
||||
<td>An STL Allocator for size_type and difference_type.</td>
|
||||
<td>std::allocator</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4>Model of</h4>
|
||||
<p><a href="container_concept.html#vector">Vector</a> .</p>
|
||||
<h4>Type requirements</h4>
|
||||
<p>None, except for those imposed by the requirements of
|
||||
<a href="container_concept.html#vector">Vector</a> .</p>
|
||||
<h4>Public base classes</h4>
|
||||
<p><code>vector_container<unit_vector<T> ></code></p>
|
||||
<h4>Members</h4>
|
||||
<table border="1" summary="members">
|
||||
<tbody>
|
||||
<tr>
|
||||
<th>Member</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>unit_vector ()</code></td>
|
||||
<td>Constructs an <code>unit_vector</code> that holds zero
|
||||
elements.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>unit_vector (size_type size, size_type index)</code></td>
|
||||
<td>Constructs the <code>index</code>-th <code>unit_vector</code>
|
||||
that holds <code>size</code> elements.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>unit_vector (const unit_vector &v)</code></td>
|
||||
<td>The copy constructor.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>void resize (size_type size, bool preserve =
|
||||
true)</code></td>
|
||||
<td>Resizes a <code>unit_vector</code> to hold <code>size</code>
|
||||
elements. Therefore the existing elements of the
|
||||
<code>unit_vector</code> are always preseved.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>size_type size () const</code></td>
|
||||
<td>Returns the size of the <code>unit_vector</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>size_type index () const</code></td>
|
||||
<td>Returns the index of the <code>unit_vector</code>.</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_reference operator [] (size_type i)
|
||||
const</code></td>
|
||||
<td>Returns the value of the <code>i</code>-th element.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>unit_vector &operator = (const unit_vector
|
||||
&v)</code></td>
|
||||
<td>The assignment operator.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>unit_vector &assign_temporary (unit_vector
|
||||
&v)</code></td>
|
||||
<td>Assigns a temporary. May change the unit vector <code>v</code>
|
||||
.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>void swap (unit_vector &v)</code></td>
|
||||
<td>Swaps the contents of the unit vectors.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_iterator begin () const</code></td>
|
||||
<td>Returns a <code>const_iterator</code> pointing to the beginning
|
||||
of the <code>unit_vector</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_iterator end () const</code></td>
|
||||
<td>Returns a <code>const_iterator</code> pointing to the end of
|
||||
the <code>unit_vector</code>.</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 <code>unit_vector</code>.</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 <code>unit_vector</code>.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a name="zero_vector"></a>Zero Vector</h2>
|
||||
<h4>Description</h4>
|
||||
<p>The templated class <code>zero_vector<T, ALLOC></code> represents
|
||||
zero vectors. For a <em>n</em>-dimensional zero vector and <em>0
|
||||
<= i < n</em> holds <em>z</em><sub><em>i</em></sub> <em>=
|
||||
0</em>.</p>
|
||||
<h4>Example</h4>
|
||||
<pre>
|
||||
#include <boost/numeric/ublas/vector.hpp>
|
||||
#include <boost/numeric/ublas/io.hpp>
|
||||
|
||||
int main () {
|
||||
using namespace boost::numeric::ublas;
|
||||
zero_vector<double> v (3);
|
||||
std::cout << v << std::endl;
|
||||
}
|
||||
</pre>
|
||||
<h4>Definition</h4>
|
||||
<p>Defined in the header vector.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 vector.</td>
|
||||
<td><code>int</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>ALLOC</code></td>
|
||||
<td>An STL Allocator for size_type and difference_type.</td>
|
||||
<td>std::allocator</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4>Model of</h4>
|
||||
<p><a href="container_concept.html#vector">Vector</a> .</p>
|
||||
<h4>Type requirements</h4>
|
||||
<p>None, except for those imposed by the requirements of
|
||||
<a href="container_concept.html#vector">Vector</a> .</p>
|
||||
<h4>Public base classes</h4>
|
||||
<p><code>vector_container<zero_vector<T> ></code></p>
|
||||
<h4>Members</h4>
|
||||
<table border="1" summary="members">
|
||||
<tbody>
|
||||
<tr>
|
||||
<th>Member</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>zero_vector ()</code></td>
|
||||
<td>Constructs a <code>zero_vector</code> that holds zero
|
||||
elements.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>zero_vector (size_type size)</code></td>
|
||||
<td>Constructs a <code>zero_vector</code> that holds
|
||||
<code>size</code> elements.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>zero_vector (const zero_vector &v)</code></td>
|
||||
<td>The copy constructor.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>void resize (size_type size, bool preserve =
|
||||
true)</code></td>
|
||||
<td>Resizes a <code>zero_vector</code> to hold <code>size</code>
|
||||
elements. Therefore the existing elements of the
|
||||
<code>zero_vector</code> are always preseved.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>size_type size () const</code></td>
|
||||
<td>Returns the size of the <code>zero_vector</code>.</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_reference operator [] (size_type i)
|
||||
const</code></td>
|
||||
<td>Returns the value of the <code>i</code>-th element.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>zero_vector &operator = (const zero_vector
|
||||
&v)</code></td>
|
||||
<td>The assignment operator.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>zero_vector &assign_temporary (zero_vector
|
||||
&v)</code></td>
|
||||
<td>Assigns a temporary. May change the zero vector <code>v</code>
|
||||
.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>void swap (zero_vector &v)</code></td>
|
||||
<td>Swaps the contents of the zero vectors.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_iterator begin () const</code></td>
|
||||
<td>Returns a <code>const_iterator</code> pointing to the beginning
|
||||
of the <code>zero_vector</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_iterator end () const</code></td>
|
||||
<td>Returns a <code>const_iterator</code> pointing to the end of
|
||||
the <code>zero_vector</code>.</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 <code>zero_vector</code>.</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 <code>zero_vector</code>.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a name="scalar_vector"></a>Scalar Vector</h2>
|
||||
<h4>Description</h4>
|
||||
<p>The templated class <code>scalar_vector<T, ALLOC></code>
|
||||
represents scalar vectors. For a <em>n</em>-dimensional scalar
|
||||
vector and <em>0 <= i < n</em> holds
|
||||
<em>z</em><sub><em>i</em></sub> <em>= s</em>.</p>
|
||||
<h4>Example</h4>
|
||||
<pre>
|
||||
#include <boost/numeric/ublas/vector.hpp>
|
||||
#include <boost/numeric/ublas/io.hpp>
|
||||
|
||||
int main () {
|
||||
using namespace boost::numeric::ublas;
|
||||
scalar_vector<double> v (3);
|
||||
std::cout << v << std::endl;
|
||||
}
|
||||
</pre>
|
||||
<h4>Definition</h4>
|
||||
<p>Defined in the header vector.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 vector.</td>
|
||||
<td><code>int</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>ALLOC</code></td>
|
||||
<td>An STL Allocator for size_type and difference_type.</td>
|
||||
<td>std::allocator</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4>Model of</h4>
|
||||
<p><a href="container_concept.html#vector">Vector</a> .</p>
|
||||
<h4>Type requirements</h4>
|
||||
<p>None, except for those imposed by the requirements of
|
||||
<a href="container_concept.html#vector">Vector</a> .</p>
|
||||
<h4>Public base classes</h4>
|
||||
<p><code>vector_container<scalar_vector<T>
|
||||
></code></p>
|
||||
<h4>Members</h4>
|
||||
<table border="1" summary="members">
|
||||
<tbody>
|
||||
<tr>
|
||||
<th>Member</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>scalar_vector ()</code></td>
|
||||
<td>Constructs a <code>scalar_vector</code> that holds zero
|
||||
elements.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>scalar_vector (size_type size, const value_type
|
||||
&value)</code></td>
|
||||
<td>Constructs a <code>scalar_vector</code> that holds
|
||||
<code>size</code> elements each of the specified value.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>scalar_vector (const scalar_vector &v)</code></td>
|
||||
<td>The copy constructor.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>void resize (size_type size, bool preserve =
|
||||
true)</code></td>
|
||||
<td>Resizes a <code>scalar_vector</code> to hold <code>size</code>
|
||||
elements. Therefore the existing elements of the
|
||||
<code>scalar_vector</code> are always preseved.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>size_type size () const</code></td>
|
||||
<td>Returns the size of the <code>scalar_vector</code>.</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_reference operator [] (size_type i)
|
||||
const</code></td>
|
||||
<td>Returns the value of the <code>i</code>-th element.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>scalar_vector &operator = (const scalar_vector
|
||||
&v)</code></td>
|
||||
<td>The assignment operator.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>scalar_vector &assign_temporary (scalar_vector
|
||||
&v)</code></td>
|
||||
<td>Assigns a temporary. May change the scalar vector
|
||||
<code>v</code> .</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>void swap (scalar_vector &v)</code></td>
|
||||
<td>Swaps the contents of the scalar vectors.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_iterator begin () const</code></td>
|
||||
<td>Returns a <code>const_iterator</code> pointing to the beginning
|
||||
of the <code>scalar_vector</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_iterator end () const</code></td>
|
||||
<td>Returns a <code>const_iterator</code> pointing to the end of
|
||||
the <code>scalar_vector</code>.</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 <code>scalar_vector</code>.</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 <code>scalar_vector</code>.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<hr />
|
||||
<p>Copyright (©) 2000-2002 Joerg Walter, Mathias Koch<br />
|
||||
Use, modification and distribution are subject to the
|
||||
Boost Software License, Version 1.0.
|
||||
(See accompanying file LICENSE_1_0.txt
|
||||
or copy at <a href="http://www.boost.org/LICENSE_1_0.txt">
|
||||
http://www.boost.org/LICENSE_1_0.txt
|
||||
</a>).
|
||||
</p>
|
||||
<script type="text/javascript">
|
||||
(function($) {
|
||||
$('#toc').toc();
|
||||
})(jQuery);
|
||||
</script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,969 @@
|
||||
<!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 name="generator" content=
|
||||
"HTML Tidy for Linux/x86 (vers 1st March 2004), see www.w3.org" />
|
||||
<meta http-equiv="Content-Type" content=
|
||||
"text/html; charset=us-ascii" />
|
||||
<link rel="stylesheet" href="../../../../boost.css" type="text/css"/>
|
||||
<link rel="stylesheet" href="ublas.css" type="text/css" />
|
||||
<script type="text/javascript" src="js/jquery-1.3.2.min.js" async="async" ></script>
|
||||
<script type="text/javascript" src="js/jquery.toc-gw.js" async="async" ></script>
|
||||
<title>Vector Expressions</title>
|
||||
</head>
|
||||
<body>
|
||||
<h1><img src="../../../../boost.png" align="middle" />Vector Expressions</h1>
|
||||
<div class="toc" id="toc"></div>
|
||||
<h2><a name="vector_expression"></a>Vector Expression</h2>
|
||||
<h4>Description</h4>
|
||||
<p>The templated class <code>vector_expression<E></code>
|
||||
is required to be a public base of all classes which model the Vector Expression concept.</p>
|
||||
<h4>Definition</h4>
|
||||
<p>Defined in the header expression_types.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>None. <u>Not a Vector Expression</u>!
|
||||
</p>
|
||||
<h4>Type requirements</h4>
|
||||
<p>None.</p>
|
||||
<h4>Public base classes</h4>
|
||||
<p>None.</p>
|
||||
<h4>Members</h4>
|
||||
<table border="1" summary="members">
|
||||
<tbody>
|
||||
<tr>
|
||||
<th>Member</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const expression_type &operator () ()
|
||||
const</code></td>
|
||||
<td>Returns a <code>const</code> reference of the expression.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>expression_type &operator () ()</code></td>
|
||||
<td>Returns a reference of the expression.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4>Notes</h4>
|
||||
<p>The <code>range</code>, <code>slice</code> and <code>project</code> functions have been removed. Use the free functions defined in <a href="vector_proxy.html">vector proxy</a> instead.</p>
|
||||
|
||||
<h2><a name="vector_container"></a>Vector Container</h2>
|
||||
<h4>Description</h4>
|
||||
<p>The templated class <code>vector_container<C></code>
|
||||
is required to be a public base of all classes which model the Vector concept.
|
||||
This includes the class <code>vector</code> itself.</p>
|
||||
<h4>Definition</h4>
|
||||
<p>Defined in the header expression_types.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>C</code></td>
|
||||
<td>The type of the vector container.</td>
|
||||
<td> </td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4>Model of</h4>
|
||||
<p>None. <u>Not a Vector Expression OR Vector</u>!
|
||||
</p>
|
||||
<h4>Type requirements</h4>
|
||||
<p>None.</p>
|
||||
<h4>Public base classes</h4>
|
||||
<p><code>vector_expression<C></code></p>
|
||||
<h4>Members</h4>
|
||||
<table border="1" summary="members">
|
||||
<tbody>
|
||||
<tr>
|
||||
<th>Member</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const container_type &operator () ()
|
||||
const</code></td>
|
||||
<td>Returns a <code>const</code> reference of the container.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>container_type &operator () ()</code></td>
|
||||
<td>Returns a reference of the container.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
<h2><a name="vector_references"></a>Vector References</h2>
|
||||
<h3>Reference</h3>
|
||||
<h4>Description</h4>
|
||||
<p>The templated class <code>vector_reference<E></code>
|
||||
contains a 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_concept.html#vector_expression">Vector Expression</a>
|
||||
.</p>
|
||||
<h4>Type requirements</h4>
|
||||
<p>None, except for those imposed by the requirements of <a href=
|
||||
"expression_concept.html#vector_expression">Vector Expression</a> .</p>
|
||||
<h4>Public base classes</h4>
|
||||
<p><code>vector_expression<vector_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_reference (expression_type &e)</code></td>
|
||||
<td>Constructs a reference of the expression.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>void resize (size_type size)</code></td>
|
||||
<td>Resizes the expression to hold at most <code>size</code>
|
||||
elements.</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>reference operator () (size_type i)</code></td>
|
||||
<td>Returns a reference 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>iterator begin ()</code></td>
|
||||
<td>Returns a <code>iterator</code> pointing to the beginning of
|
||||
the expression.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>iterator end ()</code></td>
|
||||
<td>Returns a <code>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>
|
||||
<tr>
|
||||
<td><code>reverse_iterator rbegin ()</code></td>
|
||||
<td>Returns a <code>reverse_iterator</code> pointing to the
|
||||
beginning of the reversed expression.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>reverse_iterator rend ()</code></td>
|
||||
<td>Returns a <code>reverse_iterator</code> pointing to the end of
|
||||
the reversed expression.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a name="vector_operations"></a>Vector Operations</h2>
|
||||
<h3>Unary Operation Description</h3>
|
||||
<h4>Description</h4>
|
||||
<p>The templated class <code>vector_unary<E, F></code>
|
||||
describes a unary vector operation.</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>
|
||||
<tr>
|
||||
<td><code>F</code></td>
|
||||
<td>The type of the operation.</td>
|
||||
<td> </td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4>Model of</h4>
|
||||
<p><a href="expression_concept.html#vector_expression">Vector Expression</a>
|
||||
.</p>
|
||||
<h4>Type requirements</h4>
|
||||
<p>None, except for those imposed by the requirements of <a href=
|
||||
"expression_concept.html#vector_expression">Vector Expression</a> .</p>
|
||||
<h4>Public base classes</h4>
|
||||
<p><code>vector_expression<vector_unary<E, F>
|
||||
></code></p>
|
||||
<h4>Members</h4>
|
||||
<table border="1" summary="members">
|
||||
<tbody>
|
||||
<tr>
|
||||
<th>Member</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>vector_unary (const expression_type &e)</code></td>
|
||||
<td>Constructs a description 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>Unary Operations</h3>
|
||||
<h4>Prototypes</h4>
|
||||
<pre>
|
||||
<code>template<class E, class F>
|
||||
struct vector_unary_traits {
|
||||
typedef vector_unary<typename E::const_closure_type, F> expression_type;
|
||||
typedef expression_type result_type;
|
||||
};
|
||||
|
||||
// (- v) [i] = - v [i]
|
||||
template<class E>
|
||||
typename vector_unary_traits<E, scalar_negate<typename E::value_type> >::result_type
|
||||
operator - (const vector_expression<E> &e);
|
||||
|
||||
// (conj v) [i] = conj (v [i])
|
||||
template<class E>
|
||||
typename vector_unary_traits<E, scalar_conj<typename E::value_type> >::result_type
|
||||
conj (const vector_expression<E> &e);
|
||||
|
||||
// (real v) [i] = real (v [i])
|
||||
template<class E>
|
||||
typename vector_unary_traits<E, scalar_real<typename E::value_type> >::result_type
|
||||
real (const vector_expression<E> &e);
|
||||
|
||||
// (imag v) [i] = imag (v [i])
|
||||
template<class E>
|
||||
typename vector_unary_traits<E, scalar_imag<typename E::value_type> >::result_type
|
||||
imag (const vector_expression<E> &e);
|
||||
|
||||
// (trans v) [i] = v [i]
|
||||
template<class E>
|
||||
typename vector_unary_traits<E, scalar_identity<typename E::value_type> >::result_type
|
||||
trans (const vector_expression<E> &e);
|
||||
|
||||
// (herm v) [i] = conj (v [i])
|
||||
template<class E>
|
||||
typename vector_unary_traits<E, scalar_conj<typename E::value_type> >::result_type
|
||||
herm (const vector_expression<E> &e);</code>
|
||||
</pre>
|
||||
<h4>Description</h4>
|
||||
<p><code>operator -</code> computes the additive inverse of a
|
||||
vector expression. <code>conj</code> computes the complex conjugate
|
||||
of a vector expression. <code>real</code> and <code>imag</code>
|
||||
compute the real and imaginary parts of a vector expression.
|
||||
<code>trans</code> computes the transpose of a vector expression.
|
||||
<code>herm</code> computes the hermitian, i.e. the complex
|
||||
conjugate of the transpose of a vector expression.</p>
|
||||
<h4>Definition</h4>
|
||||
<p>Defined in the header vector_expression.hpp.</p>
|
||||
<h4>Type requirements</h4>
|
||||
<ul>
|
||||
<li><code>E</code> is a model of <a href=
|
||||
"expression_concept.html#vector_expression">Vector Expression</a> .</li>
|
||||
</ul>
|
||||
<h4>Preconditions</h4>
|
||||
<p>None.</p>
|
||||
<h4>Complexity</h4>
|
||||
<p>Linear depending from the size of the vector expression.</p>
|
||||
<h4>Examples</h4>
|
||||
<pre>
|
||||
#include <boost/numeric/ublas/vector.hpp>
|
||||
#include <boost/numeric/ublas/io.hpp>
|
||||
|
||||
int main () {
|
||||
using namespace boost::numeric::ublas;
|
||||
vector<std::complex<double> > v (3);
|
||||
for (unsigned i = 0; i < v.size (); ++ i)
|
||||
v (i) = std::complex<double> (i, i);
|
||||
|
||||
std::cout << - v << std::endl;
|
||||
std::cout << conj (v) << std::endl;
|
||||
std::cout << real (v) << std::endl;
|
||||
std::cout << imag (v) << std::endl;
|
||||
std::cout << trans (v) << std::endl;
|
||||
std::cout << herm (v) << std::endl;
|
||||
}
|
||||
</pre>
|
||||
<h3>Binary Operation Description</h3>
|
||||
<h4>Description</h4>
|
||||
<p>The templated class <code>vector_binary<E1, E2, F></code>
|
||||
describes a binary vector operation.</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>E1</code></td>
|
||||
<td>The type of the first vector expression.</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>E2</code></td>
|
||||
<td>The type of the second vector expression.</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>F</code></td>
|
||||
<td>The type of the operation.</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4>Model of</h4>
|
||||
<p><a href="expression_concept.html#vector_expression">Vector Expression</a>
|
||||
.</p>
|
||||
<h4>Type requirements</h4>
|
||||
<p>None, except for those imposed by the requirements of <a href=
|
||||
"expression_concept.html#vector_expression">Vector Expression</a> .</p>
|
||||
<h4>Public base classes</h4>
|
||||
<p><code>vector_expression<vector_binary<E1, E2, F>
|
||||
></code></p>
|
||||
<h4>Members</h4>
|
||||
<table border="1" summary="members">
|
||||
<tbody>
|
||||
<tr>
|
||||
<th>Member</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>vector_binary (const expression1_type &e1, const
|
||||
expression2_type &e2)</code></td>
|
||||
<td>Constructs a description 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>Binary Operations</h3>
|
||||
<h4>Prototypes</h4>
|
||||
<pre>
|
||||
<code>template<class E1, class E2, class F>
|
||||
struct vector_binary_traits {
|
||||
typedef vector_binary<typename E1::const_closure_type,
|
||||
typename E2::const_closure_type, F> expression_type;
|
||||
typedef expression_type result_type;
|
||||
};
|
||||
|
||||
// (v1 + v2) [i] = v1 [i] + v2 [i]
|
||||
template<class E1, class E2>
|
||||
typename vector_binary_traits<E1, E2, scalar_plus<typename E1::value_type,
|
||||
typename E2::value_type> >::result_type
|
||||
operator + (const vector_expression<E1> &e1,
|
||||
const vector_expression<E2> &e2);
|
||||
|
||||
// (v1 - v2) [i] = v1 [i] - v2 [i]
|
||||
template<class E1, class E2>
|
||||
typename vector_binary_traits<E1, E2, scalar_minus<typename E1::value_type,
|
||||
typename E2::value_type> >::result_type
|
||||
operator - (const vector_expression<E1> &e1,
|
||||
const vector_expression<E2> &e2);</code>
|
||||
</pre>
|
||||
<h4>Description</h4>
|
||||
<p><code>operator +</code> computes the sum of two vector
|
||||
expressions. <code>operator -</code> computes the difference of two
|
||||
vector expressions.</p>
|
||||
<h4>Definition</h4>
|
||||
<p>Defined in the header vector_expression.hpp.</p>
|
||||
<h4>Type requirements</h4>
|
||||
<ul>
|
||||
<li><code>E1</code> is a model of <a href=
|
||||
"expression_concept.html#vector_expression">Vector Expression</a> .</li>
|
||||
<li><code>E2</code> is a model of <a href=
|
||||
"expression_concept.html#vector_expression">Vector Expression</a> .</li>
|
||||
</ul>
|
||||
<h4>Preconditions</h4>
|
||||
<ul>
|
||||
<li><code>e1 ().size () == e2 ().size ()</code></li>
|
||||
</ul>
|
||||
<h4>Complexity</h4>
|
||||
<p>Linear depending from the size of the vector expressions.</p>
|
||||
<h4>Examples</h4>
|
||||
<pre>
|
||||
#include <boost/numeric/ublas/vector.hpp>
|
||||
#include <boost/numeric/ublas/io.hpp>
|
||||
|
||||
int main () {
|
||||
using namespace boost::numeric::ublas;
|
||||
vector<double> v1 (3), v2 (3);
|
||||
for (unsigned i = 0; i < std::min (v1.size (), v2.size ()); ++ i)
|
||||
v1 (i) = v2 (i) = i;
|
||||
|
||||
std::cout << v1 + v2 << std::endl;
|
||||
std::cout << v1 - v2 << std::endl;
|
||||
}
|
||||
</pre>
|
||||
<h3>Binary Outer Operation Description</h3>
|
||||
<h4>Description</h4>
|
||||
<p>The templated class <code>vector_matrix_binary<E1, E2,
|
||||
F></code> describes a binary outer vector operation.</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>E1</code></td>
|
||||
<td>The type of the first vector expression.</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>E2</code></td>
|
||||
<td>The type of the second vector expression.</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>F</code></td>
|
||||
<td>The type of the operation.</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4>Model of</h4>
|
||||
<p><a href="expression_concept.html#matrix_expression">Matrix Expression</a>
|
||||
.</p>
|
||||
<h4>Type requirements</h4>
|
||||
<p>None, except for those imposed by the requirements of <a href=
|
||||
"expression_concept.html#matrix_expression">Matrix Expression</a> .</p>
|
||||
<h4>Public base classes</h4>
|
||||
<p><code>matrix_expression<vector_matrix_binary<E1, E2, F>
|
||||
></code></p>
|
||||
<h4>Members</h4>
|
||||
<table border="1" summary="members">
|
||||
<tbody>
|
||||
<tr>
|
||||
<th>Member</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>vector_matrix_binary (const expression1_type &e1,
|
||||
const expression2_type &e2)</code></td>
|
||||
<td>Constructs a description 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>Binary Outer Operations</h3>
|
||||
<h4>Prototypes</h4>
|
||||
<pre>
|
||||
<code>template<class E1, class E2, class F>
|
||||
struct vector_matrix_binary_traits {
|
||||
typedef vector_matrix_binary<typename E1::const_closure_type,
|
||||
typename E2::const_closure_type, F> expression_type;
|
||||
typedef expression_type result_type;
|
||||
};
|
||||
|
||||
// (outer_prod (v1, v2)) [i] [j] = v1 [i] * v2 [j]
|
||||
template<class E1, class E2>
|
||||
typename vector_matrix_binary_traits<E1, E2, scalar_multiplies<typename E1::value_type, typename E2::value_type> >::result_type
|
||||
outer_prod (const vector_expression<E1> &e1,
|
||||
const vector_expression<E2> &e2);</code>
|
||||
</pre>
|
||||
<h4>Description</h4>
|
||||
<p><code>outer_prod</code> computes the outer product of two vector
|
||||
expressions.</p>
|
||||
<h4>Definition</h4>
|
||||
<p>Defined in the header matrix_expression.hpp.</p>
|
||||
<h4>Type requirements</h4>
|
||||
<ul>
|
||||
<li><code>E1</code> is a model of <a href=
|
||||
"expression_concept.html#vector_expression">Vector Expression</a> .</li>
|
||||
<li><code>E2</code> is a model of <a href=
|
||||
"expression_concept.html#vector_expression">Vector Expression</a> .</li>
|
||||
</ul>
|
||||
<h4>Preconditions</h4>
|
||||
<p>None.</p>
|
||||
<h4>Complexity</h4>
|
||||
<p>Quadratic depending from the size of the vector expressions.</p>
|
||||
<h4>Examples</h4>
|
||||
<pre>
|
||||
#include <boost/numeric/ublas/matrix.hpp>
|
||||
#include <boost/numeric/ublas/io.hpp>
|
||||
|
||||
int main () {
|
||||
using namespace boost::numeric::ublas;
|
||||
vector<double> v1 (3), v2 (3);
|
||||
for (unsigned i = 0; i < std::min (v1.size (), v2.size ()); ++ i)
|
||||
v1 (i) = v2 (i) = i;
|
||||
|
||||
std::cout << outer_prod (v1, v2) << std::endl;
|
||||
}
|
||||
</pre>
|
||||
<h3>Scalar Vector Operation Description</h3>
|
||||
<h4>Description</h4>
|
||||
<p>The templated classes <code>vector_binary_scalar1<E1, E2,
|
||||
F></code> and <code>vector_binary_scalar2<E1, E2,
|
||||
F></code> describe binary operations between a scalar and a
|
||||
vector.</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>E1/E2</code></td>
|
||||
<td>The type of the scalar expression.</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>E2/E1</code></td>
|
||||
<td>The type of the vector expression.</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>F</code></td>
|
||||
<td>The type of the operation.</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4>Model of</h4>
|
||||
<p><a href="expression_concept.html#vector_expression">Vector Expression</a>
|
||||
.</p>
|
||||
<h4>Type requirements</h4>
|
||||
<p>None, except for those imposed by the requirements of <a href=
|
||||
"expression_concept.html#vector_expression">Vector Expression</a> .</p>
|
||||
<h4>Public base classes</h4>
|
||||
<p><code>vector_expression<vector_binary_scalar1<E1, E2,
|
||||
F> ></code> and
|
||||
<code>vector_expression<vector_binary_scalar2<E1, E2, F>
|
||||
></code> resp.</p>
|
||||
<h4>Members</h4>
|
||||
<table border="1" summary="members">
|
||||
<tbody>
|
||||
<tr>
|
||||
<th>Member</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>vector_binary_scalar1 (const expression1_type &e1,
|
||||
const expression2_type &e2)</code></td>
|
||||
<td>Constructs a description of the expression.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>vector_binary_scalar2 (const expression1_type &e1,
|
||||
const expression2_type &e2)</code></td>
|
||||
<td>Constructs a description 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>Scalar Vector Operations</h3>
|
||||
<h4>Prototypes</h4>
|
||||
<pre>
|
||||
<code>template<class T1, class E2, class F>
|
||||
struct vector_binary_scalar1_traits {
|
||||
typedef vector_binary_scalar1<scalar_const_reference<T1>,
|
||||
typename E2::const_closure_type, F> expression_type;
|
||||
typedef expression_type result_type;
|
||||
};
|
||||
|
||||
// (t * v) [i] = t * v [i]
|
||||
template<class T1, class E2>
|
||||
typename vector_binary_scalar1_traits<T1, E2, scalar_multiplies<T1, typename E2::value_type> >::result_type
|
||||
operator * (const T1 &e1,
|
||||
const vector_expression<E2> &e2);
|
||||
|
||||
template<class E1, class T2, class F>
|
||||
struct vector_binary_scalar2_traits {
|
||||
typedef vector_binary_scalar2<typename E1::const_closure_type,
|
||||
scalar_const_reference<T2>, F> expression_type;
|
||||
typedef expression_type result_type;
|
||||
};
|
||||
|
||||
// (v * t) [i] = v [i] * t
|
||||
template<class E1, class T2>
|
||||
typename vector_binary_scalar2_traits<E1, T2, scalar_multiplies<typename E1::value_type, T2> >::result_type
|
||||
operator * (const vector_expression<E1> &e1,
|
||||
const T2 &e2);
|
||||
|
||||
// (v / t) [i] = v [i] / t
|
||||
template<class E1, class T2>
|
||||
typename vector_binary_scalar2_traits<E1, T2, scalar_divides<typename E1::value_type, T2> >::result_type
|
||||
operator / (const vector_expression<E1> &e1,
|
||||
const T2 &e2);</code>
|
||||
</pre>
|
||||
<h4>Description</h4>
|
||||
<p><code>operator *</code> computes the product of a scalar and a
|
||||
vector expression. <code>operator /</code> multiplies the vector
|
||||
with the reciprocal of the scalar.</p>
|
||||
<h4>Definition</h4>
|
||||
<p>Defined in the header vector_expression.hpp.</p>
|
||||
<h4>Type requirements</h4>
|
||||
<ul>
|
||||
<li><code>T1/T2</code> is a model of <a href=
|
||||
"expression_concept.html#scalar_expression">Scalar Expression</a> .</li>
|
||||
<li><code>E2/E1</code> is a model of <a href=
|
||||
"expression_concept.html#vector_expression">Vector Expression</a> .</li>
|
||||
</ul>
|
||||
<h4>Preconditions</h4>
|
||||
<p>None.</p>
|
||||
<h4>Complexity</h4>
|
||||
<p>Linear depending from the size of the vector expression.</p>
|
||||
<h4>Examples</h4>
|
||||
<pre>
|
||||
#include <boost/numeric/ublas/vector.hpp>
|
||||
#include <boost/numeric/ublas/io.hpp>
|
||||
|
||||
int main () {
|
||||
using namespace boost::numeric::ublas;
|
||||
vector<double> v (3);
|
||||
for (unsigned i = 0; i < v.size (); ++ i)
|
||||
v (i) = i;
|
||||
|
||||
std::cout << 2.0 * v << std::endl;
|
||||
std::cout << v * 2.0 << std::endl;
|
||||
}
|
||||
</pre>
|
||||
<h2><a name="vector_reductions"></a>Vector Reductions</h2>
|
||||
<h3>Unary Reductions</h3>
|
||||
<h4>Prototypes</h4>
|
||||
<pre>
|
||||
<code>template<class E, class F>
|
||||
struct vector_scalar_unary_traits {
|
||||
typedef typename F::result_type result_type;
|
||||
};
|
||||
|
||||
// sum v = sum (v [i])
|
||||
template<class E>
|
||||
typename vector_scalar_unary_traits<E, vector_sum<typename E::value_type> >::result_type
|
||||
sum (const vector_expression<E> &e);
|
||||
|
||||
// norm_1 v = sum (abs (v [i]))
|
||||
template<class E>
|
||||
typename vector_scalar_unary_traits<E, vector_norm_1<typename E::value_type> >::result_type
|
||||
norm_1 (const vector_expression<E> &e);
|
||||
|
||||
// norm_2 v = sqrt (sum (v [i] * v [i]))
|
||||
template<class E>
|
||||
typename vector_scalar_unary_traits<E, vector_norm_2<typename E::value_type> >::result_type
|
||||
norm_2 (const vector_expression<E> &e);
|
||||
|
||||
// norm_inf v = max (abs (v [i]))
|
||||
template<class E>
|
||||
typename vector_scalar_unary_traits<E, vector_norm_inf<typename E::value_type> >::result_type
|
||||
norm_inf (const vector_expression<E> &e);
|
||||
|
||||
// index_norm_inf v = min (i: abs (v [i]) == max (abs (v [i])))
|
||||
template<class E>
|
||||
typename vector_scalar_unary_traits<E, vector_index_norm_inf<typename E::value_type> >::result_type
|
||||
index_norm_inf (const vector_expression<E> &e);</code>
|
||||
</pre>
|
||||
<h4>Description</h4>
|
||||
<p><code>sum</code> computes the sum of the vector expression's
|
||||
elements. <code>norm_1</code>, <code>norm_2</code> and
|
||||
<code>norm_inf</code> compute the corresponding
|
||||
<em>||.||</em><sub><em>1</em></sub>,
|
||||
<em>||.||</em><sub><em>2</em></sub> and
|
||||
<em>||.||</em><sub><em>inf</em></sub> vector norms.
|
||||
<code>index_norm_1</code> computes the index of the vector
|
||||
expression's first element having maximal absolute value.</p>
|
||||
<h4>Definition</h4>
|
||||
<p>Defined in the header vector_expression.hpp.</p>
|
||||
<h4>Type requirements</h4>
|
||||
<ul>
|
||||
<li><code>E</code> is a model of <a href=
|
||||
"#vector_expression">Vector Expression</a> .</li>
|
||||
</ul>
|
||||
<h4>Preconditions</h4>
|
||||
<p>None.</p>
|
||||
<h4>Complexity</h4>
|
||||
<p>Linear depending from the size of the vector expression.</p>
|
||||
<h4>Examples</h4>
|
||||
<pre>
|
||||
#include <boost/numeric/ublas/vector.hpp>
|
||||
|
||||
int main () {
|
||||
using namespace boost::numeric::ublas;
|
||||
vector<double> v (3);
|
||||
for (unsigned i = 0; i < v.size (); ++ i)
|
||||
v (i) = i;
|
||||
|
||||
std::cout << sum (v) << std::endl;
|
||||
std::cout << norm_1 (v) << std::endl;
|
||||
std::cout << norm_2 (v) << std::endl;
|
||||
std::cout << norm_inf (v) << std::endl;
|
||||
std::cout << index_norm_inf (v) << std::endl;
|
||||
}
|
||||
</pre>
|
||||
<h3>Binary Reductions</h3>
|
||||
<h4>Prototypes</h4>
|
||||
<pre>
|
||||
<code>template<class E1, class E2, class F>
|
||||
struct vector_scalar_binary_traits {
|
||||
typedef typename F::result_type result_type;
|
||||
};
|
||||
|
||||
// inner_prod (v1, v2) = sum (v1 [i] * v2 [i])
|
||||
template<class E1, class E2>
|
||||
typename vector_scalar_binary_traits<E1, E2, vector_inner_prod<typename E1::value_type,
|
||||
typename E2::value_type,
|
||||
typename promote_traits<typename E1::value_type,
|
||||
typename E2::value_type>::promote_type> >::result_type
|
||||
inner_prod (const vector_expression<E1> &e1,
|
||||
const vector_expression<E2> &e2);
|
||||
|
||||
template<class E1, class E2>
|
||||
typename vector_scalar_binary_traits<E1, E2, vector_inner_prod<typename E1::value_type,
|
||||
typename E2::value_type,
|
||||
typename type_traits<typename promote_traits<typename E1::value_type,
|
||||
typename E2::value_type>::promote_type>::precision_type> >::result_type
|
||||
prec_inner_prod (const vector_expression<E1> &e1,
|
||||
const vector_expression<E2> &e2);</code>
|
||||
</pre>
|
||||
<h4>Description</h4>
|
||||
<p><code>inner_prod</code> computes the inner product of the vector
|
||||
expressions. <code>prec_inner_prod</code> computes the double
|
||||
precision inner product of the vector expressions<code>.</code></p>
|
||||
<h4>Definition</h4>
|
||||
<p>Defined in the header vector_expression.hpp.</p>
|
||||
<h4>Type requirements</h4>
|
||||
<ul>
|
||||
<li><code>E1</code> is a model of <a href=
|
||||
"#vector_expression">Vector Expression</a> .</li>
|
||||
<li><code>E2</code> is a model of <a href=
|
||||
"#vector_expression">Vector Expression</a> .</li>
|
||||
</ul>
|
||||
<h4>Preconditions</h4>
|
||||
<ul>
|
||||
<li><code>e1 ().size () == e2 ().size ()</code></li>
|
||||
</ul>
|
||||
<h4>Complexity</h4>
|
||||
<p>Linear depending from the size of the vector expressions.</p>
|
||||
<h4>Examples</h4>
|
||||
<pre>
|
||||
#include <boost/numeric/ublas/vector.hpp>
|
||||
|
||||
int main () {
|
||||
using namespace boost::numeric::ublas;
|
||||
vector<double> v1 (3), v2 (3);
|
||||
for (unsigned i = 0; i < std::min (v1.size (), v2.size ()); ++ i)
|
||||
v1 (i) = v2 (i) = i;
|
||||
|
||||
std::cout << inner_prod (v1, v2) << std::endl;
|
||||
}
|
||||
</pre>
|
||||
<hr />
|
||||
<p>Copyright (©) 2000-2002 Joerg Walter, Mathias Koch<br />
|
||||
Use, modification and distribution are subject to the
|
||||
Boost Software License, Version 1.0.
|
||||
(See accompanying file LICENSE_1_0.txt
|
||||
or copy at <a href="http://www.boost.org/LICENSE_1_0.txt">
|
||||
http://www.boost.org/LICENSE_1_0.txt
|
||||
</a>).
|
||||
</p>
|
||||
<script type="text/javascript">
|
||||
(function($) {
|
||||
$('#toc').toc();
|
||||
})(jQuery);
|
||||
</script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,527 @@
|
||||
<!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 name="generator" content=
|
||||
"HTML Tidy for Linux/x86 (vers 1st March 2004), see www.w3.org" />
|
||||
<meta http-equiv="Content-Type" content=
|
||||
"text/html; charset=us-ascii" />
|
||||
<link rel="stylesheet" href="../../../../boost.css" type="text/css"/>
|
||||
<link rel="stylesheet" href="ublas.css" type="text/css" />
|
||||
<script type="text/javascript" src="js/jquery-1.3.2.min.js" async="async" ></script>
|
||||
<script type="text/javascript" src="js/jquery.toc-gw.js" async="async" ></script>
|
||||
<title>Vector Proxies</title>
|
||||
</head>
|
||||
<body>
|
||||
<h1><img src="../../../../boost.png" align="middle" />Vector Proxies</h1>
|
||||
<div class="toc" id="toc"></div>
|
||||
<h2><a name="vector_range"></a>Vector Range</h2>
|
||||
<h4>Description</h4>
|
||||
<p>The templated class <code>vector_range<V></code> allows
|
||||
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 () {
|
||||
using namespace boost::numeric::ublas;
|
||||
vector<double> v (3);
|
||||
vector_range<vector<double> > vr (v, range (0, 3));
|
||||
for (unsigned i = 0; i < vr.size (); ++ i)
|
||||
vr (i) = i;
|
||||
std::cout << vr << std::endl;
|
||||
}
|
||||
</pre>
|
||||
<h4>Definition</h4>
|
||||
<p>Defined in the header vector_proxy.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>V</code></td>
|
||||
<td>The type of vector referenced.</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4>Model of</h4>
|
||||
<p><a href="expression_concept.html#vector_expression">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
|
||||
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_concept.html#vector_expression">Vector Expression</a> .</p>
|
||||
<h4>Public base classes</h4>
|
||||
<p><code>vector_expression<vector_range<V> ></code></p>
|
||||
<h4>Members</h4>
|
||||
<table border="1" summary="members">
|
||||
<tbody>
|
||||
<tr>
|
||||
<th>Member</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>vector_range (vector_type &data, const range
|
||||
&r)</code></td>
|
||||
<td>Constructs a sub vector.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>size_type start () const</code></td>
|
||||
<td>Returns the start of the sub vector.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>size_type size () const</code></td>
|
||||
<td>Returns the size of the sub vector.</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>reference operator () (size_type i)</code></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>Returns the value of the <code>i</code>-th element.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>reference operator [] (size_type i)</code></td>
|
||||
<td>Returns a reference of the <code>i</code>-th element.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>vector_range &operator = (const vector_range
|
||||
&vr)</code></td>
|
||||
<td>The assignment operator.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>vector_range &assign_temporary (vector_range
|
||||
&vr)</code></td>
|
||||
<td>Assigns a temporary. May change the vector range
|
||||
<code>vr</code> .</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
vector_range &operator = (const vector_expression<AE>
|
||||
&ae)</code></td>
|
||||
<td>The extended assignment operator.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
vector_range &assign (const vector_expression<AE>
|
||||
&ae)</code></td>
|
||||
<td>Assigns a vector expression to the sub vector. Left and right
|
||||
hand side of the assignment should be independent.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
vector_range &operator += (const vector_expression<AE>
|
||||
&ae)</code></td>
|
||||
<td>A computed assignment operator. Adds the vector expression to
|
||||
the sub vector.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
vector_range &plus_assign (const vector_expression<AE>
|
||||
&ae)</code></td>
|
||||
<td>Adds a vector expression to the sub vector. Left and right hand
|
||||
side of the assignment should be independent.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
vector_range &operator -= (const vector_expression<AE>
|
||||
&ae)</code></td>
|
||||
<td>A computed assignment operator. Subtracts the vector expression
|
||||
from the sub vector.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
vector_range &minus_assign (const vector_expression<AE>
|
||||
&ae)</code></td>
|
||||
<td>Subtracts a vector expression from the sub vector. Left and
|
||||
right hand side of the assignment should be independent.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AT><br />
|
||||
vector_range &operator *= (const AT &at)</code></td>
|
||||
<td>A computed assignment operator. Multiplies the sub vector with
|
||||
a scalar.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AT><br />
|
||||
vector_range &operator /= (const AT &at)</code></td>
|
||||
<td>A computed assignment operator. Divides the sub vector through
|
||||
a scalar.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>void swap (vector_range &vr)</code></td>
|
||||
<td>Swaps the contents of the sub vectors.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_iterator begin () const</code></td>
|
||||
<td>Returns a <code>const_iterator</code> pointing to the beginning
|
||||
of the <code>vector_range</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_iterator end () const</code></td>
|
||||
<td>Returns a <code>const_iterator</code> pointing to the end of
|
||||
the <code>vector_range</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>iterator begin ()</code></td>
|
||||
<td>Returns a <code>iterator</code> pointing to the beginning of
|
||||
the <code>vector_range</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>iterator end ()</code></td>
|
||||
<td>Returns a <code>iterator</code> pointing to the end of the
|
||||
<code>vector_range</code>.</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 <code>vector_range</code>.</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 <code>vector_range</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>reverse_iterator rbegin ()</code></td>
|
||||
<td>Returns a <code>reverse_iterator</code> pointing to the
|
||||
beginning of the reversed <code>vector_range</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>reverse_iterator rend ()</code></td>
|
||||
<td>Returns a <code>reverse_iterator</code> pointing to the end of
|
||||
the reversed <code>vector_range</code>.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Simple Projections</h3>
|
||||
<h4>Description</h4>
|
||||
<p>The free <code>subrange</code> functions support the construction
|
||||
of vector ranges.</p>
|
||||
<h4>Prototypes</h4>
|
||||
<pre><code>
|
||||
template<class V>
|
||||
vector_range<V> subrange (V &data,
|
||||
V::size_type start, V::size_type stop);
|
||||
template<class V>
|
||||
const vector_range<const V> subrange (const V &data,
|
||||
V::size_type start, V::size_type stop);
|
||||
</code></pre>
|
||||
<h3>Generic Projections</h3>
|
||||
<h4>Description</h4>
|
||||
<p>The free <code>project</code> functions support the construction
|
||||
of vector ranges. Existing <code>matrix_range</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>
|
||||
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 (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_concept.html#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 () {
|
||||
using namespace boost::numeric::ublas;
|
||||
vector<double> v (3);
|
||||
for (int i = 0; i < 3; ++ i)
|
||||
project (v, range (0, 3)) (i) = i;
|
||||
std::cout << project (v, range (0, 3)) << std::endl;
|
||||
}
|
||||
</pre>
|
||||
<h2><a name="vector_slice"></a>Vector Slice</h2>
|
||||
<h4>Description</h4>
|
||||
<p>The templated class <code>vector_slice<V></code> allows
|
||||
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 () {
|
||||
using namespace boost::numeric::ublas;
|
||||
vector<double> v (3);
|
||||
vector_slice<vector<double> > vs (v, slice (0, 1, 3));
|
||||
for (unsigned i = 0; i < vs.size (); ++ i)
|
||||
vs (i) = i;
|
||||
std::cout << vs << std::endl;
|
||||
}
|
||||
</pre>
|
||||
<h4>Definition</h4>
|
||||
<p>Defined in the header vector_proxy.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>V</code></td>
|
||||
<td>The type of vector referenced.</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4>Model of</h4>
|
||||
<p><a href="expression_concept.html#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
|
||||
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_concept.html#vector_expression">Vector Expression</a> .</p>
|
||||
<h4>Public base classes</h4>
|
||||
<p><code>vector_expression<vector_slice<V> ></code></p>
|
||||
<h4>Members</h4>
|
||||
<table border="1" summary="members">
|
||||
<tbody>
|
||||
<tr>
|
||||
<th>Member</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>vector_slice (vector_type &data, const slice
|
||||
&s)</code></td>
|
||||
<td>Constructs a sub vector.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>size_type size () const</code></td>
|
||||
<td>Returns the size of the sub vector.</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>reference operator () (size_type i)</code></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>Returns the value of the <code>i</code>-th element.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>reference operator [] (size_type i)</code></td>
|
||||
<td>Returns a reference of the <code>i</code>-th element.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>vector_slice &operator = (const vector_slice
|
||||
&vs)</code></td>
|
||||
<td>The assignment operator.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>vector_slice &assign_temporary (vector_slice
|
||||
&vs)</code></td>
|
||||
<td>Assigns a temporary. May change the vector slice
|
||||
<code>vs</code> .</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
vector_slice &operator = (const vector_expression<AE>
|
||||
&ae)</code></td>
|
||||
<td>The extended assignment operator.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
vector_slice &assign (const vector_expression<AE>
|
||||
&ae)</code></td>
|
||||
<td>Assigns a vector expression to the sub vector. Left and right
|
||||
hand side of the assignment should be independent.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
vector_slice &operator += (const vector_expression<AE>
|
||||
&ae)</code></td>
|
||||
<td>A computed assignment operator. Adds the vector expression to
|
||||
the sub vector.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
vector_slice &plus_assign (const vector_expression<AE>
|
||||
&ae)</code></td>
|
||||
<td>Adds a vector expression to the sub vector. Left and right hand
|
||||
side of the assignment should be independent.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
vector_slice &operator -= (const vector_expression<AE>
|
||||
&ae)</code></td>
|
||||
<td>A computed assignment operator. Subtracts the vector expression
|
||||
from the sub vector.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
vector_slice &minus_assign (const vector_expression<AE>
|
||||
&ae)</code></td>
|
||||
<td>Subtracts a vector expression from the sub vector. Left and
|
||||
right hand side of the assignment should be independent.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AT><br />
|
||||
vector_slice &operator *= (const AT &at)</code></td>
|
||||
<td>A computed assignment operator. Multiplies the sub vector with
|
||||
a scalar.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AT><br />
|
||||
vector_slice &operator /= (const AT &at)</code></td>
|
||||
<td>A computed assignment operator. Divides the sub vector through
|
||||
a scalar.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>void swap (vector_slice &vs)</code></td>
|
||||
<td>Swaps the contents of the sub vectors.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_iterator begin () const</code></td>
|
||||
<td>Returns a <code>const_iterator</code> pointing to the beginning
|
||||
of the <code>vector_slice</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_iterator end () const</code></td>
|
||||
<td>Returns a <code>const_iterator</code> pointing to the end of
|
||||
the <code>vector_slice</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>iterator begin ()</code></td>
|
||||
<td>Returns a <code>iterator</code> pointing to the beginning of
|
||||
the <code>vector_slice</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>iterator end ()</code></td>
|
||||
<td>Returns a <code>iterator</code> pointing to the end of the
|
||||
<code>vector_slice</code>.</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 <code>vector_slice</code>.</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 <code>vector_slice</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>reverse_iterator rbegin ()</code></td>
|
||||
<td>Returns a <code>reverse_iterator</code> pointing to the
|
||||
beginning of the reversed <code>vector_slice</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>reverse_iterator rend ()</code></td>
|
||||
<td>Returns a <code>reverse_iterator</code> pointing to the end of
|
||||
the reversed <code>vector_slice</code>.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Simple Projections</h3>
|
||||
<h4>Description</h4>
|
||||
<p>The free <code>subslice</code> functions support the construction
|
||||
of vector slices.</p>
|
||||
<h4>Prototypes</h4>
|
||||
<pre><code>
|
||||
template<class V>
|
||||
vector_slice<V> subslice (V &data,
|
||||
V::size_type start, V::difference_type stride, V::size_type size);
|
||||
template<class V>
|
||||
const vector_slice<const V> subslice (const V &data,
|
||||
V::size_type start, V::difference_type stride, V::size_type size);
|
||||
</code></pre>
|
||||
<h3>Generic 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 (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 (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);
|
||||
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_concept.html#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 () {
|
||||
using namespace boost::numeric::ublas;
|
||||
vector<double> v (3);
|
||||
for (int i = 0; i < 3; ++ i)
|
||||
project (v, slice (0, 1, 3)) (i) = i;
|
||||
std::cout << project (v, slice (0, 1, 3)) << std::endl;
|
||||
}
|
||||
</pre>
|
||||
<hr />
|
||||
<p>Copyright (©) 2000-2002 Joerg Walter, Mathias Koch<br />
|
||||
Use, modification and distribution are subject to the
|
||||
Boost Software License, Version 1.0.
|
||||
(See accompanying file LICENSE_1_0.txt
|
||||
or copy at <a href="http://www.boost.org/LICENSE_1_0.txt">
|
||||
http://www.boost.org/LICENSE_1_0.txt
|
||||
</a>).
|
||||
</p>
|
||||
<script type="text/javascript">
|
||||
(function($) {
|
||||
$('#toc').toc();
|
||||
})(jQuery);
|
||||
</script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,800 @@
|
||||
<!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 name="generator" content=
|
||||
"HTML Tidy for Linux/x86 (vers 1st March 2004), see www.w3.org" />
|
||||
<meta http-equiv="Content-Type" content=
|
||||
"text/html; charset=us-ascii" />
|
||||
<link href="ublas.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../../../../boost.css" type="text/css"/>
|
||||
<link rel="stylesheet" href="ublas.css" type="text/css" />
|
||||
<script type="text/javascript" src="js/jquery-1.3.2.min.js" async="async" ></script>
|
||||
<script type="text/javascript" src="js/jquery.toc-gw.js" async="async" ></script>
|
||||
</head>
|
||||
<body>
|
||||
<h1><img src="../../../../boost.png" align="middle" />Sparse Vector</h1>
|
||||
<div class="toc" id="toc"></div>
|
||||
<h2><a name="mapped_vector"></a>Mapped Vector</h2>
|
||||
<h4>Description</h4>
|
||||
<p>The templated class <code>mapped_vector<T, A></code> is
|
||||
the base container adaptor for sparse vectors using element maps. For a
|
||||
<em>n</em>-dimensional sparse vector and <em>0 <= i < n</em>
|
||||
the non-zero elements <em>v</em><sub><em>i</em></sub> are mapped to
|
||||
consecutive elements of the associative container, i.e. for
|
||||
elements <em>k</em> =
|
||||
<em>v</em><sub><em>i</em></sub><sub><sub><em>1</em></sub></sub>and
|
||||
<em>k + 1 =
|
||||
v</em><sub><em>i</em></sub><sub><sub><em>2</em></sub></sub>of the
|
||||
container holds <em>i</em><sub><em>1</em></sub> <em><
|
||||
i</em><sub><em>2</em></sub>.</p>
|
||||
<h4>Example</h4>
|
||||
<pre>
|
||||
#include <boost/numeric/ublas/vector_sparse.hpp>
|
||||
#include <boost/numeric/ublas/io.hpp>
|
||||
|
||||
int main () {
|
||||
using namespace boost::numeric::ublas;
|
||||
mapped_vector<double> v (3, 3);
|
||||
for (unsigned i = 0; i < v.size (); ++ i)
|
||||
v (i) = i;
|
||||
std::cout << v << std::endl;
|
||||
}
|
||||
</pre>
|
||||
<h4>Definition</h4>
|
||||
<p>Defined in the header vector_sparse.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 mapped vector.</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>A</code></td>
|
||||
<td>The type of the adapted array. <a href=
|
||||
"#mapped_vector_1">[1]</a></td>
|
||||
<td><code>map_std<std::size_t, T></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4>Model of</h4>
|
||||
<p><a href="container_concept.html#vector">Vector</a> .</p>
|
||||
<h4>Type requirements</h4>
|
||||
<p>None, except for those imposed by the requirements of <a href=
|
||||
"container_concept.html#vector">Vector</a> .</p>
|
||||
<h4>Public base classes</h4>
|
||||
<p><code>vector_container<mapped_vector<T, A>
|
||||
></code></p>
|
||||
<h4>Members</h4>
|
||||
<table border="1" summary="members">
|
||||
<tbody>
|
||||
<tr>
|
||||
<th>Member</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>mapped_vector ()</code></td>
|
||||
<td>Allocates a <code>mapped_vector</code> that holds zero
|
||||
elements.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>mapped_vector (size_type size, size_type
|
||||
non_zeros = 0)</code></td>
|
||||
<td>Allocates a <code>mapped_vector</code> that holds at most
|
||||
<code>size</code> elements.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>mapped_vector (const mapped_vector &v)</code></td>
|
||||
<td>The copy constructor.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
mapped_vector (size_type non_zeros, const
|
||||
vector_expression<AE> &ae)</code></td>
|
||||
<td>The extended copy constructor.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>void resize (size_type size, bool
|
||||
preserve = true)</code></td>
|
||||
<td>Reallocates a <code>mapped_vector</code> to hold at most
|
||||
<code>size</code> elements. The existing elements of the
|
||||
<code>mapped_vector</code> are preseved when specified.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>size_type size () const</code></td>
|
||||
<td>Returns the size of the <code>mapped_vector</code>.</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>reference operator () (size_type i)</code></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>Returns the value of the <code>i</code>-th element.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>reference operator [] (size_type i)</code></td>
|
||||
<td>Returns a reference of the <code>i</code>-th element.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>mapped_vector &operator = (const mapped_vector
|
||||
&v)</code></td>
|
||||
<td>The assignment operator.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>mapped_vector &assign_temporary (mapped_vector
|
||||
&v)</code></td>
|
||||
<td>Assigns a temporary. May change the mapped vector
|
||||
<code>v</code> .</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
mapped_vector &operator = (const vector_expression<AE>
|
||||
&ae)</code></td>
|
||||
<td>The extended assignment operator.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
mapped_vector &assign (const vector_expression<AE>
|
||||
&ae)</code></td>
|
||||
<td>Assigns a vector expression to the mapped vector. Left and
|
||||
right hand side of the assignment should be independent.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
mapped_vector &operator += (const vector_expression<AE>
|
||||
&ae)</code></td>
|
||||
<td>A computed assignment operator. Adds the vector expression to
|
||||
the mapped vector.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
mapped_vector &plus_assign (const vector_expression<AE>
|
||||
&ae)</code></td>
|
||||
<td>Adds a vector expression to the mapped vector. Left and right
|
||||
hand side of the assignment should be independent.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
mapped_vector &operator -= (const vector_expression<AE>
|
||||
&ae)</code></td>
|
||||
<td>A computed assignment operator. Subtracts the vector expression
|
||||
from the mapped vector.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
mapped_vector &minus_assign (const vector_expression<AE>
|
||||
&ae)</code></td>
|
||||
<td>Subtracts a vector expression from the mapped vector. Left and
|
||||
right hand side of the assignment should be independent.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AT><br />
|
||||
mapped_vector &operator *= (const AT &at)</code></td>
|
||||
<td>A computed assignment operator. Multiplies the mapped vector
|
||||
with a scalar.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AT><br />
|
||||
mapped_vector &operator /= (const AT &at)</code></td>
|
||||
<td>A computed assignment operator. Divides the mapped vector
|
||||
through a scalar.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>void swap (mapped_vector &v)</code></td>
|
||||
<td>Swaps the contents of the mapped vectors.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>true_reference insert_element (size_type i, const_reference t)</code></td>
|
||||
<td>Inserts the value <code>t</code> at the <code>i</code>-th
|
||||
element. Duplicates elements are not allowed.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>void erase_element (size_type i)</code></td>
|
||||
<td>Erases the value at the <code>i</code>-th element.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>void clear ()</code></td>
|
||||
<td>Clears the mapped vector.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_iterator begin () const</code></td>
|
||||
<td>Returns a <code>const_iterator</code> pointing to the beginning
|
||||
of the <code>mapped_vector</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_iterator end () const</code></td>
|
||||
<td>Returns a <code>const_iterator</code> pointing to the end of
|
||||
the <code>mapped_vector</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>iterator begin ()</code></td>
|
||||
<td>Returns a <code>iterator</code> pointing to the beginning of
|
||||
the <code>mapped_vector</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>iterator end ()</code></td>
|
||||
<td>Returns a <code>iterator</code> pointing to the end of the
|
||||
<code>mapped_vector</code>.</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 <code>mapped_vector</code>.</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 <code>mapped_vector</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>reverse_iterator rbegin ()</code></td>
|
||||
<td>Returns a <code>reverse_iterator</code> pointing to the
|
||||
beginning of the reversed <code>mapped_vector</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>reverse_iterator rend ()</code></td>
|
||||
<td>Returns a <code>reverse_iterator</code> pointing to the end of
|
||||
the reversed <code>mapped_vector</code>.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4>Notes</h4>
|
||||
<p><a name="mapped_vector_1">[1]</a> Supported
|
||||
parameters for the adapted array are
|
||||
<code>map_array<std::size_t, T></code> and
|
||||
<code>map_std<std::size_t, T></code>. The latter is
|
||||
equivalent to <code>std::map<std::size_t, T></code>.</p>
|
||||
<h2><a name="compressed_vector"></a>Compressed Vector</h2>
|
||||
<h4>Description</h4>
|
||||
<p>The templated class <code>compressed_vector<T, IB, IA,
|
||||
TA></code> is the base container adaptor for compressed vectors.
|
||||
For a <em>n</em>-dimensional compressed vector and <em>0 <= i
|
||||
< n</em> the non-zero elements <em>v</em><sub><em>i</em></sub>
|
||||
are mapped to consecutive elements of the index and value
|
||||
container, i.e. for elements <em>k</em> =
|
||||
<em>v</em><sub><em>i</em></sub><sub><sub><em>1</em></sub></sub>and
|
||||
<em>k + 1 =
|
||||
v</em><sub><em>i</em></sub><sub><sub><em>2</em></sub></sub>of these
|
||||
containers holds <em>i</em><sub><em>1</em></sub> <em><
|
||||
i</em><sub><em>2</em></sub>.</p>
|
||||
<h4>Example</h4>
|
||||
<pre>
|
||||
#include <boost/numeric/ublas/vector_sparse.hpp>
|
||||
#include <boost/numeric/ublas/io.hpp>
|
||||
|
||||
int main () {
|
||||
using namespace boost::numeric::ublas;
|
||||
compressed_vector<double> v (3, 3);
|
||||
for (unsigned i = 0; i < v.size (); ++ i)
|
||||
v (i) = i;
|
||||
std::cout << v << std::endl;
|
||||
}
|
||||
</pre>
|
||||
<h4>Definition</h4>
|
||||
<p>Defined in the header vector_sparse.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 compressed vector.</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>IB</code></td>
|
||||
<td>The index base of the compressed vector. <a href=
|
||||
"#compressed_vector_1">[1]</a></td>
|
||||
<td><code>0</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>IA</code></td>
|
||||
<td>The type of the adapted array for indices. <a href=
|
||||
"#compressed_vector_2">[2]</a></td>
|
||||
<td><code>unbounded_array<std::size_t></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>TA</code></td>
|
||||
<td>The type of the adapted array for values. <a href=
|
||||
"#compressed_vector_2">[2]</a></td>
|
||||
<td><code>unbounded_array<T></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4>Model of</h4>
|
||||
<p><a href="container_concept.html#vector">Vector</a> .</p>
|
||||
<h4>Type requirements</h4>
|
||||
<p>None, except for those imposed by the requirements of <a href=
|
||||
"container_concept.html#vector">Vector</a> .</p>
|
||||
<h4>Public base classes</h4>
|
||||
<p><code>vector_container<compressed_vector<T, IB, IA,
|
||||
TA> ></code></p>
|
||||
<h4>Members</h4>
|
||||
<table border="1" summary="members">
|
||||
<tbody>
|
||||
<tr>
|
||||
<th>Member</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>compressed_vector ()</code></td>
|
||||
<td>Allocates a <code>compressed_vector</code> that holds zero
|
||||
elements.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>compressed_vector (size_type size, size_type
|
||||
non_zeros)</code></td>
|
||||
<td>Allocates a <code>compressed_vector</code> that holds at most
|
||||
<code>size</code> elements.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>compressed_vector (const compressed_vector
|
||||
&v)</code></td>
|
||||
<td>The copy constructor.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
compressed_vector (size_type non_zeros, const
|
||||
vector_expression<AE> &ae)</code></td>
|
||||
<td>The extended copy constructor.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>void resize (size_type size, bool
|
||||
preserve = true)</code></td>
|
||||
<td>Reallocates a <code>compressed_vector</code> to hold at most
|
||||
<code>size</code> elements. The existing elements of the
|
||||
<code>compress_vector</code> are preseved when specified.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>size_type size () const</code></td>
|
||||
<td>Returns the size of the <code>compressed_vector</code>.</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>reference operator () (size_type i)</code></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>Returns the value of the <code>i</code>-th element.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>reference operator [] (size_type i)</code></td>
|
||||
<td>Returns a reference of the <code>i</code>-th element.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>compressed_vector &operator = (const
|
||||
compressed_vector &v)</code></td>
|
||||
<td>The assignment operator.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>compressed_vector &assign_temporary
|
||||
(compressed_vector &v)</code></td>
|
||||
<td>Assigns a temporary. May change the compressed vector
|
||||
<code>v</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
compressed_vector &operator = (const
|
||||
vector_expression<AE> &ae)</code></td>
|
||||
<td>The extended assignment operator.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
compressed_vector &assign (const vector_expression<AE>
|
||||
&ae)</code></td>
|
||||
<td>Assigns a vector expression to the compressed vector. Left and
|
||||
right hand side of the assignment should be independent.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
compressed_vector &operator += (const
|
||||
vector_expression<AE> &ae)</code></td>
|
||||
<td>A computed assignment operator. Adds the vector expression to
|
||||
the compressed vector.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
compressed_vector &plus_assign (const
|
||||
vector_expression<AE> &ae)</code></td>
|
||||
<td>Adds a vector expression to the compressed vector. Left and
|
||||
right hand side of the assignment should be independent.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
compressed_vector &operator -= (const
|
||||
vector_expression<AE> &ae)</code></td>
|
||||
<td>A computed assignment operator. Subtracts the vector expression
|
||||
from the compressed vector.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
compressed_vector &minus_assign (const
|
||||
vector_expression<AE> &ae)</code></td>
|
||||
<td>Subtracts a vector expression from the compressed vector. Left
|
||||
and right hand side of the assignment should be independent.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AT><br />
|
||||
compressed_vector &operator *= (const AT &at)</code></td>
|
||||
<td>A computed assignment operator. Multiplies the compressed
|
||||
vector with a scalar.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AT><br />
|
||||
compressed_vector &operator /= (const AT &at)</code></td>
|
||||
<td>A computed assignment operator. Divides the compressed vector
|
||||
through a scalar.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>void swap (compressed_vector &v)</code></td>
|
||||
<td>Swaps the contents of the compressed vectors.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>true_reference insert_element (size_type i, const_reference t)</code></td>
|
||||
<td>Inserts the value <code>t</code> at the <code>i</code>-th
|
||||
element. Duplicates elements are not allowed.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>void erase_element (size_type i)</code></td>
|
||||
<td>Erases the value at the <code>i</code>-th element.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>void clear ()</code></td>
|
||||
<td>Clears the compressed vector.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_iterator begin () const</code></td>
|
||||
<td>Returns a <code>const_iterator</code> pointing to the beginning
|
||||
of the <code>compressed_vector</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_iterator end () const</code></td>
|
||||
<td>Returns a <code>const_iterator</code> pointing to the end of
|
||||
the <code>compressed_vector</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>iterator begin ()</code></td>
|
||||
<td>Returns a <code>iterator</code> pointing to the beginning of
|
||||
the <code>compressed_vector</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>iterator end ()</code></td>
|
||||
<td>Returns a <code>iterator</code> pointing to the end of the
|
||||
<code>compressed_vector</code>.</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 <code>compressed_vector</code>.</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 <code>compressed_vector</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>reverse_iterator rbegin ()</code></td>
|
||||
<td>Returns a <code>reverse_iterator</code> pointing to the
|
||||
beginning of the reversed <code>compressed_vector</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>reverse_iterator rend ()</code></td>
|
||||
<td>Returns a <code>reverse_iterator</code> pointing to the end of
|
||||
the reversed <code>compressed_vector</code>.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4>Notes</h4>
|
||||
<p><a name="compressed_vector_1">[1]</a>
|
||||
Supported parameters for the index base are <code>0</code> and
|
||||
<code>1</code> at least.</p>
|
||||
<p><a name="compressed_vector_2">[2]</a>
|
||||
Supported parameters for the adapted array are
|
||||
<code>unbounded_array<></code> ,
|
||||
<code>bounded_array<></code> and
|
||||
<code>std::vector<></code> .</p>
|
||||
<h2><a name="coordinate_vector"></a>Coordinate Vector</h2>
|
||||
<h4>Description</h4>
|
||||
<p>The templated class <code>coordinate_vector<T, IB, IA,
|
||||
TA></code> is the base container adaptor for compressed vectors.
|
||||
For a <em>n</em>-dimensional sorted coordinate vector and <em>0
|
||||
<= i < n</em> the non-zero elements
|
||||
<em>v</em><sub><em>i</em></sub> are mapped to consecutive elements
|
||||
of the index and value container, i.e. for elements <em>k</em> =
|
||||
<em>v</em><sub><em>i</em></sub><sub><sub><em>1</em></sub></sub>and
|
||||
<em>k + 1 =
|
||||
v</em><sub><em>i</em></sub><sub><sub><em>2</em></sub></sub>of these
|
||||
containers holds <em>i</em><sub><em>1</em></sub> <em><
|
||||
i</em><sub><em>2</em></sub>.</p>
|
||||
<h4>Example</h4>
|
||||
<pre>
|
||||
#include <boost/numeric/ublas/vector_sparse.hpp>
|
||||
#include <boost/numeric/ublas/io.hpp>
|
||||
|
||||
int main () {
|
||||
using namespace boost::numeric::ublas;
|
||||
coordinate_vector<double> v (3, 3);
|
||||
for (unsigned i = 0; i < v.size (); ++ i)
|
||||
v (i) = i;
|
||||
std::cout << v << std::endl;
|
||||
}
|
||||
</pre>
|
||||
<h4>Definition</h4>
|
||||
<p>Defined in the header vector_sparse.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 coordinate vector.</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>IB</code></td>
|
||||
<td>The index base of the coordinate vector. <a href=
|
||||
"#coordinate_vector_1">[1]</a></td>
|
||||
<td><code>0</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>IA</code></td>
|
||||
<td>The type of the adapted array for indices. <a href=
|
||||
"#coordinate_vector_2">[2]</a></td>
|
||||
<td><code>unbounded_array<std::size_t></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>TA</code></td>
|
||||
<td>The type of the adapted array for values. <a href=
|
||||
"#coordinate_vector_2">[2]</a></td>
|
||||
<td><code>unbounded_array<T></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4>Model of</h4>
|
||||
<p><a href="container_concept.html#vector">Vector</a> .</p>
|
||||
<h4>Type requirements</h4>
|
||||
<p>None, except for those imposed by the requirements of <a href=
|
||||
"container_concept.html#vector">Vector</a> .</p>
|
||||
<h4>Public base classes</h4>
|
||||
<p><code>vector_container<coordinate_vector<T, IB, IA,
|
||||
TA> ></code></p>
|
||||
<h4>Members</h4>
|
||||
<table border="1" summary="members">
|
||||
<tbody>
|
||||
<tr>
|
||||
<th>Member</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>coordinate_vector ()</code></td>
|
||||
<td>Allocates a <code>coordinate_vector</code> that holds zero
|
||||
elements.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>coordinate_vector (size_type size, size_type
|
||||
non_zeros)</code></td>
|
||||
<td>Allocates a <code>coordinate_vector</code> that holds at most
|
||||
<code>size</code> elements.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>coordinate_vector (const coordinate_vector
|
||||
&v)</code></td>
|
||||
<td>The copy constructor.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
coordinate_vector (size_type non_zeros, const
|
||||
vector_expression<AE> &ae)</code></td>
|
||||
<td>The extended copy constructor.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>void resize (size_type size, bool
|
||||
preserve = true)</code></td>
|
||||
<td>Reallocates a <code>coordinate_vector</code> to hold at most
|
||||
<code>size</code> elements. The existing elements of the
|
||||
<code>coordinate_vector</code> are preseved when specified.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>size_type size () const</code></td>
|
||||
<td>Returns the size of the <code>coordinate_vector</code>.</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>reference operator () (size_type i)</code></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>Returns the value of the <code>i</code>-th element.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>reference operator [] (size_type i)</code></td>
|
||||
<td>Returns a reference of the <code>i</code>-th element.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>coordinate_vector &operator = (const
|
||||
coordinate_vector &v)</code></td>
|
||||
<td>The assignment operator.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>coordinate_vector &assign_temporary
|
||||
(coordinate_vector &v)</code></td>
|
||||
<td>Assigns a temporary. May change the coordinate vector
|
||||
<code>v</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
coordinate_vector &operator = (const
|
||||
vector_expression<AE> &ae)</code></td>
|
||||
<td>The extended assignment operator.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
coordinate_vector &assign (const vector_expression<AE>
|
||||
&ae)</code></td>
|
||||
<td>Assigns a vector expression to the coordinate vector. Left and
|
||||
right hand side of the assignment should be independent.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
coordinate_vector &operator += (const
|
||||
vector_expression<AE> &ae)</code></td>
|
||||
<td>A computed assignment operator. Adds the vector expression to
|
||||
the coordinate vector.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
coordinate_vector &plus_assign (const
|
||||
vector_expression<AE> &ae)</code></td>
|
||||
<td>Adds a vector expression to the coordinate vector. Left and
|
||||
right hand side of the assignment should be independent.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
coordinate_vector &operator -= (const
|
||||
vector_expression<AE> &ae)</code></td>
|
||||
<td>A computed assignment operator. Subtracts the vector expression
|
||||
from the coordinate vector.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AE><br />
|
||||
coordinate_vector &minus_assign (const
|
||||
vector_expression<AE> &ae)</code></td>
|
||||
<td>Subtracts a vector expression from the coordinate vector. Left
|
||||
and right hand side of the assignment should be independent.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AT><br />
|
||||
coordinate_vector &operator *= (const AT &at)</code></td>
|
||||
<td>A computed assignment operator. Multiplies the coordinate
|
||||
vector with a scalar.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>template<class AT><br />
|
||||
coordinate_vector &operator /= (const AT &at)</code></td>
|
||||
<td>A computed assignment operator. Divides the coordinate vector
|
||||
through a scalar.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>void swap (coordinate_vector &v)</code></td>
|
||||
<td>Swaps the contents of the coordinate vectors.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>true_reference insert_element (size_type i, const_reference t)</code></td>
|
||||
<td>Inserts the value <code>t</code> at the <code>i</code>-th
|
||||
element. Duplicates elements are not allowed.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>void append_element (size_type i, size_type j, const_reference t)</code></td>
|
||||
<td>Appends the value <code>t</code> at the <code>i</code>-th element.
|
||||
Duplicate elements can be appended to a <code>coordinate_vector</code>. They are merged into a single
|
||||
arithmetically summed element by the <code>sort</code> function.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>void erase_element (size_type i)</code></td>
|
||||
<td>Erases the value at the <code>i</code>-th element.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>void clear ()</code></td>
|
||||
<td>Clears the coordinate vector.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_iterator begin () const</code></td>
|
||||
<td>Returns a <code>const_iterator</code> pointing to the beginning
|
||||
of the <code>coordinate_vector</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>const_iterator end () const</code></td>
|
||||
<td>Returns a <code>const_iterator</code> pointing to the end of
|
||||
the <code>coordinate_vector</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>iterator begin ()</code></td>
|
||||
<td>Returns a <code>iterator</code> pointing to the beginning of
|
||||
the <code>coordinate_vector</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>iterator end ()</code></td>
|
||||
<td>Returns a <code>iterator</code> pointing to the end of the
|
||||
<code>coordinate_vector</code>.</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 <code>coordinate_vector</code>.</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 <code>coordinate_vector</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>reverse_iterator rbegin ()</code></td>
|
||||
<td>Returns a <code>reverse_iterator</code> pointing to the
|
||||
beginning of the reversed <code>coordinate_vector</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>reverse_iterator rend ()</code></td>
|
||||
<td>Returns a <code>reverse_iterator</code> pointing to the end of
|
||||
the reversed <code>coordinate_vector</code>.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4>Notes</h4>
|
||||
<p><a name="coordinate_vector_1">[1]</a>
|
||||
Supported parameters for the index base are <code>0</code> and
|
||||
<code>1</code> at least.</p>
|
||||
<p><a name="coordinate_vector_2">[2]</a>
|
||||
Supported parameters for the adapted array are
|
||||
<code>unbounded_array<></code> ,
|
||||
<code>bounded_array<></code> and
|
||||
<code>std::vector<></code> .</p>
|
||||
<hr />
|
||||
<p>Copyright (©) 2000-2002 Joerg Walter, Mathias Koch<br />
|
||||
Use, modification and distribution are subject to the
|
||||
Boost Software License, Version 1.0.
|
||||
(See accompanying file LICENSE_1_0.txt
|
||||
or copy at <a href="http://www.boost.org/LICENSE_1_0.txt">
|
||||
http://www.boost.org/LICENSE_1_0.txt
|
||||
</a>).
|
||||
</p>
|
||||
<script type="text/javascript">
|
||||
(function($) {
|
||||
$('#toc').toc();
|
||||
})(jQuery);
|
||||
</script>
|
||||
</body>
|
||||
</html>
|
||||
Reference in New Issue
Block a user