Imported Upstream version 1.72.0
[platform/upstream/boost.git] / libs / compute / doc / html / boost / compute / vector.html
1 <html>
2 <head>
3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
4 <title>Class template vector</title>
5 <link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css">
6 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
7 <link rel="home" href="../../index.html" title="Chapter&#160;1.&#160;Boost.Compute">
8 <link rel="up" href="../../boost_compute/reference.html#header.boost.compute.container.vector_hpp" title="Header &lt;boost/compute/container/vector.hpp&gt;">
9 <link rel="prev" href="../../BOOST_CO_idm46009693226768.html" title="Macro BOOST_COMPUTE_DEFINE_VALARRAY_LOGICAL_OPERATOR">
10 <link rel="next" href="context_error.html" title="Class context_error">
11 </head>
12 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
13 <table cellpadding="2" width="100%"><tr>
14 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
15 <td align="center"><a href="../../../../../../index.html">Home</a></td>
16 <td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td>
17 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
18 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
19 <td align="center"><a href="../../../../../../more/index.htm">More</a></td>
20 </tr></table>
21 <hr>
22 <div class="spirit-nav">
23 <a accesskey="p" href="../../BOOST_CO_idm46009693226768.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_compute/reference.html#header.boost.compute.container.vector_hpp"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="context_error.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
24 </div>
25 <div class="refentry">
26 <a name="boost.compute.vector"></a><div class="titlepage"></div>
27 <div class="refnamediv">
28 <h2><span class="refentrytitle">Class template vector</span></h2>
29 <p>boost::compute::vector &#8212; A resizable array of values. </p>
30 </div>
31 <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
32 <div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: &lt;<a class="link" href="../../boost_compute/reference.html#header.boost.compute.container.vector_hpp" title="Header &lt;boost/compute/container/vector.hpp&gt;">boost/compute/container/vector.hpp</a>&gt;
33
34 </span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="keyword">typename</span> Alloc <span class="special">=</span> <a class="link" href="buffer_allocator.html" title="Class template buffer_allocator">buffer_allocator</a><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;</span> <span class="special">&gt;</span> 
35 <span class="keyword">class</span> <a class="link" href="vector.html" title="Class template vector">vector</a> <span class="special">{</span>
36 <span class="keyword">public</span><span class="special">:</span>
37   <span class="comment">// types</span>
38   <span class="keyword">typedef</span> <span class="identifier">T</span>                                       <a name="boost.compute.vector.value_type"></a><span class="identifier">value_type</span><span class="special">;</span>            
39   <span class="keyword">typedef</span> <span class="identifier">Alloc</span>                                   <a name="boost.compute.vector.allocator_type"></a><span class="identifier">allocator_type</span><span class="special">;</span>        
40   <span class="keyword">typedef</span> <span class="identifier">allocator_type</span><span class="special">::</span><span class="identifier">size_type</span>               <a name="boost.compute.vector.size_type"></a><span class="identifier">size_type</span><span class="special">;</span>             
41   <span class="keyword">typedef</span> <span class="identifier">allocator_type</span><span class="special">::</span><span class="identifier">difference_type</span>         <a name="boost.compute.vector.difference_type"></a><span class="identifier">difference_type</span><span class="special">;</span>       
42   <span class="keyword">typedef</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span>                             <a name="boost.compute.vector.reference"></a><span class="identifier">reference</span><span class="special">;</span>             
43   <span class="keyword">typedef</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span>                             <a name="boost.compute.vector.const_reference"></a><span class="identifier">const_reference</span><span class="special">;</span>       
44   <span class="keyword">typedef</span> <span class="identifier">allocator_type</span><span class="special">::</span><span class="identifier">pointer</span>                 <a name="boost.compute.vector.pointer"></a><span class="identifier">pointer</span><span class="special">;</span>               
45   <span class="keyword">typedef</span> <span class="identifier">allocator_type</span><span class="special">::</span><span class="identifier">const_pointer</span>           <a name="boost.compute.vector.const_pointer"></a><span class="identifier">const_pointer</span><span class="special">;</span>         
46   <span class="keyword">typedef</span> <a class="link" href="buffer_iterator.html" title="Class template buffer_iterator">buffer_iterator</a><span class="special">&lt;</span> <span class="identifier">T</span> <span class="special">&gt;</span>                    <a name="boost.compute.vector.iterator"></a><span class="identifier">iterator</span><span class="special">;</span>              
47   <span class="keyword">typedef</span> <a class="link" href="buffer_iterator.html" title="Class template buffer_iterator">buffer_iterator</a><span class="special">&lt;</span> <span class="identifier">T</span> <span class="special">&gt;</span>                    <a name="boost.compute.vector.const_iterator"></a><span class="identifier">const_iterator</span><span class="special">;</span>        
48   <span class="keyword">typedef</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">reverse_iterator</span><span class="special">&lt;</span> <a class="link" href="vector.html#boost.compute.vector.iterator">iterator</a> <span class="special">&gt;</span>       <a name="boost.compute.vector.reverse_iterator"></a><span class="identifier">reverse_iterator</span><span class="special">;</span>      
49   <span class="keyword">typedef</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">reverse_iterator</span><span class="special">&lt;</span> <a class="link" href="vector.html#boost.compute.vector.const_iterator">const_iterator</a> <span class="special">&gt;</span> <a name="boost.compute.vector.const_reverse_iterator"></a><span class="identifier">const_reverse_iterator</span><span class="special">;</span>
50
51   <span class="comment">// <a class="link" href="vector.html#boost.compute.vectorconstruct-copy-destruct">construct/copy/destruct</a></span>
52   <span class="keyword">explicit</span> <a class="link" href="vector.html#idm46009693094032-bb"><span class="identifier">vector</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">context</span> <span class="special">&amp;</span> <span class="special">=</span> <span class="identifier">system</span><span class="special">::</span><span class="identifier">default_context</span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span>
53   <span class="keyword">explicit</span> <a class="link" href="vector.html#idm46009693091728-bb"><span class="identifier">vector</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">context</span> <span class="special">&amp;</span> <span class="special">=</span> <span class="identifier">system</span><span class="special">::</span><span class="identifier">default_context</span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span>
54   <a class="link" href="vector.html#idm46009693086160-bb"><span class="identifier">vector</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">command_queue</span> <span class="special">&amp;</span> <span class="special">=</span> <span class="identifier">system</span><span class="special">::</span><span class="identifier">default_queue</span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span>
55   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> InputIterator<span class="special">&gt;</span> 
56     <a class="link" href="vector.html#idm46009693081072-bb"><span class="identifier">vector</span></a><span class="special">(</span><span class="identifier">InputIterator</span><span class="special">,</span> <span class="identifier">InputIterator</span><span class="special">,</span> 
57            <span class="identifier">command_queue</span> <span class="special">&amp;</span> <span class="special">=</span> <span class="identifier">system</span><span class="special">::</span><span class="identifier">default_queue</span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span>
58   <a class="link" href="vector.html#idm46009693074592-bb"><span class="identifier">vector</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="vector.html" title="Class template vector">vector</a> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">command_queue</span> <span class="special">&amp;</span> <span class="special">=</span> <span class="identifier">system</span><span class="special">::</span><span class="identifier">default_queue</span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span>
59   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> OtherAlloc<span class="special">&gt;</span> 
60     <a class="link" href="vector.html#idm46009693071424-bb"><span class="identifier">vector</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="vector.html" title="Class template vector">vector</a><span class="special">&lt;</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">OtherAlloc</span> <span class="special">&gt;</span> <span class="special">&amp;</span><span class="special">,</span> 
61            <span class="identifier">command_queue</span> <span class="special">&amp;</span> <span class="special">=</span> <span class="identifier">system</span><span class="special">::</span><span class="identifier">default_queue</span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span>
62   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> OtherAlloc<span class="special">&gt;</span> 
63     <a class="link" href="vector.html#idm46009693067408-bb"><span class="identifier">vector</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special">&lt;</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">OtherAlloc</span> <span class="special">&gt;</span> <span class="special">&amp;</span><span class="special">,</span> 
64            <span class="identifier">command_queue</span> <span class="special">&amp;</span> <span class="special">=</span> <span class="identifier">system</span><span class="special">::</span><span class="identifier">default_queue</span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span>
65   <a class="link" href="vector.html#idm46009693063824-bb"><span class="identifier">vector</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">initializer_list</span><span class="special">&lt;</span> <span class="identifier">T</span> <span class="special">&gt;</span><span class="special">,</span> 
66          <span class="identifier">command_queue</span> <span class="special">&amp;</span> <span class="special">=</span> <span class="identifier">system</span><span class="special">::</span><span class="identifier">default_queue</span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span>
67   <a class="link" href="vector.html#idm46009693054592-bb"><span class="identifier">vector</span></a><span class="special">(</span><a class="link" href="vector.html" title="Class template vector">vector</a> <span class="special">&amp;&amp;</span><span class="special">)</span><span class="special">;</span>
68   <a class="link" href="vector.html" title="Class template vector">vector</a> <span class="special">&amp;</span> <a class="link" href="vector.html#idm46009693061856-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="vector.html" title="Class template vector">vector</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
69   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> OtherAlloc<span class="special">&gt;</span> 
70     <a class="link" href="vector.html" title="Class template vector">vector</a> <span class="special">&amp;</span> <a class="link" href="vector.html#idm46009693059856-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="vector.html" title="Class template vector">vector</a><span class="special">&lt;</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">OtherAlloc</span> <span class="special">&gt;</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
71   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> OtherAlloc<span class="special">&gt;</span> 
72     <a class="link" href="vector.html" title="Class template vector">vector</a> <span class="special">&amp;</span> <a class="link" href="vector.html#idm46009693057008-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special">&lt;</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">OtherAlloc</span> <span class="special">&gt;</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
73   <a class="link" href="vector.html" title="Class template vector">vector</a> <span class="special">&amp;</span> <a class="link" href="vector.html#idm46009693052576-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="vector.html" title="Class template vector">vector</a> <span class="special">&amp;&amp;</span><span class="special">)</span><span class="special">;</span>
74   <a class="link" href="vector.html#idm46009693049536-bb"><span class="special">~</span><span class="identifier">vector</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
75
76   <span class="comment">// <a class="link" href="vector.html#idm46009693197488-bb">public member functions</a></span>
77   <a class="link" href="vector.html#boost.compute.vector.iterator">iterator</a> <a class="link" href="vector.html#idm46009693196928-bb"><span class="identifier">begin</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
78   <a class="link" href="vector.html#boost.compute.vector.const_iterator">const_iterator</a> <a class="link" href="vector.html#idm46009693195952-bb"><span class="identifier">begin</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
79   <a class="link" href="vector.html#boost.compute.vector.const_iterator">const_iterator</a> <a class="link" href="vector.html#idm46009693194704-bb"><span class="identifier">cbegin</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
80   <a class="link" href="vector.html#boost.compute.vector.iterator">iterator</a> <a class="link" href="vector.html#idm46009693193456-bb"><span class="identifier">end</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
81   <a class="link" href="vector.html#boost.compute.vector.const_iterator">const_iterator</a> <a class="link" href="vector.html#idm46009693192480-bb"><span class="identifier">end</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
82   <a class="link" href="vector.html#boost.compute.vector.const_iterator">const_iterator</a> <a class="link" href="vector.html#idm46009693191232-bb"><span class="identifier">cend</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
83   <span class="identifier">reverse_iterator</span> <a class="link" href="vector.html#idm46009693189984-bb"><span class="identifier">rbegin</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
84   <span class="identifier">const_reverse_iterator</span> <a class="link" href="vector.html#idm46009693189136-bb"><span class="identifier">rbegin</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
85   <span class="identifier">const_reverse_iterator</span> <a class="link" href="vector.html#idm46009693188016-bb"><span class="identifier">crbegin</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
86   <span class="identifier">reverse_iterator</span> <a class="link" href="vector.html#idm46009693186896-bb"><span class="identifier">rend</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
87   <span class="identifier">const_reverse_iterator</span> <a class="link" href="vector.html#idm46009693186048-bb"><span class="identifier">rend</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
88   <span class="identifier">const_reverse_iterator</span> <a class="link" href="vector.html#idm46009693184928-bb"><span class="identifier">crend</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
89   <span class="identifier">size_type</span> <a class="link" href="vector.html#idm46009693183808-bb"><span class="identifier">size</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
90   <span class="identifier">size_type</span> <a class="link" href="vector.html#idm46009693182368-bb"><span class="identifier">max_size</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
91   <span class="keyword">void</span> <a class="link" href="vector.html#idm46009693181248-bb"><span class="identifier">resize</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">,</span> <span class="identifier">command_queue</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
92   <span class="keyword">void</span> <a class="link" href="vector.html#idm46009693178288-bb"><span class="identifier">resize</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">)</span><span class="special">;</span>
93   <span class="keyword">bool</span> <a class="link" href="vector.html#idm46009693176208-bb"><span class="identifier">empty</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
94   <span class="identifier">size_type</span> <a class="link" href="vector.html#idm46009693174336-bb"><span class="identifier">capacity</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
95   <span class="keyword">void</span> <a class="link" href="vector.html#idm46009693172912-bb"><span class="identifier">reserve</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">,</span> <span class="identifier">command_queue</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
96   <span class="keyword">void</span> <a class="link" href="vector.html#idm46009693170688-bb"><span class="identifier">reserve</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">)</span><span class="special">;</span>
97   <span class="keyword">void</span> <a class="link" href="vector.html#idm46009693169152-bb"><span class="identifier">shrink_to_fit</span></a><span class="special">(</span><span class="identifier">command_queue</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
98   <span class="keyword">void</span> <a class="link" href="vector.html#idm46009693167616-bb"><span class="identifier">shrink_to_fit</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
99   <span class="identifier">reference</span> <a class="link" href="vector.html#idm46009693166768-bb"><span class="keyword">operator</span><span class="special">[</span><span class="special">]</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">)</span><span class="special">;</span>
100   <span class="identifier">const_reference</span> <a class="link" href="vector.html#idm46009693165232-bb"><span class="keyword">operator</span><span class="special">[</span><span class="special">]</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
101   <span class="identifier">reference</span> <a class="link" href="vector.html#idm46009693163424-bb"><span class="identifier">at</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">)</span><span class="special">;</span>
102   <span class="identifier">const_reference</span> <a class="link" href="vector.html#idm46009693161888-bb"><span class="identifier">at</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
103   <span class="identifier">reference</span> <a class="link" href="vector.html#idm46009693160080-bb"><span class="identifier">front</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
104   <span class="identifier">const_reference</span> <a class="link" href="vector.html#idm46009693159232-bb"><span class="identifier">front</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
105   <span class="identifier">reference</span> <a class="link" href="vector.html#idm46009693158112-bb"><span class="identifier">back</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
106   <span class="identifier">const_reference</span> <a class="link" href="vector.html#idm46009693157264-bb"><span class="identifier">back</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
107   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> InputIterator<span class="special">&gt;</span> 
108     <span class="keyword">void</span> <a class="link" href="vector.html#idm46009693156144-bb"><span class="identifier">assign</span></a><span class="special">(</span><span class="identifier">InputIterator</span><span class="special">,</span> <span class="identifier">InputIterator</span><span class="special">,</span> <span class="identifier">command_queue</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
109   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> InputIterator<span class="special">&gt;</span> <span class="keyword">void</span> <a class="link" href="vector.html#idm46009693152384-bb"><span class="identifier">assign</span></a><span class="special">(</span><span class="identifier">InputIterator</span><span class="special">,</span> <span class="identifier">InputIterator</span><span class="special">)</span><span class="special">;</span>
110   <span class="keyword">void</span> <a class="link" href="vector.html#idm46009693149312-bb"><span class="identifier">assign</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">command_queue</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
111   <span class="keyword">void</span> <a class="link" href="vector.html#idm46009693146400-bb"><span class="identifier">assign</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
112   <span class="keyword">void</span> <a class="link" href="vector.html#idm46009693144176-bb"><span class="identifier">push_back</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">command_queue</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
113   <span class="keyword">void</span> <a class="link" href="vector.html#idm46009693139184-bb"><span class="identifier">push_back</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
114   <span class="keyword">void</span> <a class="link" href="vector.html#idm46009693137104-bb"><span class="identifier">pop_back</span></a><span class="special">(</span><span class="identifier">command_queue</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
115   <span class="keyword">void</span> <a class="link" href="vector.html#idm46009693135568-bb"><span class="identifier">pop_back</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
116   <a class="link" href="vector.html#boost.compute.vector.iterator">iterator</a> <a class="link" href="vector.html#idm46009693134720-bb"><span class="identifier">insert</span></a><span class="special">(</span><a class="link" href="vector.html#boost.compute.vector.iterator">iterator</a><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">command_queue</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
117   <a class="link" href="vector.html#boost.compute.vector.iterator">iterator</a> <a class="link" href="vector.html#idm46009693131552-bb"><span class="identifier">insert</span></a><span class="special">(</span><a class="link" href="vector.html#boost.compute.vector.iterator">iterator</a><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
118   <span class="keyword">void</span> <a class="link" href="vector.html#idm46009693129072-bb"><span class="identifier">insert</span></a><span class="special">(</span><a class="link" href="vector.html#boost.compute.vector.iterator">iterator</a><span class="special">,</span> <span class="identifier">size_type</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">command_queue</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
119   <span class="keyword">void</span> <a class="link" href="vector.html#idm46009693125344-bb"><span class="identifier">insert</span></a><span class="special">(</span><a class="link" href="vector.html#boost.compute.vector.iterator">iterator</a><span class="special">,</span> <span class="identifier">size_type</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
120   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> InputIterator<span class="special">&gt;</span> 
121     <span class="keyword">void</span> <a class="link" href="vector.html#idm46009693122304-bb"><span class="identifier">insert</span></a><span class="special">(</span><a class="link" href="vector.html#boost.compute.vector.iterator">iterator</a><span class="special">,</span> <span class="identifier">InputIterator</span><span class="special">,</span> <span class="identifier">InputIterator</span><span class="special">,</span> <span class="identifier">command_queue</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
122   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> InputIterator<span class="special">&gt;</span> 
123     <span class="keyword">void</span> <a class="link" href="vector.html#idm46009693115504-bb"><span class="identifier">insert</span></a><span class="special">(</span><a class="link" href="vector.html#boost.compute.vector.iterator">iterator</a><span class="special">,</span> <span class="identifier">InputIterator</span><span class="special">,</span> <span class="identifier">InputIterator</span><span class="special">)</span><span class="special">;</span>
124   <a class="link" href="vector.html#boost.compute.vector.iterator">iterator</a> <a class="link" href="vector.html#idm46009693111072-bb"><span class="identifier">erase</span></a><span class="special">(</span><a class="link" href="vector.html#boost.compute.vector.iterator">iterator</a><span class="special">,</span> <span class="identifier">command_queue</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
125   <a class="link" href="vector.html#boost.compute.vector.iterator">iterator</a> <a class="link" href="vector.html#idm46009693108592-bb"><span class="identifier">erase</span></a><span class="special">(</span><a class="link" href="vector.html#boost.compute.vector.iterator">iterator</a><span class="special">)</span><span class="special">;</span>
126   <a class="link" href="vector.html#boost.compute.vector.iterator">iterator</a> <a class="link" href="vector.html#idm46009693106800-bb"><span class="identifier">erase</span></a><span class="special">(</span><a class="link" href="vector.html#boost.compute.vector.iterator">iterator</a><span class="special">,</span> <a class="link" href="vector.html#boost.compute.vector.iterator">iterator</a><span class="special">,</span> <span class="identifier">command_queue</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
127   <a class="link" href="vector.html#boost.compute.vector.iterator">iterator</a> <a class="link" href="vector.html#idm46009693103504-bb"><span class="identifier">erase</span></a><span class="special">(</span><a class="link" href="vector.html#boost.compute.vector.iterator">iterator</a><span class="special">,</span> <a class="link" href="vector.html#boost.compute.vector.iterator">iterator</a><span class="special">)</span><span class="special">;</span>
128   <span class="keyword">void</span> <a class="link" href="vector.html#idm46009693100896-bb"><span class="identifier">swap</span></a><span class="special">(</span><a class="link" href="vector.html" title="Class template vector">vector</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
129   <span class="keyword">void</span> <a class="link" href="vector.html#idm46009693097888-bb"><span class="identifier">clear</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
130   <span class="identifier">allocator_type</span> <a class="link" href="vector.html#idm46009693096736-bb"><span class="identifier">get_allocator</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
131   <span class="keyword">const</span> <span class="identifier">buffer</span> <span class="special">&amp;</span> <a class="link" href="vector.html#idm46009693095616-bb"><span class="identifier">get_buffer</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
132 <span class="special">}</span><span class="special">;</span></pre></div>
133 <div class="refsect1">
134 <a name="idm46113324356144"></a><h2>Description</h2>
135 <p>The <a class="link" href="vector.html" title="Class template vector">vector&lt;T&gt;</a> class stores a dynamic array of values. Internally, the data is stored in an OpenCL buffer object.</p>
136 <p>The vector class is the prefered container for storing and accessing data on a compute device. In most cases it should be used instead of directly dealing with buffer objects. If the undelying buffer is needed, it can be accessed with the get_buffer() method.</p>
137 <p>The internal storage is allocated in a specific OpenCL context which is passed as an argument to the constructor when the vector is created.</p>
138 <p>For example, to create a vector on the device containing space for ten <code class="computeroutput">int</code> values: </p>
139 <pre class="programlisting"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">compute</span><span class="special">::</span><span class="identifier">vector</span><span class="special">&lt;</span><span class="keyword">int</span><span class="special">&gt;</span> <span class="identifier">vec</span><span class="special">(</span><span class="number">10</span><span class="special">,</span> <span class="identifier">context</span><span class="special">)</span><span class="special">;</span>
140 </pre>
141 <p>Allocation and data transfer can also be performed in a single step: </p>
142 <pre class="programlisting"><span class="comment">// values on the host</span>
143 <span class="keyword">int</span> <span class="identifier">data</span><span class="special">[</span><span class="special">]</span> <span class="special">=</span> <span class="special">{</span> <span class="number">1</span><span class="special">,</span> <span class="number">2</span><span class="special">,</span> <span class="number">3</span><span class="special">,</span> <span class="number">4</span> <span class="special">}</span><span class="special">;</span>
144
145 <span class="comment">// create a vector of size four and copy the values from data</span>
146 <span class="identifier">boost</span><span class="special">::</span><span class="identifier">compute</span><span class="special">::</span><span class="identifier">vector</span><span class="special">&lt;</span><span class="keyword">int</span><span class="special">&gt;</span> <span class="identifier">vec</span><span class="special">(</span><span class="identifier">data</span><span class="special">,</span> <span class="identifier">data</span> <span class="special">+</span> <span class="number">4</span><span class="special">,</span> <span class="identifier">queue</span><span class="special">)</span><span class="special">;</span>
147 </pre>
148 <p>The Boost.Compute <code class="computeroutput">vector</code> class provides a STL-like API and is modeled after the <code class="computeroutput">std::vector</code> class from the C++ standard library. It can be used with any of the STL-like algorithms provided by Boost.Compute including <code class="computeroutput">copy()</code>, <code class="computeroutput">transform()</code>, and <code class="computeroutput">sort()</code> (among many others).</p>
149 <p>For example: </p>
150 <pre class="programlisting"><span class="comment">// a vector on a compute device</span>
151 <span class="identifier">boost</span><span class="special">::</span><span class="identifier">compute</span><span class="special">::</span><span class="identifier">vector</span><span class="special">&lt;</span><span class="keyword">float</span><span class="special">&gt;</span> <span class="identifier">vec</span> <span class="special">=</span> <span class="special">...</span>
152
153 <span class="comment">// copy data to the vector from a host std:vector</span>
154 <span class="identifier">boost</span><span class="special">::</span><span class="identifier">compute</span><span class="special">::</span><span class="identifier">copy</span><span class="special">(</span><span class="identifier">host_vec</span><span class="special">.</span><span class="identifier">begin</span><span class="special">(</span><span class="special">)</span><span class="special">,</span> <span class="identifier">host_vec</span><span class="special">.</span><span class="identifier">end</span><span class="special">(</span><span class="special">)</span><span class="special">,</span> <span class="identifier">vec</span><span class="special">.</span><span class="identifier">begin</span><span class="special">(</span><span class="special">)</span><span class="special">,</span> <span class="identifier">queue</span><span class="special">)</span><span class="special">;</span>
155
156 <span class="comment">// copy data from the vector to a host std::vector</span>
157 <span class="identifier">boost</span><span class="special">::</span><span class="identifier">compute</span><span class="special">::</span><span class="identifier">copy</span><span class="special">(</span><span class="identifier">vec</span><span class="special">.</span><span class="identifier">begin</span><span class="special">(</span><span class="special">)</span><span class="special">,</span> <span class="identifier">vec</span><span class="special">.</span><span class="identifier">end</span><span class="special">(</span><span class="special">)</span><span class="special">,</span> <span class="identifier">host_vec</span><span class="special">.</span><span class="identifier">begin</span><span class="special">(</span><span class="special">)</span><span class="special">,</span> <span class="identifier">queue</span><span class="special">)</span><span class="special">;</span>
158
159 <span class="comment">// sort the values in the vector</span>
160 <span class="identifier">boost</span><span class="special">::</span><span class="identifier">compute</span><span class="special">::</span><span class="identifier">sort</span><span class="special">(</span><span class="identifier">vec</span><span class="special">.</span><span class="identifier">begin</span><span class="special">(</span><span class="special">)</span><span class="special">,</span> <span class="identifier">vec</span><span class="special">.</span><span class="identifier">end</span><span class="special">(</span><span class="special">)</span><span class="special">,</span> <span class="identifier">queue</span><span class="special">)</span><span class="special">;</span>
161
162 <span class="comment">// calculate the sum of the values in the vector (also see reduce())</span>
163 <span class="keyword">float</span> <span class="identifier">sum</span> <span class="special">=</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">compute</span><span class="special">::</span><span class="identifier">accumulate</span><span class="special">(</span><span class="identifier">vec</span><span class="special">.</span><span class="identifier">begin</span><span class="special">(</span><span class="special">)</span><span class="special">,</span> <span class="identifier">vec</span><span class="special">.</span><span class="identifier">end</span><span class="special">(</span><span class="special">)</span><span class="special">,</span> <span class="number">0</span><span class="special">,</span> <span class="identifier">queue</span><span class="special">)</span><span class="special">;</span>
164
165 <span class="comment">// reverse the values in the vector</span>
166 <span class="identifier">boost</span><span class="special">::</span><span class="identifier">compute</span><span class="special">::</span><span class="identifier">reverse</span><span class="special">(</span><span class="identifier">vec</span><span class="special">.</span><span class="identifier">begin</span><span class="special">(</span><span class="special">)</span><span class="special">,</span> <span class="identifier">vec</span><span class="special">.</span><span class="identifier">end</span><span class="special">(</span><span class="special">)</span><span class="special">,</span> <span class="identifier">queue</span><span class="special">)</span><span class="special">;</span>
167
168 <span class="comment">// fill the vector with ones</span>
169 <span class="identifier">boost</span><span class="special">::</span><span class="identifier">compute</span><span class="special">::</span><span class="identifier">fill</span><span class="special">(</span><span class="identifier">vec</span><span class="special">.</span><span class="identifier">begin</span><span class="special">(</span><span class="special">)</span><span class="special">,</span> <span class="identifier">vec</span><span class="special">.</span><span class="identifier">end</span><span class="special">(</span><span class="special">)</span><span class="special">,</span> <span class="number">1</span><span class="special">,</span> <span class="identifier">queue</span><span class="special">)</span><span class="special">;</span>
170 </pre>
171 <p><span class="bold"><strong>See Also:</strong></span></p>
172 <p><a class="link" href="array.html" title="Class template array">array&lt;T, N&gt;</a>, buffer </p>
173 <p>
174 </p>
175 <p>
176 </p>
177 <div class="refsect2">
178 <a name="idm46113324222192"></a><h3>
179 <a name="boost.compute.vectorconstruct-copy-destruct"></a><code class="computeroutput">vector</code> 
180         public
181        construct/copy/destruct</h3>
182 <div class="orderedlist"><ol class="orderedlist" type="1">
183 <li class="listitem">
184 <pre class="literallayout"><span class="keyword">explicit</span> <a name="idm46009693094032-bb"></a><span class="identifier">vector</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">context</span> <span class="special">&amp;</span> context <span class="special">=</span> <span class="identifier">system</span><span class="special">::</span><span class="identifier">default_context</span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre>Creates an empty vector in <code class="computeroutput">context</code>. </li>
185 <li class="listitem">
186 <pre class="literallayout"><span class="keyword">explicit</span> <a name="idm46009693091728-bb"></a><span class="identifier">vector</span><span class="special">(</span><span class="identifier">size_type</span> count<span class="special">,</span> 
187                 <span class="keyword">const</span> <span class="identifier">context</span> <span class="special">&amp;</span> context <span class="special">=</span> <span class="identifier">system</span><span class="special">::</span><span class="identifier">default_context</span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre>
188 <p>Creates a vector with space for <code class="computeroutput">count</code> elements in <code class="computeroutput">context</code>.</p>
189 <p>Note that unlike <code class="computeroutput">std::vector's</code> constructor, this will not initialize the values in the container. Either call the vector constructor which takes a value to initialize with or use the fill() algorithm to set the initial values.</p>
190 <p>For example: </p>
191 <pre class="programlisting"><span class="comment">// create a vector on the device with space for ten ints</span>
192 <span class="identifier">boost</span><span class="special">::</span><span class="identifier">compute</span><span class="special">::</span><span class="identifier">vector</span><span class="special">&lt;</span><span class="keyword">int</span><span class="special">&gt;</span> <span class="identifier">vec</span><span class="special">(</span><span class="number">10</span><span class="special">,</span> <span class="identifier">context</span><span class="special">)</span><span class="special">;</span>
193 </pre>
194 <p> </p>
195 </li>
196 <li class="listitem">
197 <pre class="literallayout"><a name="idm46009693086160-bb"></a><span class="identifier">vector</span><span class="special">(</span><span class="identifier">size_type</span> count<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&amp;</span> value<span class="special">,</span> 
198        <span class="identifier">command_queue</span> <span class="special">&amp;</span> queue <span class="special">=</span> <span class="identifier">system</span><span class="special">::</span><span class="identifier">default_queue</span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre>
199 <p>Creates a vector with space for <code class="computeroutput">count</code> elements and sets each equal to <code class="computeroutput">value</code>.</p>
200 <p>For example: </p>
201 <pre class="programlisting"><span class="comment">// creates a vector with four values set to nine (e.g. [9, 9, 9, 9]).</span>
202 <span class="identifier">boost</span><span class="special">::</span><span class="identifier">compute</span><span class="special">::</span><span class="identifier">vector</span><span class="special">&lt;</span><span class="keyword">int</span><span class="special">&gt;</span> <span class="identifier">vec</span><span class="special">(</span><span class="number">4</span><span class="special">,</span> <span class="number">9</span><span class="special">,</span> <span class="identifier">queue</span><span class="special">)</span><span class="special">;</span>
203 </pre>
204 <p> </p>
205 </li>
206 <li class="listitem">
207 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> InputIterator<span class="special">&gt;</span> 
208   <a name="idm46009693081072-bb"></a><span class="identifier">vector</span><span class="special">(</span><span class="identifier">InputIterator</span> first<span class="special">,</span> <span class="identifier">InputIterator</span> last<span class="special">,</span> 
209          <span class="identifier">command_queue</span> <span class="special">&amp;</span> queue <span class="special">=</span> <span class="identifier">system</span><span class="special">::</span><span class="identifier">default_queue</span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre>
210 <p>Creates a vector with space for the values in the range [<code class="computeroutput">first</code>, <code class="computeroutput">last</code>) and copies them into the vector with <code class="computeroutput">queue</code>.</p>
211 <p>For example: </p>
212 <pre class="programlisting"><span class="comment">// values on the host</span>
213 <span class="keyword">int</span> <span class="identifier">data</span><span class="special">[</span><span class="special">]</span> <span class="special">=</span> <span class="special">{</span> <span class="number">1</span><span class="special">,</span> <span class="number">2</span><span class="special">,</span> <span class="number">3</span><span class="special">,</span> <span class="number">4</span> <span class="special">}</span><span class="special">;</span>
214
215 <span class="comment">// create a vector of size four and copy the values from data</span>
216 <span class="identifier">boost</span><span class="special">::</span><span class="identifier">compute</span><span class="special">::</span><span class="identifier">vector</span><span class="special">&lt;</span><span class="keyword">int</span><span class="special">&gt;</span> <span class="identifier">vec</span><span class="special">(</span><span class="identifier">data</span><span class="special">,</span> <span class="identifier">data</span> <span class="special">+</span> <span class="number">4</span><span class="special">,</span> <span class="identifier">queue</span><span class="special">)</span><span class="special">;</span>
217 </pre>
218 <p> </p>
219 </li>
220 <li class="listitem">
221 <pre class="literallayout"><a name="idm46009693074592-bb"></a><span class="identifier">vector</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="vector.html" title="Class template vector">vector</a> <span class="special">&amp;</span> other<span class="special">,</span> <span class="identifier">command_queue</span> <span class="special">&amp;</span> queue <span class="special">=</span> <span class="identifier">system</span><span class="special">::</span><span class="identifier">default_queue</span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre>Creates a new vector and copies the values from <code class="computeroutput">other</code>. </li>
222 <li class="listitem">
223 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> OtherAlloc<span class="special">&gt;</span> 
224   <a name="idm46009693071424-bb"></a><span class="identifier">vector</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="vector.html" title="Class template vector">vector</a><span class="special">&lt;</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">OtherAlloc</span> <span class="special">&gt;</span> <span class="special">&amp;</span> other<span class="special">,</span> 
225          <span class="identifier">command_queue</span> <span class="special">&amp;</span> queue <span class="special">=</span> <span class="identifier">system</span><span class="special">::</span><span class="identifier">default_queue</span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre>Creates a new vector and copies the values from <code class="computeroutput">other</code>. </li>
226 <li class="listitem">
227 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> OtherAlloc<span class="special">&gt;</span> 
228   <a name="idm46009693067408-bb"></a><span class="identifier">vector</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special">&lt;</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">OtherAlloc</span> <span class="special">&gt;</span> <span class="special">&amp;</span> vector<span class="special">,</span> 
229          <span class="identifier">command_queue</span> <span class="special">&amp;</span> queue <span class="special">=</span> <span class="identifier">system</span><span class="special">::</span><span class="identifier">default_queue</span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre>Creates a new vector and copies the values from <code class="computeroutput">vector</code>. </li>
230 <li class="listitem"><pre class="literallayout"><a name="idm46009693063824-bb"></a><span class="identifier">vector</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">initializer_list</span><span class="special">&lt;</span> <span class="identifier">T</span> <span class="special">&gt;</span> list<span class="special">,</span> 
231        <span class="identifier">command_queue</span> <span class="special">&amp;</span> queue <span class="special">=</span> <span class="identifier">system</span><span class="special">::</span><span class="identifier">default_queue</span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre></li>
232 <li class="listitem">
233 <pre class="literallayout"><a name="idm46009693054592-bb"></a><span class="identifier">vector</span><span class="special">(</span><a class="link" href="vector.html" title="Class template vector">vector</a> <span class="special">&amp;&amp;</span> other<span class="special">)</span><span class="special">;</span></pre>Move-constructs a new vector from <code class="computeroutput">other</code>. </li>
234 <li class="listitem"><pre class="literallayout"><a class="link" href="vector.html" title="Class template vector">vector</a> <span class="special">&amp;</span> <a name="idm46009693061856-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="vector.html" title="Class template vector">vector</a> <span class="special">&amp;</span> other<span class="special">)</span><span class="special">;</span></pre></li>
235 <li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> OtherAlloc<span class="special">&gt;</span> 
236   <a class="link" href="vector.html" title="Class template vector">vector</a> <span class="special">&amp;</span> <a name="idm46009693059856-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="vector.html" title="Class template vector">vector</a><span class="special">&lt;</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">OtherAlloc</span> <span class="special">&gt;</span> <span class="special">&amp;</span> other<span class="special">)</span><span class="special">;</span></pre></li>
237 <li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> OtherAlloc<span class="special">&gt;</span> 
238   <a class="link" href="vector.html" title="Class template vector">vector</a> <span class="special">&amp;</span> <a name="idm46009693057008-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special">&lt;</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">OtherAlloc</span> <span class="special">&gt;</span> <span class="special">&amp;</span> vector<span class="special">)</span><span class="special">;</span></pre></li>
239 <li class="listitem">
240 <pre class="literallayout"><a class="link" href="vector.html" title="Class template vector">vector</a> <span class="special">&amp;</span> <a name="idm46009693052576-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="vector.html" title="Class template vector">vector</a> <span class="special">&amp;&amp;</span> other<span class="special">)</span><span class="special">;</span></pre>Move-assigns the data from <code class="computeroutput">other</code> to <code class="computeroutput">*this</code>. </li>
241 <li class="listitem">
242 <pre class="literallayout"><a name="idm46009693049536-bb"></a><span class="special">~</span><span class="identifier">vector</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Destroys the vector object. </li>
243 </ol></div>
244 </div>
245 <div class="refsect2">
246 <a name="idm46113324004848"></a><h3>
247 <a name="idm46009693197488-bb"></a><code class="computeroutput">vector</code> public member functions</h3>
248 <div class="orderedlist"><ol class="orderedlist" type="1">
249 <li class="listitem"><pre class="literallayout"><a class="link" href="vector.html#boost.compute.vector.iterator">iterator</a> <a name="idm46009693196928-bb"></a><span class="identifier">begin</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li>
250 <li class="listitem"><pre class="literallayout"><a class="link" href="vector.html#boost.compute.vector.const_iterator">const_iterator</a> <a name="idm46009693195952-bb"></a><span class="identifier">begin</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
251 <li class="listitem"><pre class="literallayout"><a class="link" href="vector.html#boost.compute.vector.const_iterator">const_iterator</a> <a name="idm46009693194704-bb"></a><span class="identifier">cbegin</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
252 <li class="listitem"><pre class="literallayout"><a class="link" href="vector.html#boost.compute.vector.iterator">iterator</a> <a name="idm46009693193456-bb"></a><span class="identifier">end</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li>
253 <li class="listitem"><pre class="literallayout"><a class="link" href="vector.html#boost.compute.vector.const_iterator">const_iterator</a> <a name="idm46009693192480-bb"></a><span class="identifier">end</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
254 <li class="listitem"><pre class="literallayout"><a class="link" href="vector.html#boost.compute.vector.const_iterator">const_iterator</a> <a name="idm46009693191232-bb"></a><span class="identifier">cend</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
255 <li class="listitem"><pre class="literallayout"><span class="identifier">reverse_iterator</span> <a name="idm46009693189984-bb"></a><span class="identifier">rbegin</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li>
256 <li class="listitem"><pre class="literallayout"><span class="identifier">const_reverse_iterator</span> <a name="idm46009693189136-bb"></a><span class="identifier">rbegin</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
257 <li class="listitem"><pre class="literallayout"><span class="identifier">const_reverse_iterator</span> <a name="idm46009693188016-bb"></a><span class="identifier">crbegin</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
258 <li class="listitem"><pre class="literallayout"><span class="identifier">reverse_iterator</span> <a name="idm46009693186896-bb"></a><span class="identifier">rend</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li>
259 <li class="listitem"><pre class="literallayout"><span class="identifier">const_reverse_iterator</span> <a name="idm46009693186048-bb"></a><span class="identifier">rend</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
260 <li class="listitem"><pre class="literallayout"><span class="identifier">const_reverse_iterator</span> <a name="idm46009693184928-bb"></a><span class="identifier">crend</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
261 <li class="listitem">
262 <pre class="literallayout"><span class="identifier">size_type</span> <a name="idm46009693183808-bb"></a><span class="identifier">size</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns the number of elements in the vector. </li>
263 <li class="listitem"><pre class="literallayout"><span class="identifier">size_type</span> <a name="idm46009693182368-bb"></a><span class="identifier">max_size</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
264 <li class="listitem">
265 <pre class="literallayout"><span class="keyword">void</span> <a name="idm46009693181248-bb"></a><span class="identifier">resize</span><span class="special">(</span><span class="identifier">size_type</span> size<span class="special">,</span> <span class="identifier">command_queue</span> <span class="special">&amp;</span> queue<span class="special">)</span><span class="special">;</span></pre>Resizes the vector to <code class="computeroutput">size</code>. </li>
266 <li class="listitem">
267 <pre class="literallayout"><span class="keyword">void</span> <a name="idm46009693178288-bb"></a><span class="identifier">resize</span><span class="special">(</span><span class="identifier">size_type</span> size<span class="special">)</span><span class="special">;</span></pre>
268 <p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. </p>
269 </li>
270 <li class="listitem">
271 <pre class="literallayout"><span class="keyword">bool</span> <a name="idm46009693176208-bb"></a><span class="identifier">empty</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns <code class="computeroutput">true</code> if the vector is empty. </li>
272 <li class="listitem">
273 <pre class="literallayout"><span class="identifier">size_type</span> <a name="idm46009693174336-bb"></a><span class="identifier">capacity</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns the capacity of the vector. </li>
274 <li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="idm46009693172912-bb"></a><span class="identifier">reserve</span><span class="special">(</span><span class="identifier">size_type</span> size<span class="special">,</span> <span class="identifier">command_queue</span> <span class="special">&amp;</span> queue<span class="special">)</span><span class="special">;</span></pre></li>
275 <li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="idm46009693170688-bb"></a><span class="identifier">reserve</span><span class="special">(</span><span class="identifier">size_type</span> size<span class="special">)</span><span class="special">;</span></pre></li>
276 <li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="idm46009693169152-bb"></a><span class="identifier">shrink_to_fit</span><span class="special">(</span><span class="identifier">command_queue</span> <span class="special">&amp;</span> queue<span class="special">)</span><span class="special">;</span></pre></li>
277 <li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="idm46009693167616-bb"></a><span class="identifier">shrink_to_fit</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li>
278 <li class="listitem"><pre class="literallayout"><span class="identifier">reference</span> <a name="idm46009693166768-bb"></a><span class="keyword">operator</span><span class="special">[</span><span class="special">]</span><span class="special">(</span><span class="identifier">size_type</span> index<span class="special">)</span><span class="special">;</span></pre></li>
279 <li class="listitem"><pre class="literallayout"><span class="identifier">const_reference</span> <a name="idm46009693165232-bb"></a><span class="keyword">operator</span><span class="special">[</span><span class="special">]</span><span class="special">(</span><span class="identifier">size_type</span> index<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
280 <li class="listitem"><pre class="literallayout"><span class="identifier">reference</span> <a name="idm46009693163424-bb"></a><span class="identifier">at</span><span class="special">(</span><span class="identifier">size_type</span> index<span class="special">)</span><span class="special">;</span></pre></li>
281 <li class="listitem"><pre class="literallayout"><span class="identifier">const_reference</span> <a name="idm46009693161888-bb"></a><span class="identifier">at</span><span class="special">(</span><span class="identifier">size_type</span> index<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
282 <li class="listitem"><pre class="literallayout"><span class="identifier">reference</span> <a name="idm46009693160080-bb"></a><span class="identifier">front</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li>
283 <li class="listitem"><pre class="literallayout"><span class="identifier">const_reference</span> <a name="idm46009693159232-bb"></a><span class="identifier">front</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
284 <li class="listitem"><pre class="literallayout"><span class="identifier">reference</span> <a name="idm46009693158112-bb"></a><span class="identifier">back</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li>
285 <li class="listitem"><pre class="literallayout"><span class="identifier">const_reference</span> <a name="idm46009693157264-bb"></a><span class="identifier">back</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
286 <li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> InputIterator<span class="special">&gt;</span> 
287   <span class="keyword">void</span> <a name="idm46009693156144-bb"></a><span class="identifier">assign</span><span class="special">(</span><span class="identifier">InputIterator</span> first<span class="special">,</span> <span class="identifier">InputIterator</span> last<span class="special">,</span> <span class="identifier">command_queue</span> <span class="special">&amp;</span> queue<span class="special">)</span><span class="special">;</span></pre></li>
288 <li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> InputIterator<span class="special">&gt;</span> 
289   <span class="keyword">void</span> <a name="idm46009693152384-bb"></a><span class="identifier">assign</span><span class="special">(</span><span class="identifier">InputIterator</span> first<span class="special">,</span> <span class="identifier">InputIterator</span> last<span class="special">)</span><span class="special">;</span></pre></li>
290 <li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="idm46009693149312-bb"></a><span class="identifier">assign</span><span class="special">(</span><span class="identifier">size_type</span> n<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&amp;</span> value<span class="special">,</span> <span class="identifier">command_queue</span> <span class="special">&amp;</span> queue<span class="special">)</span><span class="special">;</span></pre></li>
291 <li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="idm46009693146400-bb"></a><span class="identifier">assign</span><span class="special">(</span><span class="identifier">size_type</span> n<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&amp;</span> value<span class="special">)</span><span class="special">;</span></pre></li>
292 <li class="listitem">
293 <pre class="literallayout"><span class="keyword">void</span> <a name="idm46009693144176-bb"></a><span class="identifier">push_back</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&amp;</span> value<span class="special">,</span> <span class="identifier">command_queue</span> <span class="special">&amp;</span> queue<span class="special">)</span><span class="special">;</span></pre>
294 <p>Inserts <code class="computeroutput">value</code> at the end of the vector (resizing if neccessary).</p>
295 <p>Note that calling <code class="computeroutput">push_back()</code> to insert data values one at a time is inefficient as there is a non-trivial overhead in performing a data transfer to the device. It is usually better to store a set of values on the host (for example, in a <code class="computeroutput">std::vector</code>) and then transfer them in bulk using the <code class="computeroutput">insert()</code> method or the copy() algorithm. </p>
296 </li>
297 <li class="listitem">
298 <pre class="literallayout"><span class="keyword">void</span> <a name="idm46009693139184-bb"></a><span class="identifier">push_back</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&amp;</span> value<span class="special">)</span><span class="special">;</span></pre>
299 <p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. </p>
300 </li>
301 <li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="idm46009693137104-bb"></a><span class="identifier">pop_back</span><span class="special">(</span><span class="identifier">command_queue</span> <span class="special">&amp;</span> queue<span class="special">)</span><span class="special">;</span></pre></li>
302 <li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="idm46009693135568-bb"></a><span class="identifier">pop_back</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li>
303 <li class="listitem"><pre class="literallayout"><a class="link" href="vector.html#boost.compute.vector.iterator">iterator</a> <a name="idm46009693134720-bb"></a><span class="identifier">insert</span><span class="special">(</span><a class="link" href="vector.html#boost.compute.vector.iterator">iterator</a> position<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&amp;</span> value<span class="special">,</span> <span class="identifier">command_queue</span> <span class="special">&amp;</span> queue<span class="special">)</span><span class="special">;</span></pre></li>
304 <li class="listitem"><pre class="literallayout"><a class="link" href="vector.html#boost.compute.vector.iterator">iterator</a> <a name="idm46009693131552-bb"></a><span class="identifier">insert</span><span class="special">(</span><a class="link" href="vector.html#boost.compute.vector.iterator">iterator</a> position<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&amp;</span> value<span class="special">)</span><span class="special">;</span></pre></li>
305 <li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="idm46009693129072-bb"></a><span class="identifier">insert</span><span class="special">(</span><a class="link" href="vector.html#boost.compute.vector.iterator">iterator</a> position<span class="special">,</span> <span class="identifier">size_type</span> count<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&amp;</span> value<span class="special">,</span> 
306             <span class="identifier">command_queue</span> <span class="special">&amp;</span> queue<span class="special">)</span><span class="special">;</span></pre></li>
307 <li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="idm46009693125344-bb"></a><span class="identifier">insert</span><span class="special">(</span><a class="link" href="vector.html#boost.compute.vector.iterator">iterator</a> position<span class="special">,</span> <span class="identifier">size_type</span> count<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&amp;</span> value<span class="special">)</span><span class="special">;</span></pre></li>
308 <li class="listitem">
309 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> InputIterator<span class="special">&gt;</span> 
310   <span class="keyword">void</span> <a name="idm46009693122304-bb"></a><span class="identifier">insert</span><span class="special">(</span><a class="link" href="vector.html#boost.compute.vector.iterator">iterator</a> position<span class="special">,</span> <span class="identifier">InputIterator</span> first<span class="special">,</span> <span class="identifier">InputIterator</span> last<span class="special">,</span> 
311               <span class="identifier">command_queue</span> <span class="special">&amp;</span> queue<span class="special">)</span><span class="special">;</span></pre>
312 <p>Inserts the values in the range [<code class="computeroutput">first</code>, <code class="computeroutput">last</code>) into the vector at <code class="computeroutput">position</code> using <code class="computeroutput">queue</code>. </p>
313 </li>
314 <li class="listitem">
315 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> InputIterator<span class="special">&gt;</span> 
316   <span class="keyword">void</span> <a name="idm46009693115504-bb"></a><span class="identifier">insert</span><span class="special">(</span><a class="link" href="vector.html#boost.compute.vector.iterator">iterator</a> position<span class="special">,</span> <span class="identifier">InputIterator</span> first<span class="special">,</span> <span class="identifier">InputIterator</span> last<span class="special">)</span><span class="special">;</span></pre>
317 <p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. </p>
318 </li>
319 <li class="listitem"><pre class="literallayout"><a class="link" href="vector.html#boost.compute.vector.iterator">iterator</a> <a name="idm46009693111072-bb"></a><span class="identifier">erase</span><span class="special">(</span><a class="link" href="vector.html#boost.compute.vector.iterator">iterator</a> position<span class="special">,</span> <span class="identifier">command_queue</span> <span class="special">&amp;</span> queue<span class="special">)</span><span class="special">;</span></pre></li>
320 <li class="listitem"><pre class="literallayout"><a class="link" href="vector.html#boost.compute.vector.iterator">iterator</a> <a name="idm46009693108592-bb"></a><span class="identifier">erase</span><span class="special">(</span><a class="link" href="vector.html#boost.compute.vector.iterator">iterator</a> position<span class="special">)</span><span class="special">;</span></pre></li>
321 <li class="listitem"><pre class="literallayout"><a class="link" href="vector.html#boost.compute.vector.iterator">iterator</a> <a name="idm46009693106800-bb"></a><span class="identifier">erase</span><span class="special">(</span><a class="link" href="vector.html#boost.compute.vector.iterator">iterator</a> first<span class="special">,</span> <a class="link" href="vector.html#boost.compute.vector.iterator">iterator</a> last<span class="special">,</span> <span class="identifier">command_queue</span> <span class="special">&amp;</span> queue<span class="special">)</span><span class="special">;</span></pre></li>
322 <li class="listitem"><pre class="literallayout"><a class="link" href="vector.html#boost.compute.vector.iterator">iterator</a> <a name="idm46009693103504-bb"></a><span class="identifier">erase</span><span class="special">(</span><a class="link" href="vector.html#boost.compute.vector.iterator">iterator</a> first<span class="special">,</span> <a class="link" href="vector.html#boost.compute.vector.iterator">iterator</a> last<span class="special">)</span><span class="special">;</span></pre></li>
323 <li class="listitem">
324 <pre class="literallayout"><span class="keyword">void</span> <a name="idm46009693100896-bb"></a><span class="identifier">swap</span><span class="special">(</span><a class="link" href="vector.html" title="Class template vector">vector</a> <span class="special">&amp;</span> other<span class="special">)</span><span class="special">;</span></pre>Swaps the contents of <code class="computeroutput">*this</code> with <code class="computeroutput">other</code>. </li>
325 <li class="listitem">
326 <pre class="literallayout"><span class="keyword">void</span> <a name="idm46009693097888-bb"></a><span class="identifier">clear</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Removes all elements from the vector. </li>
327 <li class="listitem"><pre class="literallayout"><span class="identifier">allocator_type</span> <a name="idm46009693096736-bb"></a><span class="identifier">get_allocator</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
328 <li class="listitem">
329 <pre class="literallayout"><span class="keyword">const</span> <span class="identifier">buffer</span> <span class="special">&amp;</span> <a name="idm46009693095616-bb"></a><span class="identifier">get_buffer</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns the underlying buffer. </li>
330 </ol></div>
331 </div>
332 </div>
333 </div>
334 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
335 <td align="left"></td>
336 <td align="right"><div class="copyright-footer">Copyright &#169; 2013, 2014 Kyle Lutz<p>
337         Distributed under the Boost Software License, Version 1.0. (See accompanying
338         file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
339       </p>
340 </div></td>
341 </tr></table>
342 <hr>
343 <div class="spirit-nav">
344 <a accesskey="p" href="../../BOOST_CO_idm46009693226768.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_compute/reference.html#header.boost.compute.container.vector_hpp"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="context_error.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
345 </div>
346 </body>
347 </html>