libstdc++
std::shared_ptr< _Tp > Class Template Reference
Inheritance diagram for std::shared_ptr< _Tp >:

List of all members.

Public Types

typedef _Tp element_type

Public Member Functions

constexpr shared_ptr () noexcept
 shared_ptr (const shared_ptr &) noexcept
template<typename _Tp1 >
 shared_ptr (_Tp1 *__p)
template<typename _Tp1 , typename _Deleter >
 shared_ptr (_Tp1 *__p, _Deleter __d)
template<typename _Deleter >
 shared_ptr (nullptr_t __p, _Deleter __d)
template<typename _Tp1 , typename _Deleter , typename _Alloc >
 shared_ptr (_Tp1 *__p, _Deleter __d, _Alloc __a)
template<typename _Deleter , typename _Alloc >
 shared_ptr (nullptr_t __p, _Deleter __d, _Alloc __a)
template<typename _Tp1 >
 shared_ptr (const shared_ptr< _Tp1 > &__r, _Tp *__p) noexcept
template<typename _Tp1 , typename = typename std::enable_if<std::is_convertible<_Tp1*, _Tp*>::value>::type>
 shared_ptr (const shared_ptr< _Tp1 > &__r) noexcept
 shared_ptr (shared_ptr &&__r) noexcept
template<typename _Tp1 , typename = typename std::enable_if<std::is_convertible<_Tp1*, _Tp*>::value>::type>
 shared_ptr (shared_ptr< _Tp1 > &&__r) noexcept
template<typename _Tp1 >
 shared_ptr (const weak_ptr< _Tp1 > &__r)
template<typename _Tp1 , typename _Del >
 shared_ptr (std::unique_ptr< _Tp1, _Del > &&__r)
constexpr shared_ptr (nullptr_t __p) noexcept
_Tp * get () const noexcept
 operator bool () const
std::add_lvalue_reference< _Tp >
::type 
operator* () const noexcept
_Tp * operator-> () const noexcept
shared_ptroperator= (const shared_ptr &) noexcept
template<typename _Tp1 >
shared_ptroperator= (const shared_ptr< _Tp1 > &__r) noexcept
shared_ptroperator= (shared_ptr &&__r) noexcept
template<class _Tp1 >
shared_ptroperator= (shared_ptr< _Tp1 > &&__r) noexcept
template<typename _Tp1 , typename _Del >
shared_ptroperator= (std::unique_ptr< _Tp1, _Del > &&__r)
template<typename _Tp1 >
bool owner_before (__shared_ptr< _Tp1, _Lp > const &__rhs) const
template<typename _Tp1 >
bool owner_before (__weak_ptr< _Tp1, _Lp > const &__rhs) const
void reset () noexcept
template<typename _Tp1 >
void reset (_Tp1 *__p)
template<typename _Tp1 , typename _Deleter >
void reset (_Tp1 *__p, _Deleter __d)
template<typename _Tp1 , typename _Deleter , typename _Alloc >
void reset (_Tp1 *__p, _Deleter __d, _Alloc __a)
void swap (__shared_ptr< _Tp, _Lp > &__other) noexcept
bool unique () const noexcept
long use_count () const noexcept

Friends

template<typename _Tp1 , typename _Alloc , typename... _Args>
shared_ptr< _Tp1 > allocate_shared (const _Alloc &__a, _Args &&...__args)

Detailed Description

template<typename _Tp>
class std::shared_ptr< _Tp >

A smart pointer with reference-counted copy semantics.

The object pointed to is deleted when the last shared_ptr pointing to it is destroyed or reset.

Definition at line 93 of file shared_ptr.h.


Constructor & Destructor Documentation

template<typename _Tp>
constexpr std::shared_ptr< _Tp >::shared_ptr ( )
inline

Construct an empty shared_ptr.

Postcondition:
use_count()==0 && get()==0

Definition at line 100 of file shared_ptr.h.

template<typename _Tp>
template<typename _Tp1 >
std::shared_ptr< _Tp >::shared_ptr ( _Tp1 *  __p)
inlineexplicit

Construct a shared_ptr that owns the pointer __p.

Parameters:
__pA pointer that is convertible to element_type*.
Postcondition:
use_count() == 1 && get() == __p
Exceptions:
std::bad_alloc,inwhich case delete __p is called.

Definition at line 112 of file shared_ptr.h.

template<typename _Tp>
template<typename _Tp1 , typename _Deleter >
std::shared_ptr< _Tp >::shared_ptr ( _Tp1 *  __p,
_Deleter  __d 
)
inline

Construct a shared_ptr that owns the pointer __p and the deleter __d.

Parameters:
__pA pointer.
__dA deleter.
Postcondition:
use_count() == 1 && get() == __p
Exceptions:
std::bad_alloc,inwhich case __d(__p) is called.

Requirements: _Deleter's copy constructor and destructor must not throw

__shared_ptr will release __p by calling __d(__p)

Definition at line 129 of file shared_ptr.h.

template<typename _Tp>
template<typename _Deleter >
std::shared_ptr< _Tp >::shared_ptr ( nullptr_t  __p,
_Deleter  __d 
)
inline

Construct a shared_ptr that owns a null pointer and the deleter __d.

Parameters:
__pA null pointer constant.
__dA deleter.
Postcondition:
use_count() == 1 && get() == __p
Exceptions:
std::bad_alloc,inwhich case __d(__p) is called.

