libstdc++
std::shared_ptr Class Reference
Inheritance diagram for std::shared_ptr:

List of all members.

Public Types

Public Member Functions

Friends


Detailed Description

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.


Constructor & Destructor Documentation

constexpr std::shared_ptr::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 _Tp1 >
std::shared_ptr::shared_ptr ( _Tp1 *  __p) [inline, explicit]

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 110 of file shared_ptr.h.

template<typename _Tp1 , typename _Deleter >
std::shared_ptr::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 127 of file shared_ptr.h.

template<typename _Deleter >
std::shared_ptr::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 144 of file shared_ptr.h.

template<typename _Tp1 , typename _Deleter , typename _Alloc >
std::shared_ptr::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 163 of file shared_ptr.h.

template<typename _Deleter , typename _Alloc >
std::shared_ptr::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 182 of file shared_ptr.h.

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

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

Parameters:
__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 204 of file shared_ptr.h.

template<typename _Tp1 , typename = typename std::enable_if<std::is_convertible<_Tp1*, _Tp*>::value>::type>
std::shared_ptr::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 216 of file shared_ptr.h.

std::shared_ptr::shared_ptr ( shared_ptr &&  __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 224 of file shared_ptr.h.

template<typename _Tp1 , typename = typename std::enable_if<std::is_convertible<_Tp1*, _Tp*>::value>::type>
std::shared_ptr::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 234 of file shared_ptr.h.

template<typename _Tp1 >
std::shared_ptr::shared_ptr ( const weak_ptr< _Tp1 > &  __r) [inline, explicit]

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 246 of file shared_ptr.h.

constexpr std::shared_ptr::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 264 of file shared_ptr.h.


Friends And Related Function Documentation

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 528 of file shared_ptr.h.


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