mirror of
https://github.com/boostorg/ublas.git
synced 2026-02-14 13:12:14 +00:00
1899 lines
72 KiB
HTML
1899 lines
72 KiB
HTML
<html>
|
||
|
||
<head>
|
||
<meta http-equiv="Content-Type"
|
||
content="text/html; charset=iso-8859-1">
|
||
<meta name="GENERATOR" content="Microsoft FrontPage Express 2.0">
|
||
<title>Sparse Matrix</title>
|
||
</head>
|
||
|
||
<body bgcolor="#FFFFFF">
|
||
|
||
<h1><img src="c++boost.gif" alt="c++boost.gif" align="center"
|
||
width="277" height="86">Sparse Matrix</h1>
|
||
|
||
<h2><a name="sparse_matrix"></a>Sparse Matrix</h2>
|
||
|
||
<h4>Description</h4>
|
||
|
||
<p>The templated class <code>sparse_matrix<T, F, A> </code>is
|
||
the base container adaptor for sparse matrices. For a <em>(m x n</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><sub><em>
|
||
</em></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><sub><em>
|
||
</em></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>int main () {
|
||
using namespace boost::numeric::ublas;
|
||
sparse_matrix<double> m (3, 3, 3 * 3);
|
||
for (int i = 0; i < m.size1 (); ++ i)
|
||
for (int 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">
|
||
<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 sparse matrix. </td>
|
||
<td> </td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>F</code></td>
|
||
<td>Functor describing the storage organization. <a
|
||
href="#sparse_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="#sparse_matrix_2">[2]</a></td>
|
||
<td><code>map_array<std::size_t, T></code></td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h4>Model of</h4>
|
||
|
||
<p><a href="container.htm#matrix">Matrix</a>. </p>
|
||
|
||
<h4>Type requirements</h4>
|
||
|
||
<p>None, except for those imposed by the requirements of <a
|
||
href="container.htm#matrix">Matrix</a>.</p>
|
||
|
||
<h4>Public base classes</h4>
|
||
|
||
<p><code>matrix_expression<sparse_matrix<T, F, A> ></code>
|
||
</p>
|
||
|
||
<h4>Members</h4>
|
||
|
||
<table border="1">
|
||
<tr>
|
||
<th>Member </th>
|
||
<th>Description </th>
|
||
</tr>
|
||
<tr>
|
||
<td><code>sparse_matrix ()</code> </td>
|
||
<td>Allocates a <code>sparse_matrix </code>that holds at
|
||
most zero rows of zero elements.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>sparse_matrix (size_type size1, size_type2,
|
||
size_type non_zeros)</code></td>
|
||
<td>Allocates a <code>sparse_matrix </code>that holds at
|
||
most <code>size1 </code>rows of <code>size2 </code>elements.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>sparse_matrix (const sparse_matrix &m)</code></td>
|
||
<td>The copy constructor.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>template<class AE><br>
|
||
sparse_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,
|
||
size_type non_zeros)</code></td>
|
||
<td>Reallocates a <code>sparse_matrix </code>to hold at
|
||
most <code>size1 </code>rows of <code>size2 </code>elements.
|
||
The content of the <code>sparse_matrix </code>is
|
||
preserved.</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>sparse_matrix &operator = (const
|
||
sparse_matrix &m)</code></td>
|
||
<td>The assignment operator.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>sparse_matrix &assign_temporary
|
||
(sparse_matrix &m)</code></td>
|
||
<td>Assigns a temporary. May change the sparse matrix <code>m</code>.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>template<class AE><br>
|
||
sparse_matrix &operator = (const
|
||
matrix_expression<AE> &ae)</code></td>
|
||
<td>The extended assignment operator.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>template<class AE><br>
|
||
sparse_matrix &assign (const
|
||
matrix_expression<AE> &ae)</code></td>
|
||
<td>Assigns a matrix expression to the sparse matrix.
|
||
Left and right hand side of the assignment should be
|
||
independent.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>template<class AE><br>
|
||
sparse_matrix &operator += (const
|
||
matrix_expression<AE> &ae)</code></td>
|
||
<td>A computed assignment operator. Adds the matrix
|
||
expression to the sparse matrix.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>template<class AE><br>
|
||
sparse_matrix &plus_assign (const
|
||
matrix_expression<AE> &ae)</code></td>
|
||
<td>Adds a matrix expression to the sparse matrix. Left
|
||
and right hand side of the assignment should be
|
||
independent.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>template<class AE><br>
|
||
sparse_matrix &operator -= (const
|
||
matrix_expression<AE> &ae)</code></td>
|
||
<td>A computed assignment operator. Subtracts the matrix
|
||
expression from the sparse matrix.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>template<class AE><br>
|
||
sparse_matrix &minus_assign (const
|
||
matrix_expression<AE> &ae)</code></td>
|
||
<td>Subtracts a matrix expression from the sparse matrix.
|
||
Left and right hand side of the assignment should be
|
||
independent.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>template<class AT><br>
|
||
sparse_matrix &operator *= (const AT &at)</code></td>
|
||
<td>A computed assignment operator. Multiplies the sparse
|
||
matrix with a scalar.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>template<class AT><br>
|
||
sparse_matrix &operator /= (const AT &at)</code></td>
|
||
<td>A computed assignment operator. Divides the sparse
|
||
matrix through a scalar.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>void swap (sparse_matrix &m)</code></td>
|
||
<td>Swaps the contents of the sparse 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 element of
|
||
the <code>i</code>-th row.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>void clear ()</code></td>
|
||
<td>Clears the sparse 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>sparse_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>sparse_matrix</code>. </td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>iterator1 begin1 () </code></td>
|
||
<td>Returns a <code>iterator1</code> pointing to the
|
||
beginning of the <code>sparse_matrix</code>. </td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>iterator1 end1 () </code></td>
|
||
<td>Returns a <code>iterator1</code> pointing to the end
|
||
of the <code>sparse_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>sparse_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>sparse_matrix</code>. </td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>iterator2 begin2 () </code></td>
|
||
<td>Returns a <code>iterator2</code> pointing to the
|
||
beginning of the <code>sparse_matrix</code>. </td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>iterator2 end2 () </code></td>
|
||
<td>Returns a <code>iterator2</code> pointing to the end
|
||
of the <code>sparse_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>sparse_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>sparse_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>sparse_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>sparse_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>sparse_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>sparse_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>sparse_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>sparse_matrix</code>. </td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h4>Notes</h4>
|
||
|
||
<p><a name="#sparse_matrix_1">[1]</a> Supported parameters for
|
||
the storage organization are <code>row_major</code> and <code>column_major</code>.</p>
|
||
|
||
<p><a name="#sparse_matrix_2">[2]</a> Supported parameters for
|
||
the adapted array are <code>map_array<std::size_t, T></code>
|
||
and <code>std::map<std::size_t, T></code>. </p>
|
||
|
||
<h4>Interface</h4>
|
||
|
||
<pre><code> // Array based sparse matrix class
|
||
template<class T, class F, class A>
|
||
class sparse_matrix:
|
||
public matrix_expression<sparse_matrix<T, F, A> > {
|
||
public:
|
||
typedef std::size_t size_type;
|
||
typedef std::ptrdiff_t difference_type;
|
||
typedef T value_type;
|
||
typedef const T &const_reference;
|
||
typedef T &reference;
|
||
typedef const T *const_pointer;
|
||
typedef T *pointer;
|
||
typedef F functor_type;
|
||
typedef A array_type;
|
||
typedef const A const_array_type;
|
||
typedef const sparse_matrix<T, F, A> const_self_type;
|
||
typedef sparse_matrix<T, F, A> self_type;
|
||
typedef const matrix_const_reference<const_self_type> const_closure_type;
|
||
typedef matrix_reference<self_type> closure_type;
|
||
typedef typename A::const_iterator const_iterator_type;
|
||
typedef typename A::iterator iterator_type;
|
||
typedef sparse_tag storage_category;
|
||
typedef typename F::orientation_category orientation_category;
|
||
|
||
// Construction and destruction
|
||
sparse_matrix ();
|
||
sparse_matrix (size_type size1, size_type size2, size_type non_zeros = 0);
|
||
sparse_matrix (const sparse_matrix &m);
|
||
template<class AE>
|
||
sparse_matrix (const matrix_expression<AE> &ae, size_type non_zeros = 0);
|
||
|
||
// Accessors
|
||
size_type size1 () const;
|
||
size_type size2 () const;
|
||
size_type non_zeros () const;
|
||
const_array_type &data () const;
|
||
array_type &data ();
|
||
|
||
// Resizing
|
||
void resize (size_type size1, size_type size2, size_type non_zeros = 0);
|
||
|
||
// Element access
|
||
const_reference operator () (size_type i, size_type j) const;
|
||
reference operator () (size_type i, size_type j);
|
||
|
||
// Assignment
|
||
sparse_matrix &operator = (const sparse_matrix &m);
|
||
sparse_matrix &assign_temporary (sparse_matrix &m);
|
||
template<class AE>
|
||
sparse_matrix &operator = (const matrix_expression<AE> &ae);
|
||
template<class AE>
|
||
sparse_matrix &reset (const matrix_expression<AE> &ae);
|
||
template<class AE>
|
||
sparse_matrix &assign (const matrix_expression<AE> &ae);
|
||
template<class AE>
|
||
sparse_matrix& operator += (const matrix_expression<AE> &ae);
|
||
template<class AE>
|
||
sparse_matrix &plus_assign (const matrix_expression<AE> &ae);
|
||
template<class AE>
|
||
sparse_matrix& operator -= (const matrix_expression<AE> &ae);
|
||
template<class AE>
|
||
sparse_matrix &minus_assign (const matrix_expression<AE> &ae);
|
||
template<class AT>
|
||
sparse_matrix& operator *= (const AT &at);
|
||
template<class AT>
|
||
sparse_matrix& operator /= (const AT &at);
|
||
|
||
// Swapping
|
||
void swap (sparse_matrix &m);
|
||
friend void swap (sparse_matrix &m1, sparse_matrix &m2);
|
||
|
||
// Element insertion and erasure
|
||
void insert (size_type i, size_type j, const_reference t);
|
||
void erase (size_type i, size_type j);
|
||
void clear ();
|
||
|
||
class const_iterator1;
|
||
class iterator1;
|
||
class const_iterator2;
|
||
class iterator2;
|
||
typedef reverse_iterator_base1<const_iterator1> const_reverse_iterator1;
|
||
typedef reverse_iterator_base1<iterator1> reverse_iterator1;
|
||
typedef reverse_iterator_base2<const_iterator2> const_reverse_iterator2;
|
||
typedef reverse_iterator_base2<iterator2> reverse_iterator2;
|
||
|
||
// Element lookup
|
||
const_iterator1 find1 (int rank, size_type i, size_type j) const;
|
||
iterator1 find1 (int rank, size_type i, size_type j);
|
||
const_iterator2 find2 (int rank, size_type i, size_type j) const;
|
||
iterator2 find2 (int rank, size_type i, size_type j);
|
||
const_iterator1 find_first1 (int rank, size_type i, size_type j) const;
|
||
iterator1 find_first1 (int rank, size_type i, size_type j);
|
||
const_iterator1 find_last1 (int rank, size_type i, size_type j) const;
|
||
iterator1 find_last1 (int rank, size_type i, size_type j);
|
||
const_iterator2 find_first2 (int rank, size_type i, size_type j) const;
|
||
iterator2 find_first2 (int rank, size_type i, size_type j);
|
||
const_iterator2 find_last2 (int rank, size_type i, size_type j) const;
|
||
iterator2 find_last2 (int rank, size_type i, size_type j);
|
||
|
||
// Iterators simply are pointers.
|
||
|
||
class const_iterator1:
|
||
public container_const_reference<sparse_matrix>,
|
||
public bidirectional_iterator_base<const_iterator1, value_type> {
|
||
public:
|
||
typedef sparse_bidirectional_iterator_tag iterator_category;
|
||
typedef typename sparse_matrix::difference_type difference_type;
|
||
typedef typename sparse_matrix::value_type value_type;
|
||
typedef typename sparse_matrix::const_reference reference;
|
||
typedef typename sparse_matrix::const_pointer pointer;
|
||
typedef const_iterator2 dual_iterator_type;
|
||
typedef const_reverse_iterator2 dual_reverse_iterator_type;
|
||
typedef typename functor_type::functor1_type functor1_type;
|
||
|
||
// Construction and destruction
|
||
const_iterator1 ();
|
||
const_iterator1 (const sparse_matrix &m, int rank, size_type i, size_type j, const const_iterator_type &it);
|
||
const_iterator1 (const iterator1 &it);
|
||
|
||
// Arithmetic
|
||
const_iterator1 &operator ++ ();
|
||
const_iterator1 &operator -- ();
|
||
|
||
// Dereference
|
||
reference operator * () const;
|
||
|
||
const_iterator2 begin () const;
|
||
const_iterator2 end () const;
|
||
const_reverse_iterator2 rbegin () const;
|
||
const_reverse_iterator2 rend () const;
|
||
|
||
// Indices
|
||
size_type index1 () const;
|
||
size_type index2 () const;
|
||
|
||
// Assignment
|
||
const_iterator1 &operator = (const const_iterator1 &it);
|
||
|
||
// Comparison
|
||
bool operator == (const const_iterator1 &it) const;
|
||
};
|
||
|
||
const_iterator1 begin1 () const;
|
||
const_iterator1 end1 () const;
|
||
|
||
class iterator1:
|
||
public container_reference<sparse_matrix>,
|
||
public bidirectional_iterator_base<iterator1, value_type> {
|
||
public:
|
||
typedef sparse_bidirectional_iterator_tag iterator_category;
|
||
typedef typename sparse_matrix::difference_type difference_type;
|
||
typedef typename sparse_matrix::value_type value_type;
|
||
typedef typename sparse_matrix::reference reference;
|
||
typedef typename sparse_matrix::pointer pointer;
|
||
typedef iterator2 dual_iterator_type;
|
||
typedef reverse_iterator2 dual_reverse_iterator_type;
|
||
typedef typename functor_type::functor1_type functor1_type;
|
||
|
||
// Construction and destruction
|
||
iterator1 ();
|
||
iterator1 (sparse_matrix &m, int rank, size_type i, size_type j, const iterator_type &it);
|
||
|
||
// Arithmetic
|
||
iterator1 &operator ++ ();
|
||
iterator1 &operator -- ();
|
||
|
||
// Dereference
|
||
reference operator * () const;
|
||
|
||
iterator2 begin () const;
|
||
iterator2 end () const;
|
||
reverse_iterator2 rbegin () const;
|
||
reverse_iterator2 rend () const;
|
||
|
||
// Indices
|
||
size_type index1 () const;
|
||
size_type index2 () const;
|
||
|
||
// Assignment
|
||
iterator1 &operator = (const iterator1 &it);
|
||
|
||
// Comparison
|
||
bool operator == (const iterator1 &it) const;
|
||
};
|
||
|
||
iterator1 begin1 ();
|
||
iterator1 end1 ();
|
||
|
||
class const_iterator2:
|
||
public container_const_reference<sparse_matrix>,
|
||
public bidirectional_iterator_base<const_iterator2, value_type> {
|
||
public:
|
||
typedef sparse_bidirectional_iterator_tag iterator_category;
|
||
typedef typename sparse_matrix::difference_type difference_type;
|
||
typedef typename sparse_matrix::value_type value_type;
|
||
typedef typename sparse_matrix::const_reference reference;
|
||
typedef typename sparse_matrix::const_pointer pointer;
|
||
typedef const_iterator1 dual_iterator_type;
|
||
typedef const_reverse_iterator1 dual_reverse_iterator_type;
|
||
typedef typename functor_type::functor2_type functor2_type;
|
||
|
||
// Construction and destruction
|
||
const_iterator2 ();
|
||
const_iterator2 (const sparse_matrix &m, int rank, size_type i, size_type j, const const_iterator_type &it);
|
||
const_iterator2 (const iterator2 &it);
|
||
|
||
// Arithmetic
|
||
const_iterator2 &operator ++ ();
|
||
const_iterator2 &operator -- ();
|
||
|
||
// Dereference
|
||
reference operator * () const;
|
||
|
||
const_iterator1 begin () const;
|
||
const_iterator1 end () const;
|
||
const_reverse_iterator1 rbegin () const;
|
||
const_reverse_iterator1 rend () const;
|
||
|
||
// Indices
|
||
size_type index1 () const;
|
||
size_type index2 () const;
|
||
|
||
// Assignment
|
||
const_iterator2 &operator = (const const_iterator2 &it);
|
||
|
||
// Comparison
|
||
bool operator == (const const_iterator2 &it) const;
|
||
};
|
||
|
||
const_iterator2 begin2 () const;
|
||
const_iterator2 end2 () const;
|
||
|
||
class iterator2:
|
||
public container_reference<sparse_matrix>,
|
||
public bidirectional_iterator_base<iterator2, value_type> {
|
||
public:
|
||
typedef sparse_bidirectional_iterator_tag iterator_category;
|
||
typedef typename sparse_matrix::difference_type difference_type;
|
||
typedef typename sparse_matrix::value_type value_type;
|
||
typedef typename sparse_matrix::reference reference;
|
||
typedef typename sparse_matrix::pointer pointer;
|
||
typedef iterator1 dual_iterator_type;
|
||
typedef reverse_iterator1 dual_reverse_iterator_type;
|
||
typedef typename functor_type::functor2_type functor2_type;
|
||
|
||
// Construction and destruction
|
||
iterator2 ();
|
||
iterator2 (sparse_matrix &m, int rank, size_type i, size_type j, const iterator_type &it);
|
||
|
||
// Arithmetic
|
||
iterator2 &operator ++ ();
|
||
iterator2 &operator -- ();
|
||
|
||
// Dereference
|
||
reference operator * () const;
|
||
|
||
iterator1 begin () const;
|
||
iterator1 end () const;
|
||
reverse_iterator1 rbegin () const;
|
||
reverse_iterator1 rend () const;
|
||
|
||
// Indices
|
||
size_type index1 () const;
|
||
size_type index2 () const;
|
||
|
||
// Assignment
|
||
iterator2 &operator = (const iterator2 &it);
|
||
|
||
// Comparison
|
||
bool operator == (const iterator2 &it) const;
|
||
};
|
||
|
||
iterator2 begin2 ();
|
||
iterator2 end2 ();
|
||
|
||
// Reverse iterators
|
||
|
||
const_reverse_iterator1 rbegin1 () const;
|
||
const_reverse_iterator1 rend1 () const;
|
||
|
||
reverse_iterator1 rbegin1 ();
|
||
reverse_iterator1 rend1 ();
|
||
|
||
const_reverse_iterator2 rbegin2 () const;
|
||
const_reverse_iterator2 rend2 () const;
|
||
|
||
reverse_iterator2 rbegin2 ();
|
||
reverse_iterator2 rend2 ();
|
||
};</code></pre>
|
||
|
||
<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><sub><em>
|
||
</em></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><sub><em>
|
||
</em></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>int main () {
|
||
using namespace boost::numeric::ublas;
|
||
compressed_matrix<double> m (3, 3, 3 * 3);
|
||
for (int i = 0; i < m.size1 (); ++ i)
|
||
for (int 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">
|
||
<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>
|
||
</table>
|
||
|
||
<h4>Model of</h4>
|
||
|
||
<p><a href="container.htm#matrix">Matrix</a>. </p>
|
||
|
||
<h4>Type requirements</h4>
|
||
|
||
<p>None, except for those imposed by the requirements of <a
|
||
href="container.htm#matrix">Matrix</a>.</p>
|
||
|
||
<h4>Public base classes</h4>
|
||
|
||
<p><code>matrix_expression<compressed_matrix<T, F, IB, IA,
|
||
TA> ></code> </p>
|
||
|
||
<h4>Members</h4>
|
||
|
||
<table border="1">
|
||
<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)</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,
|
||
size_type non_zeros)</code></td>
|
||
<td>Reallocates a <code>compressed_matrix </code>to hold
|
||
at most <code>size1 </code>rows of <code>size2 </code>elements.
|
||
The content of the <code>compressed_matrix </code>is
|
||
preserved.</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>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 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>
|
||
</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>
|
||
|
||
<h4>Interface</h4>
|
||
|
||
<pre><code> // Array based sparse matrix class
|
||
template<class T, class F, std::size_t IB, class IA, class TA>
|
||
class compressed_matrix:
|
||
public matrix_expression<compressed_matrix<T, F, IB, IA, TA> > {
|
||
public:
|
||
typedef std::size_t size_type;
|
||
typedef std::ptrdiff_t difference_type;
|
||
typedef T value_type;
|
||
typedef const T &const_reference;
|
||
typedef T &reference;
|
||
typedef const T *const_pointer;
|
||
typedef T *pointer;
|
||
typedef F functor_type;
|
||
typedef IA index_array_type;
|
||
typedef TA value_array_type;
|
||
typedef const compressed_matrix<T, F, IB, IA, TA> const_self_type;
|
||
typedef compressed_matrix<T, F, IB, IA, TA> self_type;
|
||
typedef const matrix_const_reference<const_self_type> const_closure_type;
|
||
typedef matrix_reference<self_type> closure_type;
|
||
typedef typename A::const_iterator const_iterator_type;
|
||
typedef typename A::iterator iterator_type;
|
||
typedef sparse_tag storage_category;
|
||
typedef typename F::orientation_category orientation_category;
|
||
|
||
// Construction and destruction
|
||
compressed_matrix ();
|
||
compressed_matrix (size_type size1, size_type size2, size_type non_zeros = 0);
|
||
compressed_matrix (const compressed_matrix &m);
|
||
template<class AE>
|
||
compressed_matrix (const matrix_expression<AE> &ae, size_type non_zeros = 0);
|
||
|
||
// Accessors
|
||
size_type size1 () const;
|
||
size_type size2 () const;
|
||
size_type non_zeros () const;
|
||
static size_type index_base ();
|
||
const index_array_type &index1_data () const;
|
||
index_array_type &index1_data ();
|
||
const index_array_type &index2_data () const;
|
||
index_array_type &index2_data ();
|
||
const value_array_type &value_data () const;
|
||
value_array_type &value_data ();
|
||
|
||
// Resizing
|
||
void resize (size_type size1, size_type size2, size_type non_zeros = 0);
|
||
|
||
// Element access
|
||
const_reference operator () (size_type i, size_type j) const;
|
||
reference operator () (size_type i, size_type j);
|
||
|
||
// Assignment
|
||
compressed_matrix &operator = (const compressed_matrix &m);
|
||
compressed_matrix &assign_temporary (compressed_matrix &m);
|
||
template<class AE>
|
||
compressed_matrix &operator = (const matrix_expression<AE> &ae);
|
||
template<class AE>
|
||
compressed_matrix &reset (const matrix_expression<AE> &ae);
|
||
template<class AE>
|
||
compressed_matrix &assign (const matrix_expression<AE> &ae);
|
||
template<class AE>
|
||
compressed_matrix& operator += (const matrix_expression<AE> &ae);
|
||
template<class AE>
|
||
compressed_matrix &plus_assign (const matrix_expression<AE> &ae);
|
||
template<class AE>
|
||
compressed_matrix& operator -= (const matrix_expression<AE> &ae);
|
||
template<class AE>
|
||
compressed_matrix &minus_assign (const matrix_expression<AE> &ae);
|
||
template<class AT>
|
||
compressed_matrix& operator *= (const AT &at);
|
||
template<class AT>
|
||
compressed_matrix& operator /= (const AT &at);
|
||
|
||
// Swapping
|
||
void swap (compressed_matrix &m);
|
||
friend void swap (compressed_matrix &m1, compressed_matrix &m2);
|
||
|
||
// Element insertion and erasure
|
||
void insert (size_type i, size_type j, const_reference t);
|
||
void erase (size_type i, size_type j);
|
||
void clear ();
|
||
|
||
class const_iterator1;
|
||
class iterator1;
|
||
class const_iterator2;
|
||
class iterator2;
|
||
typedef reverse_iterator_base1<const_iterator1> const_reverse_iterator1;
|
||
typedef reverse_iterator_base1<iterator1> reverse_iterator1;
|
||
typedef reverse_iterator_base2<const_iterator2> const_reverse_iterator2;
|
||
typedef reverse_iterator_base2<iterator2> reverse_iterator2;
|
||
|
||
// Element lookup
|
||
const_iterator1 find1 (int rank, size_type i, size_type j) const;
|
||
iterator1 find1 (int rank, size_type i, size_type j);
|
||
const_iterator2 find2 (int rank, size_type i, size_type j) const;
|
||
iterator2 find2 (int rank, size_type i, size_type j);
|
||
const_iterator1 find_first1 (int rank, size_type i, size_type j) const;
|
||
iterator1 find_first1 (int rank, size_type i, size_type j);
|
||
const_iterator1 find_last1 (int rank, size_type i, size_type j) const;
|
||
iterator1 find_last1 (int rank, size_type i, size_type j);
|
||
const_iterator2 find_first2 (int rank, size_type i, size_type j) const;
|
||
iterator2 find_first2 (int rank, size_type i, size_type j);
|
||
const_iterator2 find_last2 (int rank, size_type i, size_type j) const;
|
||
iterator2 find_last2 (int rank, size_type i, size_type j);
|
||
|
||
// Iterators simply are pointers.
|
||
|
||
class const_iterator1:
|
||
public container_const_reference<compressed_matrix>,
|
||
public bidirectional_iterator_base<const_iterator1, value_type> {
|
||
public:
|
||
typedef sparse_bidirectional_iterator_tag iterator_category;
|
||
typedef typename compressed_matrix::difference_type difference_type;
|
||
typedef typename compressed_matrix::value_type value_type;
|
||
typedef typename compressed_matrix::const_reference reference;
|
||
typedef typename compressed_matrix::const_pointer pointer;
|
||
typedef const_iterator2 dual_iterator_type;
|
||
typedef const_reverse_iterator2 dual_reverse_iterator_type;
|
||
typedef typename functor_type::functor1_type functor1_type;
|
||
|
||
// Construction and destruction
|
||
const_iterator1 ();
|
||
const_iterator1 (const compressed_matrix &m, int rank, size_type i, size_type j, const const_iterator_type &it);
|
||
const_iterator1 (const iterator1 &it);
|
||
|
||
// Arithmetic
|
||
const_iterator1 &operator ++ ();
|
||
const_iterator1 &operator -- ();
|
||
|
||
// Dereference
|
||
reference operator * () const;
|
||
|
||
const_iterator2 begin () const;
|
||
const_iterator2 end () const;
|
||
const_reverse_iterator2 rbegin () const;
|
||
const_reverse_iterator2 rend () const;
|
||
|
||
// Indices
|
||
size_type index1 () const;
|
||
size_type index2 () const;
|
||
|
||
// Assignment
|
||
const_iterator1 &operator = (const const_iterator1 &it);
|
||
|
||
// Comparison
|
||
bool operator == (const const_iterator1 &it) const;
|
||
};
|
||
|
||
const_iterator1 begin1 () const;
|
||
const_iterator1 end1 () const;
|
||
|
||
class iterator1:
|
||
public container_reference<compressed_matrix>,
|
||
public bidirectional_iterator_base<iterator1, value_type> {
|
||
public:
|
||
typedef sparse_bidirectional_iterator_tag iterator_category;
|
||
typedef typename compressed_matrix::difference_type difference_type;
|
||
typedef typename compressed_matrix::value_type value_type;
|
||
typedef typename compressed_matrix::reference reference;
|
||
typedef typename compressed_matrix::pointer pointer;
|
||
typedef iterator2 dual_iterator_type;
|
||
typedef reverse_iterator2 dual_reverse_iterator_type;
|
||
typedef typename functor_type::functor1_type functor1_type;
|
||
|
||
// Construction and destruction
|
||
iterator1 ();
|
||
iterator1 (compressed_matrix &m, int rank, size_type i, size_type j, const iterator_type &it);
|
||
|
||
// Arithmetic
|
||
iterator1 &operator ++ ();
|
||
iterator1 &operator -- ();
|
||
|
||
// Dereference
|
||
reference operator * () const;
|
||
|
||
iterator2 begin () const;
|
||
iterator2 end () const;
|
||
reverse_iterator2 rbegin () const;
|
||
reverse_iterator2 rend () const;
|
||
|
||
// Indices
|
||
size_type index1 () const;
|
||
size_type index2 () const;
|
||
|
||
// Assignment
|
||
iterator1 &operator = (const iterator1 &it);
|
||
|
||
// Comparison
|
||
bool operator == (const iterator1 &it) const;
|
||
};
|
||
|
||
iterator1 begin1 ();
|
||
iterator1 end1 ();
|
||
|
||
class const_iterator2:
|
||
public container_const_reference<compressed_matrix>,
|
||
public bidirectional_iterator_base<const_iterator2, value_type> {
|
||
public:
|
||
typedef sparse_bidirectional_iterator_tag iterator_category;
|
||
typedef typename compressed_matrix::difference_type difference_type;
|
||
typedef typename compressed_matrix::value_type value_type;
|
||
typedef typename compressed_matrix::const_reference reference;
|
||
typedef typename compressed_matrix::const_pointer pointer;
|
||
typedef const_iterator1 dual_iterator_type;
|
||
typedef const_reverse_iterator1 dual_reverse_iterator_type;
|
||
typedef typename functor_type::functor2_type functor2_type;
|
||
|
||
// Construction and destruction
|
||
const_iterator2 ();
|
||
const_iterator2 (const compressed_matrix &m, int rank, size_type i, size_type j, const const_iterator_type &it);
|
||
const_iterator2 (const iterator2 &it);
|
||
|
||
// Arithmetic
|
||
const_iterator2 &operator ++ ();
|
||
const_iterator2 &operator -- ();
|
||
|
||
// Dereference
|
||
reference operator * () const;
|
||
|
||
const_iterator1 begin () const;
|
||
const_iterator1 end () const;
|
||
const_reverse_iterator1 rbegin () const;
|
||
const_reverse_iterator1 rend () const;
|
||
|
||
// Indices
|
||
size_type index1 () const;
|
||
size_type index2 () const;
|
||
|
||
// Assignment
|
||
const_iterator2 &operator = (const const_iterator2 &it);
|
||
|
||
// Comparison
|
||
bool operator == (const const_iterator2 &it) const;
|
||
};
|
||
|
||
const_iterator2 begin2 () const;
|
||
const_iterator2 end2 () const;
|
||
|
||
class iterator2:
|
||
public container_reference<compressed_matrix>,
|
||
public bidirectional_iterator_base<iterator2, value_type> {
|
||
public:
|
||
typedef sparse_bidirectional_iterator_tag iterator_category;
|
||
typedef typename compressed_matrix::difference_type difference_type;
|
||
typedef typename compressed_matrix::value_type value_type;
|
||
typedef typename compressed_matrix::reference reference;
|
||
typedef typename compressed_matrix::pointer pointer;
|
||
typedef iterator1 dual_iterator_type;
|
||
typedef reverse_iterator1 dual_reverse_iterator_type;
|
||
typedef typename functor_type::functor2_type functor2_type;
|
||
|
||
// Construction and destruction
|
||
iterator2 ();
|
||
iterator2 (compressed_matrix &m, int rank, size_type i, size_type j, const iterator_type &it);
|
||
|
||
// Arithmetic
|
||
iterator2 &operator ++ ();
|
||
iterator2 &operator -- ();
|
||
|
||
// Dereference
|
||
reference operator * () const;
|
||
|
||
iterator1 begin () const;
|
||
iterator1 end () const;
|
||
reverse_iterator1 rbegin () const;
|
||
reverse_iterator1 rend () const;
|
||
|
||
// Indices
|
||
size_type index1 () const;
|
||
size_type index2 () const;
|
||
|
||
// Assignment
|
||
iterator2 &operator = (const iterator2 &it);
|
||
|
||
// Comparison
|
||
bool operator == (const iterator2 &it) const;
|
||
};
|
||
|
||
iterator2 begin2 ();
|
||
iterator2 end2 ();
|
||
|
||
// Reverse iterators
|
||
|
||
const_reverse_iterator1 rbegin1 () const;
|
||
const_reverse_iterator1 rend1 () const;
|
||
|
||
reverse_iterator1 rbegin1 ();
|
||
reverse_iterator1 rend1 ();
|
||
|
||
const_reverse_iterator2 rbegin2 () const;
|
||
const_reverse_iterator2 rend2 () const;
|
||
|
||
reverse_iterator2 rbegin2 ();
|
||
reverse_iterator2 rend2 ();
|
||
};</code></pre>
|
||
|
||
<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><sub><em>
|
||
</em></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><sub><em>
|
||
</em></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>int main () {
|
||
using namespace boost::numeric::ublas;
|
||
coordinate_matrix<double> m (3, 3, 3 * 3);
|
||
for (int i = 0; i < m.size1 (); ++ i)
|
||
for (int 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">
|
||
<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>
|
||
</table>
|
||
|
||
<h4>Model of</h4>
|
||
|
||
<p><a href="container.htm#matrix">Matrix</a>. </p>
|
||
|
||
<h4>Type requirements</h4>
|
||
|
||
<p>None, except for those imposed by the requirements of <a
|
||
href="container.htm#matrix">Matrix</a>.</p>
|
||
|
||
<h4>Public base classes</h4>
|
||
|
||
<p><code>matrix_expression<coordinate_matrix<T, F, IB, IA,
|
||
TA> ></code> </p>
|
||
|
||
<h4>Members</h4>
|
||
|
||
<table border="1">
|
||
<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)</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,
|
||
size_type non_zeros)</code></td>
|
||
<td>Reallocates a <code>coordinate_matrix </code>to hold
|
||
at most <code>size1 </code>rows of <code>size2 </code>elements.
|
||
The content of the <code>coordinate_matrix </code>is
|
||
preserved.</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>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 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>
|
||
</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>
|
||
|
||
<h4>Interface</h4>
|
||
|
||
<pre><code> // Array based sparse matrix class
|
||
template<class T, class F, std::size_t IB, class IA, class TA>
|
||
class coordinate_matrix:
|
||
public matrix_expression<coordinate_matrix<T, F, IB, IA, TA> > {
|
||
public:
|
||
typedef std::size_t size_type;
|
||
typedef std::ptrdiff_t difference_type;
|
||
typedef T value_type;
|
||
typedef const T &const_reference;
|
||
typedef T &reference;
|
||
typedef const T *const_pointer;
|
||
typedef T *pointer;
|
||
typedef F functor_type;
|
||
typedef IA index_array_type;
|
||
typedef TA value_array_type;
|
||
typedef const coordinate_matrix<T, F, IB, IA, TA> const_self_type;
|
||
typedef coordinate_matrix<T, F, IB, IA, TA> self_type;
|
||
typedef const matrix_const_reference<const_self_type> const_closure_type;
|
||
typedef matrix_reference<self_type> closure_type;
|
||
typedef typename A::const_iterator const_iterator_type;
|
||
typedef typename A::iterator iterator_type;
|
||
typedef sparse_tag storage_category;
|
||
typedef typename F::orientation_category orientation_category;
|
||
|
||
// Construction and destruction
|
||
coordinate_matrix ();
|
||
coordinate_matrix (size_type size1, size_type size2, size_type non_zeros = 0);
|
||
coordinate_matrix (const coordinate_matrix &m);
|
||
template<class AE>
|
||
coordinate_matrix (const matrix_expression<AE> &ae, size_type non_zeros = 0);
|
||
|
||
// Accessors
|
||
size_type size1 () const;
|
||
size_type size2 () const;
|
||
size_type non_zeros () const;
|
||
static size_type index_base ();
|
||
const index_array_type &index1_data () const;
|
||
index_array_type &index1_data ();
|
||
const index_array_type &index2_data () const;
|
||
index_array_type &index2_data ();
|
||
const value_array_type &value_data () const;
|
||
value_array_type &value_data ();
|
||
|
||
// Resizing
|
||
void resize (size_type size1, size_type size2, size_type non_zeros = 0);
|
||
|
||
// Element access
|
||
const_reference operator () (size_type i, size_type j) const;
|
||
reference operator () (size_type i, size_type j);
|
||
|
||
// Assignment
|
||
coordinate_matrix &operator = (const coordinate_matrix &m);
|
||
coordinate_matrix &assign_temporary (coordinate_matrix &m);
|
||
template<class AE>
|
||
coordinate_matrix &operator = (const matrix_expression<AE> &ae);
|
||
template<class AE>
|
||
coordinate_matrix &reset (const matrix_expression<AE> &ae);
|
||
template<class AE>
|
||
coordinate_matrix &assign (const matrix_expression<AE> &ae);
|
||
template<class AE>
|
||
coordinate_matrix& operator += (const matrix_expression<AE> &ae);
|
||
template<class AE>
|
||
coordinate_matrix &plus_assign (const matrix_expression<AE> &ae);
|
||
template<class AE>
|
||
coordinate_matrix& operator -= (const matrix_expression<AE> &ae);
|
||
template<class AE>
|
||
coordinate_matrix &minus_assign (const matrix_expression<AE> &ae);
|
||
template<class AT>
|
||
coordinate_matrix& operator *= (const AT &at);
|
||
template<class AT>
|
||
coordinate_matrix& operator /= (const AT &at);
|
||
|
||
// Swapping
|
||
void swap (coordinate_matrix &m);
|
||
friend void swap (coordinate_matrix &m1, coordinate_matrix &m2);
|
||
|
||
// Element insertion and erasure
|
||
void insert (size_type i, size_type j, const_reference t);
|
||
void erase (size_type i, size_type j);
|
||
void clear ();
|
||
|
||
class const_iterator1;
|
||
class iterator1;
|
||
class const_iterator2;
|
||
class iterator2;
|
||
typedef reverse_iterator_base1<const_iterator1> const_reverse_iterator1;
|
||
typedef reverse_iterator_base1<iterator1> reverse_iterator1;
|
||
typedef reverse_iterator_base2<const_iterator2> const_reverse_iterator2;
|
||
typedef reverse_iterator_base2<iterator2> reverse_iterator2;
|
||
|
||
// Element lookup
|
||
const_iterator1 find1 (int rank, size_type i, size_type j) const;
|
||
iterator1 find1 (int rank, size_type i, size_type j);
|
||
const_iterator2 find2 (int rank, size_type i, size_type j) const;
|
||
iterator2 find2 (int rank, size_type i, size_type j);
|
||
const_iterator1 find_first1 (int rank, size_type i, size_type j) const;
|
||
iterator1 find_first1 (int rank, size_type i, size_type j);
|
||
const_iterator1 find_last1 (int rank, size_type i, size_type j) const;
|
||
iterator1 find_last1 (int rank, size_type i, size_type j);
|
||
const_iterator2 find_first2 (int rank, size_type i, size_type j) const;
|
||
iterator2 find_first2 (int rank, size_type i, size_type j);
|
||
const_iterator2 find_last2 (int rank, size_type i, size_type j) const;
|
||
iterator2 find_last2 (int rank, size_type i, size_type j);
|
||
|
||
// Iterators simply are pointers.
|
||
|
||
class const_iterator1:
|
||
public container_const_reference<coordinate_matrix>,
|
||
public bidirectional_iterator_base<const_iterator1, value_type> {
|
||
public:
|
||
typedef sparse_bidirectional_iterator_tag iterator_category;
|
||
typedef typename coordinate_matrix::difference_type difference_type;
|
||
typedef typename coordinate_matrix::value_type value_type;
|
||
typedef typename coordinate_matrix::const_reference reference;
|
||
typedef typename coordinate_matrix::const_pointer pointer;
|
||
typedef const_iterator2 dual_iterator_type;
|
||
typedef const_reverse_iterator2 dual_reverse_iterator_type;
|
||
typedef typename functor_type::functor1_type functor1_type;
|
||
|
||
// Construction and destruction
|
||
const_iterator1 ();
|
||
const_iterator1 (const coordinate_matrix &m, int rank, size_type i, size_type j, const const_iterator_type &it);
|
||
const_iterator1 (const iterator1 &it);
|
||
|
||
// Arithmetic
|
||
const_iterator1 &operator ++ ();
|
||
const_iterator1 &operator -- ();
|
||
|
||
// Dereference
|
||
reference operator * () const;
|
||
|
||
const_iterator2 begin () const;
|
||
const_iterator2 end () const;
|
||
const_reverse_iterator2 rbegin () const;
|
||
const_reverse_iterator2 rend () const;
|
||
|
||
// Indices
|
||
size_type index1 () const;
|
||
size_type index2 () const;
|
||
|
||
// Assignment
|
||
const_iterator1 &operator = (const const_iterator1 &it);
|
||
|
||
// Comparison
|
||
bool operator == (const const_iterator1 &it) const;
|
||
};
|
||
|
||
const_iterator1 begin1 () const;
|
||
const_iterator1 end1 () const;
|
||
|
||
class iterator1:
|
||
public container_reference<coordinate_matrix>,
|
||
public bidirectional_iterator_base<iterator1, value_type> {
|
||
public:
|
||
typedef sparse_bidirectional_iterator_tag iterator_category;
|
||
typedef typename coordinate_matrix::difference_type difference_type;
|
||
typedef typename coordinate_matrix::value_type value_type;
|
||
typedef typename coordinate_matrix::reference reference;
|
||
typedef typename coordinate_matrix::pointer pointer;
|
||
typedef iterator2 dual_iterator_type;
|
||
typedef reverse_iterator2 dual_reverse_iterator_type;
|
||
typedef typename functor_type::functor1_type functor1_type;
|
||
|
||
// Construction and destruction
|
||
iterator1 ();
|
||
iterator1 (coordinate_matrix &m, int rank, size_type i, size_type j, const iterator_type &it);
|
||
|
||
// Arithmetic
|
||
iterator1 &operator ++ ();
|
||
iterator1 &operator -- ();
|
||
|
||
// Dereference
|
||
reference operator * () const;
|
||
|
||
iterator2 begin () const;
|
||
iterator2 end () const;
|
||
reverse_iterator2 rbegin () const;
|
||
reverse_iterator2 rend () const;
|
||
|
||
// Indices
|
||
size_type index1 () const;
|
||
size_type index2 () const;
|
||
|
||
// Assignment
|
||
iterator1 &operator = (const iterator1 &it);
|
||
|
||
// Comparison
|
||
bool operator == (const iterator1 &it) const;
|
||
};
|
||
|
||
iterator1 begin1 ();
|
||
iterator1 end1 ();
|
||
|
||
class const_iterator2:
|
||
public container_const_reference<coordinate_matrix>,
|
||
public bidirectional_iterator_base<const_iterator2, value_type> {
|
||
public:
|
||
typedef sparse_bidirectional_iterator_tag iterator_category;
|
||
typedef typename coordinate_matrix::difference_type difference_type;
|
||
typedef typename coordinate_matrix::value_type value_type;
|
||
typedef typename coordinate_matrix::const_reference reference;
|
||
typedef typename coordinate_matrix::const_pointer pointer;
|
||
typedef const_iterator1 dual_iterator_type;
|
||
typedef const_reverse_iterator1 dual_reverse_iterator_type;
|
||
typedef typename functor_type::functor2_type functor2_type;
|
||
|
||
// Construction and destruction
|
||
const_iterator2 ();
|
||
const_iterator2 (const coordinate_matrix &m, int rank, size_type i, size_type j, const const_iterator_type &it);
|
||
const_iterator2 (const iterator2 &it);
|
||
|
||
// Arithmetic
|
||
const_iterator2 &operator ++ ();
|
||
const_iterator2 &operator -- ();
|
||
|
||
// Dereference
|
||
reference operator * () const;
|
||
|
||
const_iterator1 begin () const;
|
||
const_iterator1 end () const;
|
||
const_reverse_iterator1 rbegin () const;
|
||
const_reverse_iterator1 rend () const;
|
||
|
||
// Indices
|
||
size_type index1 () const;
|
||
size_type index2 () const;
|
||
|
||
// Assignment
|
||
const_iterator2 &operator = (const const_iterator2 &it);
|
||
|
||
// Comparison
|
||
bool operator == (const const_iterator2 &it) const;
|
||
};
|
||
|
||
const_iterator2 begin2 () const;
|
||
const_iterator2 end2 () const;
|
||
|
||
class iterator2:
|
||
public container_reference<coordinate_matrix>,
|
||
public bidirectional_iterator_base<iterator2, value_type> {
|
||
public:
|
||
typedef sparse_bidirectional_iterator_tag iterator_category;
|
||
typedef typename coordinate_matrix::difference_type difference_type;
|
||
typedef typename coordinate_matrix::value_type value_type;
|
||
typedef typename coordinate_matrix::reference reference;
|
||
typedef typename coordinate_matrix::pointer pointer;
|
||
typedef iterator1 dual_iterator_type;
|
||
typedef reverse_iterator1 dual_reverse_iterator_type;
|
||
typedef typename functor_type::functor2_type functor2_type;
|
||
|
||
// Construction and destruction
|
||
iterator2 ();
|
||
iterator2 (coordinate_matrix &m, int rank, size_type i, size_type j, const iterator_type &it);
|
||
|
||
// Arithmetic
|
||
iterator2 &operator ++ ();
|
||
iterator2 &operator -- ();
|
||
|
||
// Dereference
|
||
reference operator * () const;
|
||
|
||
iterator1 begin () const;
|
||
iterator1 end () const;
|
||
reverse_iterator1 rbegin () const;
|
||
reverse_iterator1 rend () const;
|
||
|
||
// Indices
|
||
size_type index1 () const;
|
||
size_type index2 () const;
|
||
|
||
// Assignment
|
||
iterator2 &operator = (const iterator2 &it);
|
||
|
||
// Comparison
|
||
bool operator == (const iterator2 &it) const;
|
||
};
|
||
|
||
iterator2 begin2 ();
|
||
iterator2 end2 ();
|
||
|
||
// Reverse iterators
|
||
|
||
const_reverse_iterator1 rbegin1 () const;
|
||
const_reverse_iterator1 rend1 () const;
|
||
|
||
reverse_iterator1 rbegin1 ();
|
||
reverse_iterator1 rend1 ();
|
||
|
||
const_reverse_iterator2 rbegin2 () const;
|
||
const_reverse_iterator2 rend2 () const;
|
||
|
||
reverse_iterator2 rbegin2 ();
|
||
reverse_iterator2 rend2 ();
|
||
};</code></pre>
|
||
|
||
<hr>
|
||
|
||
<p>Copyright (<28>) 2000-2002 Joerg Walter, Mathias Koch <br>
|
||
Permission to copy, use, modify, sell and distribute this
|
||
document is granted provided this copyright notice appears in all
|
||
copies. This document is provided ``as is'' without express or
|
||
implied warranty, and with no claim as to its suitability for any
|
||
purpose.</p>
|
||
|
||
<p>Last revised: 8/3/2002</p>
|
||
</body>
|
||
</html>
|