class_s_t_l_aligned_allocator.html 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=11"/>
  6. <meta name="generator" content="Doxygen 1.12.0"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>Jolt Physics: STLAlignedAllocator&lt; T, N &gt; Class Template Reference</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <script type="text/javascript" src="clipboard.js"></script>
  13. <link href="navtree.css" rel="stylesheet" type="text/css"/>
  14. <script type="text/javascript" src="navtreedata.js"></script>
  15. <script type="text/javascript" src="navtree.js"></script>
  16. <script type="text/javascript" src="resize.js"></script>
  17. <script type="text/javascript" src="cookie.js"></script>
  18. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  19. <script type="text/javascript" src="search/searchdata.js"></script>
  20. <script type="text/javascript" src="search/search.js"></script>
  21. <script type="text/x-mathjax-config">
  22. MathJax.Hub.Config({
  23. extensions: ["tex2jax.js"],
  24. jax: ["input/TeX","output/HTML-CSS"],
  25. });
  26. </script>
  27. <script type="text/javascript" async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js"></script>
  28. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  29. </head>
  30. <body>
  31. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  32. <div id="titlearea">
  33. <table cellspacing="0" cellpadding="0">
  34. <tbody>
  35. <tr id="projectrow">
  36. <td id="projectlogo"><img alt="Logo" src="LogoSmall.png"/></td>
  37. <td id="projectalign">
  38. <div id="projectname">Jolt Physics
  39. </div>
  40. <div id="projectbrief">A multi core friendly Game Physics Engine</div>
  41. </td>
  42. </tr>
  43. </tbody>
  44. </table>
  45. </div>
  46. <!-- end header part -->
  47. <!-- Generated by Doxygen 1.12.0 -->
  48. <script type="text/javascript">
  49. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  50. var searchBox = new SearchBox("searchBox", "search/",'.html');
  51. /* @license-end */
  52. </script>
  53. <script type="text/javascript">
  54. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  55. $(function() { codefold.init(0); });
  56. /* @license-end */
  57. </script>
  58. <script type="text/javascript" src="menudata.js"></script>
  59. <script type="text/javascript" src="menu.js"></script>
  60. <script type="text/javascript">
  61. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  62. $(function() {
  63. initMenu('',true,false,'search.php','Search',true);
  64. $(function() { init_search(); });
  65. });
  66. /* @license-end */
  67. </script>
  68. <div id="main-nav"></div>
  69. </div><!-- top -->
  70. <div id="side-nav" class="ui-resizable side-nav-resizable">
  71. <div id="nav-tree">
  72. <div id="nav-tree-contents">
  73. <div id="nav-sync" class="sync"></div>
  74. </div>
  75. </div>
  76. <div id="splitbar" style="-moz-user-select:none;"
  77. class="ui-resizable-handle">
  78. </div>
  79. </div>
  80. <script type="text/javascript">
  81. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  82. $(function(){initNavTree('class_s_t_l_aligned_allocator.html',''); initResizable(true); });
  83. /* @license-end */
  84. </script>
  85. <div id="doc-content">
  86. <!-- window showing the filter options -->
  87. <div id="MSearchSelectWindow"
  88. onmouseover="return searchBox.OnSearchSelectShow()"
  89. onmouseout="return searchBox.OnSearchSelectHide()"
  90. onkeydown="return searchBox.OnSearchSelectKey(event)">
  91. </div>
  92. <!-- iframe showing the search results (closed by default) -->
  93. <div id="MSearchResultsWindow">
  94. <div id="MSearchResults">
  95. <div class="SRPage">
  96. <div id="SRIndex">
  97. <div id="SRResults"></div>
  98. <div class="SRStatus" id="Loading">Loading...</div>
  99. <div class="SRStatus" id="Searching">Searching...</div>
  100. <div class="SRStatus" id="NoMatches">No Matches</div>
  101. </div>
  102. </div>
  103. </div>
  104. </div>
  105. <div class="header">
  106. <div class="summary">
  107. <a href="#nested-classes">Classes</a> &#124;
  108. <a href="#pub-types">Public Types</a> &#124;
  109. <a href="#pub-methods">Public Member Functions</a> &#124;
  110. <a href="class_s_t_l_aligned_allocator-members.html">List of all members</a> </div>
  111. <div class="headertitle"><div class="title">STLAlignedAllocator&lt; T, N &gt; Class Template Reference</div></div>
  112. </div><!--header-->
  113. <div class="contents">
  114. <p>STL allocator that takes care that memory is aligned to N bytes.
  115. <a href="#details">More...</a></p>
  116. <p><code>#include &lt;<a class="el" href="_s_t_l_aligned_allocator_8h_source.html">STLAlignedAllocator.h</a>&gt;</code></p>
  117. <table class="memberdecls">
  118. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
  119. Classes</h2></td></tr>
  120. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_s_t_l_aligned_allocator_1_1rebind.html">rebind</a></td></tr>
  121. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Converting to allocator for other type. <a href="struct_s_t_l_aligned_allocator_1_1rebind.html#details">More...</a><br /></td></tr>
  122. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  123. </table><table class="memberdecls">
  124. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-types" name="pub-types"></a>
  125. Public Types</h2></td></tr>
  126. <tr class="memitem:a4457facc139621863361195814d170df" id="r_a4457facc139621863361195814d170df"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a4457facc139621863361195814d170df">value_type</a> = T</td></tr>
  127. <tr class="separator:a4457facc139621863361195814d170df"><td class="memSeparator" colspan="2">&#160;</td></tr>
  128. <tr class="memitem:a00f960ad0c626b48190ed45c3a9f4f93" id="r_a00f960ad0c626b48190ed45c3a9f4f93"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a00f960ad0c626b48190ed45c3a9f4f93">pointer</a> = T *</td></tr>
  129. <tr class="memdesc:a00f960ad0c626b48190ed45c3a9f4f93"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to type. <br /></td></tr>
  130. <tr class="separator:a00f960ad0c626b48190ed45c3a9f4f93"><td class="memSeparator" colspan="2">&#160;</td></tr>
  131. <tr class="memitem:aebb20b18116799083cdb1c21bd5bd298" id="r_aebb20b18116799083cdb1c21bd5bd298"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aebb20b18116799083cdb1c21bd5bd298">const_pointer</a> = const T *</td></tr>
  132. <tr class="separator:aebb20b18116799083cdb1c21bd5bd298"><td class="memSeparator" colspan="2">&#160;</td></tr>
  133. <tr class="memitem:a56b7aed0a19cfcdb3265edd1b2f128c9" id="r_a56b7aed0a19cfcdb3265edd1b2f128c9"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a56b7aed0a19cfcdb3265edd1b2f128c9">reference</a> = T &amp;</td></tr>
  134. <tr class="separator:a56b7aed0a19cfcdb3265edd1b2f128c9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  135. <tr class="memitem:af511fc1b1dddec672d902e3ef16d0f39" id="r_af511fc1b1dddec672d902e3ef16d0f39"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af511fc1b1dddec672d902e3ef16d0f39">const_reference</a> = const T &amp;</td></tr>
  136. <tr class="separator:af511fc1b1dddec672d902e3ef16d0f39"><td class="memSeparator" colspan="2">&#160;</td></tr>
  137. <tr class="memitem:a0004fb3a233bcaa84924f839156d06b3" id="r_a0004fb3a233bcaa84924f839156d06b3"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a0004fb3a233bcaa84924f839156d06b3">size_type</a> = size_t</td></tr>
  138. <tr class="separator:a0004fb3a233bcaa84924f839156d06b3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  139. <tr class="memitem:a2a9287cbd8ce3d27c67aeb33a20ff9ba" id="r_a2a9287cbd8ce3d27c67aeb33a20ff9ba"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a2a9287cbd8ce3d27c67aeb33a20ff9ba">difference_type</a> = ptrdiff_t</td></tr>
  140. <tr class="separator:a2a9287cbd8ce3d27c67aeb33a20ff9ba"><td class="memSeparator" colspan="2">&#160;</td></tr>
  141. <tr class="memitem:af538a14e83578101a7d7cdcc8bb0ccbd" id="r_af538a14e83578101a7d7cdcc8bb0ccbd"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af538a14e83578101a7d7cdcc8bb0ccbd">is_always_equal</a> = std::true_type</td></tr>
  142. <tr class="memdesc:af538a14e83578101a7d7cdcc8bb0ccbd"><td class="mdescLeft">&#160;</td><td class="mdescRight">The allocator is stateless. <br /></td></tr>
  143. <tr class="separator:af538a14e83578101a7d7cdcc8bb0ccbd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  144. <tr class="memitem:a19ac9547e054a16d7cc86a365fcbde35" id="r_a19ac9547e054a16d7cc86a365fcbde35"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a19ac9547e054a16d7cc86a365fcbde35">propagate_on_container_move_assignment</a> = std::true_type</td></tr>
  145. <tr class="memdesc:a19ac9547e054a16d7cc86a365fcbde35"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allocator supports moving. <br /></td></tr>
  146. <tr class="separator:a19ac9547e054a16d7cc86a365fcbde35"><td class="memSeparator" colspan="2">&#160;</td></tr>
  147. </table><table class="memberdecls">
  148. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
  149. Public Member Functions</h2></td></tr>
  150. <tr class="memitem:a490bc5212d1eaa558cd629b920f7ab4f" id="r_a490bc5212d1eaa558cd629b920f7ab4f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a490bc5212d1eaa558cd629b920f7ab4f">STLAlignedAllocator</a> ()=default</td></tr>
  151. <tr class="memdesc:a490bc5212d1eaa558cd629b920f7ab4f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <br /></td></tr>
  152. <tr class="separator:a490bc5212d1eaa558cd629b920f7ab4f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  153. <tr class="memitem:adcbf21beef1553bd11174da4a4a4a274" id="r_adcbf21beef1553bd11174da4a4a4a274"><td class="memTemplParams" colspan="2">template&lt;typename T2 &gt; </td></tr>
  154. <tr class="memitem:adcbf21beef1553bd11174da4a4a4a274"><td class="memTemplItemLeft" align="right" valign="top">&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#adcbf21beef1553bd11174da4a4a4a274">STLAlignedAllocator</a> (const <a class="el" href="class_s_t_l_aligned_allocator.html">STLAlignedAllocator</a>&lt; T2, N &gt; &amp;)</td></tr>
  155. <tr class="memdesc:adcbf21beef1553bd11174da4a4a4a274"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor from other allocator. <br /></td></tr>
  156. <tr class="separator:adcbf21beef1553bd11174da4a4a4a274"><td class="memSeparator" colspan="2">&#160;</td></tr>
  157. <tr class="memitem:a3e191bdbfbb57772ab22df9ec23a6996" id="r_a3e191bdbfbb57772ab22df9ec23a6996"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a00f960ad0c626b48190ed45c3a9f4f93">pointer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a3e191bdbfbb57772ab22df9ec23a6996">allocate</a> (<a class="el" href="#a0004fb3a233bcaa84924f839156d06b3">size_type</a> inN)</td></tr>
  158. <tr class="memdesc:a3e191bdbfbb57772ab22df9ec23a6996"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allocate memory. <br /></td></tr>
  159. <tr class="separator:a3e191bdbfbb57772ab22df9ec23a6996"><td class="memSeparator" colspan="2">&#160;</td></tr>
  160. <tr class="memitem:a7ee785ea3499d6b21ce7872cb66988eb" id="r_a7ee785ea3499d6b21ce7872cb66988eb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a7ee785ea3499d6b21ce7872cb66988eb">deallocate</a> (<a class="el" href="#a00f960ad0c626b48190ed45c3a9f4f93">pointer</a> inPointer, <a class="el" href="#a0004fb3a233bcaa84924f839156d06b3">size_type</a>)</td></tr>
  161. <tr class="memdesc:a7ee785ea3499d6b21ce7872cb66988eb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Free memory. <br /></td></tr>
  162. <tr class="separator:a7ee785ea3499d6b21ce7872cb66988eb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  163. <tr class="memitem:a187d266d7db5bbd12a876eb83641602e" id="r_a187d266d7db5bbd12a876eb83641602e"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a187d266d7db5bbd12a876eb83641602e">operator==</a> (const <a class="el" href="class_s_t_l_aligned_allocator.html">STLAlignedAllocator</a>&lt; T, N &gt; &amp;) const</td></tr>
  164. <tr class="memdesc:a187d266d7db5bbd12a876eb83641602e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allocators are stateless so assumed to be equal. <br /></td></tr>
  165. <tr class="separator:a187d266d7db5bbd12a876eb83641602e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  166. <tr class="memitem:a07e008a7bc893d0386c0e98f2f2d485e" id="r_a07e008a7bc893d0386c0e98f2f2d485e"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a07e008a7bc893d0386c0e98f2f2d485e">operator!=</a> (const <a class="el" href="class_s_t_l_aligned_allocator.html">STLAlignedAllocator</a>&lt; T, N &gt; &amp;) const</td></tr>
  167. <tr class="separator:a07e008a7bc893d0386c0e98f2f2d485e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  168. </table>
  169. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  170. <div class="textblock"><div class="compoundTemplParams">template&lt;typename T, size_t N&gt;<br />
  171. class STLAlignedAllocator&lt; T, N &gt;</div><p>STL allocator that takes care that memory is aligned to N bytes. </p>
  172. </div><h2 class="groupheader">Member Typedef Documentation</h2>
  173. <a id="aebb20b18116799083cdb1c21bd5bd298" name="aebb20b18116799083cdb1c21bd5bd298"></a>
  174. <h2 class="memtitle"><span class="permalink"><a href="#aebb20b18116799083cdb1c21bd5bd298">&#9670;&#160;</a></span>const_pointer</h2>
  175. <div class="memitem">
  176. <div class="memproto">
  177. <div class="memtemplate">
  178. template&lt;typename T , size_t N&gt; </div>
  179. <table class="memname">
  180. <tr>
  181. <td class="memname">using <a class="el" href="class_s_t_l_aligned_allocator.html">STLAlignedAllocator</a>&lt; T, N &gt;::const_pointer = const T *</td>
  182. </tr>
  183. </table>
  184. </div><div class="memdoc">
  185. </div>
  186. </div>
  187. <a id="af511fc1b1dddec672d902e3ef16d0f39" name="af511fc1b1dddec672d902e3ef16d0f39"></a>
  188. <h2 class="memtitle"><span class="permalink"><a href="#af511fc1b1dddec672d902e3ef16d0f39">&#9670;&#160;</a></span>const_reference</h2>
  189. <div class="memitem">
  190. <div class="memproto">
  191. <div class="memtemplate">
  192. template&lt;typename T , size_t N&gt; </div>
  193. <table class="memname">
  194. <tr>
  195. <td class="memname">using <a class="el" href="class_s_t_l_aligned_allocator.html">STLAlignedAllocator</a>&lt; T, N &gt;::const_reference = const T &amp;</td>
  196. </tr>
  197. </table>
  198. </div><div class="memdoc">
  199. </div>
  200. </div>
  201. <a id="a2a9287cbd8ce3d27c67aeb33a20ff9ba" name="a2a9287cbd8ce3d27c67aeb33a20ff9ba"></a>
  202. <h2 class="memtitle"><span class="permalink"><a href="#a2a9287cbd8ce3d27c67aeb33a20ff9ba">&#9670;&#160;</a></span>difference_type</h2>
  203. <div class="memitem">
  204. <div class="memproto">
  205. <div class="memtemplate">
  206. template&lt;typename T , size_t N&gt; </div>
  207. <table class="memname">
  208. <tr>
  209. <td class="memname">using <a class="el" href="class_s_t_l_aligned_allocator.html">STLAlignedAllocator</a>&lt; T, N &gt;::difference_type = ptrdiff_t</td>
  210. </tr>
  211. </table>
  212. </div><div class="memdoc">
  213. </div>
  214. </div>
  215. <a id="af538a14e83578101a7d7cdcc8bb0ccbd" name="af538a14e83578101a7d7cdcc8bb0ccbd"></a>
  216. <h2 class="memtitle"><span class="permalink"><a href="#af538a14e83578101a7d7cdcc8bb0ccbd">&#9670;&#160;</a></span>is_always_equal</h2>
  217. <div class="memitem">
  218. <div class="memproto">
  219. <div class="memtemplate">
  220. template&lt;typename T , size_t N&gt; </div>
  221. <table class="memname">
  222. <tr>
  223. <td class="memname">using <a class="el" href="class_s_t_l_aligned_allocator.html">STLAlignedAllocator</a>&lt; T, N &gt;::is_always_equal = std::true_type</td>
  224. </tr>
  225. </table>
  226. </div><div class="memdoc">
  227. <p>The allocator is stateless. </p>
  228. </div>
  229. </div>
  230. <a id="a00f960ad0c626b48190ed45c3a9f4f93" name="a00f960ad0c626b48190ed45c3a9f4f93"></a>
  231. <h2 class="memtitle"><span class="permalink"><a href="#a00f960ad0c626b48190ed45c3a9f4f93">&#9670;&#160;</a></span>pointer</h2>
  232. <div class="memitem">
  233. <div class="memproto">
  234. <div class="memtemplate">
  235. template&lt;typename T , size_t N&gt; </div>
  236. <table class="memname">
  237. <tr>
  238. <td class="memname">using <a class="el" href="class_s_t_l_aligned_allocator.html">STLAlignedAllocator</a>&lt; T, N &gt;::pointer = T *</td>
  239. </tr>
  240. </table>
  241. </div><div class="memdoc">
  242. <p>Pointer to type. </p>
  243. </div>
  244. </div>
  245. <a id="a19ac9547e054a16d7cc86a365fcbde35" name="a19ac9547e054a16d7cc86a365fcbde35"></a>
  246. <h2 class="memtitle"><span class="permalink"><a href="#a19ac9547e054a16d7cc86a365fcbde35">&#9670;&#160;</a></span>propagate_on_container_move_assignment</h2>
  247. <div class="memitem">
  248. <div class="memproto">
  249. <div class="memtemplate">
  250. template&lt;typename T , size_t N&gt; </div>
  251. <table class="memname">
  252. <tr>
  253. <td class="memname">using <a class="el" href="class_s_t_l_aligned_allocator.html">STLAlignedAllocator</a>&lt; T, N &gt;::propagate_on_container_move_assignment = std::true_type</td>
  254. </tr>
  255. </table>
  256. </div><div class="memdoc">
  257. <p>Allocator supports moving. </p>
  258. </div>
  259. </div>
  260. <a id="a56b7aed0a19cfcdb3265edd1b2f128c9" name="a56b7aed0a19cfcdb3265edd1b2f128c9"></a>
  261. <h2 class="memtitle"><span class="permalink"><a href="#a56b7aed0a19cfcdb3265edd1b2f128c9">&#9670;&#160;</a></span>reference</h2>
  262. <div class="memitem">
  263. <div class="memproto">
  264. <div class="memtemplate">
  265. template&lt;typename T , size_t N&gt; </div>
  266. <table class="memname">
  267. <tr>
  268. <td class="memname">using <a class="el" href="class_s_t_l_aligned_allocator.html">STLAlignedAllocator</a>&lt; T, N &gt;::reference = T &amp;</td>
  269. </tr>
  270. </table>
  271. </div><div class="memdoc">
  272. <p>Reference to type. Can be removed in C++20. </p>
  273. </div>
  274. </div>
  275. <a id="a0004fb3a233bcaa84924f839156d06b3" name="a0004fb3a233bcaa84924f839156d06b3"></a>
  276. <h2 class="memtitle"><span class="permalink"><a href="#a0004fb3a233bcaa84924f839156d06b3">&#9670;&#160;</a></span>size_type</h2>
  277. <div class="memitem">
  278. <div class="memproto">
  279. <div class="memtemplate">
  280. template&lt;typename T , size_t N&gt; </div>
  281. <table class="memname">
  282. <tr>
  283. <td class="memname">using <a class="el" href="class_s_t_l_aligned_allocator.html">STLAlignedAllocator</a>&lt; T, N &gt;::size_type = size_t</td>
  284. </tr>
  285. </table>
  286. </div><div class="memdoc">
  287. </div>
  288. </div>
  289. <a id="a4457facc139621863361195814d170df" name="a4457facc139621863361195814d170df"></a>
  290. <h2 class="memtitle"><span class="permalink"><a href="#a4457facc139621863361195814d170df">&#9670;&#160;</a></span>value_type</h2>
  291. <div class="memitem">
  292. <div class="memproto">
  293. <div class="memtemplate">
  294. template&lt;typename T , size_t N&gt; </div>
  295. <table class="memname">
  296. <tr>
  297. <td class="memname">using <a class="el" href="class_s_t_l_aligned_allocator.html">STLAlignedAllocator</a>&lt; T, N &gt;::value_type = T</td>
  298. </tr>
  299. </table>
  300. </div><div class="memdoc">
  301. </div>
  302. </div>
  303. <h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  304. <a id="a490bc5212d1eaa558cd629b920f7ab4f" name="a490bc5212d1eaa558cd629b920f7ab4f"></a>
  305. <h2 class="memtitle"><span class="permalink"><a href="#a490bc5212d1eaa558cd629b920f7ab4f">&#9670;&#160;</a></span>STLAlignedAllocator() <span class="overload">[1/2]</span></h2>
  306. <div class="memitem">
  307. <div class="memproto">
  308. <div class="memtemplate">
  309. template&lt;typename T , size_t N&gt; </div>
  310. <table class="mlabels">
  311. <tr>
  312. <td class="mlabels-left">
  313. <table class="memname">
  314. <tr>
  315. <td class="memname"><a class="el" href="class_s_t_l_aligned_allocator.html">STLAlignedAllocator</a>&lt; T, N &gt;<a class="el" href="class_s_t_l_aligned_allocator.html">::STLAlignedAllocator</a> </td>
  316. <td>(</td>
  317. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  318. <td></td>
  319. </tr>
  320. </table>
  321. </td>
  322. <td class="mlabels-right">
  323. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">default</span></span> </td>
  324. </tr>
  325. </table>
  326. </div><div class="memdoc">
  327. <p>Constructor. </p>
  328. </div>
  329. </div>
  330. <a id="adcbf21beef1553bd11174da4a4a4a274" name="adcbf21beef1553bd11174da4a4a4a274"></a>
  331. <h2 class="memtitle"><span class="permalink"><a href="#adcbf21beef1553bd11174da4a4a4a274">&#9670;&#160;</a></span>STLAlignedAllocator() <span class="overload">[2/2]</span></h2>
  332. <div class="memitem">
  333. <div class="memproto">
  334. <div class="memtemplate">
  335. template&lt;typename T , size_t N&gt; </div>
  336. <div class="memtemplate">
  337. template&lt;typename T2 &gt; </div>
  338. <table class="mlabels">
  339. <tr>
  340. <td class="mlabels-left">
  341. <table class="memname">
  342. <tr>
  343. <td class="memname"><a class="el" href="class_s_t_l_aligned_allocator.html">STLAlignedAllocator</a>&lt; T, N &gt;<a class="el" href="class_s_t_l_aligned_allocator.html">::STLAlignedAllocator</a> </td>
  344. <td>(</td>
  345. <td class="paramtype">const <a class="el" href="class_s_t_l_aligned_allocator.html">STLAlignedAllocator</a>&lt; T2, N &gt; &amp;</td> <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  346. <td></td>
  347. </tr>
  348. </table>
  349. </td>
  350. <td class="mlabels-right">
  351. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span> </td>
  352. </tr>
  353. </table>
  354. </div><div class="memdoc">
  355. <p>Constructor from other allocator. </p>
  356. </div>
  357. </div>
  358. <h2 class="groupheader">Member Function Documentation</h2>
  359. <a id="a3e191bdbfbb57772ab22df9ec23a6996" name="a3e191bdbfbb57772ab22df9ec23a6996"></a>
  360. <h2 class="memtitle"><span class="permalink"><a href="#a3e191bdbfbb57772ab22df9ec23a6996">&#9670;&#160;</a></span>allocate()</h2>
  361. <div class="memitem">
  362. <div class="memproto">
  363. <div class="memtemplate">
  364. template&lt;typename T , size_t N&gt; </div>
  365. <table class="mlabels">
  366. <tr>
  367. <td class="mlabels-left">
  368. <table class="memname">
  369. <tr>
  370. <td class="memname"><a class="el" href="#a00f960ad0c626b48190ed45c3a9f4f93">pointer</a> <a class="el" href="class_s_t_l_aligned_allocator.html">STLAlignedAllocator</a>&lt; T, N &gt;::allocate </td>
  371. <td>(</td>
  372. <td class="paramtype"><a class="el" href="#a0004fb3a233bcaa84924f839156d06b3">size_type</a></td> <td class="paramname"><span class="paramname"><em>inN</em></span></td><td>)</td>
  373. <td></td>
  374. </tr>
  375. </table>
  376. </td>
  377. <td class="mlabels-right">
  378. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  379. </tr>
  380. </table>
  381. </div><div class="memdoc">
  382. <p>Allocate memory. </p>
  383. </div>
  384. </div>
  385. <a id="a7ee785ea3499d6b21ce7872cb66988eb" name="a7ee785ea3499d6b21ce7872cb66988eb"></a>
  386. <h2 class="memtitle"><span class="permalink"><a href="#a7ee785ea3499d6b21ce7872cb66988eb">&#9670;&#160;</a></span>deallocate()</h2>
  387. <div class="memitem">
  388. <div class="memproto">
  389. <div class="memtemplate">
  390. template&lt;typename T , size_t N&gt; </div>
  391. <table class="mlabels">
  392. <tr>
  393. <td class="mlabels-left">
  394. <table class="memname">
  395. <tr>
  396. <td class="memname">void <a class="el" href="class_s_t_l_aligned_allocator.html">STLAlignedAllocator</a>&lt; T, N &gt;::deallocate </td>
  397. <td>(</td>
  398. <td class="paramtype"><a class="el" href="#a00f960ad0c626b48190ed45c3a9f4f93">pointer</a></td> <td class="paramname"><span class="paramname"><em>inPointer</em></span>, </td>
  399. </tr>
  400. <tr>
  401. <td class="paramkey"></td>
  402. <td></td>
  403. <td class="paramtype"><a class="el" href="#a0004fb3a233bcaa84924f839156d06b3">size_type</a></td> <td class="paramname"><span class="paramname"><em></em></span>&#160;)</td>
  404. </tr>
  405. </table>
  406. </td>
  407. <td class="mlabels-right">
  408. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  409. </tr>
  410. </table>
  411. </div><div class="memdoc">
  412. <p>Free memory. </p>
  413. </div>
  414. </div>
  415. <a id="a07e008a7bc893d0386c0e98f2f2d485e" name="a07e008a7bc893d0386c0e98f2f2d485e"></a>
  416. <h2 class="memtitle"><span class="permalink"><a href="#a07e008a7bc893d0386c0e98f2f2d485e">&#9670;&#160;</a></span>operator!=()</h2>
  417. <div class="memitem">
  418. <div class="memproto">
  419. <div class="memtemplate">
  420. template&lt;typename T , size_t N&gt; </div>
  421. <table class="mlabels">
  422. <tr>
  423. <td class="mlabels-left">
  424. <table class="memname">
  425. <tr>
  426. <td class="memname">bool <a class="el" href="class_s_t_l_aligned_allocator.html">STLAlignedAllocator</a>&lt; T, N &gt;::operator!= </td>
  427. <td>(</td>
  428. <td class="paramtype">const <a class="el" href="class_s_t_l_aligned_allocator.html">STLAlignedAllocator</a>&lt; T, N &gt; &amp;</td> <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  429. <td> const</td>
  430. </tr>
  431. </table>
  432. </td>
  433. <td class="mlabels-right">
  434. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  435. </tr>
  436. </table>
  437. </div><div class="memdoc">
  438. </div>
  439. </div>
  440. <a id="a187d266d7db5bbd12a876eb83641602e" name="a187d266d7db5bbd12a876eb83641602e"></a>
  441. <h2 class="memtitle"><span class="permalink"><a href="#a187d266d7db5bbd12a876eb83641602e">&#9670;&#160;</a></span>operator==()</h2>
  442. <div class="memitem">
  443. <div class="memproto">
  444. <div class="memtemplate">
  445. template&lt;typename T , size_t N&gt; </div>
  446. <table class="mlabels">
  447. <tr>
  448. <td class="mlabels-left">
  449. <table class="memname">
  450. <tr>
  451. <td class="memname">bool <a class="el" href="class_s_t_l_aligned_allocator.html">STLAlignedAllocator</a>&lt; T, N &gt;::operator== </td>
  452. <td>(</td>
  453. <td class="paramtype">const <a class="el" href="class_s_t_l_aligned_allocator.html">STLAlignedAllocator</a>&lt; T, N &gt; &amp;</td> <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  454. <td> const</td>
  455. </tr>
  456. </table>
  457. </td>
  458. <td class="mlabels-right">
  459. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  460. </tr>
  461. </table>
  462. </div><div class="memdoc">
  463. <p>Allocators are stateless so assumed to be equal. </p>
  464. </div>
  465. </div>
  466. <hr/>The documentation for this class was generated from the following file:<ul>
  467. <li>Jolt/Core/<a class="el" href="_s_t_l_aligned_allocator_8h_source.html">STLAlignedAllocator.h</a></li>
  468. </ul>
  469. </div><!-- contents -->
  470. </div><!-- doc-content -->
  471. <!-- start footer part -->
  472. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  473. <ul>
  474. <li class="navelem"><a class="el" href="class_s_t_l_aligned_allocator.html">STLAlignedAllocator</a></li>
  475. <li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.12.0 </li>
  476. </ul>
  477. </div>
  478. </body>
  479. </html>