<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.15"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> <title>libstdc++: std::__allocated_ptr< _Alloc > Struct 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"> /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ $(document).ready(initResizable); /* @license-end */</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">libstdc++ </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.15 --> </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"> /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ $(document).ready(function(){initNavTree('a04692.html','');}); /* @license-end */ </script> <div id="doc-content"> <div class="header"> <div class="summary"> <a href="#pub-types">Public Types</a> | <a href="#pub-methods">Public Member Functions</a> | <a href="a04689.html">List of all members</a> </div> <div class="headertitle"> <div class="title">std::__allocated_ptr< _Alloc > Struct Template Reference</div> </div> </div><!--header--> <div class="contents"> <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:a27664de3f829cbe44071fe4f5660ab75"><td class="memItemLeft" align="right" valign="top"><a id="a27664de3f829cbe44071fe4f5660ab75"></a> using </td><td class="memItemRight" valign="bottom"><b>pointer</b> = typename <a class="el" href="a04636.html">allocator_traits</a>< _Alloc >::pointer</td></tr> <tr class="separator:a27664de3f829cbe44071fe4f5660ab75"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ad5dab9178c02fc5162c739479b15d566"><td class="memItemLeft" align="right" valign="top"><a id="ad5dab9178c02fc5162c739479b15d566"></a> using </td><td class="memItemRight" valign="bottom"><b>value_type</b> = typename <a class="el" href="a04636.html">allocator_traits</a>< _Alloc >::value_type</td></tr> <tr class="separator:ad5dab9178c02fc5162c739479b15d566"><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:aa6dc842b0059cbc04204b7b85c0739ed"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a04692.html#aa6dc842b0059cbc04204b7b85c0739ed">__allocated_ptr</a> (_Alloc &__a, pointer __ptr) noexcept</td></tr> <tr class="separator:aa6dc842b0059cbc04204b7b85c0739ed"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a966c17e818aa46f93c352e1ae4bf872a"><td class="memTemplParams" colspan="2">template<typename _Ptr , typename _Req = _Require<is_same<_Ptr, value_type*>>> </td></tr> <tr class="memitem:a966c17e818aa46f93c352e1ae4bf872a"><td class="memTemplItemLeft" align="right" valign="top"> </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a04692.html#a966c17e818aa46f93c352e1ae4bf872a">__allocated_ptr</a> (_Alloc &__a, _Ptr __ptr)</td></tr> <tr class="separator:a966c17e818aa46f93c352e1ae4bf872a"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a039de128ed7917b07a0a0b10e491a6af"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a04692.html#a039de128ed7917b07a0a0b10e491a6af">__allocated_ptr</a> (<a class="el" href="a04692.html">__allocated_ptr</a> &&__gd) noexcept</td></tr> <tr class="separator:a039de128ed7917b07a0a0b10e491a6af"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aa88dd0de1ff3b4586cde0906dc41645f"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a04692.html#aa88dd0de1ff3b4586cde0906dc41645f">~__allocated_ptr</a> ()</td></tr> <tr class="separator:aa88dd0de1ff3b4586cde0906dc41645f"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a8c2790a1ba48d3f00a77feb0eda93b19"><td class="memItemLeft" align="right" valign="top">value_type * </td><td class="memItemRight" valign="bottom"><a class="el" href="a04692.html#a8c2790a1ba48d3f00a77feb0eda93b19">get</a> ()</td></tr> <tr class="separator:a8c2790a1ba48d3f00a77feb0eda93b19"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:af6ed2d0a405aee06f81dda8452a6e2ce"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a04692.html">__allocated_ptr</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="a04692.html#af6ed2d0a405aee06f81dda8452a6e2ce">operator=</a> (std::nullptr_t) noexcept</td></tr> <tr class="separator:af6ed2d0a405aee06f81dda8452a6e2ce"><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 _Alloc><br /> struct std::__allocated_ptr< _Alloc ></h3> <p>Non-standard RAII type for managing pointers obtained from allocators. </p> <p class="definition">Definition at line <a class="el" href="a00269_source.html#l00046">46</a> of file <a class="el" href="a00269_source.html">allocated_ptr.h</a>.</p> </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> <a id="aa6dc842b0059cbc04204b7b85c0739ed"></a> <h2 class="memtitle"><span class="permalink"><a href="#aa6dc842b0059cbc04204b7b85c0739ed">◆ </a></span>__allocated_ptr() <span class="overload">[1/3]</span></h2> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<typename _Alloc > </div> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname"><a class="el" href="a04692.html">std::__allocated_ptr</a>< _Alloc >::<a class="el" href="a04692.html">__allocated_ptr</a> </td> <td>(</td> <td class="paramtype">_Alloc & </td> <td class="paramname"><em>__a</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">pointer </td> <td class="paramname"><em>__ptr</em> </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 class="mlabel">noexcept</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Take ownership of __ptr. </p> <p class="definition">Definition at line <a class="el" href="a00269_source.html#l00052">52</a> of file <a class="el" href="a00269_source.html">allocated_ptr.h</a>.</p> </div> </div> <a id="a966c17e818aa46f93c352e1ae4bf872a"></a> <h2 class="memtitle"><span class="permalink"><a href="#a966c17e818aa46f93c352e1ae4bf872a">◆ </a></span>__allocated_ptr() <span class="overload">[2/3]</span></h2> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<typename _Alloc > </div> <div class="memtemplate"> template<typename _Ptr , typename _Req = _Require<is_same<_Ptr, value_type*>>> </div> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname"><a class="el" href="a04692.html">std::__allocated_ptr</a>< _Alloc >::<a class="el" href="a04692.html">__allocated_ptr</a> </td> <td>(</td> <td class="paramtype">_Alloc & </td> <td class="paramname"><em>__a</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">_Ptr </td> <td class="paramname"><em>__ptr</em> </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>Convert __ptr to allocator's pointer type and take ownership of it. </p> <p class="definition">Definition at line <a class="el" href="a00269_source.html#l00059">59</a> of file <a class="el" href="a00269_source.html">allocated_ptr.h</a>.</p> </div> </div> <a id="a039de128ed7917b07a0a0b10e491a6af"></a> <h2 class="memtitle"><span class="permalink"><a href="#a039de128ed7917b07a0a0b10e491a6af">◆ </a></span>__allocated_ptr() <span class="overload">[3/3]</span></h2> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<typename _Alloc > </div> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname"><a class="el" href="a04692.html">std::__allocated_ptr</a>< _Alloc >::<a class="el" href="a04692.html">__allocated_ptr</a> </td> <td>(</td> <td class="paramtype"><a class="el" href="a04692.html">__allocated_ptr</a>< _Alloc > && </td> <td class="paramname"><em>__gd</em></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Transfer ownership of the owned pointer. </p> <p class="definition">Definition at line <a class="el" href="a00269_source.html#l00065">65</a> of file <a class="el" href="a00269_source.html">allocated_ptr.h</a>.</p> </div> </div> <a id="aa88dd0de1ff3b4586cde0906dc41645f"></a> <h2 class="memtitle"><span class="permalink"><a href="#aa88dd0de1ff3b4586cde0906dc41645f">◆ </a></span>~__allocated_ptr()</h2> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<typename _Alloc > </div> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname"><a class="el" href="a04692.html">std::__allocated_ptr</a>< _Alloc >::~<a class="el" href="a04692.html">__allocated_ptr</a> </td> <td>(</td> <td class="paramname"></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>Deallocate the owned pointer. </p> <p class="definition">Definition at line <a class="el" href="a00269_source.html#l00070">70</a> of file <a class="el" href="a00269_source.html">allocated_ptr.h</a>.</p> <p class="reference">References <a class="el" href="a16473_source.html#l00327">std::allocator_traits< _Alloc >::deallocate()</a>.</p> </div> </div> <h2 class="groupheader">Member Function Documentation</h2> <a id="a8c2790a1ba48d3f00a77feb0eda93b19"></a> <h2 class="memtitle"><span class="permalink"><a href="#a8c2790a1ba48d3f00a77feb0eda93b19">◆ </a></span>get()</h2> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<typename _Alloc > </div> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">value_type* <a class="el" href="a04692.html">std::__allocated_ptr</a>< _Alloc >::get </td> <td>(</td> <td class="paramtype">void </td> <td class="paramname"></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>Get the address that the owned pointer refers to. </p> <p class="definition">Definition at line <a class="el" href="a00269_source.html#l00085">85</a> of file <a class="el" href="a00269_source.html">allocated_ptr.h</a>.</p> </div> </div> <a id="af6ed2d0a405aee06f81dda8452a6e2ce"></a> <h2 class="memtitle"><span class="permalink"><a href="#af6ed2d0a405aee06f81dda8452a6e2ce">◆ </a></span>operator=()</h2> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<typename _Alloc > </div> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname"><a class="el" href="a04692.html">__allocated_ptr</a>& <a class="el" href="a04692.html">std::__allocated_ptr</a>< _Alloc >::operator= </td> <td>(</td> <td class="paramtype">std::nullptr_t </td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Release ownership of the owned pointer. </p> <p class="definition">Definition at line <a class="el" href="a00269_source.html#l00078">78</a> of file <a class="el" href="a00269_source.html">allocated_ptr.h</a>.</p> </div> </div> <hr/>The documentation for this struct was generated from the following file:<ul> <li><a class="el" href="a00269_source.html">allocated_ptr.h</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="a01538.html">std</a></li><li class="navelem"><a class="el" href="a04692.html">__allocated_ptr</a></li> <li class="footer">Generated by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.15 </li> </ul> </div> </body> </html>