mirror of
https://github.com/boostorg/ublas.git
synced 2026-02-09 11:32:19 +00:00
499 lines
31 KiB
HTML
499 lines
31 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<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">
|
|
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>#include <boost/numeric/ublas/vector.hpp><br>#include <boost/numeric/ublas/io.hpp><br><br>int main () {<br> using namespace boost::numeric::ublas;<br> vector<double> v (3);<br> vector_range<vector<double> > vr (v, range (0, 3));<br> for (unsigned i = 0; i < vr.size (); ++ i)<br> vr (i) = i;<br> std::cout << vr << std::endl;<br>}<br></pre>
|
|
<h4>Definition</h4>
|
|
|
|
<p>Defined in the header vector_proxy.hpp.</p>
|
|
|
|
<h4>Template parameters</h4>
|
|
|
|
<table border="1">
|
|
<tbody>
|
|
<tr>
|
|
<th>Parameter </th>
|
|
<th>Description </th>
|
|
<th>Default </th>
|
|
</tr>
|
|
<tr>
|
|
<td><code>V</code> </td>
|
|
<td>The type of vector referenced. </td>
|
|
<td> </td>
|
|
</tr>
|
|
|
|
</tbody>
|
|
</table>
|
|
|
|
<h4>Model of</h4>
|
|
|
|
<p><a href="expression.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">
|
|
<tbody>
|
|
<tr>
|
|
<th>Member </th>
|
|
<th>Description </th>
|
|
</tr>
|
|
<tr>
|
|
<td><code>vector_range (vector_type &data, const range
|
|
&r)</code></td>
|
|
<td>Constructs a sub vector.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>size_type start () const</code></td>
|
|
<td>Returns the start of the sub vector.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>size_type size () const</code></td>
|
|
<td>Returns the size of the sub vector.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>const_reference operator () (size_type i) const</code></td>
|
|
<td>Returns the value of the <code>i</code>-th element. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>reference operator () (size_type i)</code></td>
|
|
<td>Returns a reference of the <code>i</code>-th element.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>const_reference operator [] (size_type i) const</code></td>
|
|
<td>Returns the value of the <code>i</code>-th element. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>reference operator [] (size_type i)</code></td>
|
|
<td>Returns a reference of the <code>i</code>-th element.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>vector_range &operator = (const vector_range
|
|
&vr)</code></td>
|
|
<td>The assignment operator.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>vector_range &assign_temporary (vector_range
|
|
&vr)</code></td>
|
|
<td>Assigns a temporary. May change the vector range <code>vr</code>
|
|
.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>template<class AE><br>
|
|
vector_range &operator = (const vector_expression<AE>
|
|
&ae)</code></td>
|
|
<td>The extended assignment operator.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>template<class AE><br>
|
|
vector_range &assign (const vector_expression<AE>
|
|
&ae)</code></td>
|
|
<td>Assigns a vector expression to the sub vector. Left
|
|
and right hand side of the assignment should be independent.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>template<class AE><br>
|
|
vector_range &operator += (const vector_expression<AE>
|
|
&ae)</code></td>
|
|
<td>A computed assignment operator. Adds the vector expression
|
|
to the sub vector.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>template<class AE><br>
|
|
vector_range &plus_assign (const vector_expression<AE>
|
|
&ae)</code></td>
|
|
<td>Adds a vector expression to the sub vector. Left and
|
|
right hand side of the assignment should be independent.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>template<class AE><br>
|
|
vector_range &operator -= (const vector_expression<AE>
|
|
&ae)</code></td>
|
|
<td>A computed assignment operator. Subtracts the vector
|
|
expression from the sub vector.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>template<class AE><br>
|
|
vector_range &minus_assign (const vector_expression<AE>
|
|
&ae)</code></td>
|
|
<td>Subtracts a vector expression from the sub vector. Left
|
|
and right hand side of the assignment should be independent.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>template<class AT><br>
|
|
vector_range &operator *= (const AT &at)</code></td>
|
|
<td>A computed assignment operator. Multiplies the sub vector
|
|
with a scalar.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>template<class AT><br>
|
|
vector_range &operator /= (const AT &at)</code></td>
|
|
<td>A computed assignment operator. Divides the sub vector
|
|
through a scalar.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>void swap (vector_range &vr)</code></td>
|
|
<td>Swaps the contents of the sub vectors. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>const_iterator begin () const</code></td>
|
|
<td>Returns a <code>const_iterator</code> pointing to the
|
|
beginning of the <code>vector_range</code>. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>const_iterator end () const</code></td>
|
|
<td>Returns a <code>const_iterator</code> pointing to the
|
|
end of the <code>vector_range</code>. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>iterator begin () </code></td>
|
|
<td>Returns a <code>iterator</code> pointing to the beginning
|
|
of the <code>vector_range</code>. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>iterator end () </code></td>
|
|
<td>Returns a <code>iterator</code> pointing to the end
|
|
of the <code>vector_range</code>. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>const_reverse_iterator rbegin () const</code></td>
|
|
<td>Returns a <code>const_reverse_iterator</code> pointing
|
|
to the beginning of the reversed <code>vector_range</code>. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>const_reverse_iterator rend () const</code></td>
|
|
<td>Returns a <code>const_reverse_iterator</code> pointing
|
|
to the end of the reversed <code>vector_range</code>. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>reverse_iterator rbegin () </code></td>
|
|
<td>Returns a <code>reverse_iterator</code> pointing to
|
|
the beginning of the reversed <code>vector_range</code>. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>reverse_iterator rend () </code></td>
|
|
<td>Returns a <code>reverse_iterator</code> pointing to
|
|
the end of the reversed <code>vector_range</code>. </td>
|
|
</tr>
|
|
|
|
</tbody>
|
|
</table>
|
|
|
|
<h4>Interface</h4>
|
|
|
|
<pre><code> // Vector based range class<br> template<class V><br> class vector_range:<br> public vector_expression<vector_range<V> > {<br> public:<br> typedef const V const_vector_type;<br> typedef V vector_type;<br> typedef typename V::size_type size_type;<br> typedef typename V::difference_type difference_type;<br> typedef typename V::value_type value_type;<br> typedef typename V::const_reference const_reference;<br> typedef typename V::reference reference;<br> typedef typename V::const_pointer const_pointer;<br> typedef typename V::pointer pointer;<br> typedef const vector_const_reference<const vector_range<vector_type> > const_closure_type;<br> typedef vector_reference<vector_range<vector_type> > closure_type;<br> typedef typename V::const_iterator const_iterator_type;<br> typedef typename V::iterator iterator_type;<br> typedef typename storage_restrict_traits<typename V::storage_category,<br> dense_proxy_tag>::storage_category storage_category;<br><br> // Construction and destruction<br> vector_range ();<br> vector_range (vector_type &data, const range &r);<br><br> // Accessors<br> size_type start () const;<br> size_type size () const;<br> const_vector_type &data () const;<br> vector_type &data ();<br><br><br> // Element access<br> const_reference operator () (size_type i) const;<br> reference operator () (size_type i);<br><br> const_reference operator [] (size_type i) const;<br> reference operator [] (size_type i);<br><br> vector_range<vector_type> project (const range &r) const;<br><br> // Assignment<br> vector_range &operator = (const vector_range &vr);<br> vector_range &assign_temporary (vector_range &vr);<br> template<class AE><br> vector_range &operator = (const vector_expression<AE> &ae);<br> template<class AE><br> vector_range &assign (const vector_expression<AE> &ae);<br> template<class AE><br> vector_range &operator += (const vector_expression<AE> &ae);<br> template<class AE><br> vector_range &plus_assign (const vector_expression<AE> &ae);<br> template<class AE><br> vector_range &operator -= (const vector_expression<AE> &ae);<br> template<class AE><br> vector_range &minus_assign (const vector_expression<AE> &ae);<br> template<class AT><br> vector_range &operator *= (const AT &at);<br> template<class AT><br> vector_range &operator /= (const AT &at);<br><br> // Swapping<br> void swap (vector_range &vr);<br> friend void swap (vector_range &vr1, vector_range &vr2);<br><br> class const_iterator;<br> class iterator;<br><br> // Element lookup<br> const_iterator find_first (size_type i) const;<br> iterator find_first (size_type i);<br> const_iterator find_last (size_type i) const;<br> iterator find_last (size_type i);<br><br> // Iterators simply are pointers.<br><br> class const_iterator:<br> public container_const_reference<vector_range>,<br> public random_access_iterator_base<const_iterator, value_type> {<br> public:<br> typedef typename const_iterator_type::iterator_category iterator_category;<br> typedef typename const_iterator_type::difference_type difference_type;<br> typedef typename const_iterator_type::value_type value_type;<br> typedef typename const_iterator_type::reference reference;<br> typedef typename const_iterator_type::pointer pointer;<br><br> // Construction and destruction<br> const_iterator ();<br> const_iterator (const vector_range &vr, const const_iterator_type &it);<br> const_iterator (const iterator &it);<br><br> // Arithmetic<br> const_iterator &operator ++ ();<br> const_iterator &operator -- ();<br> const_iterator &operator += (difference_type n);<br> const_iterator &operator -= (difference_type n);<br> difference_type operator - (const const_iterator &it) const;<br><br> // Dereference<br> reference operator * () const;<br><br> // Index<br> size_type index () const;<br><br> // Assignment<br> const_iterator &operator = (const const_iterator &it);<br><br> // Comparison<br> bool operator == (const const_iterator &it) const;<br> bool operator <(const const_iterator &it) const;<br> };<br><br> const_iterator begin () const;<br> const_iterator end () const;<br><br> class iterator:<br> public container_reference<vector_range>,<br> public random_access_iterator_base<iterator, value_type> {<br> public:<br> typedef typename iterator_type::iterator_category iterator_category;<br> typedef typename iterator_type::difference_type difference_type;<br> typedef typename iterator_type::value_type value_type;<br> typedef typename iterator_type::reference reference;<br> typedef typename iterator_type::pointer pointer;<br><br> // Construction and destruction<br> iterator ();<br> iterator (vector_range &vr, const iterator_type &it);<br><br> // Arithmetic<br> iterator &operator ++ ();<br> iterator &operator -- ();<br> iterator &operator += (difference_type n);<br> iterator &operator -= (difference_type n);<br> difference_type operator - (const iterator &it) const;<br><br> // Dereference<br> reference operator * () const;<br><br> // Index<br> size_type index () const;<br><br> // Assignment<br> iterator &operator = (const iterator &it);<br><br> // Comparison<br> bool operator == (const iterator &it) const;<br> bool operator <(const iterator &it) const;<br> };<br><br> iterator begin ();<br> iterator end ();<br><br> // Reverse iterator<br><br> typedef reverse_iterator_base<const_iterator> const_reverse_iterator;<br><br> const_reverse_iterator rbegin () const;<br> const_reverse_iterator rend () const;<br><br> typedef reverse_iterator_base<iterator> reverse_iterator;<br><br> reverse_iterator rbegin ();<br> reverse_iterator rend ();<br> };</code></pre>
|
|
|
|
<h3>Projections</h3>
|
|
|
|
<h4>Prototypes</h4>
|
|
|
|
<pre><code> template<class V><br> vector_range<V> project (V &data, const range &r);<br> template<class V><br> const vector_range<const V> project (const V &data, const range &r);<br> template<class V><br> 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>#include <boost/numeric/ublas/vector.hpp><br>#include <boost/numeric/ublas/io.hpp><br><br>int main () {<br> using namespace boost::numeric::ublas;<br> vector<double> v (3);<br> for (int i = 0; i < 3; ++ i)<br> project (v, range (0, 3)) (i) = i;<br> std::cout << project (v, range (0, 3)) << std::endl;<br>}</pre>
|
|
<h2><a name="vector_slice"></a>
|
|
Vector Slice</h2>
|
|
|
|
<h4>Description</h4>
|
|
|
|
<p>The templated class <code>vector_slice<V> </code>allows addressing
|
|
a slice of a vector.</p>
|
|
|
|
<h4>Example</h4>
|
|
|
|
<pre>#include <boost/numeric/ublas/vector.hpp><br>#include <boost/numeric/ublas/io.hpp><br><br>int main () {<br> using namespace boost::numeric::ublas;<br> vector<double> v (3);<br> vector_slice<vector<double> > vs (v, slice (0, 1, 3));<br> for (unsigned i = 0; i < vs.size (); ++ i)<br> vs (i) = i;<br> std::cout << vs << std::endl;<br>}<br></pre>
|
|
<h4>Definition</h4>
|
|
|
|
<p>Defined in the header vector_proxy.hpp.</p>
|
|
|
|
<h4>Template parameters</h4>
|
|
|
|
<table border="1">
|
|
<tbody>
|
|
<tr>
|
|
<th>Parameter </th>
|
|
<th>Description </th>
|
|
<th>Default </th>
|
|
</tr>
|
|
<tr>
|
|
<td><code>V</code> </td>
|
|
<td>The type of vector referenced. </td>
|
|
<td> </td>
|
|
</tr>
|
|
|
|
</tbody>
|
|
</table>
|
|
|
|
<h4>Model of</h4>
|
|
|
|
<p><a href="expression.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">
|
|
<tbody>
|
|
<tr>
|
|
<th>Member </th>
|
|
<th>Description </th>
|
|
</tr>
|
|
<tr>
|
|
<td><code>vector_slice (vector_type &data, const slice
|
|
&s)</code></td>
|
|
<td>Constructs a sub vector.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>size_type size () const</code></td>
|
|
<td>Returns the size of the sub vector.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>const_reference operator () (size_type i) const</code></td>
|
|
<td>Returns the value of the <code>i</code>-th element. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>reference operator () (size_type i)</code></td>
|
|
<td>Returns a reference of the <code>i</code>-th element.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>const_reference operator [] (size_type i) const</code></td>
|
|
<td>Returns the value of the <code>i</code>-th element. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>reference operator [] (size_type i)</code></td>
|
|
<td>Returns a reference of the <code>i</code>-th element.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>vector_slice &operator = (const vector_slice
|
|
&vs)</code></td>
|
|
<td>The assignment operator.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>vector_slice &assign_temporary (vector_slice
|
|
&vs)</code></td>
|
|
<td>Assigns a temporary. May change the vector slice <code>vs</code>
|
|
.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>template<class AE><br>
|
|
vector_slice &operator = (const vector_expression<AE>
|
|
&ae)</code></td>
|
|
<td>The extended assignment operator.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>template<class AE><br>
|
|
vector_slice &assign (const vector_expression<AE>
|
|
&ae)</code></td>
|
|
<td>Assigns a vector expression to the sub vector. Left
|
|
and right hand side of the assignment should be independent.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>template<class AE><br>
|
|
vector_slice &operator += (const vector_expression<AE>
|
|
&ae)</code></td>
|
|
<td>A computed assignment operator. Adds the vector expression
|
|
to the sub vector.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>template<class AE><br>
|
|
vector_slice &plus_assign (const vector_expression<AE>
|
|
&ae)</code></td>
|
|
<td>Adds a vector expression to the sub vector. Left and
|
|
right hand side of the assignment should be independent.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>template<class AE><br>
|
|
vector_slice &operator -= (const vector_expression<AE>
|
|
&ae)</code></td>
|
|
<td>A computed assignment operator. Subtracts the vector
|
|
expression from the sub vector.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>template<class AE><br>
|
|
vector_slice &minus_assign (const vector_expression<AE>
|
|
&ae)</code></td>
|
|
<td>Subtracts a vector expression from the sub vector. Left
|
|
and right hand side of the assignment should be independent.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>template<class AT><br>
|
|
vector_slice &operator *= (const AT &at)</code></td>
|
|
<td>A computed assignment operator. Multiplies the sub vector
|
|
with a scalar.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>template<class AT><br>
|
|
vector_slice &operator /= (const AT &at)</code></td>
|
|
<td>A computed assignment operator. Divides the sub vector
|
|
through a scalar.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>void swap (vector_slice &vs)</code></td>
|
|
<td>Swaps the contents of the sub vectors. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>const_iterator begin () const</code></td>
|
|
<td>Returns a <code>const_iterator</code> pointing to the
|
|
beginning of the <code>vector_slice</code>. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>const_iterator end () const</code></td>
|
|
<td>Returns a <code>const_iterator</code> pointing to the
|
|
end of the <code>vector_slice</code>. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>iterator begin () </code></td>
|
|
<td>Returns a <code>iterator</code> pointing to the beginning
|
|
of the <code>vector_slice</code>. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>iterator end () </code></td>
|
|
<td>Returns a <code>iterator</code> pointing to the end
|
|
of the <code>vector_slice</code>. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>const_reverse_iterator rbegin () const</code></td>
|
|
<td>Returns a <code>const_reverse_iterator</code> pointing
|
|
to the beginning of the reversed <code>vector_slice</code>. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>const_reverse_iterator rend () const</code></td>
|
|
<td>Returns a <code>const_reverse_iterator</code> pointing
|
|
to the end of the reversed <code>vector_slice</code>. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>reverse_iterator rbegin () </code></td>
|
|
<td>Returns a <code>reverse_iterator</code> pointing to
|
|
the beginning of the reversed <code>vector_slice</code>. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>reverse_iterator rend () </code></td>
|
|
<td>Returns a <code>reverse_iterator</code> pointing to
|
|
the end of the reversed <code>vector_slice</code>. </td>
|
|
</tr>
|
|
|
|
</tbody>
|
|
</table>
|
|
|
|
<h4>Interface</h4>
|
|
|
|
<pre><code> // Vector based slice class<br> template<class V><br> class vector_slice:<br> public vector_expression<vector_slice<V> > {<br> public:<br> typedef const V const_vector_type;<br> typedef V vector_type;<br> typedef typename V::size_type size_type;<br> typedef typename V::difference_type difference_type;<br> typedef typename V::value_type value_type;<br> typedef typename V::const_reference const_reference;<br> typedef typename V::reference reference;<br> typedef typename V::const_pointer const_pointer;<br> typedef typename V::pointer pointer;<br> typedef const vector_const_reference<const vector_slice<vector_type> > const_closure_type;<br> typedef vector_reference<vector_slice<vector_type> > closure_type;<br> typedef slice::const_iterator const_iterator_type;<br> typedef slice::const_iterator iterator_type;<br> typedef typename storage_restrict_traits<typename V::storage_category,<br> dense_proxy_tag>::storage_category storage_category;<br><br> // Construction and destruction<br> vector_slice ();<br> vector_slice (vector_type &data, const slice &s);<br><br> // Accessors<br> size_type start () const;<br> size_type stride () const;<br> size_type size () const;<br> const_vector_type &data () const;<br> vector_type &data ();<br><br><br> // Element access<br> const_reference operator () (size_type i) const;<br> reference operator () (size_type i);<br><br> const_reference operator [] (size_type i) const;<br> reference operator [] (size_type i);<br><br> vector_slice<vector_type> project (const range &r) const;<br> vector_slice<vector_type> project (const slice &s) const;<br><br> // Assignment<br> vector_slice &operator = (const vector_slice &vs);<br> vector_slice &assign_temporary (vector_slice &vs);<br> template<class AE><br> vector_slice &operator = (const vector_expression<AE> &ae);<br> template<class AE><br> vector_slice &assign (const vector_expression<AE> &ae);<br> template<class AE><br> vector_slice &operator += (const vector_expression<AE> &ae);<br> template<class AE><br> vector_slice &plus_assign (const vector_expression<AE> &ae);<br> template<class AE><br> vector_slice &operator -= (const vector_expression<AE> &ae);<br> template<class AE><br> vector_slice &minus_assign (const vector_expression<AE> &ae);<br> template<class AT><br> vector_slice &operator *= (const AT &at);<br> template<class AT><br> vector_slice &operator /= (const AT &at);<br><br> // Swapping<br> void swap (vector_slice &vs);<br> friend void swap (vector_slice &vs1, vector_slice &vs2);<br><br> class const_iterator;<br> class iterator;<br><br> // Element lookup<br> const_iterator find_first (size_type i) const;<br> iterator find_first (size_type i);<br> const_iterator find_last (size_type i) const;<br> iterator find_last (size_type i);<br><br> // Iterators simply are indices.<br><br> class const_iterator:<br> public container_const_reference<vector_slice>,<br> public random_access_iterator_base<const_iterator, value_type> {<br> public:<br> typedef typename V::const_iterator::iterator_category iterator_category;<br> typedef typename V::const_iterator::difference_type difference_type;<br> typedef typename V::const_iterator::value_type value_type;<br> typedef typename V::const_iterator::reference reference;<br> typedef typename V::const_iterator::pointer pointer;<br><br> // Construction and destruction<br> const_iterator ();<br> const_iterator (const vector_slice &vs, const const_iterator_type &it);<br> const_iterator (const iterator &it);<br><br> // Arithmetic<br> const_iterator &operator ++ ();<br> const_iterator &operator -- ();<br> const_iterator &operator += (difference_type n);<br> const_iterator &operator -= (difference_type n);<br> difference_type operator - (const const_iterator &it) const;<br><br> // Dereference<br> reference operator * () const;<br><br> // Index<br> size_type index () const;<br><br> // Assignment<br> const_iterator &operator = (const const_iterator &it);<br><br> // Comparison<br> bool operator == (const const_iterator &it) const;<br> bool operator <(const const_iterator &it) const;<br> };<br><br> const_iterator begin () const;<br> const_iterator end () const;<br><br> class iterator:<br> public container_reference<vector_slice>,<br> public random_access_iterator_base<iterator, value_type> {<br> public:<br> typedef typename V::iterator::iterator_category iterator_category;<br> typedef typename V::iterator::difference_type difference_type;<br> typedef typename V::iterator::value_type value_type;<br> typedef typename V::iterator::reference reference;<br> typedef typename V::iterator::pointer pointer;<br><br> // Construction and destruction<br> iterator ();<br> iterator (vector_slice &vs, const iterator_type &it);<br><br> // Arithmetic<br> iterator &operator ++ ();<br> iterator &operator -- ();<br> iterator &operator += (difference_type n);<br> iterator &operator -= (difference_type n);<br> difference_type operator - (const iterator &it) const;<br><br> // Dereference<br> reference operator * () const;<br><br> // Index<br> size_type index () const;<br><br> // Assignment<br> iterator &operator = (const iterator &it);<br><br> // Comparison<br> bool operator == (const iterator &it) const;<br> bool operator <(const iterator &it) const;<br> };<br><br> iterator begin ();<br> iterator end ();<br><br> // Reverse iterator<br><br> typedef reverse_iterator_base<const_iterator> const_reverse_iterator;<br><br> const_reverse_iterator rbegin () const;<br> const_reverse_iterator rend () const;<br><br> typedef reverse_iterator_base<iterator> reverse_iterator;<br><br> reverse_iterator rbegin ();<br> reverse_iterator rend ();<br> };</code></pre>
|
|
|
|
<h3>Projections</h3>
|
|
|
|
<h4>Prototypes</h4>
|
|
|
|
<pre><code> template<class V><br> vector_slice<V> project (const vector_slice<V> &data, const range &r);<br> template<class V><br> vector_slice<V> project (V &data, const slice &s);<br> template<class V><br> const vector_slice<const V> project (const V &data, const slice &s);<br> template<class V><br> 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>#include <boost/numeric/ublas/vector.hpp><br>#include <boost/numeric/ublas/io.hpp><br><br>int main () {<br> using namespace boost::numeric::ublas;<br> vector<double> v (3);<br> for (int i = 0; i < 3; ++ i)<br> project (v, slice (0, 1, 3)) (i) = i;<br> std::cout << project (v, slice (0, 1, 3)) << std::endl;<br>}<br></pre>
|
|
<hr>
|
|
<p>Copyright (©) 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: 1/15/2003</p>
|
|
|
|
</body>
|
|
</html>
|