Requirements: _Deleter's copy constructor and destructor must not throw

The last owner will call __d(__p)

Definition at line 146 of file shared_ptr.h.

template<typename _Tp>
template<typename _Tp1 , typename _Deleter , typename _Alloc >
std::shared_ptr< _Tp >::shared_ptr ( _Tp1 *  __p,
_Deleter  __d,
_Alloc  __a 
)
inline

Construct a shared_ptr that owns the pointer __p and the deleter __d.

Parameters:
__pA pointer.
__dA deleter.
__aAn allocator.
Postcondition:
use_count() == 1 && get() == __p
Exceptions:
std::bad_alloc,inwhich case __d(__p) is called.

Requirements: _Deleter's copy constructor and destructor must not throw _Alloc's copy constructor and destructor must not throw.

__shared_ptr will release __p by calling __d(__p)

Definition at line 165 of file shared_ptr.h.

template<typename _Tp>
template<typename _Deleter , typename _Alloc >
std::shared_ptr< _Tp >::shared_ptr ( nullptr_t  __p,
_Deleter  __d,
_Alloc  __a 
)
inline

Construct a shared_ptr that owns a null pointer and the deleter __d.

Parameters:
__pA null pointer constant.
__dA deleter.
__aAn allocator.
Postcondition:
use_count() == 1 && get() == __p
Exceptions:
std::bad_alloc,inwhich case __d(__p) is called.

Requirements: _Deleter's copy constructor and destructor must not throw _Alloc's copy constructor and destructor must not throw.

The last owner will call __d(__p)

Definition at line 184 of file shared_ptr.h.

template<typename _Tp>
template<typename _Tp1 >
std::shared_ptr< _Tp >::shared_ptr ( const shared_ptr< _Tp1 > &  __r,
_Tp *  __p 
)
inline

Constructs a shared_ptr instance that stores __p and shares ownership with __r.

Parameters:
<strong>rA shared_ptr.
__pA pointer that will remain valid while *r is valid.
Postcondition:
get() == __p && use_count() == __r.use_count()

This can be used to construct a shared_ptr to a sub-object of an object managed by an existing shared_ptr.

shared_ptr< pair<int,int> > pii(new pair<int,int>());
shared_ptr<int> pi(pii, &pii->first);
assert(pii.use_count() == 2);

Definition at line 206 of file shared_ptr.h.

template<typename _Tp>
template<typename _Tp1 , typename = typename std::enable_if<std::is_convertible<_Tp1*, _Tp*>::value>::type>
std::shared_ptr< _Tp >::shared_ptr ( const shared_ptr< _Tp1 > &  __r)
inline

If __r is empty, constructs an empty shared_ptr; otherwise construct a shared_ptr that shares ownership with __r.

Parameters:
__rA shared_ptr.
Postcondition:
get() == __r.get() && use_count() == __r.use_count()

Definition at line 218 of file shared_ptr.h.

template<typename _Tp>
std::shared_ptr< _Tp >::shared_ptr ( shared_ptr< _Tp > &&  __r)
inline

Move-constructs a shared_ptr instance from __r.

Parameters:
__rA shared_ptr rvalue.
Postcondition:
*this contains the old value of __r, __r is empty.

Definition at line 226 of file shared_ptr.h.

template<typename _Tp>
template<typename _Tp1 , typename = typename std::enable_if<std::is_convertible<_Tp1*, _Tp*>::value>::type>
std::shared_ptr< _Tp >::shared_ptr ( shared_ptr< _Tp1 > &&  __r)
inline

Move-constructs a shared_ptr instance from __r.

Parameters:
__rA shared_ptr rvalue.
Postcondition:
*this contains the old value of __r, __r is empty.

Definition at line 236 of file shared_ptr.h.

template<typename _Tp>
template<typename _Tp1 >
std::shared_ptr< _Tp >::shared_ptr ( const weak_ptr< _Tp1 > &  __r)
inlineexplicit

Constructs a shared_ptr that shares ownership with __r and stores a copy of the pointer stored in __r.

Parameters:
__rA weak_ptr.
Postcondition:
use_count() == __r.use_count()
Exceptions:
bad_weak_ptrwhen __r.expired(), in which case the constructor has no effect.

Definition at line 248 of file shared_ptr.h.

template<typename _Tp>
constexpr std::shared_ptr< _Tp >::shared_ptr ( nullptr_t  __p)
inline

Construct an empty shared_ptr.

Parameters:
__pA null pointer constant.
Postcondition:
use_count() == 0 && get() == nullptr

Definition at line 266 of file shared_ptr.h.


Friends And Related Function Documentation

template<typename _Tp>
template<typename _Tp1 , typename _Alloc , typename... _Args>
shared_ptr<_Tp1> allocate_shared ( const _Alloc &  __a,
_Args &&...  __args 
)
friend

Create an object that is owned by a shared_ptr.

Parameters:
__aAn allocator.
__argsArguments for the _Tp object's constructor.
Returns:
A shared_ptr that owns the newly created object.
Exceptions:
Anexception thrown from _Alloc::allocate or from the constructor of _Tp.

A copy of __a will be used to allocate memory for the shared_ptr and the new object.

Definition at line 596 of file shared_ptr.h.


The documentation for this class was generated from the following file: