forked from boostorg/smart_ptr
Deboldify, clean up intrusive_ptr.html.
This commit is contained in:
Peter Dimov
@ -2,48 +2,48 @@
|
|||||||
<html>
|
<html>
|
||||||
<head>
|
<head>
|
||||||
<title>intrusive_ptr</title>
|
<title>intrusive_ptr</title>
|
||||||
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
|
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
|
||||||
</head>
|
</head>
|
||||||
<body text="#000000" bgColor="#ffffff">
|
<body text="#000000" bgcolor="#ffffff">
|
||||||
<h1><A href="../../index.htm"><IMG height="86" alt="boost.png (6897 bytes)" src="../../boost.png" width="277" align="middle"
|
<h1><a href="../../index.htm"><img height="86" alt="boost.png (6897 bytes)" src="../../boost.png" width="277" align="middle"
|
||||||
border="0"></A>intrusive_ptr class template</h1>
|
border="0" /></a>intrusive_ptr class template</h1>
|
||||||
<p>
|
<p>
|
||||||
<A href="#Introduction">Introduction</A><br>
|
<a href="#Introduction">Introduction</a><br />
|
||||||
<A href="#Synopsis">Synopsis</A><br>
|
<a href="#Synopsis">Synopsis</a><br />
|
||||||
<A href="#Members">Members</A><br>
|
<a href="#Members">Members</a><br />
|
||||||
<A href="#functions">Free Functions</A><br>
|
<a href="#functions">Free Functions</a><br />
|
||||||
</p>
|
</p>
|
||||||
<h2><a name="Introduction">Introduction</a></h2>
|
<h2><a name="Introduction">Introduction</a></h2>
|
||||||
<p>The <b>intrusive_ptr</b> class template stores a pointer to an object with an
|
<p>The <code>intrusive_ptr</code> class template stores a pointer to an object with an
|
||||||
embedded reference count. Every new <b>intrusive_ptr</b> instance increments
|
embedded reference count. Every new <code>intrusive_ptr</code> instance increments
|
||||||
the reference count by using an unqualified call to the function <STRONG>intrusive_ptr_add_ref</STRONG>,
|
the reference count by using an unqualified call to the function <code>intrusive_ptr_add_ref</code>,
|
||||||
passing it the pointer as an argument. Similarly, when an <STRONG>intrusive_ptr</STRONG>
|
passing it the pointer as an argument. Similarly, when an <code>intrusive_ptr</code>
|
||||||
is destroyed, it calls <STRONG>intrusive_ptr_release</STRONG>; this function is
|
is destroyed, it calls <code>intrusive_ptr_release</code>; this function is
|
||||||
responsible for destroying the object when its reference count drops to zero.
|
responsible for destroying the object when its reference count drops to zero.
|
||||||
The user is expected to provide suitable definitions of these two functions. On
|
The user is expected to provide suitable definitions of these two functions. On
|
||||||
compilers that support argument-dependent lookup, <STRONG>intrusive_ptr_add_ref</STRONG>
|
compilers that support argument-dependent lookup, <code>intrusive_ptr_add_ref</code>
|
||||||
and <STRONG>intrusive_ptr_release</STRONG> should be defined in the namespace
|
and <code>intrusive_ptr_release</code> should be defined in the namespace
|
||||||
that corresponds to their parameter; otherwise, the definitions need to go in
|
that corresponds to their parameter; otherwise, the definitions need to go in
|
||||||
namespace <STRONG>boost</STRONG>. The library provides a helper base class template
|
namespace <code>boost</code>. The library provides a helper base class template
|
||||||
<STRONG><a href="intrusive_ref_counter.html">intrusive_ref_counter</a></STRONG> which may
|
<code><a href="intrusive_ref_counter.html">intrusive_ref_counter</a></code> which may
|
||||||
help adding support for <STRONG>intrusive_ptr</STRONG> to user's types.</p>
|
help adding support for <code>intrusive_ptr</code> to user types.</p>
|
||||||
<p>The class template is parameterized on <b>T</b>, the type of the object pointed
|
<p>The class template is parameterized on <code>T</code>, the type of the object pointed
|
||||||
to. <STRONG>intrusive_ptr<T></STRONG> can be implicitly converted to <STRONG>intrusive_ptr<U></STRONG>
|
to. <code>intrusive_ptr<T></code> can be implicitly converted to <code>intrusive_ptr<U></code>
|
||||||
whenever <STRONG>T*</STRONG> can be implicitly converted to <STRONG>U*</STRONG>.</p>
|
whenever <code>T*</code> can be implicitly converted to <code>U*</code>.</p>
|
||||||
<P>The main reasons to use <STRONG>intrusive_ptr</STRONG> are:</P>
|
<p>The main reasons to use <code>intrusive_ptr</code> are:</p>
|
||||||
<UL>
|
<ul>
|
||||||
<LI>
|
<li>
|
||||||
Some existing frameworks or OSes provide objects with embedded reference
|
Some existing frameworks or OSes provide objects with embedded reference
|
||||||
counts;
|
counts;</li>
|
||||||
<LI>
|
<li>
|
||||||
The memory footprint of <STRONG>intrusive_ptr</STRONG>
|
The memory footprint of <code>intrusive_ptr</code>
|
||||||
is the same as the corresponding raw pointer;
|
is the same as the corresponding raw pointer;</li>
|
||||||
<LI>
|
<li>
|
||||||
<STRONG>intrusive_ptr<T></STRONG> can be constructed from an arbitrary
|
<code>intrusive_ptr<T></code> can be constructed from an arbitrary
|
||||||
raw pointer of type <STRONG>T *</STRONG>.</LI></UL>
|
raw pointer of type <code>T *</code>.</li></ul>
|
||||||
<P>As a general rule, if it isn't obvious whether <STRONG>intrusive_ptr</STRONG> better
|
<p>As a general rule, if it isn't obvious whether <code>intrusive_ptr</code> better
|
||||||
fits your needs than <STRONG>shared_ptr</STRONG>, try a <STRONG>shared_ptr</STRONG>-based
|
fits your needs than <code>shared_ptr</code>, try a <code>shared_ptr</code>-based
|
||||||
design first.</P>
|
design first.</p>
|
||||||
<h2><a name="Synopsis">Synopsis</a></h2>
|
<h2><a name="Synopsis">Synopsis</a></h2>
|
||||||
<pre>namespace boost {
|
<pre>namespace boost {
|
||||||
|
|
||||||
@ -51,77 +51,77 @@
|
|||||||
|
|
||||||
public:
|
public:
|
||||||
|
|
||||||
typedef T <A href="#element_type" >element_type</A>;
|
typedef T <a href="#element_type" >element_type</a>;
|
||||||
|
|
||||||
<A href="#constructors" >intrusive_ptr</A>(); // never throws
|
<a href="#constructors" >intrusive_ptr</a>(); // never throws
|
||||||
<A href="#constructors" >intrusive_ptr</A>(T * p, bool add_ref = true);
|
<a href="#constructors" >intrusive_ptr</a>(T * p, bool add_ref = true);
|
||||||
|
|
||||||
<A href="#constructors" >intrusive_ptr</A>(intrusive_ptr const & r);
|
<a href="#constructors" >intrusive_ptr</a>(intrusive_ptr const & r);
|
||||||
template<class Y> <A href="#constructors" >intrusive_ptr</A>(intrusive_ptr<Y> const & r);
|
template<class Y> <a href="#constructors" >intrusive_ptr</a>(intrusive_ptr<Y> const & r);
|
||||||
|
|
||||||
<A href="#destructor" >~intrusive_ptr</A>();
|
<a href="#destructor" >~intrusive_ptr</a>();
|
||||||
|
|
||||||
intrusive_ptr & <A href="#assignment" >operator=</A>(intrusive_ptr const & r);
|
intrusive_ptr & <a href="#assignment" >operator=</a>(intrusive_ptr const & r);
|
||||||
template<class Y> intrusive_ptr & <A href="#assignment" >operator=</A>(intrusive_ptr<Y> const & r);
|
template<class Y> intrusive_ptr & <a href="#assignment" >operator=</a>(intrusive_ptr<Y> const & r);
|
||||||
intrusive_ptr & <A href="#assignment" >operator=</A>(T * r);
|
intrusive_ptr & <a href="#assignment" >operator=</a>(T * r);
|
||||||
|
|
||||||
void <a href="#reset" >reset</a>();
|
void <a href="#reset" >reset</a>();
|
||||||
void <a href="#reset" >reset</a>(T * r);
|
void <a href="#reset" >reset</a>(T * r);
|
||||||
void <a href="#reset" >reset</a>(T * r, bool add_ref);
|
void <a href="#reset" >reset</a>(T * r, bool add_ref);
|
||||||
|
|
||||||
T & <A href="#indirection" >operator*</A>() const; // never throws
|
T & <a href="#indirection" >operator*</a>() const; // never throws
|
||||||
T * <A href="#indirection" >operator-></A>() const; // never throws
|
T * <a href="#indirection" >operator-></a>() const; // never throws
|
||||||
T * <A href="#get" >get</A>() const; // never throws
|
T * <a href="#get" >get</a>() const; // never throws
|
||||||
T * <A href="#detach" >detach</A>(); // never throws
|
T * <a href="#detach" >detach</a>(); // never throws
|
||||||
|
|
||||||
operator <A href="#conversions" ><i>unspecified-bool-type</i></A>() const; // never throws
|
operator <a href="#conversions" ><i>unspecified-bool-type</i></a>() const; // never throws
|
||||||
|
|
||||||
void <A href="#swap" >swap</A>(intrusive_ptr & b); // never throws
|
void <a href="#swap" >swap</a>(intrusive_ptr & b); // never throws
|
||||||
};
|
};
|
||||||
|
|
||||||
template<class T, class U>
|
template<class T, class U>
|
||||||
bool <A href="#comparison" >operator==</A>(intrusive_ptr<T> const & a, intrusive_ptr<U> const & b); // never throws
|
bool <a href="#comparison" >operator==</a>(intrusive_ptr<T> const & a, intrusive_ptr<U> const & b); // never throws
|
||||||
|
|
||||||
template<class T, class U>
|
template<class T, class U>
|
||||||
bool <A href="#comparison" >operator!=</A>(intrusive_ptr<T> const & a, intrusive_ptr<U> const & b); // never throws
|
bool <a href="#comparison" >operator!=</a>(intrusive_ptr<T> const & a, intrusive_ptr<U> const & b); // never throws
|
||||||
|
|
||||||
template<class T>
|
template<class T>
|
||||||
bool <A href="#comparison" >operator==</A>(intrusive_ptr<T> const & a, T * b); // never throws
|
bool <a href="#comparison" >operator==</a>(intrusive_ptr<T> const & a, T * b); // never throws
|
||||||
|
|
||||||
template<class T>
|
template<class T>
|
||||||
bool <A href="#comparison" >operator!=</A>(intrusive_ptr<T> const & a, T * b); // never throws
|
bool <a href="#comparison" >operator!=</a>(intrusive_ptr<T> const & a, T * b); // never throws
|
||||||
|
|
||||||
template<class T>
|
template<class T>
|
||||||
bool <A href="#comparison" >operator==</A>(T * a, intrusive_ptr<T> const & b); // never throws
|
bool <a href="#comparison" >operator==</a>(T * a, intrusive_ptr<T> const & b); // never throws
|
||||||
|
|
||||||
template<class T>
|
template<class T>
|
||||||
bool <A href="#comparison" >operator!=</A>(T * a, intrusive_ptr<T> const & b); // never throws
|
bool <a href="#comparison" >operator!=</a>(T * a, intrusive_ptr<T> const & b); // never throws
|
||||||
|
|
||||||
template<class T, class U>
|
template<class T, class U>
|
||||||
bool <A href="#comparison" >operator<</A>(intrusive_ptr<T> const & a, intrusive_ptr<U> const & b); // never throws
|
bool <a href="#comparison" >operator<</a>(intrusive_ptr<T> const & a, intrusive_ptr<U> const & b); // never throws
|
||||||
|
|
||||||
template<class T> void <A href="#free-swap" >swap</A>(intrusive_ptr<T> & a, intrusive_ptr<T> & b); // never throws
|
template<class T> void <a href="#free-swap" >swap</a>(intrusive_ptr<T> & a, intrusive_ptr<T> & b); // never throws
|
||||||
|
|
||||||
template<class T> T * <A href="#get_pointer" >get_pointer</A>(intrusive_ptr<T> const & p); // never throws
|
template<class T> T * <a href="#get_pointer" >get_pointer</a>(intrusive_ptr<T> const & p); // never throws
|
||||||
|
|
||||||
template<class T, class U>
|
template<class T, class U>
|
||||||
intrusive_ptr<T> <A href="#static_pointer_cast" >static_pointer_cast</A>(intrusive_ptr<U> const & r); // never throws
|
intrusive_ptr<T> <a href="#static_pointer_cast" >static_pointer_cast</a>(intrusive_ptr<U> const & r); // never throws
|
||||||
|
|
||||||
template<class T, class U>
|
template<class T, class U>
|
||||||
intrusive_ptr<T> <A href="#const_pointer_cast" >const_pointer_cast</A>(intrusive_ptr<U> const & r); // never throws
|
intrusive_ptr<T> <a href="#const_pointer_cast" >const_pointer_cast</a>(intrusive_ptr<U> const & r); // never throws
|
||||||
|
|
||||||
template<class T, class U>
|
template<class T, class U>
|
||||||
intrusive_ptr<T> <A href="#dynamic_pointer_cast" >dynamic_pointer_cast</A>(intrusive_ptr<U> const & r); // never throws
|
intrusive_ptr<T> <a href="#dynamic_pointer_cast" >dynamic_pointer_cast</a>(intrusive_ptr<U> const & r); // never throws
|
||||||
|
|
||||||
template<class E, class T, class Y>
|
template<class E, class T, class Y>
|
||||||
std::basic_ostream<E, T> & <A href="#insertion-operator" >operator<<</A> (std::basic_ostream<E, T> & os, intrusive_ptr<Y> const & p);
|
std::basic_ostream<E, T> & <a href="#insertion-operator" >operator<<</a> (std::basic_ostream<E, T> & os, intrusive_ptr<Y> const & p);
|
||||||
|
|
||||||
}</pre>
|
}</pre>
|
||||||
<h2><a name="Members">Members</a></h2>
|
<h2><a name="Members">Members</a></h2>
|
||||||
<h3><a name="element_type">element_type</a></h3>
|
<h3><a name="element_type">element_type</a></h3>
|
||||||
<pre>typedef T element_type;</pre>
|
<pre>typedef T element_type;</pre>
|
||||||
<blockquote>
|
<blockquote>
|
||||||
<p>Provides the type of the template parameter T.</p>
|
<p>Provides the type of the template parameter <code>T</code>.</p>
|
||||||
</blockquote>
|
</blockquote>
|
||||||
<h3><a name="constructors">constructors</a></h3>
|
<h3><a name="constructors">constructors</a></h3>
|
||||||
<pre>intrusive_ptr(); // never throws</pre>
|
<pre>intrusive_ptr(); // never throws</pre>
|
||||||
@ -142,30 +142,30 @@ template<class Y> intrusive_ptr(intrusive_ptr<Y> const & r);</pr
|
|||||||
</blockquote>
|
</blockquote>
|
||||||
<h3><a name="destructor">destructor</a></h3>
|
<h3><a name="destructor">destructor</a></h3>
|
||||||
<pre>~intrusive_ptr();</pre>
|
<pre>~intrusive_ptr();</pre>
|
||||||
<BLOCKQUOTE>
|
<blockquote>
|
||||||
<P><B>Effects:</B> <code>if(get() != 0) intrusive_ptr_release(get());</code>.</P>
|
<p><b>Effects:</b> <code>if(get() != 0) intrusive_ptr_release(get());</code>.</p>
|
||||||
</BLOCKQUOTE>
|
</blockquote>
|
||||||
<H3><a name="assignment">assignment</a></H3>
|
<h3><a name="assignment">assignment</a></h3>
|
||||||
<pre>intrusive_ptr & operator=(intrusive_ptr const & r);
|
<pre>intrusive_ptr & operator=(intrusive_ptr const & r);
|
||||||
template<class Y> intrusive_ptr & operator=(intrusive_ptr<Y> const & r);
|
template<class Y> intrusive_ptr & operator=(intrusive_ptr<Y> const & r);
|
||||||
intrusive_ptr & operator=(T * r);</pre>
|
intrusive_ptr & operator=(T * r);</pre>
|
||||||
<BLOCKQUOTE>
|
<blockquote>
|
||||||
<P><B>Effects:</B> Equivalent to <code>intrusive_ptr(r).swap(*this)</code>.</P>
|
<p><b>Effects:</b> Equivalent to <code>intrusive_ptr(r).swap(*this)</code>.</p>
|
||||||
<P><B>Returns:</B> <code>*this</code>.</P>
|
<p><b>Returns:</b> <code>*this</code>.</p>
|
||||||
</BLOCKQUOTE>
|
</blockquote>
|
||||||
<H3><a name="reset">reset</a></H3>
|
<h3><a name="reset">reset</a></h3>
|
||||||
<pre>void reset();</pre>
|
<pre>void reset();</pre>
|
||||||
<BLOCKQUOTE>
|
<blockquote>
|
||||||
<P><B>Effects:</B> Equivalent to <code>intrusive_ptr().swap(*this)</code>.</P>
|
<p><b>Effects:</b> Equivalent to <code>intrusive_ptr().swap(*this)</code>.</p>
|
||||||
</BLOCKQUOTE>
|
</blockquote>
|
||||||
<pre>void reset(T * r);</pre>
|
<pre>void reset(T * r);</pre>
|
||||||
<BLOCKQUOTE>
|
<blockquote>
|
||||||
<P><B>Effects:</B> Equivalent to <code>intrusive_ptr(r).swap(*this)</code>.</P>
|
<p><b>Effects:</b> Equivalent to <code>intrusive_ptr(r).swap(*this)</code>.</p>
|
||||||
</BLOCKQUOTE>
|
</blockquote>
|
||||||
<pre>void reset(T * r, bool add_ref);</pre>
|
<pre>void reset(T * r, bool add_ref);</pre>
|
||||||
<BLOCKQUOTE>
|
<blockquote>
|
||||||
<P><B>Effects:</B> Equivalent to <code>intrusive_ptr(r, add_ref).swap(*this)</code>.</P>
|
<p><b>Effects:</b> Equivalent to <code>intrusive_ptr(r, add_ref).swap(*this)</code>.</p>
|
||||||
</BLOCKQUOTE>
|
</blockquote>
|
||||||
<h3><a name="indirection">indirection</a></h3>
|
<h3><a name="indirection">indirection</a></h3>
|
||||||
<pre>T & operator*() const; // never throws</pre>
|
<pre>T & operator*() const; // never throws</pre>
|
||||||
<blockquote>
|
<blockquote>
|
||||||
@ -192,7 +192,7 @@ intrusive_ptr & operator=(T * r);</pre>
|
|||||||
<p><b>Throws:</b> nothing.</p>
|
<p><b>Throws:</b> nothing.</p>
|
||||||
<p><b>Postconditions:</b> <code>get() == 0</code>.</p>
|
<p><b>Postconditions:</b> <code>get() == 0</code>.</p>
|
||||||
<p><b>Notes:</b> The returned pointer has an elevated reference count. This
|
<p><b>Notes:</b> The returned pointer has an elevated reference count. This
|
||||||
allows conversion of an <b>intrusive_ptr</b> back to a raw pointer,
|
allows conversion of an <code>intrusive_ptr</code> back to a raw pointer,
|
||||||
without the performance overhead of acquiring and dropping an extra
|
without the performance overhead of acquiring and dropping an extra
|
||||||
reference. It can be viewed as the complement of the
|
reference. It can be viewed as the complement of the
|
||||||
non-reference-incrementing constructor.</p>
|
non-reference-incrementing constructor.</p>
|
||||||
@ -207,10 +207,10 @@ intrusive_ptr & operator=(T * r);</pre>
|
|||||||
<p><b>Returns:</b> an unspecified value that, when used in boolean contexts, is
|
<p><b>Returns:</b> an unspecified value that, when used in boolean contexts, is
|
||||||
equivalent to <code>get() != 0</code>.</p>
|
equivalent to <code>get() != 0</code>.</p>
|
||||||
<p><b>Throws:</b> nothing.</p>
|
<p><b>Throws:</b> nothing.</p>
|
||||||
<P><B>Notes:</B> This conversion operator allows <b>intrusive_ptr</b> objects to be
|
<p><b>Notes:</b> This conversion operator allows <code>intrusive_ptr</code> objects to be
|
||||||
used in boolean contexts, like <code>if (p && p->valid()) {}</code>.
|
used in boolean contexts, like <code>if (p && p->valid()) {}</code>.
|
||||||
The actual target type is typically a pointer to a member function, avoiding
|
The actual target type is typically a pointer to a member function, avoiding
|
||||||
many of the implicit conversion pitfalls.</P>
|
many of the implicit conversion pitfalls.</p>
|
||||||
</blockquote>
|
</blockquote>
|
||||||
<h3><a name="swap">swap</a></h3>
|
<h3><a name="swap">swap</a></h3>
|
||||||
<pre>void swap(intrusive_ptr & b); // never throws</pre>
|
<pre>void swap(intrusive_ptr & b); // never throws</pre>
|
||||||
@ -261,59 +261,59 @@ intrusive_ptr & operator=(T * r);</pre>
|
|||||||
<blockquote>
|
<blockquote>
|
||||||
<p><b>Returns:</b> <code>std::less<T *>()(a.get(), b.get())</code>.</p>
|
<p><b>Returns:</b> <code>std::less<T *>()(a.get(), b.get())</code>.</p>
|
||||||
<p><b>Throws:</b> nothing.</p>
|
<p><b>Throws:</b> nothing.</p>
|
||||||
<P><B>Notes:</B> Allows <STRONG>intrusive_ptr</STRONG> objects to be used as keys
|
<p><b>Notes:</b> Allows <code>intrusive_ptr</code> objects to be used as keys
|
||||||
in associative containers.</P>
|
in associative containers.</p>
|
||||||
</blockquote>
|
</blockquote>
|
||||||
<h3><a name="free-swap">swap</a></h3>
|
<h3><a name="free-swap">swap</a></h3>
|
||||||
<pre>template<class T>
|
<pre>template<class T>
|
||||||
void swap(intrusive_ptr<T> & a, intrusive_ptr<T> & b); // never throws</pre>
|
void swap(intrusive_ptr<T> & a, intrusive_ptr<T> & b); // never throws</pre>
|
||||||
<BLOCKQUOTE>
|
<blockquote>
|
||||||
<P><B>Effects:</B> Equivalent to <code>a.swap(b)</code>.</P>
|
<p><b>Effects:</b> Equivalent to <code>a.swap(b)</code>.</p>
|
||||||
<P><B>Throws:</B> nothing.</P>
|
<p><b>Throws:</b> nothing.</p>
|
||||||
<P><B>Notes:</B> Matches the interface of <B>std::swap</B>. Provided as an aid to
|
<p><b>Notes:</b> Matches the interface of <code>std::swap</code>. Provided as an aid to
|
||||||
generic programming.</P>
|
generic programming.</p>
|
||||||
</BLOCKQUOTE>
|
</blockquote>
|
||||||
<h3><a name="get_pointer">get_pointer</a></h3>
|
<h3><a name="get_pointer">get_pointer</a></h3>
|
||||||
<pre>template<class T>
|
<pre>template<class T>
|
||||||
T * get_pointer(intrusive_ptr<T> const & p); // never throws</pre>
|
T * get_pointer(intrusive_ptr<T> const & p); // never throws</pre>
|
||||||
<BLOCKQUOTE>
|
<blockquote>
|
||||||
<P><B>Returns:</B> <code>p.get()</code>.</P>
|
<p><b>Returns:</b> <code>p.get()</code>.</p>
|
||||||
<P><B>Throws:</B> nothing.</P>
|
<p><b>Throws:</b> nothing.</p>
|
||||||
<P><B>Notes:</B> Provided as an aid to generic programming. Used by <A href="../bind/mem_fn.html">
|
<p><b>Notes:</b> Provided as an aid to generic programming. Used by <a href="../bind/mem_fn.html">
|
||||||
mem_fn</A>.</P>
|
mem_fn</a>.</p>
|
||||||
</BLOCKQUOTE>
|
</blockquote>
|
||||||
<h3><a name="static_pointer_cast">static_pointer_cast</a></h3>
|
<h3><a name="static_pointer_cast">static_pointer_cast</a></h3>
|
||||||
<pre>template<class T, class U>
|
<pre>template<class T, class U>
|
||||||
intrusive_ptr<T> static_pointer_cast(intrusive_ptr<U> const & r); // never throws</pre>
|
intrusive_ptr<T> static_pointer_cast(intrusive_ptr<U> const & r); // never throws</pre>
|
||||||
<BLOCKQUOTE>
|
<blockquote>
|
||||||
<P><B>Returns:</B> <code>intrusive_ptr<T>(static_cast<T*>(r.get()))</code>.</P>
|
<p><b>Returns:</b> <code>intrusive_ptr<T>(static_cast<T*>(r.get()))</code>.</p>
|
||||||
<P><B>Throws:</B> nothing.</P>
|
<p><b>Throws:</b> nothing.</p>
|
||||||
</BLOCKQUOTE>
|
</blockquote>
|
||||||
<h3><a name="const_pointer_cast">const_pointer_cast</a></h3>
|
<h3><a name="const_pointer_cast">const_pointer_cast</a></h3>
|
||||||
<pre>template<class T, class U>
|
<pre>template<class T, class U>
|
||||||
intrusive_ptr<T> const_pointer_cast(intrusive_ptr<U> const & r); // never throws</pre>
|
intrusive_ptr<T> const_pointer_cast(intrusive_ptr<U> const & r); // never throws</pre>
|
||||||
<BLOCKQUOTE>
|
<blockquote>
|
||||||
<P><B>Returns:</B> <code>intrusive_ptr<T>(const_cast<T*>(r.get()))</code>.</P>
|
<p><b>Returns:</b> <code>intrusive_ptr<T>(const_cast<T*>(r.get()))</code>.</p>
|
||||||
<P><B>Throws:</B> nothing.</P>
|
<p><b>Throws:</b> nothing.</p>
|
||||||
</BLOCKQUOTE>
|
</blockquote>
|
||||||
<h3><a name="dynamic_pointer_cast">dynamic_pointer_cast</a></h3>
|
<h3><a name="dynamic_pointer_cast">dynamic_pointer_cast</a></h3>
|
||||||
<pre>template<class T, class U>
|
<pre>template<class T, class U>
|
||||||
intrusive_ptr<T> dynamic_pointer_cast(intrusive_ptr<U> const & r);</pre>
|
intrusive_ptr<T> dynamic_pointer_cast(intrusive_ptr<U> const & r);</pre>
|
||||||
<BLOCKQUOTE>
|
<blockquote>
|
||||||
<P><B>Returns:</B> <code>intrusive_ptr<T>(dynamic_cast<T*>(r.get()))</code>.</P>
|
<p><b>Returns:</b> <code>intrusive_ptr<T>(dynamic_cast<T*>(r.get()))</code>.</p>
|
||||||
<P><B>Throws:</B> nothing.</P>
|
<p><b>Throws:</b> nothing.</p>
|
||||||
</BLOCKQUOTE>
|
</blockquote>
|
||||||
<h3><a name="insertion-operator">operator<<</a></h3>
|
<h3><a name="insertion-operator">operator<<</a></h3>
|
||||||
<pre>template<class E, class T, class Y>
|
<pre>template<class E, class T, class Y>
|
||||||
std::basic_ostream<E, T> & operator<< (std::basic_ostream<E, T> & os, intrusive_ptr<Y> const & p);</pre>
|
std::basic_ostream<E, T> & operator<< (std::basic_ostream<E, T> & os, intrusive_ptr<Y> const & p);</pre>
|
||||||
<BLOCKQUOTE>
|
<blockquote>
|
||||||
<p><STRONG>Effects:</STRONG> <code>os << p.get();</code>.</p>
|
<p><b>Effects:</b> <code>os << p.get();</code>.</p>
|
||||||
<P><B>Returns:</B> <code>os</code>.</P>
|
<p><b>Returns:</b> <code>os</code>.</p>
|
||||||
</BLOCKQUOTE>
|
</blockquote>
|
||||||
<hr>
|
<hr />
|
||||||
<p>
|
<p>
|
||||||
<small>Copyright <20> 2003-2005, 2013 Peter Dimov. Distributed under the Boost Software License, Version
|
<small>Copyright <20> 2003-2005, 2013 Peter Dimov. Distributed under the Boost Software License, Version
|
||||||
1.0. See accompanying file <A href="../../LICENSE_1_0.txt">LICENSE_1_0.txt</A> or
|
1.0. See accompanying file <a href="../../LICENSE_1_0.txt">LICENSE_1_0.txt</a> or
|
||||||
copy at <A href="http://www.boost.org/LICENSE_1_0.txt">http://www.boost.org/LICENSE_1_0.txt</A>.</small></p>
|
copy at <a href="http://www.boost.org/LICENSE_1_0.txt">http://www.boost.org/LICENSE_1_0.txt</a>.</small></p>
|
||||||
</body>
|
</body>
|
||||||
</html>
|
</html>
|
||||||
|
|||||||
Reference in New Issue
Block a user