GiNaC::ptr< T > Class Template Reference

Class of (intrusively) reference-counted pointers that support copy-on-write semantics. More...

#include <ptr.h>

Public Member Functions
	ptr (T *t) noexcept
	Bind ptr to newly created object, start reference counting.
	ptr (T &t) noexcept
	Bind ptr to existing reference-counted object.
	ptr (const ptr &other) noexcept
	~ptr ()
ptr &	operator= (const ptr &other)
T &	operator* () const noexcept
T *	operator-> () const noexcept
void	makewritable ()
	Announce your intention to modify the object bound to this ptr.
void	swap (ptr &other) noexcept
	Swap the bound object of this ptr with another ptr.
template<class U >
bool	operator== (const ptr< U > &rhs) const noexcept
template<class U >
bool	operator!= (const ptr< U > &rhs) const noexcept

Private Attributes
T *	p

Friends
struct	std::less< ptr< T > >
T *	get_pointer (const ptr &x) noexcept
template<class U >
bool	operator== (const ptr &lhs, const U *rhs) noexcept
template<class U >
bool	operator!= (const ptr &lhs, const U *rhs) noexcept
template<class U >
bool	operator== (const U *lhs, const ptr &rhs) noexcept
template<class U >
bool	operator!= (const U *lhs, const ptr &rhs) noexcept
std::ostream &	operator<< (std::ostream &os, const ptr< T > &rhs)

Detailed Description

template<class T>
class GiNaC::ptr< T >

Class of (intrusively) reference-counted pointers that support copy-on-write semantics.

Requirements for T: must support the refcounted interface (usually by being derived from refcounted) T* T::duplicate() member function (only if makewriteable() is used)

Definition at line 55 of file ptr.h.

Constructor & Destructor Documentation

ptr() [1/3]

template<class T >

GiNaC::ptr< T >::ptr ( T *  t )

inlinenoexcept

Bind ptr to newly created object, start reference counting.

Definition at line 66 of file ptr.h.

References GINAC_ASSERT, and GiNaC::ptr< T >::p.

ptr() [2/3]

template<class T >

GiNaC::ptr< T >::ptr ( T &  t )

inlineexplicitnoexcept

Bind ptr to existing reference-counted object.

Definition at line 69 of file ptr.h.

References GiNaC::ptr< T >::p.

ptr() [3/3]

template<class T >

GiNaC::ptr< T >::ptr ( const ptr< T > &  other )

inlinenoexcept

Definition at line 71 of file ptr.h.

References GiNaC::ptr< T >::p.

~ptr()

template<class T >

GiNaC::ptr< T >::~ptr ( )

inline

Definition at line 73 of file ptr.h.

References GiNaC::ptr< T >::p.

Member Function Documentation

operator=()

template<class T >

ptr & GiNaC::ptr< T >::operator= ( const ptr< T > &  other )

inline

Definition at line 79 of file ptr.h.

References GiNaC::ptr< T >::p.

operator*()

template<class T >

T & GiNaC::ptr< T >::operator* ( ) const

inlinenoexcept

Definition at line 92 of file ptr.h.

References GiNaC::ptr< T >::p.

operator->()

template<class T >

T * GiNaC::ptr< T >::operator-> ( ) const

inlinenoexcept

Definition at line 93 of file ptr.h.

References GiNaC::ptr< T >::p.

makewritable()

template<class T >

void GiNaC::ptr< T >::makewritable ( )

inline

Announce your intention to modify the object bound to this ptr.

This ensures that the object is not shared by any other ptrs.

Definition at line 99 of file ptr.h.

References GiNaC::ptr< T >::p.

swap()

template<class T >

void GiNaC::ptr< T >::swap ( ptr< T > &  other )

inlinenoexcept

Swap the bound object of this ptr with another ptr.

Definition at line 110 of file ptr.h.

References GiNaC::ptr< T >::p.

operator==()

template<class T >

template<class U >

bool GiNaC::ptr< T >::operator== ( const ptr< U > &  rhs ) const

inlinenoexcept

Definition at line 123 of file ptr.h.

References GiNaC::ptr< T >::get_pointer, GiNaC::ptr< T >::p, and GiNaC::rhs().

operator!=()

template<class T >

template<class U >

bool GiNaC::ptr< T >::operator!= ( const ptr< U > &  rhs ) const

inlinenoexcept

Definition at line 126 of file ptr.h.

References GiNaC::ptr< T >::get_pointer, GiNaC::ptr< T >::p, and GiNaC::rhs().

Friends And Related Symbol Documentation

std::less< ptr< T > >

template<class T >

friend struct std::less< ptr< T > >

friend

Definition at line 44 of file ptr.h.

get_pointer

template<class T >

T * get_pointer ( const ptr< T > &  x )

friend

Definition at line 95 of file ptr.h.

Referenced by GiNaC::ptr< T >::operator!=(), and GiNaC::ptr< T >::operator==().

operator== [1/2]

template<class T >

template<class U >

bool operator== ( const ptr< T > &  lhs, const U *  rhs  )

friend

Definition at line 129 of file ptr.h.

operator!= [1/2]

template<class T >

template<class U >

bool operator!= ( const ptr< T > &  lhs, const U *  rhs  )

friend

Definition at line 132 of file ptr.h.

operator== [2/2]

template<class T >

template<class U >

bool operator== ( const U *  lhs, const ptr< T > &  rhs  )

friend

Definition at line 135 of file ptr.h.

operator!= [2/2]

template<class T >

template<class U >

bool operator!= ( const U *  lhs, const ptr< T > &  rhs  )

friend

Definition at line 138 of file ptr.h.

operator<<

template<class T >

std::ostream & operator<< ( std::ostream &  os, const ptr< T > &  rhs  )

friend

Definition at line 140 of file ptr.h.

Member Data Documentation

p

template<class T >

T* GiNaC::ptr< T >::p

private

Definition at line 147 of file ptr.h.

Referenced by GiNaC::ptr< T >::makewritable(), GiNaC::ptr< T >::operator!=(), GiNaC::ptr< T >::operator*(), GiNaC::ptr< T >::operator->(), GiNaC::ptr< T >::operator=(), GiNaC::ptr< T >::operator==(), GiNaC::ptr< T >::ptr(), GiNaC::ptr< T >::ptr(), GiNaC::ptr< T >::ptr(), GiNaC::ptr< T >::swap(), and GiNaC::ptr< T >::~ptr().

---

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

• ptr.h