mirror of
https://github.com/PhasicFlow/phasicFlow.git
synced 2025-06-22 16:28:30 +00:00
documentation for v1.0
This commit is contained in:
HRN
@ -5,7 +5,7 @@
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
||||
<meta name="generator" content="Doxygen 1.8.17"/>
|
||||
<meta name="description" content="PhasicFlow is an open-source parallel DEM (discrete element method) package for simulating granular flow. It is developed in C++ and can be exectued on both GPU (like CUDA) and CPU.">
|
||||
<title>PhasicFlow: uniquePtr< T, Deleter > Class Template Reference</title>
|
||||
<title>PhasicFlow: uniquePtr< T > 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>
|
||||
@ -107,54 +107,28 @@ $(document).ready(function(){initNavTree('classpFlow_1_1uniquePtr.html',''); ini
|
||||
<a href="#pub-static-methods">Static Public Member Functions</a> |
|
||||
<a href="classpFlow_1_1uniquePtr-members.html">List of all members</a> </div>
|
||||
<div class="headertitle">
|
||||
<div class="title">uniquePtr< T, Deleter > Class Template Reference</div> </div>
|
||||
<div class="title">uniquePtr< T > Class Template Reference</div> </div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
|
||||
<img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for uniquePtr< T, Deleter >:</div>
|
||||
<img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for uniquePtr< T >:</div>
|
||||
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
|
||||
</div>
|
||||
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
|
||||
<div class="center"><img src="classpFlow_1_1uniquePtr__inherit__graph.png" border="0" usemap="#uniquePtr_3_01T_00_01Deleter_01_4_inherit__map" alt="Inheritance graph"/></div>
|
||||
<map name="uniquePtr_3_01T_00_01Deleter_01_4_inherit__map" id="uniquePtr_3_01T_00_01Deleter_01_4_inherit__map">
|
||||
<area shape="rect" title=" " alt="" coords="232,516,411,543"/>
|
||||
<area shape="rect" href="classpFlow_1_1uniquePtr.html" title=" " alt="" coords="676,25,904,52"/>
|
||||
<area shape="rect" href="classpFlow_1_1uniquePtr.html" title=" " alt="" coords="691,77,889,118"/>
|
||||
<area shape="rect" href="classpFlow_1_1uniquePtr.html" title=" " alt="" coords="679,143,901,169"/>
|
||||
<area shape="rect" href="classpFlow_1_1uniquePtr.html" title=" " alt="" coords="692,194,888,235"/>
|
||||
<area shape="rect" href="classpFlow_1_1uniquePtr.html" title=" " alt="" coords="671,260,909,287"/>
|
||||
<area shape="rect" href="classpFlow_1_1uniquePtr.html" title=" " alt="" coords="691,311,889,353"/>
|
||||
<area shape="rect" href="classpFlow_1_1uniquePtr.html" title=" " alt="" coords="665,377,915,404"/>
|
||||
<area shape="rect" href="classpFlow_1_1uniquePtr.html" title=" " alt="" coords="689,428,891,455"/>
|
||||
<area shape="rect" href="classpFlow_1_1uniquePtr.html" title=" " alt="" coords="697,479,883,521"/>
|
||||
<area shape="rect" href="classpFlow_1_1uniquePtr.html" title=" " alt="" coords="677,545,903,572"/>
|
||||
<area shape="rect" href="classpFlow_1_1uniquePtr.html" title=" " alt="" coords="693,597,887,638"/>
|
||||
<area shape="rect" href="classpFlow_1_1uniquePtr.html" title=" " alt="" coords="688,662,892,703"/>
|
||||
<area shape="rect" href="classpFlow_1_1uniquePtr.html" title=" " alt="" coords="675,728,905,755"/>
|
||||
<area shape="rect" href="classpFlow_1_1uniquePtr.html" title=" " alt="" coords="681,779,899,805"/>
|
||||
<area shape="rect" href="classpFlow_1_1uniquePtr.html" title=" " alt="" coords="677,829,903,856"/>
|
||||
<area shape="rect" href="classpFlow_1_1uniquePtr.html" title=" " alt="" coords="694,881,886,922"/>
|
||||
<area shape="rect" href="classpFlow_1_1uniquePtr.html" title=" " alt="" coords="691,947,889,973"/>
|
||||
<area shape="rect" href="classpFlow_1_1uniquePtr.html" title=" " alt="" coords="687,998,893,1039"/>
|
||||
<area shape="rect" title=" " alt="" coords="5,509,183,550"/>
|
||||
</map>
|
||||
<div class="center"><img src="classpFlow_1_1uniquePtr__inherit__graph.png" border="0" usemap="#uniquePtr_3_01T_01_4_inherit__map" alt="Inheritance graph"/></div>
|
||||
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
|
||||
<div id="dynsection-1" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
|
||||
<img id="dynsection-1-trigger" src="closed.png" alt="+"/> Collaboration diagram for uniquePtr< T, Deleter >:</div>
|
||||
<img id="dynsection-1-trigger" src="closed.png" alt="+"/> Collaboration diagram for uniquePtr< T >:</div>
|
||||
<div id="dynsection-1-summary" class="dynsummary" style="display:block;">
|
||||
</div>
|
||||
<div id="dynsection-1-content" class="dyncontent" style="display:none;">
|
||||
<div class="center"><img src="classpFlow_1_1uniquePtr__coll__graph.png" border="0" usemap="#uniquePtr_3_01T_00_01Deleter_01_4_coll__map" alt="Collaboration graph"/></div>
|
||||
<map name="uniquePtr_3_01T_00_01Deleter_01_4_coll__map" id="uniquePtr_3_01T_00_01Deleter_01_4_coll__map">
|
||||
<area shape="rect" title=" " alt="" coords="5,95,184,121"/>
|
||||
<area shape="rect" title=" " alt="" coords="6,5,183,47"/>
|
||||
</map>
|
||||
<div class="center"><img src="classpFlow_1_1uniquePtr__coll__graph.png" border="0" usemap="#uniquePtr_3_01T_01_4_coll__map" alt="Collaboration graph"/></div>
|
||||
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
|
||||
<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:a195b4af27fd861da73b1bebed3307624"><td class="memItemLeft" align="right" valign="top">typedef std::unique_ptr< T, Deleter > </td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1uniquePtr.html#a195b4af27fd861da73b1bebed3307624">uniquePtrType</a></td></tr>
|
||||
<tr class="separator:a195b4af27fd861da73b1bebed3307624"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a148c597bb7fb76ab2e511cea299742ce"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1uniquePtr.html#a148c597bb7fb76ab2e511cea299742ce">uniquePtrType</a> = std::unique_ptr< T ></td></tr>
|
||||
<tr class="separator:a148c597bb7fb76ab2e511cea299742ce"><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>
|
||||
@ -164,6 +138,8 @@ Public Member Functions</h2></td></tr>
|
||||
<tr class="separator:a9b6e1a7a6d5d7db85bae38ba04aaec7f"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ad3aaf80867f8090e20c6a5bb52b73669"><td class="memItemLeft" align="right" valign="top">const T & </td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1uniquePtr.html#ad3aaf80867f8090e20c6a5bb52b73669">operator()</a> () const</td></tr>
|
||||
<tr class="separator:ad3aaf80867f8090e20c6a5bb52b73669"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a67b76affb3b5d35fa419ac234144038b"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1uniquePtr.html#a67b76affb3b5d35fa419ac234144038b">operator bool</a> () const</td></tr>
|
||||
<tr class="separator:a67b76affb3b5d35fa419ac234144038b"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table><table class="memberdecls">
|
||||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
|
||||
Static Public Member Functions</h2></td></tr>
|
||||
@ -172,25 +148,25 @@ Static Public Member Functions</h2></td></tr>
|
||||
<tr class="separator:a1856ce6582a2744ed317e12a53249b65"><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, typename Deleter = std::default_delete<T>><br />
|
||||
class pFlow::uniquePtr< T, Deleter ></h3>
|
||||
<div class="textblock"><h3>template<typename T><br />
|
||||
class pFlow::uniquePtr< T ></h3>
|
||||
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="uniquePtr_8hpp_source.html#l00044">44</a> of file <a class="el" href="uniquePtr_8hpp_source.html">uniquePtr.hpp</a>.</p>
|
||||
<p class="definition">Definition at line <a class="el" href="uniquePtr_8hpp_source.html#l00042">42</a> of file <a class="el" href="uniquePtr_8hpp_source.html">uniquePtr.hpp</a>.</p>
|
||||
</div><h2 class="groupheader">Member Typedef Documentation</h2>
|
||||
<a id="a195b4af27fd861da73b1bebed3307624"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a195b4af27fd861da73b1bebed3307624">◆ </a></span>uniquePtrType</h2>
|
||||
<a id="a148c597bb7fb76ab2e511cea299742ce"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a148c597bb7fb76ab2e511cea299742ce">◆ </a></span>uniquePtrType</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">typedef std::unique_ptr<T,Deleter> <a class="el" href="classpFlow_1_1uniquePtr.html#a195b4af27fd861da73b1bebed3307624">uniquePtrType</a></td>
|
||||
<td class="memname">using <a class="el" href="classpFlow_1_1uniquePtr.html#a148c597bb7fb76ab2e511cea299742ce">uniquePtrType</a> = std::unique_ptr<T></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="uniquePtr_8hpp_source.html#l00050">50</a> of file <a class="el" href="uniquePtr_8hpp_source.html">uniquePtr.hpp</a>.</p>
|
||||
<p class="definition">Definition at line <a class="el" href="uniquePtr_8hpp_source.html#l00048">48</a> of file <a class="el" href="uniquePtr_8hpp_source.html">uniquePtr.hpp</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@ -219,7 +195,7 @@ class pFlow::uniquePtr< T, Deleter ></h3>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="uniquePtr_8hpp_source.html#l00057">57</a> of file <a class="el" href="uniquePtr_8hpp_source.html">uniquePtr.hpp</a>.</p>
|
||||
<p class="definition">Definition at line <a class="el" href="uniquePtr_8hpp_source.html#l00055">55</a> of file <a class="el" href="uniquePtr_8hpp_source.html">uniquePtr.hpp</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@ -246,7 +222,7 @@ class pFlow::uniquePtr< T, Deleter ></h3>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="uniquePtr_8hpp_source.html#l00062">62</a> of file <a class="el" href="uniquePtr_8hpp_source.html">uniquePtr.hpp</a>.</p>
|
||||
<p class="definition">Definition at line <a class="el" href="uniquePtr_8hpp_source.html#l00060">60</a> of file <a class="el" href="uniquePtr_8hpp_source.html">uniquePtr.hpp</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@ -273,7 +249,7 @@ class pFlow::uniquePtr< T, Deleter ></h3>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="uniquePtr_8hpp_source.html#l00072">72</a> of file <a class="el" href="uniquePtr_8hpp_source.html">uniquePtr.hpp</a>.</p>
|
||||
<p class="definition">Definition at line <a class="el" href="uniquePtr_8hpp_source.html#l00066">66</a> of file <a class="el" href="uniquePtr_8hpp_source.html">uniquePtr.hpp</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@ -300,7 +276,34 @@ class pFlow::uniquePtr< T, Deleter ></h3>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="uniquePtr_8hpp_source.html#l00085">85</a> of file <a class="el" href="uniquePtr_8hpp_source.html">uniquePtr.hpp</a>.</p>
|
||||
<p class="definition">Definition at line <a class="el" href="uniquePtr_8hpp_source.html#l00079">79</a> of file <a class="el" href="uniquePtr_8hpp_source.html">uniquePtr.hpp</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="a67b76affb3b5d35fa419ac234144038b"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a67b76affb3b5d35fa419ac234144038b">◆ </a></span>operator bool()</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="mlabels">
|
||||
<tr>
|
||||
<td class="mlabels-left">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">operator bool </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 class="mlabel">explicit</span></span> </td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="uniquePtr_8hpp_source.html#l00091">91</a> of file <a class="el" href="uniquePtr_8hpp_source.html">uniquePtr.hpp</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
Reference in New Issue
Block a user