/usr/share/doc/opencl-clhpp-headers/html/classcl_1_1_s_v_m_allocator.html is in opencl-clhpp-headers-doc 2.0.10+git12-g5dd8bb9-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>OpenCL C++ Bindings: cl::SVMAllocator< T, SVMTrait > Class Template Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">OpenCL C++ Bindings
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('classcl_1_1_s_v_m_allocator.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#friends">Friends</a> |
<a href="classcl_1_1_s_v_m_allocator-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">cl::SVMAllocator< T, SVMTrait > Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structcl_1_1_s_v_m_allocator_1_1rebind.html">rebind</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a80bd529e576d0ff30cc55ee9f0ec3f8c"><td class="memItemLeft" align="right" valign="top"><a id="a80bd529e576d0ff30cc55ee9f0ec3f8c"></a>
typedef T </td><td class="memItemRight" valign="bottom"><b>value_type</b></td></tr>
<tr class="separator:a80bd529e576d0ff30cc55ee9f0ec3f8c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6222e5ff48358bc0f826885bb2a4a4ec"><td class="memItemLeft" align="right" valign="top"><a id="a6222e5ff48358bc0f826885bb2a4a4ec"></a>
typedef value_type * </td><td class="memItemRight" valign="bottom"><b>pointer</b></td></tr>
<tr class="separator:a6222e5ff48358bc0f826885bb2a4a4ec"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af5daf4a4173794758e399e45a2f028a9"><td class="memItemLeft" align="right" valign="top"><a id="af5daf4a4173794758e399e45a2f028a9"></a>
typedef const value_type * </td><td class="memItemRight" valign="bottom"><b>const_pointer</b></td></tr>
<tr class="separator:af5daf4a4173794758e399e45a2f028a9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa9a3870b226f6286dbf1917ff1d8e03b"><td class="memItemLeft" align="right" valign="top"><a id="aa9a3870b226f6286dbf1917ff1d8e03b"></a>
typedef value_type & </td><td class="memItemRight" valign="bottom"><b>reference</b></td></tr>
<tr class="separator:aa9a3870b226f6286dbf1917ff1d8e03b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a64a4984f03ddff3a757f200b4c4fb357"><td class="memItemLeft" align="right" valign="top"><a id="a64a4984f03ddff3a757f200b4c4fb357"></a>
typedef const value_type & </td><td class="memItemRight" valign="bottom"><b>const_reference</b></td></tr>
<tr class="separator:a64a4984f03ddff3a757f200b4c4fb357"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afe51e51ed34089444241a43aab0950ef"><td class="memItemLeft" align="right" valign="top"><a id="afe51e51ed34089444241a43aab0950ef"></a>
typedef std::size_t </td><td class="memItemRight" valign="bottom"><b>size_type</b></td></tr>
<tr class="separator:afe51e51ed34089444241a43aab0950ef"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aed0caac86c149d127e6d686a764e2073"><td class="memItemLeft" align="right" valign="top"><a id="aed0caac86c149d127e6d686a764e2073"></a>
typedef std::ptrdiff_t </td><td class="memItemRight" valign="bottom"><b>difference_type</b></td></tr>
<tr class="separator:aed0caac86c149d127e6d686a764e2073"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a532a5219ffd5c855070a1e4f22832711"><td class="memItemLeft" align="right" valign="top"><a id="a532a5219ffd5c855070a1e4f22832711"></a>
 </td><td class="memItemRight" valign="bottom"><b>SVMAllocator</b> (<a class="el" href="classcl_1_1_context.html">cl::Context</a> context)</td></tr>
<tr class="separator:a532a5219ffd5c855070a1e4f22832711"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a927ffbac7ec2a7cb0aee2d24a9f986b1"><td class="memItemLeft" align="right" valign="top"><a id="a927ffbac7ec2a7cb0aee2d24a9f986b1"></a>
 </td><td class="memItemRight" valign="bottom"><b>SVMAllocator</b> (const <a class="el" href="classcl_1_1_s_v_m_allocator.html">SVMAllocator</a> &other)</td></tr>
<tr class="separator:a927ffbac7ec2a7cb0aee2d24a9f986b1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af103176d8c51fc469fb0b7d85a597a9f"><td class="memTemplParams" colspan="2"><a id="af103176d8c51fc469fb0b7d85a597a9f"></a>
template<typename U > </td></tr>
<tr class="memitem:af103176d8c51fc469fb0b7d85a597a9f"><td class="memTemplItemLeft" align="right" valign="top"> </td><td class="memTemplItemRight" valign="bottom"><b>SVMAllocator</b> (const <a class="el" href="classcl_1_1_s_v_m_allocator.html">SVMAllocator</a>< U, SVMTrait > &other)</td></tr>
<tr class="separator:af103176d8c51fc469fb0b7d85a597a9f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a10ae2172078bf1aa987a0e3ace96cbb7"><td class="memItemLeft" align="right" valign="top"><a id="a10ae2172078bf1aa987a0e3ace96cbb7"></a>
pointer </td><td class="memItemRight" valign="bottom"><b>address</b> (reference r) CL_HPP_NOEXCEPT_</td></tr>
<tr class="separator:a10ae2172078bf1aa987a0e3ace96cbb7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afcc4bd8a99bc004c286f49a7f3e84766"><td class="memItemLeft" align="right" valign="top"><a id="afcc4bd8a99bc004c286f49a7f3e84766"></a>
const_pointer </td><td class="memItemRight" valign="bottom"><b>address</b> (const_reference r) CL_HPP_NOEXCEPT_</td></tr>
<tr class="separator:afcc4bd8a99bc004c286f49a7f3e84766"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a44858d70971c7801aa62d7a64d18df00"><td class="memItemLeft" align="right" valign="top">pointer </td><td class="memItemRight" valign="bottom"><a class="el" href="classcl_1_1_s_v_m_allocator.html#a44858d70971c7801aa62d7a64d18df00">allocate</a> (size_type size, typename <a class="el" href="classcl_1_1_s_v_m_allocator.html">cl::SVMAllocator</a>< void, SVMTrait >::const_pointer=0)</td></tr>
<tr class="separator:a44858d70971c7801aa62d7a64d18df00"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a695f4693c4245c66285e7f4a0405cf84"><td class="memItemLeft" align="right" valign="top"><a id="a695f4693c4245c66285e7f4a0405cf84"></a>
void </td><td class="memItemRight" valign="bottom"><b>deallocate</b> (pointer p, size_type)</td></tr>
<tr class="separator:a695f4693c4245c66285e7f4a0405cf84"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aec263261a88fb1ec64a3e5f9a4ef41a7"><td class="memItemLeft" align="right" valign="top">size_type </td><td class="memItemRight" valign="bottom"><a class="el" href="classcl_1_1_s_v_m_allocator.html#aec263261a88fb1ec64a3e5f9a4ef41a7">max_size</a> () const CL_HPP_NOEXCEPT_</td></tr>
<tr class="separator:aec263261a88fb1ec64a3e5f9a4ef41a7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a57e823e939f67e1209450d996556c080"><td class="memTemplParams" colspan="2"><a id="a57e823e939f67e1209450d996556c080"></a>
template<class U , class... Args> </td></tr>
<tr class="memitem:a57e823e939f67e1209450d996556c080"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><b>construct</b> (U *p, Args &&... args)</td></tr>
<tr class="separator:a57e823e939f67e1209450d996556c080"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a86498cce5cce2d8ac1c509862eb28977"><td class="memTemplParams" colspan="2"><a id="a86498cce5cce2d8ac1c509862eb28977"></a>
template<class U > </td></tr>
<tr class="memitem:a86498cce5cce2d8ac1c509862eb28977"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><b>destroy</b> (U *p)</td></tr>
<tr class="separator:a86498cce5cce2d8ac1c509862eb28977"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abaa89b1232891a728d3530dbd71e7cb6"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcl_1_1_s_v_m_allocator.html#abaa89b1232891a728d3530dbd71e7cb6">operator==</a> (<a class="el" href="classcl_1_1_s_v_m_allocator.html">SVMAllocator</a> const &rhs)</td></tr>
<tr class="separator:abaa89b1232891a728d3530dbd71e7cb6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a72088f264071b2648aa80e20594d6398"><td class="memItemLeft" align="right" valign="top"><a id="a72088f264071b2648aa80e20594d6398"></a>
bool </td><td class="memItemRight" valign="bottom"><b>operator!=</b> (<a class="el" href="classcl_1_1_s_v_m_allocator.html">SVMAllocator</a> const &a)</td></tr>
<tr class="separator:a72088f264071b2648aa80e20594d6398"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:a0146b33b7681b60e7678780ae05fb43f"><td class="memTemplParams" colspan="2"><a id="a0146b33b7681b60e7678780ae05fb43f"></a>
template<typename U , typename V > </td></tr>
<tr class="memitem:a0146b33b7681b60e7678780ae05fb43f"><td class="memTemplItemLeft" align="right" valign="top">class </td><td class="memTemplItemRight" valign="bottom"><b>SVMAllocator</b></td></tr>
<tr class="separator:a0146b33b7681b60e7678780ae05fb43f"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template<typename T, class SVMTrait><br />
class cl::SVMAllocator< T, SVMTrait ></h3>
<p>STL-like allocator class for managing SVM objects provided for convenience.</p>
<p>Note that while this behaves like an allocator for the purposes of constructing vectors and similar objects, care must be taken when using with smart pointers. The allocator should not be used to construct a unique_ptr if we are using coarse-grained SVM mode because the coarse-grained management behaviour would behave incorrectly with respect to reference counting.</p>
<p>Instead the allocator embeds a Deleter which may be used with unique_ptr and is used with the allocate_shared and allocate_ptr supplied operations. </p>
<p class="definition">Definition at line <a class="el" href="cl2_8hpp_source.html#l03387">3387</a> of file <a class="el" href="cl2_8hpp_source.html">cl2.hpp</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a44858d70971c7801aa62d7a64d18df00"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a44858d70971c7801aa62d7a64d18df00">◆ </a></span>allocate()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T, class SVMTrait> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">pointer <a class="el" href="classcl_1_1_s_v_m_allocator.html">cl::SVMAllocator</a>< T, SVMTrait >::allocate </td>
<td>(</td>
<td class="paramtype">size_type </td>
<td class="paramname"><em>size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">typename <a class="el" href="classcl_1_1_s_v_m_allocator.html">cl::SVMAllocator</a>< void, SVMTrait >::const_pointer </td>
<td class="paramname"> = <code>0</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Allocate an SVM pointer.</p>
<p>If the allocator is coarse-grained, this will take ownership to allow containers to correctly construct data in place. </p>
<p class="definition">Definition at line <a class="el" href="cl2_8hpp_source.html#l03451">3451</a> of file <a class="el" href="cl2_8hpp_source.html">cl2.hpp</a>.</p>
</div>
</div>
<a id="aec263261a88fb1ec64a3e5f9a4ef41a7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aec263261a88fb1ec64a3e5f9a4ef41a7">◆ </a></span>max_size()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T, class SVMTrait> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">size_type <a class="el" href="classcl_1_1_s_v_m_allocator.html">cl::SVMAllocator</a>< T, SVMTrait >::max_size </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the maximum possible allocation size. This is the minimum of the maximum sizes of all devices in the context. </p>
<p class="definition">Definition at line <a class="el" href="cl2_8hpp_source.html#l03493">3493</a> of file <a class="el" href="cl2_8hpp_source.html">cl2.hpp</a>.</p>
</div>
</div>
<a id="abaa89b1232891a728d3530dbd71e7cb6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abaa89b1232891a728d3530dbd71e7cb6">◆ </a></span>operator==()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T, class SVMTrait> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classcl_1_1_s_v_m_allocator.html">cl::SVMAllocator</a>< T, SVMTrait >::operator== </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classcl_1_1_s_v_m_allocator.html">SVMAllocator</a>< T, SVMTrait > const & </td>
<td class="paramname"><em>rhs</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns true if the contexts match. </p>
<p class="definition">Definition at line <a class="el" href="cl2_8hpp_source.html#l03521">3521</a> of file <a class="el" href="cl2_8hpp_source.html">cl2.hpp</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="cl2_8hpp_source.html">cl2.hpp</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="namespacecl.html">cl</a></li><li class="navelem"><a class="el" href="classcl_1_1_s_v_m_allocator.html">SVMAllocator</a></li>
<li class="footer">Generated on Thu Jan 25 2018 01:39:34 for OpenCL C++ Bindings by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
</ul>
</div>
</body>
</html>
|