An implementation of shared pointers that is broadly similar to C++11 shared_ptr (https://en.cppreference.com/w/cpp/memory/shared_ptr). More...
#include <fastjet/SharedPtr.hh>
Public Member Functions | |
| SharedPtr () | |
| default ctor | |
| template<class Y > | |
| SharedPtr (Y *ptr) | |
| initialise with the main data More... | |
| SharedPtr (SharedPtr const &share) | |
| overload the copy ctor so that it updates count More... | |
| ~SharedPtr () | |
| default dtor | |
| void | reset () |
| reset the pointer to default value (NULL) | |
| template<class Y > | |
| void | reset (Y *ptr) |
| reset from a pointer | |
| template<class Y > | |
| void | reset (SharedPtr< Y > const &share) |
| do a smart copy More... | |
| SharedPtr & | operator= (SharedPtr const &share) |
| overload the = operator so that it updates count More... | |
| template<class Y > | |
| SharedPtr & | operator= (SharedPtr< Y > const &share) |
| overload the = operator so that it updates count More... | |
| T * | operator() () const |
| return the pointer we're pointing to More... | |
| T & | operator* () const |
| indirection, get a reference to the stored pointer More... | |
| T * | operator-> () const |
| indirection, get the stored pointer More... | |
| T * | get () const |
| get the stored pointer | |
| bool | unique () const |
| check if the instance is unique | |
| long | use_count () const |
| return the number of counts | |
| operator bool () const | |
| conversion to bool This will allow you to use the indirection nicely | |
| void | swap (SharedPtr &share) |
| exchange the content of the two pointers | |
| void | set_count (const long &count) |
| force the count to be set to a specified value More... | |
Detailed Description
template<class T>
class fastjet::SharedPtr< T >
An implementation of shared pointers that is broadly similar to C++11 shared_ptr (https://en.cppreference.com/w/cpp/memory/shared_ptr).
One key additional feature is
- the ability to force an update of the count with the set_count(...) member.
This effectively allows us to incorporate an offset in the count, which allows deletions to be triggered even when some pointers remain. We use this in particular for automatic deletion of a ClusterSequence when no pointers to its structure object remain other than those in the PseudoJets that are part of the ClusterSequence object itself.
Key features that are missing relative to C++11 are
- conversion from weak and auto pointers
- support for deleters and allocators
- static, constant and dynamic casts
- constructor and assignment sharing ownership with a shared pointer r but storing a different pointer than r (needed for the previous item)
In the last 2 cases, their implementation would require storing two pointers for every copies of the shared pointer, while our implementation only needs one. We did not implement them since we want to limit as much as possible memory and time consumption, and can easily avoid (at least for our needs so far) the casts.
The class has been tested against the boost (v1.42) implementation (for the parts that we have implemented).
Definition at line 341 of file SharedPtr.hh.
Constructor & Destructor Documentation
◆ SharedPtr() [1/2]
initialise with the main data
- Parameters
-
t : the object we want a smart pointer to
Definition at line 351 of file SharedPtr.hh.
◆ SharedPtr() [2/2]
|
inline |
overload the copy ctor so that it updates count
- Parameters
-
share : the object we want to copy
Definition at line 357 of file SharedPtr.hh.
Member Function Documentation
◆ reset()
|
inline |
do a smart copy
- Parameters
-
share : the object we want to copy Q? Do we need a non-template<Y> version as for the ctor and the assignment?
Definition at line 402 of file SharedPtr.hh.
◆ operator=() [1/2]
|
inline |
overload the = operator so that it updates count
- Parameters
-
share : the object we want to copy
Definition at line 426 of file SharedPtr.hh.
◆ operator=() [2/2]
|
inline |
overload the = operator so that it updates count
- Parameters
-
share : the object we want to copy
Definition at line 433 of file SharedPtr.hh.
◆ operator()()
|
inline |
return the pointer we're pointing to
Since FastJet 3.2.0, this is depracated since it is no longer part of std::shared_ptr<T>. Use SharedPtr<T>::get() instead
Definition at line 446 of file SharedPtr.hh.
◆ operator*()
|
inline |
indirection, get a reference to the stored pointer
!!! WATCH OUT It fails to check the requirement that the stored pointer must not be NULL!! So you need explicitly to check the validity in your code
Definition at line 457 of file SharedPtr.hh.
◆ operator->()
|
inline |
indirection, get the stored pointer
!!! WATCH OUT It fails to check the requirement that the stored pointer must not be NULL!! So you need explicitly to check the validity in your code
Definition at line 467 of file SharedPtr.hh.
◆ set_count()
|
inline |
force the count to be set to a specified value
- Parameters
-
count the value that we need to reset to
Definition at line 507 of file SharedPtr.hh.
The documentation for this class was generated from the following file:
- include/fastjet/SharedPtr.hh
