mirror of
https://github.com/boostorg/ublas.git
synced 2026-02-09 11:32:19 +00:00
1352 lines
48 KiB
HTML
1352 lines
48 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 Vector</title>
|
||
</head>
|
||
|
||
<body bgcolor="#FFFFFF">
|
||
|
||
<h1><img src="c++boost.gif" alt="c++boost.gif" align="center"
|
||
width="277" height="86">Sparse Vector</h1>
|
||
|
||
<h2><a name="sparse_vector"></a>Sparse Vector</h2>
|
||
|
||
<h4>Description</h4>
|
||
|
||
<p>The templated class <code>sparse_vector<T, A> </code>is
|
||
the base container adaptor for sparse vectors. 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><sub><em>
|
||
</em></sub>and <em>k + 1 = v</em><sub><em>i</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>.</p>
|
||
|
||
<h4>Example</h4>
|
||
|
||
<pre>int main () {
|
||
using namespace boost::numeric::ublas;
|
||
sparse_vector<double> v (3, 3);
|
||
for (int 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">
|
||
<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 vector. </td>
|
||
<td> </td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>A</code></td>
|
||
<td>The type of the adapted array. <a
|
||
href="#sparse_vector_1">[1]</a></td>
|
||
<td><code>map_array<std::size_t, T></code></td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h4>Model of</h4>
|
||
|
||
<p><a href="container.htm#vector">Vector</a>. </p>
|
||
|
||
<h4>Type requirements</h4>
|
||
|
||
<p>None, except for those imposed by the requirements of <a
|
||
href="container.htm#vector">Vector</a>.</p>
|
||
|
||
<h4>Public base classes</h4>
|
||
|
||
<p><code>vector_expression<sparse_vector<T, A> ></code>
|
||
</p>
|
||
|
||
<h4>Members</h4>
|
||
|
||
<table border="1">
|
||
<tr>
|
||
<th>Member </th>
|
||
<th>Description </th>
|
||
</tr>
|
||
<tr>
|
||
<td><code>sparse_vector ()</code> </td>
|
||
<td>Allocates a <code>sparse_vector </code>that holds
|
||
zero elements.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>sparse_vector (size_type size, size_type
|
||
non_zeros)</code></td>
|
||
<td>Allocates a <code>sparse_vector </code>that holds at
|
||
most <code>size</code> elements.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>sparse_vector (const sparse_vector &v)</code></td>
|
||
<td>The copy constructor.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>template<class AE><br>
|
||
sparse_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, size_type
|
||
non_zeros)</code></td>
|
||
<td>Reallocates a <code>sparse_vector </code>to hold at
|
||
most <code>size</code> elements. The content of the <code>sparse_vector
|
||
</code>is preserved.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>size_type size () const</code></td>
|
||
<td>Returns the size of the <code>sparse_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>sparse_vector &operator = (const
|
||
sparse_vector &v)</code></td>
|
||
<td>The assignment operator.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>sparse_vector &assign_temporary
|
||
(sparse_vector &v)</code></td>
|
||
<td>Assigns a temporary. May change the sparse vector <code>v</code>.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>template<class AE><br>
|
||
sparse_vector &operator = (const
|
||
vector_expression<AE> &ae)</code></td>
|
||
<td>The extended assignment operator.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>template<class AE><br>
|
||
sparse_vector &assign (const
|
||
vector_expression<AE> &ae)</code></td>
|
||
<td>Assigns a vector expression to the sparse vector.
|
||
Left and right hand side of the assignment should be
|
||
independent.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>template<class AE><br>
|
||
sparse_vector &operator += (const
|
||
vector_expression<AE> &ae)</code></td>
|
||
<td>A computed assignment operator. Adds the vector
|
||
expression to the sparse vector.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>template<class AE><br>
|
||
sparse_vector &plus_assign (const
|
||
vector_expression<AE> &ae)</code></td>
|
||
<td>Adds a vector expression to the sparse vector. Left
|
||
and right hand side of the assignment should be
|
||
independent.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>template<class AE><br>
|
||
sparse_vector &operator -= (const
|
||
vector_expression<AE> &ae)</code></td>
|
||
<td>A computed assignment operator. Subtracts the vector
|
||
expression from the sparse vector.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>template<class AE><br>
|
||
sparse_vector &minus_assign (const
|
||
vector_expression<AE> &ae)</code></td>
|
||
<td>Subtracts a vector expression from the sparse vector.
|
||
Left and right hand side of the assignment should be
|
||
independent.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>template<class AT><br>
|
||
sparse_vector &operator *= (const AT &at)</code></td>
|
||
<td>A computed assignment operator. Multiplies the sparse
|
||
vector with a scalar.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>template<class AT><br>
|
||
sparse_vector &operator /= (const AT &at)</code></td>
|
||
<td>A computed assignment operator. Divides the sparse
|
||
vector through a scalar.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>void swap (sparse_vector &v)</code></td>
|
||
<td>Swaps the contents of the sparse vectors. </td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>void insert (size_type i, const_reference t)</code></td>
|
||
<td>Inserts the value <code>t</code> at the <code>i</code>-th
|
||
element.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>void erase (size_type i)</code></td>
|
||
<td>Erases the value at the <code>i</code>-th element.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>void clear ()</code></td>
|
||
<td>Clears the sparse 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>sparse_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>sparse_vector</code>. </td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>iterator begin () </code></td>
|
||
<td>Returns a <code>iterator</code> pointing to the
|
||
beginning of the <code>sparse_vector</code>. </td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>iterator end () </code></td>
|
||
<td>Returns a <code>iterator</code> pointing to the end
|
||
of the <code>sparse_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>sparse_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>sparse_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>sparse_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>sparse_vector</code>. </td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h4>Notes</h4>
|
||
|
||
<p><a name="#sparse_vector_1">[1]</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 vector class
|
||
template<class T, class A>
|
||
class sparse_vector:
|
||
public vector_expression<sparse_vector<T, 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 A array_type;
|
||
typedef const A const_array_type;
|
||
typedef const sparse_vector<T, A> const_self_type;
|
||
typedef sparse_vector<T, A> self_type;
|
||
typedef const vector_const_reference<const_self_type> const_closure_type;
|
||
typedef vector_reference<self_type> closure_type;
|
||
typedef typename A::const_iterator const_iterator_type;
|
||
typedef typename A::iterator iterator_type;
|
||
typedef sparse_tag storage_category;
|
||
|
||
// Construction and destruction
|
||
sparse_vector ();
|
||
sparse_vector (size_type size, size_type non_zeros = 0);
|
||
sparse_vector (const sparse_vector &v);
|
||
template<class AE>
|
||
sparse_vector (const vector_expression<AE> &ae, size_type non_zeros = 0);
|
||
|
||
// Accessors
|
||
size_type size () const;
|
||
size_type non_zeros () const;
|
||
const_array_type &data () const;
|
||
array_type &data ();
|
||
|
||
// Resizing
|
||
void resize (size_type size, size_type non_zeros = 0);
|
||
|
||
// Element access
|
||
const_reference operator () (size_type i) const;
|
||
reference operator () (size_type i);
|
||
|
||
const_reference operator [] (size_type i) const;
|
||
reference operator [] (size_type i);
|
||
|
||
// Assignment
|
||
sparse_vector &operator = (const sparse_vector &v);
|
||
sparse_vector &assign_temporary (sparse_vector &v);
|
||
template<class AE>
|
||
sparse_vector &operator = (const vector_expression<AE> &ae);
|
||
template<class AE>
|
||
sparse_vector &reset (const vector_expression<AE> &ae);
|
||
template<class AE>
|
||
sparse_vector &assign (const vector_expression<AE> &ae);
|
||
template<class AE>
|
||
sparse_vector &operator += (const vector_expression<AE> &ae);
|
||
template<class AE>
|
||
sparse_vector &plus_assign (const vector_expression<AE> &ae);
|
||
template<class AE>
|
||
sparse_vector &operator -= (const vector_expression<AE> &ae);
|
||
template<class AE>
|
||
sparse_vector &minus_assign (const vector_expression<AE> &ae);
|
||
template<class AT>
|
||
sparse_vector &operator *= (const AT &at);
|
||
template<class AT>
|
||
sparse_vector &operator /= (const AT &at);
|
||
|
||
// Swapping
|
||
void swap (sparse_vector &v);
|
||
friend void swap (sparse_vector &v1, sparse_vector &v2);
|
||
|
||
// Element insertion and erasure
|
||
void insert (size_type i, const_reference t);
|
||
void erase (size_type i);
|
||
void clear ();
|
||
|
||
class const_iterator;
|
||
class iterator;
|
||
|
||
// Element lookup
|
||
const_iterator find (size_type i) const;
|
||
iterator find (size_type i);
|
||
const_iterator find_first (size_type i) const;
|
||
iterator find_first (size_type i);
|
||
const_iterator find_last (size_type i) const;
|
||
iterator find_last (size_type i);
|
||
|
||
// Iterators simply are pointers.
|
||
|
||
class const_iterator:
|
||
public container_const_reference<sparse_vector>,
|
||
public bidirectional_iterator_base<const_iterator, value_type> {
|
||
public:
|
||
typedef sparse_bidirectional_iterator_tag iterator_category;
|
||
typedef typename sparse_vector::difference_type difference_type;
|
||
typedef typename sparse_vector::value_type value_type;
|
||
typedef typename sparse_vector::const_reference reference;
|
||
typedef typename sparse_vector::const_pointer pointer;
|
||
|
||
// Construction and destruction
|
||
const_iterator ();
|
||
const_iterator (const sparse_vector &v, const const_iterator_type &it);
|
||
const_iterator (const iterator &it);
|
||
|
||
// Arithmetic
|
||
const_iterator &operator ++ ();
|
||
const_iterator &operator -- ();
|
||
|
||
// Dereference
|
||
reference operator * () const;
|
||
|
||
// Index
|
||
size_type index () const;
|
||
|
||
// Assignment
|
||
const_iterator &operator = (const const_iterator &it);
|
||
|
||
// Comparison
|
||
bool operator == (const const_iterator &it) const;
|
||
};
|
||
|
||
const_iterator begin () const;
|
||
const_iterator end () const;
|
||
|
||
class iterator:
|
||
public container_reference<sparse_vector>,
|
||
public bidirectional_iterator_base<iterator, value_type> {
|
||
public:
|
||
typedef sparse_bidirectional_iterator_tag iterator_category;
|
||
typedef typename sparse_vector::difference_type difference_type;
|
||
typedef typename sparse_vector::value_type value_type;
|
||
typedef typename sparse_vector::reference reference;
|
||
typedef typename sparse_vector::pointer pointer;
|
||
|
||
// Construction and destruction
|
||
iterator ();
|
||
iterator (sparse_vector &v, const iterator_type &it);
|
||
|
||
// Arithmetic
|
||
iterator &operator ++ ();
|
||
iterator &operator -- ();
|
||
|
||
// Dereference
|
||
reference operator * () const;
|
||
|
||
// Index
|
||
size_type index () const;
|
||
|
||
// Assignment
|
||
iterator &operator = (const iterator &it);
|
||
|
||
// Comparison
|
||
bool operator == (const iterator &it) const;
|
||
};
|
||
|
||
iterator begin ();
|
||
iterator end ();
|
||
|
||
// Reverse iterator
|
||
|
||
typedef reverse_iterator_base<const_iterator> const_reverse_iterator;
|
||
|
||
const_reverse_iterator rbegin () const;
|
||
const_reverse_iterator rend () const;
|
||
|
||
typedef reverse_iterator_base<iterator> reverse_iterator;
|
||
|
||
reverse_iterator rbegin ();
|
||
reverse_iterator rend ();
|
||
};</code></pre>
|
||
|
||
<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><sub><em>
|
||
</em></sub>and <em>k + 1 = v</em><sub><em>i</em></sub><sub><sub><em>2</em></sub></sub><sub><em>
|
||
</em></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>int main () {
|
||
using namespace boost::numeric::ublas;
|
||
compressed_vector<double> v (3, 3);
|
||
for (int 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">
|
||
<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>
|
||
</table>
|
||
|
||
<h4>Model of</h4>
|
||
|
||
<p><a href="container.htm#vector">Vector</a>. </p>
|
||
|
||
<h4>Type requirements</h4>
|
||
|
||
<p>None, except for those imposed by the requirements of <a
|
||
href="container.htm#vector">Vector</a>.</p>
|
||
|
||
<h4>Public base classes</h4>
|
||
|
||
<p><code>vector_expression<compressed_vector<T, IB, IA,
|
||
TA> ></code> </p>
|
||
|
||
<h4>Members</h4>
|
||
|
||
<table border="1">
|
||
<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, size_type
|
||
non_zeros)</code></td>
|
||
<td>Reallocates a <code>compressed_vector </code>to hold
|
||
at most <code>size</code> elements. The content of the <code>compressed_vector
|
||
</code>is preserved.</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>void insert (size_type i, const_reference t)</code></td>
|
||
<td>Inserts the value <code>t</code> at the <code>i</code>-th
|
||
element.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>void erase (size_type i)</code></td>
|
||
<td>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>
|
||
</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>
|
||
|
||
<h4>Interface</h4>
|
||
|
||
<pre><code> // Array based sparse vector class
|
||
template<class T, std::size_t IB, class IA, class TA>
|
||
class compressed_vector:
|
||
public vector_expression<compressed_vector<T, 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 IA index_array_type;
|
||
typedef TA value_array_type;
|
||
typedef const compressed_vector<T, IB, IA, TA> const_self_type;
|
||
typedef compressed_vector<T, IB, IA, TA> self_type;
|
||
typedef const vector_const_reference<const_self_type> const_closure_type;
|
||
typedef vector_reference<self_type> closure_type;
|
||
typedef typename IA::const_iterator const_iterator_type;
|
||
typedef typename IA::iterator iterator_type;
|
||
typedef sparse_tag storage_category;
|
||
|
||
// Construction and destruction
|
||
compressed_vector ();
|
||
compressed_vector (size_type size, size_type non_zeros = 0);
|
||
compressed_vector (const compressed_vector &v);
|
||
template<class AE>
|
||
compressed_vector (const vector_expression<AE> &ae, size_type non_zeros = 0);
|
||
|
||
// Accessors
|
||
size_type size () const;
|
||
size_type non_zeros () const;
|
||
static size_type index_base ();
|
||
const index_array_type &index_data () const;
|
||
index_array_type &index_data ();
|
||
const value_array_type &value_data () const;
|
||
value_array_type &value_data ();
|
||
|
||
// Resizing
|
||
void resize (size_type size, size_type non_zeros = 0);
|
||
|
||
// Element access
|
||
const_reference operator () (size_type i) const;
|
||
reference operator () (size_type i);
|
||
|
||
const_reference operator [] (size_type i) const;
|
||
reference operator [] (size_type i);
|
||
|
||
// Assignment
|
||
compressed_vector &operator = (const compressed_vector &v);
|
||
compressed_vector &assign_temporary (compressed_vector &v);
|
||
template<class AE>
|
||
compressed_vector &operator = (const vector_expression<AE> &ae);
|
||
template<class AE>
|
||
compressed_vector &reset (const vector_expression<AE> &ae);
|
||
template<class AE>
|
||
compressed_vector &assign (const vector_expression<AE> &ae);
|
||
template<class AE>
|
||
compressed_vector &operator += (const vector_expression<AE> &ae);
|
||
template<class AE>
|
||
compressed_vector &plus_assign (const vector_expression<AE> &ae);
|
||
template<class AE>
|
||
compressed_vector &operator -= (const vector_expression<AE> &ae);
|
||
template<class AE>
|
||
compressed_vector &minus_assign (const vector_expression<AE> &ae);
|
||
template<class AT>
|
||
compressed_vector &operator *= (const AT &at);
|
||
template<class AT>
|
||
compressed_vector &operator /= (const AT &at);
|
||
|
||
// Swapping
|
||
void swap (compressed_vector &v);
|
||
friend void swap (compressed_vector &v1, compressed_vector &v2);
|
||
|
||
// Element insertion and erasure
|
||
void insert (size_type i, const_reference t);
|
||
void erase (size_type i);
|
||
void clear ();
|
||
|
||
class const_iterator;
|
||
class iterator;
|
||
|
||
// Element lookup
|
||
const_iterator find (size_type i) const;
|
||
iterator find (size_type i);
|
||
const_iterator find_first (size_type i) const;
|
||
iterator find_first (size_type i);
|
||
const_iterator find_last (size_type i) const;
|
||
iterator find_last (size_type i);
|
||
|
||
// Iterators simply are pointers.
|
||
|
||
class const_iterator:
|
||
public container_const_reference<compressed_vector>,
|
||
public bidirectional_iterator_base<const_iterator, value_type> {
|
||
public:
|
||
typedef sparse_bidirectional_iterator_tag iterator_category;
|
||
typedef typename compressed_vector::difference_type difference_type;
|
||
typedef typename compressed_vector::value_type value_type;
|
||
typedef typename compressed_vector::const_reference reference;
|
||
typedef typename compressed_vector::const_pointer pointer;
|
||
|
||
// Construction and destruction
|
||
const_iterator ();
|
||
const_iterator (const compressed_vector &v, const const_iterator_type &it);
|
||
const_iterator (const iterator &it);
|
||
|
||
// Arithmetic
|
||
const_iterator &operator ++ ();
|
||
const_iterator &operator -- ();
|
||
|
||
// Dereference
|
||
reference operator * () const;
|
||
|
||
// Index
|
||
size_type index () const;
|
||
|
||
// Assignment
|
||
const_iterator &operator = (const const_iterator &it);
|
||
|
||
// Comparison
|
||
bool operator == (const const_iterator &it) const;
|
||
};
|
||
|
||
const_iterator begin () const;
|
||
const_iterator end () const;
|
||
|
||
class iterator:
|
||
public container_reference<compressed_vector>,
|
||
public bidirectional_iterator_base<iterator, value_type> {
|
||
public:
|
||
typedef sparse_bidirectional_iterator_tag iterator_category;
|
||
typedef typename compressed_vector::difference_type difference_type;
|
||
typedef typename compressed_vector::value_type value_type;
|
||
typedef typename compressed_vector::reference reference;
|
||
typedef typename compressed_vector::pointer pointer;
|
||
|
||
// Construction and destruction
|
||
iterator ();
|
||
iterator (compressed_vector &v, const iterator_type &it);
|
||
|
||
// Arithmetic
|
||
iterator &operator ++ ();
|
||
iterator &operator -- ();
|
||
|
||
// Dereference
|
||
reference operator * () const;
|
||
|
||
// Index
|
||
size_type index () const;
|
||
|
||
// Assignment
|
||
iterator &operator = (const iterator &it);
|
||
|
||
// Comparison
|
||
bool operator == (const iterator &it) const;
|
||
};
|
||
|
||
iterator begin ();
|
||
iterator end ();
|
||
|
||
// Reverse iterator
|
||
|
||
typedef reverse_iterator_base<const_iterator> const_reverse_iterator;
|
||
|
||
const_reverse_iterator rbegin () const;
|
||
const_reverse_iterator rend () const;
|
||
|
||
typedef reverse_iterator_base<iterator> reverse_iterator;
|
||
|
||
reverse_iterator rbegin ();
|
||
reverse_iterator rend ();
|
||
};</code></pre>
|
||
|
||
<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><sub><em>
|
||
</em></sub>and <em>k + 1 = v</em><sub><em>i</em></sub><sub><sub><em>2</em></sub></sub><sub><em>
|
||
</em></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>int main () {
|
||
using namespace boost::numeric::ublas;
|
||
coordinate_vector<double> v (3, 3);
|
||
for (int 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">
|
||
<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>
|
||
</table>
|
||
|
||
<h4>Model of</h4>
|
||
|
||
<p><a href="container.htm#vector">Vector</a>. </p>
|
||
|
||
<h4>Type requirements</h4>
|
||
|
||
<p>None, except for those imposed by the requirements of <a
|
||
href="container.htm#vector">Vector</a>.</p>
|
||
|
||
<h4>Public base classes</h4>
|
||
|
||
<p><code>vector_expression<coordinate_vector<T, IB, IA,
|
||
TA> ></code> </p>
|
||
|
||
<h4>Members</h4>
|
||
|
||
<table border="1">
|
||
<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, size_type
|
||
non_zeros)</code></td>
|
||
<td>Reallocates a <code>coordinate_vector </code>to hold
|
||
at most <code>size</code> elements. The content of the <code>coordinate_vector
|
||
</code>is preserved.</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>void insert (size_type i, const_reference t)</code></td>
|
||
<td>Inserts the value <code>t</code> at the <code>i</code>-th
|
||
element.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>void erase (size_type i)</code></td>
|
||
<td>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>
|
||
</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>
|
||
|
||
<h4>Interface</h4>
|
||
|
||
<pre><code> // Array based sparse vector class
|
||
template<class T, std::size_t IB, class IA, class TA>
|
||
class coordinate_vector:
|
||
public vector_expression<coordinate_vector<T, 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 IA index_array_type;
|
||
typedef TA value_array_type;
|
||
typedef const coordinate_vector<T, IB, IA, TA> const_self_type;
|
||
typedef coordinate_vector<T, IB, IA, TA> self_type;
|
||
typedef const vector_const_reference<const_self_type> const_closure_type;
|
||
typedef vector_reference<self_type> closure_type;
|
||
typedef typename IA::const_iterator const_iterator_type;
|
||
typedef typename IA::iterator iterator_type;
|
||
typedef sparse_tag storage_category;
|
||
|
||
// Construction and destruction
|
||
coordinate_vector ();
|
||
coordinate_vector (size_type size, size_type non_zeros = 0);
|
||
coordinate_vector (const coordinate_vector &v);
|
||
template<class AE>
|
||
coordinate_vector (const vector_expression<AE> &ae, size_type non_zeros = 0);
|
||
|
||
// Accessors
|
||
size_type size () const;
|
||
size_type non_zeros () const;
|
||
static size_type index_base ();
|
||
const index_array_type &index_data () const;
|
||
index_array_type &index_data ();
|
||
const value_array_type &value_data () const;
|
||
value_array_type &value_data ();
|
||
|
||
// Resizing
|
||
void resize (size_type size, size_type non_zeros = 0);
|
||
|
||
// Element access
|
||
const_reference operator () (size_type i) const;
|
||
reference operator () (size_type i);
|
||
|
||
const_reference operator [] (size_type i) const;
|
||
reference operator [] (size_type i);
|
||
|
||
// Assignment
|
||
coordinate_vector &operator = (const coordinate_vector &v);
|
||
coordinate_vector &assign_temporary (coordinate_vector &v);
|
||
template<class AE>
|
||
coordinate_vector &operator = (const vector_expression<AE> &ae);
|
||
template<class AE>
|
||
coordinate_vector &reset (const vector_expression<AE> &ae);
|
||
template<class AE>
|
||
coordinate_vector &assign (const vector_expression<AE> &ae);
|
||
template<class AE>
|
||
coordinate_vector &operator += (const vector_expression<AE> &ae);
|
||
template<class AE>
|
||
coordinate_vector &plus_assign (const vector_expression<AE> &ae);
|
||
template<class AE>
|
||
coordinate_vector &operator -= (const vector_expression<AE> &ae);
|
||
template<class AE>
|
||
coordinate_vector &minus_assign (const vector_expression<AE> &ae);
|
||
template<class AT>
|
||
coordinate_vector &operator *= (const AT &at);
|
||
template<class AT>
|
||
coordinate_vector &operator /= (const AT &at);
|
||
|
||
// Swapping
|
||
void swap (coordinate_vector &v);
|
||
friend void swap (coordinate_vector &v1, coordinate_vector &v2);
|
||
|
||
// Element insertion and erasure
|
||
void insert (size_type i, const_reference t);
|
||
void erase (size_type i);
|
||
void clear ();
|
||
|
||
class const_iterator;
|
||
class iterator;
|
||
|
||
// Element lookup
|
||
const_iterator find (size_type i) const;
|
||
iterator find (size_type i);
|
||
const_iterator find_first (size_type i) const;
|
||
iterator find_first (size_type i);
|
||
const_iterator find_last (size_type i) const;
|
||
iterator find_last (size_type i);
|
||
|
||
// Iterators simply are pointers.
|
||
|
||
class const_iterator:
|
||
public container_const_reference<coordinate_vector>,
|
||
public bidirectional_iterator_base<const_iterator, value_type> {
|
||
public:
|
||
typedef sparse_bidirectional_iterator_tag iterator_category;
|
||
typedef typename coordinate_vector::difference_type difference_type;
|
||
typedef typename coordinate_vector::value_type value_type;
|
||
typedef typename coordinate_vector::const_reference reference;
|
||
typedef typename coordinate_vector::const_pointer pointer;
|
||
|
||
// Construction and destruction
|
||
const_iterator ();
|
||
const_iterator (const coordinate_vector &v, const const_iterator_type &it);
|
||
const_iterator (const iterator &it);
|
||
|
||
// Arithmetic
|
||
const_iterator &operator ++ ();
|
||
const_iterator &operator -- ();
|
||
|
||
// Dereference
|
||
reference operator * () const;
|
||
|
||
// Index
|
||
size_type index () const;
|
||
|
||
// Assignment
|
||
const_iterator &operator = (const const_iterator &it);
|
||
|
||
// Comparison
|
||
bool operator == (const const_iterator &it) const;
|
||
};
|
||
|
||
const_iterator begin () const;
|
||
const_iterator end () const;
|
||
|
||
class iterator:
|
||
public container_reference<coordinate_vector>,
|
||
public bidirectional_iterator_base<iterator, value_type> {
|
||
public:
|
||
typedef sparse_bidirectional_iterator_tag iterator_category;
|
||
typedef typename coordinate_vector::difference_type difference_type;
|
||
typedef typename coordinate_vector::value_type value_type;
|
||
typedef typename coordinate_vector::reference reference;
|
||
typedef typename coordinate_vector::pointer pointer;
|
||
|
||
// Construction and destruction
|
||
iterator ();
|
||
iterator (coordinate_vector &v, const iterator_type &it);
|
||
|
||
// Arithmetic
|
||
iterator &operator ++ ();
|
||
iterator &operator -- ();
|
||
|
||
// Dereference
|
||
reference operator * () const;
|
||
|
||
// Index
|
||
size_type index () const;
|
||
|
||
// Assignment
|
||
iterator &operator = (const iterator &it);
|
||
|
||
// Comparison
|
||
bool operator == (const iterator &it) const;
|
||
};
|
||
|
||
iterator begin ();
|
||
iterator end ();
|
||
|
||
// Reverse iterator
|
||
|
||
typedef reverse_iterator_base<const_iterator> const_reverse_iterator;
|
||
|
||
const_reverse_iterator rbegin () const;
|
||
const_reverse_iterator rend () const;
|
||
|
||
typedef reverse_iterator_base<iterator> reverse_iterator;
|
||
|
||
reverse_iterator rbegin ();
|
||
reverse_iterator rend ();
|
||
};</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>
|