mirror of
https://github.com/boostorg/ublas.git
synced 2026-02-13 12:52:14 +00:00
862 lines
29 KiB
HTML
862 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 Proxies</title>
|
||
</head>
|
||
|
||
<body bgcolor="#FFFFFF">
|
||
|
||
<h1><img src="c++boost.gif" alt="c++boost.gif" align="center"
|
||
width="277" height="86">Vector Proxies</h1>
|
||
|
||
<h2><a name="vector_range"></a>Vector Range</h2>
|
||
|
||
<h4>Description</h4>
|
||
|
||
<p>The templated class <code>vector_range<V> </code>allows
|
||
addressing a range of a vector.</p>
|
||
|
||
<h4>Example</h4>
|
||
|
||
<pre>int main () {
|
||
using namespace boost::numeric::ublas;
|
||
vector<double> v (3);
|
||
vector_range<vector<double> > vr (v, range (0, 3));
|
||
for (int i = 0; i < vr.size (); ++ i)
|
||
vr (i) = i;
|
||
std::cout << vr << std::endl;
|
||
}</pre>
|
||
|
||
<h4>Definition</h4>
|
||
|
||
<p>Defined in the header vector_proxy.hpp.</p>
|
||
|
||
<h4>Template parameters</h4>
|
||
|
||
<table border="1">
|
||
<tr>
|
||
<th>Parameter </th>
|
||
<th>Description </th>
|
||
<th>Default </th>
|
||
</tr>
|
||
<tr>
|
||
<td><code>V</code> </td>
|
||
<td>The type of vector referenced. </td>
|
||
<td> </td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h4>Model of</h4>
|
||
|
||
<p><a href="expression.htm#vector_expressio">Vector Expression</a>.
|
||
</p>
|
||
|
||
<h4>Type requirements</h4>
|
||
|
||
<p>None, except for those imposed by the requirements of <a
|
||
href="expression.htm#vector_expression">Vector Expression</a>.</p>
|
||
|
||
<h4>Public base classes</h4>
|
||
|
||
<p><code>vector_expression<vector_range<V> ></code> </p>
|
||
|
||
<h4>Members</h4>
|
||
|
||
<table border="1">
|
||
<tr>
|
||
<th>Member </th>
|
||
<th>Description </th>
|
||
</tr>
|
||
<tr>
|
||
<td><code>vector_range (vector_type &data, const
|
||
range &r)</code></td>
|
||
<td>Constructs a sub vector.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>size_type start () const</code></td>
|
||
<td>Returns the start of the sub vector.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>size_type size () const</code></td>
|
||
<td>Returns the size of the sub vector.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>const_reference operator () (size_type i) const</code></td>
|
||
<td>Returns the value of the <code>i</code>-th element. </td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>reference operator () (size_type i)</code></td>
|
||
<td>Returns a reference of the <code>i</code>-th element.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>const_reference operator [] (size_type i) const</code></td>
|
||
<td>Returns the value of the <code>i</code>-th element. </td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>reference operator [] (size_type i)</code></td>
|
||
<td>Returns a reference of the <code>i</code>-th element.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>vector_range &operator = (const
|
||
vector_range &vr)</code></td>
|
||
<td>The assignment operator.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>vector_range &assign_temporary
|
||
(vector_range &vr)</code></td>
|
||
<td>Assigns a temporary. May change the vector range <code>vr</code>.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>template<class AE><br>
|
||
vector_range &operator = (const
|
||
vector_expression<AE> &ae)</code></td>
|
||
<td>The extended assignment operator.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>template<class AE><br>
|
||
vector_range &assign (const
|
||
vector_expression<AE> &ae)</code></td>
|
||
<td>Assigns a vector expression to the sub vector. Left
|
||
and right hand side of the assignment should be
|
||
independent.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>template<class AE><br>
|
||
vector_range &operator += (const
|
||
vector_expression<AE> &ae)</code></td>
|
||
<td>A computed assignment operator. Adds the vector
|
||
expression to the sub vector.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>template<class AE><br>
|
||
vector_range &plus_assign (const
|
||
vector_expression<AE> &ae)</code></td>
|
||
<td>Adds a vector expression to the sub vector. Left and
|
||
right hand side of the assignment should be independent.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>template<class AE><br>
|
||
vector_range &operator -= (const
|
||
vector_expression<AE> &ae)</code></td>
|
||
<td>A computed assignment operator. Subtracts the vector
|
||
expression from the sub vector.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>template<class AE><br>
|
||
vector_range &minus_assign (const
|
||
vector_expression<AE> &ae)</code></td>
|
||
<td>Subtracts a vector expression from the sub vector.
|
||
Left and right hand side of the assignment should be
|
||
independent.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>template<class AT><br>
|
||
vector_range &operator *= (const AT &at)</code></td>
|
||
<td>A computed assignment operator. Multiplies the sub
|
||
vector with a scalar.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>template<class AT><br>
|
||
vector_range &operator /= (const AT &at)</code></td>
|
||
<td>A computed assignment operator. Divides the sub
|
||
vector through a scalar.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>void swap (vector_range &vr)</code></td>
|
||
<td>Swaps the contents of the sub vectors. </td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>const_iterator begin () const</code></td>
|
||
<td>Returns a <code>const_iterator</code> pointing to the
|
||
beginning of the <code>vector_range</code>. </td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>const_iterator end () const</code></td>
|
||
<td>Returns a <code>const_iterator</code> pointing to the
|
||
end of the <code>vector_range</code>. </td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>iterator begin () </code></td>
|
||
<td>Returns a <code>iterator</code> pointing to the
|
||
beginning of the <code>vector_range</code>. </td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>iterator end () </code></td>
|
||
<td>Returns a <code>iterator</code> pointing to the end
|
||
of the <code>vector_range</code>. </td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>const_reverse_iterator rbegin () const</code></td>
|
||
<td>Returns a <code>const_reverse_iterator</code>
|
||
pointing to the beginning of the reversed <code>vector_range</code>.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>const_reverse_iterator rend () const</code></td>
|
||
<td>Returns a <code>const_reverse_iterator</code>
|
||
pointing to the end of the reversed <code>vector_range</code>.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>reverse_iterator rbegin () </code></td>
|
||
<td>Returns a <code>reverse_iterator</code> pointing to
|
||
the beginning of the reversed <code>vector_range</code>. </td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>reverse_iterator rend () </code></td>
|
||
<td>Returns a <code>reverse_iterator</code> pointing to
|
||
the end of the reversed <code>vector_range</code>. </td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h4>Interface</h4>
|
||
|
||
<pre><code> // Vector based range class
|
||
template<class V>
|
||
class vector_range:
|
||
public vector_expression<vector_range<V> > {
|
||
public:
|
||
typedef const V const_vector_type;
|
||
typedef V vector_type;
|
||
typedef typename V::size_type size_type;
|
||
typedef typename V::difference_type difference_type;
|
||
typedef typename V::value_type value_type;
|
||
typedef typename V::const_reference const_reference;
|
||
typedef typename V::reference reference;
|
||
typedef typename V::const_pointer const_pointer;
|
||
typedef typename V::pointer pointer;
|
||
typedef const vector_const_reference<const vector_range<vector_type> > const_closure_type;
|
||
typedef vector_reference<vector_range<vector_type> > closure_type;
|
||
typedef typename V::const_iterator const_iterator_type;
|
||
typedef typename V::iterator iterator_type;
|
||
typedef typename storage_restrict_traits<typename V::storage_category,
|
||
dense_proxy_tag>::storage_category storage_category;
|
||
|
||
// Construction and destruction
|
||
vector_range ();
|
||
vector_range (vector_type &data, const range &r);
|
||
|
||
// Accessors
|
||
size_type start () const;
|
||
size_type size () const;
|
||
const_vector_type &data () const;
|
||
vector_type &data ();
|
||
|
||
|
||
// 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);
|
||
|
||
vector_range<vector_type> project (const range &r) const;
|
||
|
||
// Assignment
|
||
vector_range &operator = (const vector_range &vr);
|
||
vector_range &assign_temporary (vector_range &vr);
|
||
template<class AE>
|
||
vector_range &operator = (const vector_expression<AE> &ae);
|
||
template<class AE>
|
||
vector_range &assign (const vector_expression<AE> &ae);
|
||
template<class AE>
|
||
vector_range &operator += (const vector_expression<AE> &ae);
|
||
template<class AE>
|
||
vector_range &plus_assign (const vector_expression<AE> &ae);
|
||
template<class AE>
|
||
vector_range &operator -= (const vector_expression<AE> &ae);
|
||
template<class AE>
|
||
vector_range &minus_assign (const vector_expression<AE> &ae);
|
||
template<class AT>
|
||
vector_range &operator *= (const AT &at);
|
||
template<class AT>
|
||
vector_range &operator /= (const AT &at);
|
||
|
||
// Swapping
|
||
void swap (vector_range &vr);
|
||
friend void swap (vector_range &vr1, vector_range &vr2);
|
||
|
||
class const_iterator;
|
||
class iterator;
|
||
|
||
// Element lookup
|
||
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_range>,
|
||
public random_access_iterator_base<const_iterator, value_type> {
|
||
public:
|
||
typedef typename V::const_iterator::iterator_category iterator_category;
|
||
typedef typename V::const_iterator::difference_type difference_type;
|
||
typedef typename V::const_iterator::value_type value_type;
|
||
typedef typename V::const_iterator::reference reference;
|
||
typedef typename V::const_iterator::pointer pointer;
|
||
|
||
// Construction and destruction
|
||
const_iterator ();
|
||
const_iterator (const vector_range &vr, 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_range>,
|
||
public random_access_iterator_base<iterator, value_type> {
|
||
public:
|
||
typedef typename V::iterator::iterator_category iterator_category;
|
||
typedef typename V::iterator::difference_type difference_type;
|
||
typedef typename V::iterator::value_type value_type;
|
||
typedef typename V::iterator::reference reference;
|
||
typedef typename V::iterator::pointer pointer;
|
||
|
||
// Construction and destruction
|
||
iterator ();
|
||
iterator (vector_range &vr, 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 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>
|
||
|
||
<h3>Projections</h3>
|
||
|
||
<h4>Prototypes</h4>
|
||
|
||
<pre><code> template<class V>
|
||
vector_range<V> project (V &data, const range &r);
|
||
template<class V>
|
||
const vector_range<const V> project (const V &data, const range &r);
|
||
template<class V>
|
||
vector_range<V> project (const vector_range<V> &data, const range &r);</code></pre>
|
||
|
||
<h4>Description</h4>
|
||
|
||
<p>The free <code>project</code> functions support the
|
||
construction of vector ranges.</p>
|
||
|
||
<h4>Definition</h4>
|
||
|
||
<p>Defined in the header vector_proxy.hpp.</p>
|
||
|
||
<h4>Type requirements</h4>
|
||
|
||
<dir>
|
||
<li><code>V</code> is a model of <a
|
||
href="expression.htm#vector_expression">Vector Expression</a>.</li>
|
||
</dir>
|
||
|
||
<h4>Preconditions</h4>
|
||
|
||
<dir>
|
||
<li><code>r.start () + r.size () <= data.size ()</code></li>
|
||
</dir>
|
||
|
||
<h4>Complexity</h4>
|
||
|
||
<p>Linear depending from the size of the range.</p>
|
||
|
||
<h4>Examples</h4>
|
||
|
||
<pre>int main () {
|
||
using namespace boost::numeric::ublas;
|
||
vector<double> v (3);
|
||
for (int i = 0; i < 3; ++ i)
|
||
project (v, range (0, 3)) (i) = i;
|
||
std::cout << project (v, range (0, 3)) << std::endl;
|
||
}</pre>
|
||
|
||
<h2><a name="vector_slice"></a>Vector Slice</h2>
|
||
|
||
<h4>Description</h4>
|
||
|
||
<p>The templated class <code>vector_slice<V> </code>allows
|
||
addressing a slice of a vector.</p>
|
||
|
||
<h4>Example</h4>
|
||
|
||
<pre>int main () {
|
||
using namespace boost::numeric::ublas;
|
||
vector<double> v (3);
|
||
vector_slice<vector<double> > vs (v, slice (0, 1, 3));
|
||
for (int i = 0; i < vs.size (); ++ i)
|
||
vs (i) = i;
|
||
std::cout << vs << std::endl;
|
||
}</pre>
|
||
|
||
<h4>Definition</h4>
|
||
|
||
<p>Defined in the header vector_proxy.hpp.</p>
|
||
|
||
<h4>Template parameters</h4>
|
||
|
||
<table border="1">
|
||
<tr>
|
||
<th>Parameter </th>
|
||
<th>Description </th>
|
||
<th>Default </th>
|
||
</tr>
|
||
<tr>
|
||
<td><code>V</code> </td>
|
||
<td>The type of vector referenced. </td>
|
||
<td> </td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h4>Model of</h4>
|
||
|
||
<p><a href="expression.htm#vector_expression">Vector Expression</a>.
|
||
</p>
|
||
|
||
<h4>Type requirements</h4>
|
||
|
||
<p>None, except for those imposed by the requirements of <a
|
||
href="expression.htm#vector_expression">Vector Expression</a>.</p>
|
||
|
||
<h4>Public base classes</h4>
|
||
|
||
<p><code>vector_expression<vector_slice<V> ></code> </p>
|
||
|
||
<h4>Members</h4>
|
||
|
||
<table border="1">
|
||
<tr>
|
||
<th>Member </th>
|
||
<th>Description </th>
|
||
</tr>
|
||
<tr>
|
||
<td><code>vector_slice (vector_type &data, const
|
||
slice &s)</code></td>
|
||
<td>Constructs a sub vector.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>size_type size () const</code></td>
|
||
<td>Returns the size of the sub vector.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>const_reference operator () (size_type i) const</code></td>
|
||
<td>Returns the value of the <code>i</code>-th element. </td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>reference operator () (size_type i)</code></td>
|
||
<td>Returns a reference of the <code>i</code>-th element.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>const_reference operator [] (size_type i) const</code></td>
|
||
<td>Returns the value of the <code>i</code>-th element. </td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>reference operator [] (size_type i)</code></td>
|
||
<td>Returns a reference of the <code>i</code>-th element.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>vector_slice &operator = (const
|
||
vector_slice &vs)</code></td>
|
||
<td>The assignment operator.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>vector_slice &assign_temporary
|
||
(vector_slice &vs)</code></td>
|
||
<td>Assigns a temporary. May change the vector slice <code>vs</code>.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>template<class AE><br>
|
||
vector_slice &operator = (const
|
||
vector_expression<AE> &ae)</code></td>
|
||
<td>The extended assignment operator.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>template<class AE><br>
|
||
vector_slice &assign (const
|
||
vector_expression<AE> &ae)</code></td>
|
||
<td>Assigns a vector expression to the sub vector. Left
|
||
and right hand side of the assignment should be
|
||
independent.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>template<class AE><br>
|
||
vector_slice &operator += (const
|
||
vector_expression<AE> &ae)</code></td>
|
||
<td>A computed assignment operator. Adds the vector
|
||
expression to the sub vector.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>template<class AE><br>
|
||
vector_slice &plus_assign (const
|
||
vector_expression<AE> &ae)</code></td>
|
||
<td>Adds a vector expression to the sub vector. Left and
|
||
right hand side of the assignment should be independent.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>template<class AE><br>
|
||
vector_slice &operator -= (const
|
||
vector_expression<AE> &ae)</code></td>
|
||
<td>A computed assignment operator. Subtracts the vector
|
||
expression from the sub vector.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>template<class AE><br>
|
||
vector_slice &minus_assign (const
|
||
vector_expression<AE> &ae)</code></td>
|
||
<td>Subtracts a vector expression from the sub vector.
|
||
Left and right hand side of the assignment should be
|
||
independent.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>template<class AT><br>
|
||
vector_slice &operator *= (const AT &at)</code></td>
|
||
<td>A computed assignment operator. Multiplies the sub
|
||
vector with a scalar.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>template<class AT><br>
|
||
vector_slice &operator /= (const AT &at)</code></td>
|
||
<td>A computed assignment operator. Divides the sub
|
||
vector through a scalar.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>void swap (vector_slice &vs)</code></td>
|
||
<td>Swaps the contents of the sub vectors. </td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>const_iterator begin () const</code></td>
|
||
<td>Returns a <code>const_iterator</code> pointing to the
|
||
beginning of the <code>vector_slice</code>. </td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>const_iterator end () const</code></td>
|
||
<td>Returns a <code>const_iterator</code> pointing to the
|
||
end of the <code>vector_slice</code>. </td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>iterator begin () </code></td>
|
||
<td>Returns a <code>iterator</code> pointing to the
|
||
beginning of the <code>vector_slice</code>. </td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>iterator end () </code></td>
|
||
<td>Returns a <code>iterator</code> pointing to the end
|
||
of the <code>vector_slice</code>. </td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>const_reverse_iterator rbegin () const</code></td>
|
||
<td>Returns a <code>const_reverse_iterator</code>
|
||
pointing to the beginning of the reversed <code>vector_slice</code>.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>const_reverse_iterator rend () const</code></td>
|
||
<td>Returns a <code>const_reverse_iterator</code>
|
||
pointing to the end of the reversed <code>vector_slice</code>.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>reverse_iterator rbegin () </code></td>
|
||
<td>Returns a <code>reverse_iterator</code> pointing to
|
||
the beginning of the reversed <code>vector_slice</code>. </td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>reverse_iterator rend () </code></td>
|
||
<td>Returns a <code>reverse_iterator</code> pointing to
|
||
the end of the reversed <code>vector_slice</code>. </td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h4>Interface</h4>
|
||
|
||
<pre><code> // Vector based slice class
|
||
template<class V>
|
||
class vector_slice:
|
||
public vector_expression<vector_slice<V> > {
|
||
public:
|
||
typedef const V const_vector_type;
|
||
typedef V vector_type;
|
||
typedef typename V::size_type size_type;
|
||
typedef typename V::difference_type difference_type;
|
||
typedef typename V::value_type value_type;
|
||
typedef typename V::const_reference const_reference;
|
||
typedef typename V::reference reference;
|
||
typedef typename V::const_pointer const_pointer;
|
||
typedef typename V::pointer pointer;
|
||
typedef const vector_const_reference<const vector_slice<vector_type> > const_closure_type;
|
||
typedef vector_reference<vector_slice<vector_type> > closure_type;
|
||
typedef slice::const_iterator const_iterator_type;
|
||
typedef slice::const_iterator iterator_type;
|
||
typedef typename storage_restrict_traits<typename V::storage_category,
|
||
dense_proxy_tag>::storage_category storage_category;
|
||
|
||
// Construction and destruction
|
||
vector_slice ();
|
||
vector_slice (vector_type &data, const slice &s);
|
||
|
||
// Accessors
|
||
size_type start () const;
|
||
size_type stride () const;
|
||
size_type size () const;
|
||
const_vector_type &data () const;
|
||
vector_type &data ();
|
||
|
||
|
||
// 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);
|
||
|
||
vector_slice<vector_type> project (const range &r) const;
|
||
vector_slice<vector_type> project (const slice &s) const;
|
||
|
||
// Assignment
|
||
vector_slice &operator = (const vector_slice &vs);
|
||
vector_slice &assign_temporary (vector_slice &vs);
|
||
template<class AE>
|
||
vector_slice &operator = (const vector_expression<AE> &ae);
|
||
template<class AE>
|
||
vector_slice &assign (const vector_expression<AE> &ae);
|
||
template<class AE>
|
||
vector_slice &operator += (const vector_expression<AE> &ae);
|
||
template<class AE>
|
||
vector_slice &plus_assign (const vector_expression<AE> &ae);
|
||
template<class AE>
|
||
vector_slice &operator -= (const vector_expression<AE> &ae);
|
||
template<class AE>
|
||
vector_slice &minus_assign (const vector_expression<AE> &ae);
|
||
template<class AT>
|
||
vector_slice &operator *= (const AT &at);
|
||
template<class AT>
|
||
vector_slice &operator /= (const AT &at);
|
||
|
||
// Swapping
|
||
void swap (vector_slice &vs);
|
||
friend void swap (vector_slice &vs1, vector_slice &vs2);
|
||
|
||
class const_iterator;
|
||
class iterator;
|
||
|
||
// Element lookup
|
||
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 indices.
|
||
|
||
class const_iterator:
|
||
public container_const_reference<vector_slice>,
|
||
public random_access_iterator_base<const_iterator, value_type> {
|
||
public:
|
||
typedef typename V::const_iterator::iterator_category iterator_category;
|
||
typedef typename V::const_iterator::difference_type difference_type;
|
||
typedef typename V::const_iterator::value_type value_type;
|
||
typedef typename V::const_iterator::reference reference;
|
||
typedef typename V::const_iterator::pointer pointer;
|
||
|
||
// Construction and destruction
|
||
const_iterator ();
|
||
const_iterator (const vector_slice &vs, 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_slice>,
|
||
public random_access_iterator_base<iterator, value_type> {
|
||
public:
|
||
typedef typename V::iterator::iterator_category iterator_category;
|
||
typedef typename V::iterator::difference_type difference_type;
|
||
typedef typename V::iterator::value_type value_type;
|
||
typedef typename V::iterator::reference reference;
|
||
typedef typename V::iterator::pointer pointer;
|
||
|
||
// Construction and destruction
|
||
iterator ();
|
||
iterator (vector_slice &vs, 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 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>
|
||
|
||
<h3>Projections</h3>
|
||
|
||
<h4>Prototypes</h4>
|
||
|
||
<pre><code> template<class V>
|
||
vector_slice<V> project (const vector_slice<V> &data, const range &r);
|
||
template<class V>
|
||
vector_slice<V> project (V &data, const slice &s);
|
||
template<class V>
|
||
const vector_slice<const V> project (const V &data, const slice &s);
|
||
template<class V>
|
||
vector_slice<V> project (const vector_slice<V> &data, const slice &s);</code></pre>
|
||
|
||
<h4>Description</h4>
|
||
|
||
<p>The free <code>project</code> functions support the
|
||
construction of vector slices.</p>
|
||
|
||
<h4>Definition</h4>
|
||
|
||
<p>Defined in the header vector_proxy.hpp.</p>
|
||
|
||
<h4>Type requirements</h4>
|
||
|
||
<dir>
|
||
<li><code>V</code> is a model of <a
|
||
href="expression.htm#vector_expression">Vector Expression</a>.</li>
|
||
</dir>
|
||
|
||
<h4>Preconditions</h4>
|
||
|
||
<ul type="disc">
|
||
<li><code>s.start () + s.stride () * s.size () <=
|
||
data.size ()</code></li>
|
||
</ul>
|
||
|
||
<h4>Complexity</h4>
|
||
|
||
<p>Linear depending from the size of the slice.</p>
|
||
|
||
<h4>Examples</h4>
|
||
|
||
<pre>int main () {
|
||
using namespace boost::numeric::ublas;
|
||
vector<double> v (3);
|
||
for (int i = 0; i < 3; ++ i)
|
||
project (v, slice (0, 1, 3)) (i) = i;
|
||
std::cout << project (v, slice (0, 1, 3)) << std::endl;
|
||
}</pre>
|
||
|
||
<hr>
|
||
|
||
<p>Copyright (<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>
|