Show
Ignore:
Timestamp:
08/29/09 20:54:10 (15 years ago)
Author:
smidl
Message:

doc

Files:
1 modified

Legend:

Unmodified
Added
Removed
  • library/doc/html/classbdm_1_1shared__ptr.html

    r538 r590  
    6868</div> 
    6969<div class="contents"> 
    70 <h1>bdm::shared_ptr&lt; T &gt; Class Template Reference</h1><!-- doxytag: class="bdm::shared_ptr" -->A naive implementation of roughly a subset of the std::tr1:<a class="el" href="classbdm_1_1shared__ptr.html" title="A naive implementation of roughly a subset of the std::tr1:shared_ptr spec.">shared_ptr</a> spec.   
     70<h1>bdm::shared_ptr&lt; T &gt; Class Template Reference</h1><!-- doxytag: class="bdm::shared_ptr" -->A naive implementation of roughly a subset of the std::tr1::shared_ptr spec.   
    7171<a href="#_details">More...</a> 
    7272<p> 
     
    7878<tr><td></td></tr> 
    7979<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> 
    80 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="66a4d41031e37618f1a9bb3c81814c11"></a><!-- doxytag: member="bdm::shared_ptr::shared_ptr" ref="66a4d41031e37618f1a9bb3c81814c11" args="()" --> 
    81 &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1shared__ptr.html#66a4d41031e37618f1a9bb3c81814c11">shared_ptr</a> ()</td></tr> 
    82  
    83 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Creates an empty <a class="el" href="classbdm_1_1shared__ptr.html" title="A naive implementation of roughly a subset of the std::tr1:shared_ptr spec.">shared_ptr</a> - one that doesn't point anywhere. <br></td></tr> 
     80<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1shared__ptr.html#66a4d41031e37618f1a9bb3c81814c11">shared_ptr</a> ()</td></tr> 
     81 
     82<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor.  <a href="#66a4d41031e37618f1a9bb3c81814c11"></a><br></td></tr> 
    8483<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1shared__ptr.html#c8b7f0a813173581530c80d7ac4fc7c2">shared_ptr</a> (T *p)</td></tr> 
    8584 
    8685<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1shared__ptr.html#357702d12bfd608a08b46e4a194aa4b5">shared_ptr</a> (const <a class="el" href="classbdm_1_1shared__ptr.html">shared_ptr</a>&lt; T &gt; &amp;other)</td></tr> 
    8786 
     87<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Copy constructor.  <a href="#357702d12bfd608a08b46e4a194aa4b5"></a><br></td></tr> 
    8888<tr><td class="memTemplParams" nowrap colspan="2">template&lt;typename U &gt; </td></tr> 
    8989<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classbdm_1_1shared__ptr.html#affa5b17385493f4102c52cf75d3b509">shared_ptr</a> (const <a class="el" href="classbdm_1_1shared__ptr.html">shared_ptr</a>&lt; U &gt; &amp;other)</td></tr> 
    9090 
     91<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Generalized copy.  <a href="#affa5b17385493f4102c52cf75d3b509"></a><br></td></tr> 
     92<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1shared__ptr.html#79374842e417d2f64e449e374be4cfc1">~shared_ptr</a> ()</td></tr> 
     93 
    9194<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="55263b1c8efbd3f8fddf703e2c457f6c"></a><!-- doxytag: member="bdm::shared_ptr::operator=" ref="55263b1c8efbd3f8fddf703e2c457f6c" args="(const shared_ptr&lt; T &gt; &amp;other)" --> 
    92 <a class="el" href="classbdm_1_1shared__ptr.html">shared_ptr</a>&lt; T &gt; &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="classbdm_1_1shared__ptr.html">shared_ptr</a>&lt; T &gt; &amp;other)</td></tr> 
    93  
     95<a class="el" href="classbdm_1_1shared__ptr.html">shared_ptr</a>&lt; T &gt; &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1shared__ptr.html#55263b1c8efbd3f8fddf703e2c457f6c">operator=</a> (const <a class="el" href="classbdm_1_1shared__ptr.html">shared_ptr</a>&lt; T &gt; &amp;other)</td></tr> 
     96 
     97<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Assignment operator. <br></td></tr> 
    9498<tr><td class="memItemLeft" nowrap align="right" valign="top">T *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1shared__ptr.html#37ebcfb6750dd7b5630f1d2354c07a96">get</a> ()</td></tr> 
    9599 
     
    105109 
    106110<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="338dbc6aa9fd95175abdc2df3ae2c284"></a><!-- doxytag: member="bdm::shared_ptr::unique" ref="338dbc6aa9fd95175abdc2df3ae2c284" args="() const " --> 
    107 bool&nbsp;</td><td class="memItemRight" valign="bottom"><b>unique</b> () const </td></tr> 
    108  
    109 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8e52b8887a4408c52b5263a5717343f2"></a><!-- doxytag: member="bdm::shared_ptr::use_count" ref="8e52b8887a4408c52b5263a5717343f2" args="() const " --> 
    110 long&nbsp;</td><td class="memItemRight" valign="bottom"><b>use_count</b> () const </td></tr> 
    111  
    112 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6cac71bb600f9f7c6fbed9335fd22d37"></a><!-- doxytag: member="bdm::shared_ptr::operator bool" ref="6cac71bb600f9f7c6fbed9335fd22d37" args="() const " --> 
    113 &nbsp;</td><td class="memItemRight" valign="bottom"><b>operator bool</b> () const </td></tr> 
    114  
     111bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1shared__ptr.html#338dbc6aa9fd95175abdc2df3ae2c284">unique</a> () const </td></tr> 
     112 
     113<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns <a class="el" href="classbdm_1_1shared__ptr.html#8e52b8887a4408c52b5263a5717343f2">use_count()</a> == 1. <br></td></tr> 
     114<tr><td class="memItemLeft" nowrap align="right" valign="top">long&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1shared__ptr.html#8e52b8887a4408c52b5263a5717343f2">use_count</a> () const </td></tr> 
     115 
     116<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1shared__ptr.html#6cac71bb600f9f7c6fbed9335fd22d37">operator bool</a> () const </td></tr> 
     117 
     118<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Boolean cast.  <a href="#6cac71bb600f9f7c6fbed9335fd22d37"></a><br></td></tr> 
     119<tr><td class="memTemplParams" nowrap colspan="2">template&lt;typename U &gt; </td></tr> 
     120<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classbdm_1_1shared__ptr.html#b3cd369b00369ab92456aa0645e8d560">operator shared_ptr&lt; const U &gt;</a> () const </td></tr> 
     121 
     122<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">const cast  <a href="#b3cd369b00369ab92456aa0645e8d560"></a><br></td></tr> 
    115123<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="fca7fd588f8de50e7590357305b00984"></a><!-- doxytag: member="bdm::shared_ptr::swap" ref="fca7fd588f8de50e7590357305b00984" args="(shared_ptr &amp;other)" --> 
    116 void&nbsp;</td><td class="memItemRight" valign="bottom"><b>swap</b> (<a class="el" href="classbdm_1_1shared__ptr.html">shared_ptr</a> &amp;other)</td></tr> 
    117  
     124void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1shared__ptr.html#fca7fd588f8de50e7590357305b00984">swap</a> (<a class="el" href="classbdm_1_1shared__ptr.html">shared_ptr</a> &amp;other)</td></tr> 
     125 
     126<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Efficient swap for <a class="el" href="classbdm_1_1shared__ptr.html" title="A naive implementation of roughly a subset of the std::tr1::shared_ptr spec.">shared_ptr</a>. <br></td></tr> 
    118127<tr><td colspan="2"><br><h2>Friends</h2></td></tr> 
    119128<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9a4da829475f0cf1809fc6ef555ffe06"></a><!-- doxytag: member="bdm::shared_ptr::shared_ptr" ref="9a4da829475f0cf1809fc6ef555ffe06" args="" --> 
     
    125134 class bdm::shared_ptr&lt; T &gt;</h3> 
    126135 
    127 A naive implementation of roughly a subset of the std::tr1:<a class="el" href="classbdm_1_1shared__ptr.html" title="A naive implementation of roughly a subset of the std::tr1:shared_ptr spec.">shared_ptr</a> spec.  
     136A naive implementation of roughly a subset of the std::tr1::shared_ptr spec.  
    128137<p> 
    129138Really just roughly - it ignores memory exceptions, for example; also note I didn't read the spec.<p> 
    130 The standard template would naturally be preferable, _if_ it was included in the standard libraries of all supported compilers - but as of 2009, that's still a problem... <hr><h2>Constructor &amp; Destructor Documentation</h2> 
     139The standard template would naturally be preferable, <b>if</b> it was included in the standard libraries of all supported compilers - but as of 2009, that's still a problem... <hr><h2>Constructor &amp; Destructor Documentation</h2> 
     140<a class="anchor" name="66a4d41031e37618f1a9bb3c81814c11"></a><!-- doxytag: member="bdm::shared_ptr::shared_ptr" ref="66a4d41031e37618f1a9bb3c81814c11" args="()" --> 
     141<div class="memitem"> 
     142<div class="memproto"> 
     143<div class="memtemplate"> 
     144template&lt;typename T&gt; </div> 
     145      <table class="memname"> 
     146        <tr> 
     147          <td class="memname"><a class="el" href="classbdm_1_1shared__ptr.html">bdm::shared_ptr</a>&lt; T &gt;::<a class="el" href="classbdm_1_1shared__ptr.html">shared_ptr</a>           </td> 
     148          <td>(</td> 
     149          <td class="paramname">          </td> 
     150          <td>&nbsp;)&nbsp;</td> 
     151          <td><code> [inline]</code></td> 
     152        </tr> 
     153      </table> 
     154</div> 
     155<div class="memdoc"> 
     156 
     157<p> 
     158Default constructor.  
     159<p> 
     160Creates an empty <a class="el" href="classbdm_1_1shared__ptr.html" title="A naive implementation of roughly a subset of the std::tr1::shared_ptr spec.">shared_ptr</a> - one that doesn't point anywhere.  
     161</div> 
     162</div><p> 
    131163<a class="anchor" name="c8b7f0a813173581530c80d7ac4fc7c2"></a><!-- doxytag: member="bdm::shared_ptr::shared_ptr" ref="c8b7f0a813173581530c80d7ac4fc7c2" args="(T *p)" --> 
    132164<div class="memitem"> 
     
    148180 
    149181<p> 
    150 Constructs a <a class="el" href="classbdm_1_1shared__ptr.html" title="A naive implementation of roughly a subset of the std::tr1:shared_ptr spec.">shared_ptr</a> that owns the pointer p (unless p is NULL, in which case this constructor creates an empty <a class="el" href="classbdm_1_1shared__ptr.html" title="A naive implementation of roughly a subset of the std::tr1:shared_ptr spec.">shared_ptr</a>). When p isn't null, it must have been alllocated by new!  
     182Constructs a <a class="el" href="classbdm_1_1shared__ptr.html" title="A naive implementation of roughly a subset of the std::tr1::shared_ptr spec.">shared_ptr</a> that owns the pointer p (unless p is NULL, in which case this constructor creates an empty <a class="el" href="classbdm_1_1shared__ptr.html" title="A naive implementation of roughly a subset of the std::tr1::shared_ptr spec.">shared_ptr</a>). When p isn't null, it must have been alllocated by new!  
    151183</div> 
    152184</div><p> 
     
    170202 
    171203<p> 
    172 If other is empty, constructs an empty <a class="el" href="classbdm_1_1shared__ptr.html" title="A naive implementation of roughly a subset of the std::tr1:shared_ptr spec.">shared_ptr</a>; otherwise, constructs a <a class="el" href="classbdm_1_1shared__ptr.html" title="A naive implementation of roughly a subset of the std::tr1:shared_ptr spec.">shared_ptr</a> that shares ownership with other.  
     204Copy constructor.  
     205<p> 
     206If other is empty, constructs an empty <a class="el" href="classbdm_1_1shared__ptr.html" title="A naive implementation of roughly a subset of the std::tr1::shared_ptr spec.">shared_ptr</a>; otherwise, constructs a <a class="el" href="classbdm_1_1shared__ptr.html" title="A naive implementation of roughly a subset of the std::tr1::shared_ptr spec.">shared_ptr</a> that shares ownership with other.  
    173207</div> 
    174208</div><p> 
     
    194228 
    195229<p> 
    196 If other is empty, constructs an empty <a class="el" href="classbdm_1_1shared__ptr.html" title="A naive implementation of roughly a subset of the std::tr1:shared_ptr spec.">shared_ptr</a>; otherwise, constructs a <a class="el" href="classbdm_1_1shared__ptr.html" title="A naive implementation of roughly a subset of the std::tr1:shared_ptr spec.">shared_ptr</a> that shares ownership with other.  
     230Generalized copy.  
     231<p> 
     232Allows initialization of shared pointer of a base type from raw pointer to a derived type.<p> 
     233If other is empty, constructs an empty <a class="el" href="classbdm_1_1shared__ptr.html" title="A naive implementation of roughly a subset of the std::tr1::shared_ptr spec.">shared_ptr</a>; otherwise, constructs a <a class="el" href="classbdm_1_1shared__ptr.html" title="A naive implementation of roughly a subset of the std::tr1::shared_ptr spec.">shared_ptr</a> that shares ownership with other.  
     234</div> 
     235</div><p> 
     236<a class="anchor" name="79374842e417d2f64e449e374be4cfc1"></a><!-- doxytag: member="bdm::shared_ptr::~shared_ptr" ref="79374842e417d2f64e449e374be4cfc1" args="()" --> 
     237<div class="memitem"> 
     238<div class="memproto"> 
     239<div class="memtemplate"> 
     240template&lt;typename T&gt; </div> 
     241      <table class="memname"> 
     242        <tr> 
     243          <td class="memname"><a class="el" href="classbdm_1_1shared__ptr.html">bdm::shared_ptr</a>&lt; T &gt;::~<a class="el" href="classbdm_1_1shared__ptr.html">shared_ptr</a>           </td> 
     244          <td>(</td> 
     245          <td class="paramname">          </td> 
     246          <td>&nbsp;)&nbsp;</td> 
     247          <td><code> [inline]</code></td> 
     248        </tr> 
     249      </table> 
     250</div> 
     251<div class="memdoc"> 
     252 
     253<p> 
     254Destructor.  
    197255</div> 
    198256</div><p> 
     
    216274 
    217275<p> 
    218 Returns the stored pointer (which remains owned by this instance).  
     276Returns the stored pointer (which remains owned by this instance). For empty instances, this method returns NULL.  
    219277</div> 
    220278</div><p> 
     
    237295 
    238296<p> 
    239 Returns the stored pointer (which remains owned by this instance).  
    240 <p>Referenced by <a class="el" href="bdmbase_8cpp-source.html#l00309">bdm::mepdf::from_setting()</a>, and <a class="el" href="bdmbase_8h-source.html#l00725">bdm::mepdf::mepdf()</a>.</p> 
    241  
     297Returns the stored pointer (which remains owned by this instance). For empty instances, this method returns NULL.  
     298<p>Referenced by <a class="el" href="bdmbase_8cpp-source.html#l00345">bdm::mepdf::from_setting()</a>, <a class="el" href="bdmbase_8h-source.html#l00719">bdm::mepdf::mepdf()</a>, and <a class="el" href="kalman_8h-source.html#l00120">bdm::Kalman&lt; fsqmat &gt;::posterior()</a>.</p> 
     299 
     300</div> 
     301</div><p> 
     302<a class="anchor" name="6cac71bb600f9f7c6fbed9335fd22d37"></a><!-- doxytag: member="bdm::shared_ptr::operator bool" ref="6cac71bb600f9f7c6fbed9335fd22d37" args="() const " --> 
     303<div class="memitem"> 
     304<div class="memproto"> 
     305<div class="memtemplate"> 
     306template&lt;typename T&gt; </div> 
     307      <table class="memname"> 
     308        <tr> 
     309          <td class="memname"><a class="el" href="classbdm_1_1shared__ptr.html">bdm::shared_ptr</a>&lt; T &gt;::operator bool           </td> 
     310          <td>(</td> 
     311          <td class="paramname">          </td> 
     312          <td>&nbsp;)&nbsp;</td> 
     313          <td> const<code> [inline]</code></td> 
     314        </tr> 
     315      </table> 
     316</div> 
     317<div class="memdoc"> 
     318 
     319<p> 
     320Boolean cast.  
     321<p> 
     322This operator returns true if and only if the instance isn't empty.  
     323</div> 
     324</div><p> 
     325<a class="anchor" name="b3cd369b00369ab92456aa0645e8d560"></a><!-- doxytag: member="bdm::shared_ptr::operator shared_ptr&lt; const U &gt;" ref="b3cd369b00369ab92456aa0645e8d560" args="() const " --> 
     326<div class="memitem"> 
     327<div class="memproto"> 
     328<div class="memtemplate"> 
     329template&lt;typename T&gt; </div> 
     330<div class="memtemplate"> 
     331template&lt;typename U &gt; </div> 
     332      <table class="memname"> 
     333        <tr> 
     334          <td class="memname"><a class="el" href="classbdm_1_1shared__ptr.html">bdm::shared_ptr</a>&lt; T &gt;::operator <a class="el" href="classbdm_1_1shared__ptr.html">shared_ptr</a>&lt; const U &gt;           </td> 
     335          <td>(</td> 
     336          <td class="paramname">          </td> 
     337          <td>&nbsp;)&nbsp;</td> 
     338          <td> const<code> [inline]</code></td> 
     339        </tr> 
     340      </table> 
     341</div> 
     342<div class="memdoc"> 
     343 
     344<p> 
     345const cast  
     346<p> 
     347Shared pointer to T can be converted to shared pointer to const T, just like T * can be converted to T const *.  
    242348</div> 
    243349</div><p> 
     
    323429 
    324430<p> 
    325 Returns the stored pointer (which remains owned by this instance). This method may only be called when the stored pointer isn't NULL.  
     431Dereferences the stored pointer (which remains owned by this instance). This method may only be called when the stored pointer isn't NULL.  
     432</div> 
     433</div><p> 
     434<a class="anchor" name="8e52b8887a4408c52b5263a5717343f2"></a><!-- doxytag: member="bdm::shared_ptr::use_count" ref="8e52b8887a4408c52b5263a5717343f2" args="() const " --> 
     435<div class="memitem"> 
     436<div class="memproto"> 
     437<div class="memtemplate"> 
     438template&lt;typename T&gt; </div> 
     439      <table class="memname"> 
     440        <tr> 
     441          <td class="memname">long <a class="el" href="classbdm_1_1shared__ptr.html">bdm::shared_ptr</a>&lt; T &gt;::use_count           </td> 
     442          <td>(</td> 
     443          <td class="paramname">          </td> 
     444          <td>&nbsp;)&nbsp;</td> 
     445          <td> const<code> [inline]</code></td> 
     446        </tr> 
     447      </table> 
     448</div> 
     449<div class="memdoc"> 
     450 
     451<p> 
     452Returns the number of <a class="el" href="classbdm_1_1shared__ptr.html" title="A naive implementation of roughly a subset of the std::tr1::shared_ptr spec.">shared_ptr</a> instances (including this instance) that share ownership with this instance. For empty instances, this method returns 0.  
    326453</div> 
    327454</div><p> 
     
    329456<li><a class="el" href="shared__ptr_8h-source.html">shared_ptr.h</a></ul> 
    330457</div> 
    331 <hr size="1"><address style="text-align: right;"><small>Generated on Sun Aug 16 17:58:19 2009 for mixpp by&nbsp; 
     458<hr size="1"><address style="text-align: right;"><small>Generated on Sat Aug 29 20:49:46 2009 for mixpp by&nbsp; 
    332459<a href="http://www.doxygen.org/index.html"> 
    333460<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>