libs/compute/doc/html/boost/compute/buffer_allocator.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Class template buffer_allocator</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.allocator.buffer_allocator_hpp" title="Header &lt;boost/compute/allocator/buffer_allocator.hpp&gt;">
   9 <link rel="prev" href="upper_bound.html" title="Function template upper_bound">
  10 <link rel="next" href="pinned_allocator.html" title="Class template pinned_allocator">
  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="upper_bound.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_compute/reference.html#header.boost.compute.allocator.buffer_allocator_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="pinned_allocator.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="refentry">
  26 <a name="boost.compute.buffer_allocator"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Class template buffer_allocator</span></h2>
  29 <p>boost::compute::buffer_allocator &#8212; The <a class="link" href="buffer_allocator.html" title="Class template buffer_allocator">buffer_allocator</a> class allocates memory with buffer objects. </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.allocator.buffer_allocator_hpp" title="Header &lt;boost/compute/allocator/buffer_allocator.hpp&gt;">boost/compute/allocator/buffer_allocator.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">&gt;</span>
  35 <span class="keyword">class</span> <a class="link" href="buffer_allocator.html" title="Class template buffer_allocator">buffer_allocator</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.buffer_allocator.value_type"></a><span class="identifier">value_type</span><span class="special">;</span>
  39   <span class="keyword">typedef</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span>    <a name="boost.compute.buffer_allocator.pointer"></a><span class="identifier">pointer</span><span class="special">;</span>
  40   <span class="keyword">typedef</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span>    <a name="boost.compute.buffer_allocator.const_pointer"></a><span class="identifier">const_pointer</span><span class="special">;</span>
  41   <span class="keyword">typedef</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span>    <a name="boost.compute.buffer_allocator.size_type"></a><span class="identifier">size_type</span><span class="special">;</span>
  42   <span class="keyword">typedef</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ptrdiff_t</span> <a name="boost.compute.buffer_allocator.difference_type"></a><span class="identifier">difference_type</span><span class="special">;</span>
  43
  44   <span class="comment">// <a class="link" href="buffer_allocator.html#boost.compute.buffer_allocatorconstruct-copy-destruct">construct/copy/destruct</a></span>
  45   <span class="keyword">explicit</span> <a class="link" href="buffer_allocator.html#idm46009693879200-bb"><span class="identifier">buffer_allocator</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="special">;</span>
  46   <a class="link" href="buffer_allocator.html#idm46009693877952-bb"><span class="identifier">buffer_allocator</span></a><span class="special">(</span><span class="keyword">const</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">&amp;</span><span class="special">)</span><span class="special">;</span>
  47   <a class="link" href="buffer_allocator.html#idm46009693874528-bb"><span class="identifier">buffer_allocator</span></a><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">&amp;&amp;</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
  48   <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">&amp;</span> <a class="link" href="buffer_allocator.html#idm46009693876528-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</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">&amp;</span><span class="special">)</span><span class="special">;</span>
  49   <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">&amp;</span> <a class="link" href="buffer_allocator.html#idm46009693872992-bb"><span class="keyword">operator</span><span class="special">=</span></a><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">&amp;&amp;</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
  50   <a class="link" href="buffer_allocator.html#idm46009693870880-bb"><span class="special">~</span><span class="identifier">buffer_allocator</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  51
  52   <span class="comment">// <a class="link" href="buffer_allocator.html#idm46009693885920-bb">public member functions</a></span>
  53   <span class="identifier">pointer</span> <a class="link" href="buffer_allocator.html#idm46009693885360-bb"><span class="identifier">allocate</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">)</span><span class="special">;</span>
  54   <span class="keyword">void</span> <a class="link" href="buffer_allocator.html#idm46009693883824-bb"><span class="identifier">deallocate</span></a><span class="special">(</span><span class="identifier">pointer</span><span class="special">,</span> <span class="identifier">size_type</span><span class="special">)</span><span class="special">;</span>
  55   <span class="identifier">size_type</span> <a class="link" href="buffer_allocator.html#idm46009693881600-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>
  56   <span class="identifier">context</span> <a class="link" href="buffer_allocator.html#idm46009693880480-bb"><span class="identifier">get_context</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  57
  58   <span class="comment">// <a class="link" href="buffer_allocator.html#idm46009693870592-bb">protected member functions</a></span>
  59   <span class="keyword">void</span> <a class="link" href="buffer_allocator.html#idm46009693870016-bb"><span class="identifier">set_mem_flags</span></a><span class="special">(</span><span class="identifier">cl_mem_flags</span><span class="special">)</span><span class="special">;</span>
  60 <span class="special">}</span><span class="special">;</span></pre></div>
  61 <div class="refsect1">
  62 <a name="idm46113329603520"></a><h2>Description</h2>
  63 <p><span class="bold"><strong>See Also:</strong></span></p>
  64 <p>buffer </p>
  65 <p>
  66 </p>
  67 <p>
  68 </p>
  69 <div class="refsect2">
  70 <a name="idm46113329601744"></a><h3>
  71 <a name="boost.compute.buffer_allocatorconstruct-copy-destruct"></a><code class="computeroutput">buffer_allocator</code>
  72         public
  73        construct/copy/destruct</h3>
  74 <div class="orderedlist"><ol class="orderedlist" type="1">
  75 <li class="listitem"><pre class="literallayout"><span class="keyword">explicit</span> <a name="idm46009693879200-bb"></a><span class="identifier">buffer_allocator</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="special">;</span></pre></li>
  76 <li class="listitem"><pre class="literallayout"><a name="idm46009693877952-bb"></a><span class="identifier">buffer_allocator</span><span class="special">(</span><span class="keyword">const</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">&amp;</span> other<span class="special">)</span><span class="special">;</span></pre></li>
  77 <li class="listitem"><pre class="literallayout"><a name="idm46009693874528-bb"></a><span class="identifier">buffer_allocator</span><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">&amp;&amp;</span> other<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre></li>
  78 <li class="listitem"><pre class="literallayout"><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">&amp;</span> <a name="idm46009693876528-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</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">&amp;</span> other<span class="special">)</span><span class="special">;</span></pre></li>
  79 <li class="listitem"><pre class="literallayout"><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">&amp;</span> <a name="idm46009693872992-bb"></a><span class="keyword">operator</span><span class="special">=</span><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">&amp;&amp;</span> other<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre></li>
  80 <li class="listitem"><pre class="literallayout"><a name="idm46009693870880-bb"></a><span class="special">~</span><span class="identifier">buffer_allocator</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li>
  81 </ol></div>
  82 </div>
  83 <div class="refsect2">
  84 <a name="idm46113329549872"></a><h3>
  85 <a name="idm46009693885920-bb"></a><code class="computeroutput">buffer_allocator</code> public member functions</h3>
  86 <div class="orderedlist"><ol class="orderedlist" type="1">
  87 <li class="listitem"><pre class="literallayout"><span class="identifier">pointer</span> <a name="idm46009693885360-bb"></a><span class="identifier">allocate</span><span class="special">(</span><span class="identifier">size_type</span> n<span class="special">)</span><span class="special">;</span></pre></li>
  88 <li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="idm46009693883824-bb"></a><span class="identifier">deallocate</span><span class="special">(</span><span class="identifier">pointer</span> p<span class="special">,</span> <span class="identifier">size_type</span> n<span class="special">)</span><span class="special">;</span></pre></li>
  89 <li class="listitem"><pre class="literallayout"><span class="identifier">size_type</span> <a name="idm46009693881600-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>
  90 <li class="listitem"><pre class="literallayout"><span class="identifier">context</span> <a name="idm46009693880480-bb"></a><span class="identifier">get_context</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
  91 </ol></div>
  92 </div>
  93 <div class="refsect2">
  94 <a name="idm46113329526336"></a><h3>
  95 <a name="idm46009693870592-bb"></a><code class="computeroutput">buffer_allocator</code> protected member functions</h3>
  96 <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="idm46009693870016-bb"></a><span class="identifier">set_mem_flags</span><span class="special">(</span><span class="identifier">cl_mem_flags</span> flags<span class="special">)</span><span class="special">;</span></pre></li></ol></div>
  97 </div>
  98 </div>
  99 </div>
 100 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 101 <td align="left"></td>
 102 <td align="right"><div class="copyright-footer">Copyright &#169; 2013, 2014 Kyle Lutz<p>
 103         Distributed under the Boost Software License, Version 1.0. (See accompanying
 104         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>)
 105       </p>
 106 </div></td>
 107 </tr></table>
 108 <hr>
 109 <div class="spirit-nav">
 110 <a accesskey="p" href="upper_bound.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_compute/reference.html#header.boost.compute.allocator.buffer_allocator_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="pinned_allocator.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
 111 </div>
 112 </body>
 113 </html>