mirror of
https://github.com/boostorg/ublas.git
synced 2026-02-14 13:12:14 +00:00
905 lines
29 KiB
HTML
905 lines
29 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>Vector</title>
|
||
</head>
|
||
|
||
<body bgcolor="#FFFFFF">
|
||
|
||
<h1><img src="c++boost.gif" alt="c++boost.gif" align="center"
|
||
width="277" height="86">Vector</h1>
|
||
|
||
<h2><a name="vector"></a>Vector</h2>
|
||
|
||
<h4>Description</h4>
|
||
|
||
<p>The templated class <code>vector<T, A> </code>is the
|
||
base container adaptor for dense vectors. For a <em>n</em>-dimensional
|
||
vector and <em>0 <= i < n </em>every element <em>v</em><sub><em>i</em></sub>
|
||
is mapped to the <em>i-</em>th element of the container.</p>
|
||
|
||
<h4>Example</h4>
|
||
|
||
<pre>int main () {
|
||
using namespace boost::numeric::ublas;
|
||
vector<double> v (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.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 vector. </td>
|
||
<td> </td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>A</code></td>
|
||
<td>The type of the adapted array. <a href="#vector_1">[1]</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<vector<T, A> ></code> </p>
|
||
|
||
<h4>Members</h4>
|
||
|
||
<table border="1">
|
||
<tr>
|
||
<th>Member </th>
|
||
<th>Description </th>
|
||
</tr>
|
||
<tr>
|
||
<td><code>vector ()</code> </td>
|
||
<td>Allocates an uninitialized <code>vector</code> that
|
||
holds zero elements.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>vector (size_type size)</code></td>
|
||
<td>Allocates an uninitialized <code>vector</code> that
|
||
holds <code>size</code> elements.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>vector (const vector &v)</code></td>
|
||
<td>The copy constructor.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>template<class AE><br>
|
||
vector (const vector_expression<AE> &ae)</code></td>
|
||
<td>The extended copy constructor.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>void resize (size_type size)</code></td>
|
||
<td>Reallocates a <code>vector</code> to hold <code>size</code>
|
||
elements. The content of the <code>vector</code> is not
|
||
preserved.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>size_type size () const</code></td>
|
||
<td>Returns the size of the <code>vector</code>. </td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>const_reference operator () (size_type i) const</code></td>
|
||
<td>Returns a <code>const </code>reference of the <code>i</code>-th
|
||
element. </td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>reference operator () (size_type i)</code></td>
|
||
<td>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 a <code>const </code>reference of the <code>i</code>-th
|
||
element. </td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>reference operator [] (size_type i)</code></td>
|
||
<td>Returns a reference of the <code>i</code>-th element.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>vector &operator = (const vector &v)</code></td>
|
||
<td>The assignment operator.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>vector &assign_temporary (vector &v)</code></td>
|
||
<td>Assigns a temporary. May change the vector <code>v</code>.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>template<class AE><br>
|
||
vector &operator = (const vector_expression<AE>
|
||
&ae)</code></td>
|
||
<td>The extended assignment operator.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>template<class AE><br>
|
||
vector &assign (const vector_expression<AE>
|
||
&ae)</code></td>
|
||
<td>Assigns a vector expression to the vector. Left and
|
||
right hand side of the assignment should be independent.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>template<class AE><br>
|
||
vector &operator += (const
|
||
vector_expression<AE> &ae)</code></td>
|
||
<td>A computed assignment operator. Adds the vector
|
||
expression to the vector.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>template<class AE><br>
|
||
vector &plus_assign (const
|
||
vector_expression<AE> &ae)</code></td>
|
||
<td>Adds a vector expression to the vector. Left and
|
||
right hand side of the assignment should be independent.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>template<class AE><br>
|
||
vector &operator -= (const
|
||
vector_expression<AE> &ae)</code></td>
|
||
<td>A computed assignment operator. Subtracts the vector
|
||
expression from the vector.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>template<class AE><br>
|
||
vector &minus_assign (const
|
||
vector_expression<AE> &ae)</code></td>
|
||
<td>Subtracts a vector expression from the vector. Left
|
||
and right hand side of the assignment should be
|
||
independent.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>template<class AT><br>
|
||
vector &operator *= (const AT &at)</code></td>
|
||
<td>A computed assignment operator. Multiplies the vector
|
||
with a scalar.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>template<class AT><br>
|
||
vector &operator /= (const AT &at)</code></td>
|
||
<td>A computed assignment operator. Divides the vector
|
||
through a scalar.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>void swap (vector &v)</code></td>
|
||
<td>Swaps the contents of the 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 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>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>vector</code>. </td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>iterator begin () </code></td>
|
||
<td>Returns a <code>iterator</code> pointing to the
|
||
beginning of the <code>vector</code>. </td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>iterator end () </code></td>
|
||
<td>Returns a <code>iterator</code> pointing to the end
|
||
of the <code>vector</code>. </td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>const_reverse_iterator rbegin () const</code></td>
|
||
<td>Returns a <code>const_reverse_iterator</code>
|
||
pointing to the beginning of the reversed <code>vector</code>.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>const_reverse_iterator rend () const</code></td>
|
||
<td>Returns a <code>const_reverse_iterator</code>
|
||
pointing to the end of the reversed <code>vector</code>. </td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>reverse_iterator rbegin () </code></td>
|
||
<td>Returns a <code>reverse_iterator</code> pointing to
|
||
the beginning of the reversed <code>vector</code>. </td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>reverse_iterator rend () </code></td>
|
||
<td>Returns a <code>reverse_iterator</code> pointing to
|
||
the end of the reversed <code>vector</code>. </td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h4>Notes</h4>
|
||
|
||
<p><a name="#vector_1">[1]</a> Supported parameters for the
|
||
adapted array are <code>unbounded_array<T></code>, <code>bounded_array<T></code>
|
||
and <code>std::vector<T></code>. </p>
|
||
|
||
<h4>Interface</h4>
|
||
|
||
<pre><code> // Array based vector class
|
||
template<class T, class A>
|
||
class vector:
|
||
public vector_expression<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 F functor_type;
|
||
typedef A array_type;
|
||
typedef const A const_array_type;
|
||
typedef const vector<T, A> const_self_type;
|
||
typedef 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 dense_tag storage_category;
|
||
|
||
// Construction and destruction
|
||
vector ();
|
||
vector (size_type size);
|
||
vector (const vector &v);
|
||
template<class AE>
|
||
vector (const vector_expression<AE> &ae);
|
||
|
||
// Accessors
|
||
size_type size () const;
|
||
const_array_type &data () const;
|
||
array_type &data ();
|
||
|
||
// Resizing
|
||
void resize (size_type size);
|
||
|
||
// 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
|
||
vector &operator = (const vector &v);
|
||
vector &assign_temporary (vector &v);
|
||
template<class AE>
|
||
vector &operator = (const vector_expression<AE> &ae);
|
||
template<class AE>
|
||
vector &reset (const vector_expression<AE> &ae);
|
||
template<class AE>
|
||
vector &assign (const vector_expression<AE> &ae);
|
||
template<class AE>
|
||
vector &operator += (const vector_expression<AE> &ae);
|
||
template<class AE>
|
||
vector &plus_assign (const vector_expression<AE> &ae);
|
||
template<class AE>
|
||
vector &operator -= (const vector_expression<AE> &ae);
|
||
template<class AE>
|
||
vector &minus_assign (const vector_expression<AE> &ae);
|
||
template<class AT>
|
||
vector &operator *= (const AT &at);
|
||
template<class AT>
|
||
vector &operator /= (const AT &at);
|
||
|
||
// Swapping
|
||
void swap (vector &v);
|
||
friend void swap (vector &v1, 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<vector>,
|
||
public random_access_iterator_base<const_iterator, value_type> {
|
||
public:
|
||
typedef dense_random_access_iterator_tag iterator_category;
|
||
typedef typename vector::difference_type difference_type;
|
||
typedef typename vector::value_type value_type;
|
||
typedef typename vector::const_reference reference;
|
||
typedef typename vector::const_pointer pointer;
|
||
|
||
// Construction and destruction
|
||
const_iterator ();
|
||
const_iterator (const vector &v, const const_iterator_type &it);
|
||
const_iterator (const iterator &it):
|
||
|
||
// Arithmetic
|
||
const_iterator &operator ++ ();
|
||
const_iterator &operator -- ();
|
||
const_iterator &operator += (difference_type n);
|
||
const_iterator &operator -= (difference_type n);
|
||
difference_type operator - (const const_iterator &it) const;
|
||
|
||
// 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;
|
||
bool operator < (const const_iterator &it) const;
|
||
};
|
||
|
||
const_iterator begin () const;
|
||
const_iterator end () const;
|
||
|
||
class iterator:
|
||
public container_reference<vector>,
|
||
public random_access_iterator_base<iterator, value_type> {
|
||
public:
|
||
typedef dense_random_access_iterator_tag iterator_category;
|
||
typedef typename vector::difference_type difference_type;
|
||
typedef typename vector::value_type value_type;
|
||
typedef typename vector::reference reference;
|
||
typedef typename vector::pointer pointer;
|
||
|
||
// Construction and destruction
|
||
iterator ();
|
||
iterator (vector &v, const iterator_type &it);
|
||
|
||
// Arithmetic
|
||
iterator &operator ++ ();
|
||
iterator &operator -- ();
|
||
iterator &operator += (difference_type n);
|
||
iterator &operator -= (difference_type n);
|
||
difference_type operator - (const iterator &it) const;
|
||
|
||
// Dereference
|
||
reference operator * () const;
|
||
|
||
// Index
|
||
size_type index () const;
|
||
|
||
// Assignment
|
||
iterator &operator = (const iterator &it);
|
||
|
||
// Comparison
|
||
bool operator == (const iterator &it) const;
|
||
bool operator < (const 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="unit_vector"></a>Unit Vector</h2>
|
||
|
||
<h4>Description</h4>
|
||
|
||
<p>The templated class <code>unit_vector<T> </code>represents
|
||
canonical unit vectors. For the <em>k</em>-th <em>n</em>-dimensional
|
||
canonical unit vector and <em>0 <= i < n </em>holds <em>u</em><sup><em>k</em></sup><sub><em>i</em></sub><em>
|
||
= 0</em>, if <em>i <> k</em>, and <em>u</em><sup><em>k</em></sup><sub><em>i</em></sub><em>
|
||
= 1</em>. </p>
|
||
|
||
<h4>Example</h4>
|
||
|
||
<pre>int main () {
|
||
using namespace boost::numeric::ublas;
|
||
for (int i = 0; i < 3; ++ i) {
|
||
unit_vector<double> v (3, i);
|
||
std::cout << v << std::endl;
|
||
}
|
||
}</pre>
|
||
|
||
<h4>Definition</h4>
|
||
|
||
<p>Defined in the header vector.hpp.</p>
|
||
|
||
<h4>Template parameters</h4>
|
||
|
||
<table border="1">
|
||
<tr>
|
||
<th>Parameter </th>
|
||
<th>Description </th>
|
||
<th>Default </th>
|
||
</tr>
|
||
<tr>
|
||
<td><code>T</code> </td>
|
||
<td>The type of object stored in the vector. </td>
|
||
<td> </td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h4>Model of</h4>
|
||
|
||
<p><a href="expression.htm#vector_expression">Vector Expression</a>.
|
||
</p>
|
||
|
||
<h4>Type requirements</h4>
|
||
|
||
<p>None, except for those imposed by the requirements of <a
|
||
href="expression.htm#vector_expression">Vector Expression</a>.</p>
|
||
|
||
<h4>Public base classes</h4>
|
||
|
||
<p><code>vector_expression<unit_vector<T> ></code> </p>
|
||
|
||
<h4>Members</h4>
|
||
|
||
<table border="1">
|
||
<tr>
|
||
<th>Member </th>
|
||
<th>Description </th>
|
||
</tr>
|
||
<tr>
|
||
<td><code>unit_vector ()</code> </td>
|
||
<td>Constructs an <code>unit_vector</code> that holds
|
||
zero elements.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>unit_vector (size_type size, size_type index)</code></td>
|
||
<td>Constructs the <code>index</code>-th <code>unit_vector</code>
|
||
that holds <code>size</code> elements.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>unit_vector (const unit_vector &v)</code></td>
|
||
<td>The copy constructor.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>void resize (size_type size)</code></td>
|
||
<td>Resizes a <code>unit_vector</code> to hold <code>size</code>
|
||
elements. </td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>size_type size () const</code></td>
|
||
<td>Returns the size of the <code>unit_vector</code>. </td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>size_type index () const</code></td>
|
||
<td>Returns the index of the <code>unit_vector</code>. </td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>const_reference operator () (size_type i) const</code></td>
|
||
<td>Returns the value of the <code>i</code>-th element. </td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>const_reference operator [] (size_type i) const</code></td>
|
||
<td>Returns the value of the <code>i</code>-th element. </td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>unit_vector &operator = (const unit_vector
|
||
&v)</code></td>
|
||
<td>The assignment operator.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>unit_vector &assign_temporary (unit_vector
|
||
&v)</code></td>
|
||
<td>Assigns a temporary. May change the unit vector <code>v</code>.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>void swap (unit_vector &v)</code></td>
|
||
<td>Swaps the contents of the unit vectors. </td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>const_iterator begin () const</code></td>
|
||
<td>Returns a <code>const_iterator</code> pointing to the
|
||
beginning of the <code>unit_vector</code>. </td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>const_iterator end () const</code></td>
|
||
<td>Returns a <code>const_iterator</code> pointing to the
|
||
end of the <code>unit_vector</code>. </td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>const_reverse_iterator rbegin () const</code></td>
|
||
<td>Returns a <code>const_reverse_iterator</code>
|
||
pointing to the beginning of the reversed <code>unit_vector</code>.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>const_reverse_iterator rend () const</code></td>
|
||
<td>Returns a <code>const_reverse_iterator</code>
|
||
pointing to the end of the reversed <code>unit_vector</code>.
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h4>Interface</h4>
|
||
|
||
<pre><code> // Unit vector class
|
||
template<class T>
|
||
class unit_vector:
|
||
public vector_expression<unit_vector<T> > {
|
||
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 const unit_vector<T> const_self_type;
|
||
typedef unit_vector<T> self_type;
|
||
typedef const vector_const_reference<const_self_type> const_closure_type;
|
||
typedef size_type const_iterator_type;
|
||
typedef packed_tag storage_category;
|
||
|
||
// Construction and destruction
|
||
unit_vector ();
|
||
unit_vector (size_type size, size_type index);
|
||
unit_vector (const unit_vector &v);
|
||
|
||
// Accessors
|
||
size_type size () const;
|
||
size_type index () const;
|
||
|
||
// Resizing
|
||
void resize (size_type size);
|
||
|
||
// Element access
|
||
const_reference operator () (size_type i) const;
|
||
|
||
const_reference operator [] (size_type i) const;
|
||
|
||
// Assignment
|
||
unit_vector &operator = (const unit_vector &v);
|
||
unit_vector &assign_temporary (unit_vector &v);
|
||
|
||
// Swapping
|
||
void swap (unit_vector &v);
|
||
friend void swap (unit_vector &v1, unit_vector &v2);
|
||
|
||
class const_iterator;
|
||
|
||
// Element lookup
|
||
const_iterator find_first (size_type i) const;
|
||
const_iterator find_last (size_type i) const;
|
||
|
||
// Iterator simply is an index.
|
||
|
||
class const_iterator:
|
||
public container_const_reference<unit_vector>,
|
||
public random_access_iterator_base<const_iterator, value_type> {
|
||
public:
|
||
typedef packed_random_access_iterator_tag iterator_category;
|
||
typedef typename unit_vector::difference_type difference_type;
|
||
typedef typename unit_vector::value_type value_type;
|
||
typedef typename unit_vector::const_reference reference;
|
||
typedef typename unit_vector::const_pointer pointer;
|
||
|
||
// Construction and destruction
|
||
const_iterator ();
|
||
const_iterator (const unit_vector &v, const const_iterator_type &it);
|
||
|
||
// Arithmetic
|
||
const_iterator &operator ++ ();
|
||
const_iterator &operator -- ();
|
||
const_iterator &operator += (difference_type n);
|
||
const_iterator &operator -= (difference_type n);
|
||
difference_type operator - (const const_iterator &it) const;
|
||
|
||
// 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;
|
||
bool operator < (const const_iterator &it) const;
|
||
};
|
||
|
||
typedef const_iterator iterator;
|
||
|
||
const_iterator begin () const;
|
||
const_iterator end () const;
|
||
|
||
// Reverse iterator
|
||
|
||
typedef reverse_iterator_base<const_iterator> const_reverse_iterator;
|
||
|
||
const_reverse_iterator rbegin () const;
|
||
const_reverse_iterator rend () const;
|
||
};</code></pre>
|
||
|
||
<h2><a name="zero_vector"></a>Zero Vector</h2>
|
||
|
||
<h4>Description</h4>
|
||
|
||
<p>The templated class <code>zero_vector<T> </code>represents
|
||
zero vectors. For a <em>n</em>-dimensional zero vector and <em>0
|
||
<= i < n </em>holds <em>z</em><sub><em>i</em></sub><em> = 0</em>.
|
||
</p>
|
||
|
||
<h4>Example</h4>
|
||
|
||
<pre>int main () {
|
||
using namespace boost::numeric::ublas;
|
||
zero_vector<double> v (3);
|
||
std::cout << v << std::endl;
|
||
}</pre>
|
||
|
||
<h4>Definition</h4>
|
||
|
||
<p>Defined in the header vector.hpp.</p>
|
||
|
||
<h4>Template parameters</h4>
|
||
|
||
<table border="1">
|
||
<tr>
|
||
<th>Parameter </th>
|
||
<th>Description </th>
|
||
<th>Default </th>
|
||
</tr>
|
||
<tr>
|
||
<td><code>T</code> </td>
|
||
<td>The type of object stored in the vector. </td>
|
||
<td> </td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h4>Model of</h4>
|
||
|
||
<p><a href="expression.htm#vector_expression">Vector Expression</a>.
|
||
</p>
|
||
|
||
<h4>Type requirements</h4>
|
||
|
||
<p>None, except for those imposed by the requirements of <a
|
||
href="expression.htm#vector_expression">Vector Expression</a>.</p>
|
||
|
||
<h4>Public base classes</h4>
|
||
|
||
<p><code>vector_expression<zero_vector<T> ></code> </p>
|
||
|
||
<h4>Members</h4>
|
||
|
||
<table border="1">
|
||
<tr>
|
||
<th>Member </th>
|
||
<th>Description </th>
|
||
</tr>
|
||
<tr>
|
||
<td><code>zero_vector ()</code> </td>
|
||
<td>Constructs a <code>zero_vector</code> that holds zero
|
||
elements.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>zero_vector (size_type size)</code></td>
|
||
<td>Constructs a <code>zero_vector</code> that holds <code>size</code>
|
||
elements.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>zero_vector (const zero_vector &v)</code></td>
|
||
<td>The copy constructor.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>void resize (size_type size)</code></td>
|
||
<td>Resizes a <code>zero_vector</code> to hold <code>size</code>
|
||
elements. </td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>size_type size () const</code></td>
|
||
<td>Returns the size of the <code>zero_vector</code>. </td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>const_reference operator () (size_type i) const</code></td>
|
||
<td>Returns the value of the <code>i</code>-th element. </td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>const_reference operator [] (size_type i) const</code></td>
|
||
<td>Returns the value of the <code>i</code>-th element. </td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>zero_vector &operator = (const zero_vector
|
||
&v)</code></td>
|
||
<td>The assignment operator.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>zero_vector &assign_temporary (zero_vector
|
||
&v)</code></td>
|
||
<td>Assigns a temporary. May change the zero vector <code>v</code>.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>void swap (zero_vector &v)</code></td>
|
||
<td>Swaps the contents of the zero vectors. </td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>const_iterator begin () const</code></td>
|
||
<td>Returns a <code>const_iterator</code> pointing to the
|
||
beginning of the <code>zero_vector</code>. </td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>const_iterator end () const</code></td>
|
||
<td>Returns a <code>const_iterator</code> pointing to the
|
||
end of the <code>zero_vector</code>. </td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>const_reverse_iterator rbegin () const</code></td>
|
||
<td>Returns a <code>const_reverse_iterator</code>
|
||
pointing to the beginning of the reversed <code>zero_vector</code>.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>const_reverse_iterator rend () const</code></td>
|
||
<td>Returns a <code>const_reverse_iterator</code>
|
||
pointing to the end of the reversed <code>zero_vector</code>.
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h4>Interface</h4>
|
||
|
||
<pre><code> // Zero vector class
|
||
template<class T>
|
||
class zero_vector:
|
||
public vector_expression<zero_vector<T> > {
|
||
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 const zero_vector<T> const_self_type;
|
||
typedef zero_vector<T> self_type;
|
||
typedef const vector_const_reference<const_self_type> const_closure_type;
|
||
typedef size_type const_iterator_type;
|
||
typedef sparse_tag storage_category;
|
||
|
||
// Construction and destruction
|
||
zero_vector ();
|
||
zero_vector (size_type size);
|
||
zero_vector (const zero_vector &v);
|
||
|
||
// Accessors
|
||
size_type size () const;
|
||
size_type index () const;
|
||
|
||
// Resizing
|
||
void resize (size_type size);
|
||
|
||
// Element access
|
||
const_reference operator () (size_type i) const;
|
||
|
||
const_reference operator [] (size_type i) const;
|
||
|
||
// Assignment
|
||
zero_vector &operator = (const zero_vector &v);
|
||
zero_vector &assign_temporary (zero_vector &v);
|
||
|
||
// Swapping
|
||
void swap (zero_vector &v);
|
||
friend void swap (zero_vector &v1, zero_vector &v2);
|
||
|
||
class const_iterator;
|
||
|
||
// Element lookup
|
||
const_iterator find_first (size_type i) const;
|
||
const_iterator find_last (size_type i) const;
|
||
|
||
// Iterator simply is an index.
|
||
|
||
class const_iterator:
|
||
public container_const_reference<zero_vector>,
|
||
public bidirectional_iterator_base<const_iterator, value_type> {
|
||
public:
|
||
typedef sparse_bidirectional_iterator_tag iterator_category;
|
||
typedef typename zero_vector::difference_type difference_type;
|
||
typedef typename zero_vector::value_type value_type;
|
||
typedef typename zero_vector::const_reference reference;
|
||
typedef typename zero_vector::const_pointer pointer;
|
||
|
||
// Construction and destruction
|
||
const_iterator ();
|
||
const_iterator (const zero_vector &v, const const_iterator_type &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;
|
||
};
|
||
|
||
typedef const_iterator iterator;
|
||
|
||
const_iterator begin () const;
|
||
const_iterator end () const;
|
||
|
||
// Reverse iterator
|
||
|
||
typedef reverse_iterator_base<const_iterator> const_reverse_iterator;
|
||
|
||
const_reverse_iterator rbegin () const;
|
||
const_reverse_iterator rend () const;
|
||
};</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>
|