Teuchos - Trilinos Tools Package Version of the Day
Related Functions
Teuchos::ArrayRCP< T > Class Template Reference

Reference-counted smart pointer for managing arrays. More...

#include <Teuchos_ArrayRCPDecl.hpp>

List of all members.

Public Types

Public typedefs
typedef Teuchos_Ordinal Ordinal
 Integer index type used throughout ArrayRCP.
typedef Ordinal size_type
 Type representing the number of elements in an ArrayRCP or view thereof.
typedef Ordinal difference_type
 Type representing the difference between two size_type values.
typedef
std::random_access_iterator_tag 
iterator_category
 Category of ArrayRCP's iterator type.
typedef T * iterator_type
 Type of an ArrayRCP's iterator.
typedef T value_type
 Type of each array element.
typedef T & reference
 Type of a (nonconstant) reference to an array element.
typedef const T & const_reference
 Type of a (constant) reference to an array element.
typedef T * pointer
 Type of a (raw) (nonconstant) pointer to an array element.
typedef T * const_pointer
 Type of a (raw) (constant) pointer to an array element.
typedef T element_type
 Type of each array element.
typedef T * iterator
 Nonconstant iterator type used if bounds checking is disabled.
typedef const T * const_iterator
 Constant iterator type used if bounds checking is disabled.

Public Member Functions

Constructors/Destructors/Initializers
 ArrayRCP (ENull null_arg=null)
 Default constructor; initialize to an empty array.
 ArrayRCP (T *p, size_type lowerOffset, size_type size, bool has_ownership, const ERCPNodeLookup rcpNodeLookup=RCP_ENABLE_NODE_LOOKUP)
 Construct from a raw pointer and a valid range.
template<class Dealloc_T >
 ArrayRCP (T *p, size_type lowerOffset, size_type size, Dealloc_T dealloc, bool has_ownership)
 Construct from a raw pointer, a valid range, and a deallocator.
 ArrayRCP (size_type size, const T &val=T())
 Construct an array with the given number of elements.
 ArrayRCP (const ArrayRCP< T > &r_ptr)
 Initialize from another ArrayRCP<T> object.
 ~ArrayRCP ()
 Destructor, that decrements the reference count.
ArrayRCP< T > & operator= (const ArrayRCP< T > &r_ptr)
 Assignment operator: Makes *this reference the input array.
Object/Pointer Access Functions
bool is_null () const
 True if the underlying pointer is null, else false.
T * operator-> () const
 Pointer (->) access to members of underlying object for current position.
T & operator* () const
 Dereference the underlying object for the current pointer position.
T * get () const
 Get the raw C++ pointer to the underlying object.
T * getRawPtr () const
 Get the raw C++ pointer to the underlying object.
T & operator[] (size_type offset) const
 Random object access.
Pointer Arithmetic Functions
ArrayRCP< T > & operator++ ()
 Prefix increment of pointer (i.e. ++ptr).
ArrayRCP< T > operator++ (int)
 Postfix increment of pointer (i.e. ptr++).
ArrayRCP< T > & operator-- ()
 Prefix decrement of pointer (i.e. --ptr).
ArrayRCP< T > operator-- (int)
 Postfix decrement of pointer (i.e. ptr--).
ArrayRCP< T > & operator+= (size_type offset)
 Pointer integer increment (i.e. ptr+=offset).
ArrayRCP< T > & operator-= (size_type offset)
 Pointer integer increment (i.e. ptr-=offset).
ArrayRCP< T > operator+ (size_type offset) const
 Pointer integer increment (i.e. ptr+offset).
ArrayRCP< T > operator- (size_type offset) const
 Pointer integer decrement (i.e. ptr-offset).
Standard Container-Like Functions
iterator begin () const
 Return an iterator to beginning of the array of data.
iterator end () const
 Return an iterator to past the end of the array of data.
ArrayRCP Views
ArrayRCP< const T > getConst () const
 Return object for only const access to data.
ArrayRCP< T > persistingView (size_type lowerOffset, size_type size) const
 Return a persisting view of a contiguous range of elements.
Size and extent query functions
size_type lowerOffset () const
 Return the lower offset to valid data.
size_type upperOffset () const
 Return the upper offset to valid data.
size_type size () const
 The total number of entries in the array.
ArrayView views
ArrayView< T > view (size_type lowerOffset, size_type size) const
 Return a nonpersisting view of a contiguous range of elements.
ArrayView< T > operator() (size_type lowerOffset, size_type size) const
 Return a nonpersisting view of a contiguous range of elements.
ArrayView< T > operator() () const
 Return a nonpersisting view of *this.
Implicit conversions
 operator ArrayRCP< const T > () const
 Convert from ArrayRCP<T> to ArrayRCP<const T>.
std::vector like and other misc functions
void assign (size_type n, const T &val)
 Resize and assign n elements of val.
template<class Iter >
void assign (Iter first, Iter last)
 Resize and assign to iterator sequence [first, last)
void deepCopy (const ArrayView< const T > &av)
 Deep copy the elements from one ArrayView object into this object.
void resize (const size_type n, const T &val=T())
 Resize and append new elements if necessary.
void clear ()
 Resize to zero.
Reference counting
ERCPStrength strength () const
 Strength of the pointer.
bool is_valid_ptr () const
 Return whether the underlying object pointer is still valid.
int strong_count () const
 Return the number of active RCP<> objects that have a "strong" reference to the underlying reference-counted object.
int weak_count () const
 Return the number of active RCP<> objects that have a "weak" reference to the underlying reference-counted object.
int total_count () const
 Total count (strong_count() + weak_count()).
void set_has_ownership ()
 Give this and other ArrayRCP<> objects ownership of the underlying referenced array to delete it.
bool has_ownership () const
 Returns true if this has ownership of object pointed to by this->get() in order to deallocate it.
T * release ()
 Release the ownership of the underlying array.
ArrayRCP< T > create_weak () const
 Create a new weak reference from another (strong) reference.
ArrayRCP< T > create_strong () const
 Create a new strong RCP object from another (weak) RCP object.
template<class T2 >
bool shares_resource (const ArrayRCP< T2 > &r_ptr) const
 Returns true if the smart pointers share the same underlying reference-counted object.
Assertion Functions.
const ArrayRCP< T > & assert_not_null () const
 Throws NullReferenceError if this->get()==NULL, otherwise returns reference to *this.
const ArrayRCP< T > & assert_in_range (size_type lowerOffset, size_type size) const
 Throws NullReferenceError if this->get()==NULL orthis->get()!=NULL, throws RangeError if (lowerOffset < this->lowerOffset() || this->upperOffset() < upperOffset, otherwise returns reference to *this
const ArrayRCP< T > & assert_valid_ptr () const
 If the object pointer is non-null, assert that it is still valid.
Deprecated
TEUCHOS_DEPRECATED int count () const
 Returns strong_count() [deprecated].

Related Functions

(Note that these are not member functions.)

template<class T >
ArrayRCP< T > arcp (const RCP< Array< T > > &v)
 Wrap an RCP<Array<T> > object as an ArrayRCP<T> object.
template<class T >
ArrayRCP< const T > arcp (const RCP< const Array< T > > &v)
 Wrap a RCP<const Array<T> > object as an ArrayRCP<const T> object.
template<class T >
ArrayRCP< T > arcpFromArray (Array< T > &a)
 Wrap an Array<T> object as a non-owning ArrayRCP<T> object.
template<class T >
ArrayRCP< const T > arcpFromArray (const Array< T > &a)
 Wrap a const Array<T> object as a non-owning ArrayRCP<T> object.
template<class T >
ArrayRCP< T > arcp (T *p, typename ArrayRCP< T >::size_type lowerOffset, typename ArrayRCP< T >::size_type size, bool owns_mem=true)
 Wraps a preallocated array of data with the assumption to call the array version of delete.
template<class T , class Dealloc_T >
ArrayRCP< T > arcp (T *p, typename ArrayRCP< T >::size_type lowerOffset, typename ArrayRCP< T >::size_type size, Dealloc_T dealloc, bool owns_mem)
 Wraps a preallocated array of data and uses a templated deallocation strategy object to define deletion .
template<class T >
ArrayRCP< T > arcp (typename ArrayRCP< T >::size_type size)
 Allocate a new array just given a dimension.
template<class T >
ArrayRCP< T > arcpCloneNode (const ArrayRCP< T > &a)
 Allocate a new ArrayRCP object with a new RCPNode with memory pointing to the initial node.
template<class T >
ArrayRCP< T > arcpClone (const ArrayView< const T > &v)
 Allocate a new array by cloning data from an input array view.
template<class T , class Embedded >
ArrayRCP< T > arcpWithEmbeddedObjPreDestroy (T *p, typename ArrayRCP< T >::size_type lowerOffset, typename ArrayRCP< T >::size_type size, const Embedded &embedded, bool owns_mem=true)
 Create an ArrayRCP with and also put in an embedded object.
template<class T , class Embedded >
ArrayRCP< T > arcpWithEmbeddedObjPostDestroy (T *p, typename ArrayRCP< T >::size_type lowerOffset, typename ArrayRCP< T >::size_type size, const Embedded &embedded, bool owns_mem=true)
 Create an ArrayRCP with and also put in an embedded object.
template<class T , class Embedded >
ArrayRCP< T > arcpWithEmbeddedObj (T *p, typename ArrayRCP< T >::size_type lowerOffset, typename ArrayRCP< T >::size_type size, const Embedded &embedded, bool owns_mem=true)
 Create an ArrayRCP with and also put in an embedded object.
template<class T >
ArrayRCP< T > arcp (const RCP< std::vector< T > > &v)
 Wrap an std::vector<T> object as an ArrayRCP<T> object.
template<class T >
ArrayRCP< const T > arcp (const RCP< const std::vector< T > > &v)
 Wrap a const std::vector<T> object as an ArrayRCP<const T> object.
template<class T >
ArrayRCP< T > arcpFromArrayView (const ArrayView< T > &av)
 Get an ArrayRCP object out of an ArrayView object.
template<class T >
RCP< std::vector< T > > get_std_vector (const ArrayRCP< T > &ptr)
 Get an std::vector<T> object out of an ArrayRCP<T> object that was created using the arcp() above to wrap the std::vector in the first place..
template<class T >
RCP< const std::vector< T > > get_std_vector (const ArrayRCP< const T > &ptr)
 Get a const std::vector<T> object out of an ArrayRCP<const T> object that was created using the arcp() above to wrap the std::vector in the first place.
template<class T >
bool is_null (const ArrayRCP< T > &p)
 Returns true if p.get()==NULL.
template<class T >
bool nonnull (const ArrayRCP< T > &p)
 Returns true if p.get()!=NULL.
template<class T >
bool operator== (const ArrayRCP< T > &p, ENull)
 Returns true if p.get()==NULL.
template<class T >
bool operator!= (const ArrayRCP< T > &p, ENull)
 Returns true if p.get()!=NULL.
template<class T1 , class T2 >
bool operator== (const ArrayRCP< T1 > &p1, const ArrayRCP< T2 > &p2)
 
template<class T1 , class T2 >
bool operator!= (const ArrayRCP< T1 > &p1, const ArrayRCP< T2 > &p2)
 
template<class T1 , class T2 >
bool operator< (const ArrayRCP< T1 > &p1, const ArrayRCP< T2 > &p2)
 
template<class T1 , class T2 >
bool operator<= (const ArrayRCP< T1 > &p1, const ArrayRCP< T2 > &p2)
 
template<class T1 , class T2 >
bool operator> (const ArrayRCP< T1 > &p1, const ArrayRCP< T2 > &p2)
 
template<class T1 , class T2 >
bool operator>= (const ArrayRCP< T1 > &p1, const ArrayRCP< T2 > &p2)
 
template<class T >
ArrayRCP< T >::difference_type operator- (const ArrayRCP< T > &p1, const ArrayRCP< T > &p2)
 Returns difference of two ArrayRCP objects.
template<class T2 , class T1 >
ArrayRCP< T2 > arcp_const_cast (const ArrayRCP< T1 > &p1)
 Const cast of underlying ArrayRCP type from const T* to T*.
template<class T2 , class T1 >
ArrayRCP< T2 > arcp_reinterpret_cast (const ArrayRCP< T1 > &p1)
 Reinterpret cast of underlying ArrayRCP type from T1* to T2*.
template<class T2 , class T1 >
ArrayRCP< T2 > arcp_reinterpret_cast_nonpod (const ArrayRCP< T1 > &p1, const T2 &val=T2())
 Reinterpret cast of underlying ArrayRCP type from T1* to T2* where T2 is a non-POD (non-plain-old-data).
template<class T2 , class T1 >
ArrayRCP< T2 > arcp_implicit_cast (const ArrayRCP< T1 > &p1)
 Implicit case the underlying ArrayRCP type from T1* to T2*.
template<class T1 , class T2 >
void set_extra_data (const T1 &extra_data, const std::string &name, const Ptr< ArrayRCP< T2 > > &p, EPrePostDestruction destroy_when=POST_DESTROY, bool force_unique=true)
 Set extra data associated with a ArrayRCP object.
template<class T1 , class T2 >
T1 & get_extra_data (ArrayRCP< T2 > &p, const std::string &name)
 Get a non-const reference to extra data associated with a ArrayRCP object.
template<class T1 , class T2 >
const T1 & get_extra_data (const ArrayRCP< T2 > &p, const std::string &name)
 Get a const reference to extra data associated with a ArrayRCP object.
template<class T1 , class T2 >
T1 * get_optional_extra_data (ArrayRCP< T2 > &p, const std::string &name)
 Get a pointer to non-const extra data (if it exists) associated with a ArrayRCP object.
template<class T1 , class T2 >
const T1 * get_optional_extra_data (const ArrayRCP< T2 > &p, const std::string &name)
 Get a pointer to const extra data (if it exists) associated with a ArrayRCP object.
template<class Dealloc_T , class T >
Dealloc_T & get_nonconst_dealloc (const ArrayRCP< T > &p)
 Return a non-const reference to the underlying deallocator object.
template<class Dealloc_T , class T >
const Dealloc_T & get_dealloc (const ArrayRCP< T > &p)
 Return a const reference to the underlying deallocator object.
template<class Dealloc_T , class T >
const Dealloc_T * get_optional_dealloc (const ArrayRCP< T > &p)
 Return a pointer to the underlying non-const deallocator object if it exists.
template<class Dealloc_T , class T >
Dealloc_T * get_optional_nonconst_dealloc (const ArrayRCP< T > &p)
 Return a pointer to the underlying const deallocator object if it exists.
template<class TOrig , class Embedded , class T >
const Embedded & getEmbeddedObj (const ArrayRCP< T > &p)
 Get a const reference to an embedded object that was set by calling arcpWithEmbeddedObjPreDestroy(), arcpWithEmbeddedObjPostDestory(), or arcpWithEmbeddedObj().
template<class TOrig , class Embedded , class T >
Embedded & getNonconstEmbeddedObj (const ArrayRCP< T > &p)
 Get a const reference to an embedded object that was set by calling arcpWithEmbeddedObjPreDestroy(), arcpWithEmbeddedObjPostDestory(), or arcpWithEmbeddedObj().
template<class T >
std::ostream & operator<< (std::ostream &out, const ArrayRCP< T > &p)
 Output stream inserter.

Detailed Description

template<class T>
class Teuchos::ArrayRCP< T >

Reference-counted smart pointer for managing arrays.

Template Parameters:
TThe type of each element in the array.

Summary

ArrayRCP manages an array of objects of type T. Like RCP, it uses reference counting to decide when to deallocate the array. This lets you share references to the array, without worrying about who is responsible for deallocating it. We may thus call an ArrayRCP a "shared array."

Details

Managing an array of objects is very different from managing a pointer to an individual, possibly polymorphic, object. For example, while implicit conversions from derived to base types can be useful when dealing with pointers to single objects, they often cause problems when working with arrays of objects. Therefore, this class contains those capabilities of raw pointers that are good when working with arrays of objects, but excludes those that are bad, such as implicit conversions from derived to base types. If you really do want a shared array with implicit conversions from derived to base types, you may use an ArrayRCP<RCP<T> >.

Optional bounds checking

You may enable bounds checking and other safety checks for this class by setting the Teuchos_ENABLE_DEBUG:BOOL=ON CMake option when configuring your Trilinos build. This option is off by default. It incurs a significant performance penalty and so is not recommended for production builds. Bounds checking requires that you always create ArrayRCP instances with the correct range. For example, if you use one of the constructors that accepts a raw pointer, you are responsible for supplying the correct number of elements in the array. Our bounds checking implementation does not attempt to replace memory debugging tools such as the Memcheck tool in Valgrind.

Requirements on the type T

ArrayRCP imposes the following requirements on the type T of elements in the array:

Design discussion

This class has a partial specialization for const T that omits the conversion operator operator ArrayRCP<const T>() const, and the assign() and deepCopy() methods (which perform a deep copy). The conversion operator does not make sense if T is already const T' for some type T', and the assign() and deepCopy() methods do not make sense if the right-hand side of the assignment is const.

Partial specialization results in duplicated code, so Teuchos developers should be careful to make modifications in both the fully generic implementation and in the partial specialization.

We considered avoiding most of the duplication by making ArrayRCP<T> and its partial specialization ArrayRCP<const T> inherit from a common base class, which contains all the common code. However, the circular dependency between ArrayRCP and ArrayView would have complicated this solution. We chose instead the simple "partial specialization without a common base class" solution, which does not interfere with the ArrayRCP / ArrayView circular dependency.

Examples:

ArrayRCP_test.cpp.

Definition at line 127 of file Teuchos_ArrayRCPDecl.hpp.


Member Typedef Documentation

template<class T>
typedef Teuchos_Ordinal Teuchos::ArrayRCP< T >::Ordinal

Integer index type used throughout ArrayRCP.

Definition at line 133 of file Teuchos_ArrayRCPDecl.hpp.

template<class T>
typedef Ordinal Teuchos::ArrayRCP< T >::size_type

Type representing the number of elements in an ArrayRCP or view thereof.

Definition at line 136 of file Teuchos_ArrayRCPDecl.hpp.

template<class T>
typedef Ordinal Teuchos::ArrayRCP< T >::difference_type

Type representing the difference between two size_type values.

Definition at line 139 of file Teuchos_ArrayRCPDecl.hpp.

template<class T>
typedef std::random_access_iterator_tag Teuchos::ArrayRCP< T >::iterator_category

Category of ArrayRCP's iterator type.

Definition at line 142 of file Teuchos_ArrayRCPDecl.hpp.

template<class T>
typedef T* Teuchos::ArrayRCP< T >::iterator_type

Type of an ArrayRCP's iterator.

Definition at line 145 of file Teuchos_ArrayRCPDecl.hpp.

template<class T>
typedef T Teuchos::ArrayRCP< T >::value_type

Type of each array element.

Definition at line 148 of file Teuchos_ArrayRCPDecl.hpp.

template<class T>
typedef T& Teuchos::ArrayRCP< T >::reference

Type of a (nonconstant) reference to an array element.

Definition at line 151 of file Teuchos_ArrayRCPDecl.hpp.

template<class T>
typedef const T& Teuchos::ArrayRCP< T >::const_reference

Type of a (constant) reference to an array element.

Definition at line 154 of file Teuchos_ArrayRCPDecl.hpp.

template<class T>
typedef T* Teuchos::ArrayRCP< T >::pointer

Type of a (raw) (nonconstant) pointer to an array element.

Definition at line 157 of file Teuchos_ArrayRCPDecl.hpp.

template<class T>
typedef T* Teuchos::ArrayRCP< T >::const_pointer

Type of a (raw) (constant) pointer to an array element.

Definition at line 160 of file Teuchos_ArrayRCPDecl.hpp.

template<class T>
typedef T Teuchos::ArrayRCP< T >::element_type

Type of each array element.

Definition at line 163 of file Teuchos_ArrayRCPDecl.hpp.

template<class T>
typedef T* Teuchos::ArrayRCP< T >::iterator

Nonconstant iterator type used if bounds checking is disabled.

Definition at line 172 of file Teuchos_ArrayRCPDecl.hpp.

template<class T>
typedef const T* Teuchos::ArrayRCP< T >::const_iterator

Constant iterator type used if bounds checking is disabled.

Definition at line 174 of file Teuchos_ArrayRCPDecl.hpp.


Constructor & Destructor Documentation

template<class T >
Teuchos::ArrayRCP< T >::ArrayRCP ( ENull  null_arg = null) [inline]

Default constructor; initialize to an empty array.

This lets users write code like:

 ArrayRCP<int> p = null;

or

 ArrayRCP<int> p;

Both lines of code above set the raw array pointer to NULL, and the array's length to zero.

Definition at line 118 of file Teuchos_ArrayRCP.hpp.

template<class T>
Teuchos::ArrayRCP< T >::ArrayRCP ( T *  p,
size_type  lowerOffset,
size_type  size,
bool  has_ownership,
const ERCPNodeLookup  rcpNodeLookup = RCP_ENABLE_NODE_LOOKUP 
) [inline]

Construct from a raw pointer and a valid range.

Parameters:
p[in] Raw array pointer.
lowerOffset[in] Array index at which the range starts (zero if at the beginning of the range).
size[in] Number of array elements in the range.
has_ownership[in] True if the ArrayRCP is responsible for deallocating the raw array (using delete []) when the reference count goes to zero. If false, the ArrayRCP does not deallocate the array.
rcpNodeLookup[in] Whether to perform RCPNode lookup. The default value is fine for nearly all use cases.
Postcondition:
this->get() == p
this->lowerOffset() == lowerOffset
this->upperOffset() == size + lowerOffset - 1
this->has_ownership() == has_ownership
Warning:
You should avoid manipulating raw pointers and use other methods to construct an ArrayRCP object instead!

Definition at line 148 of file Teuchos_ArrayRCP.hpp.

template<class T>
template<class Dealloc_T >
Teuchos::ArrayRCP< T >::ArrayRCP ( T *  p,
size_type  lowerOffset,
size_type  size,
Dealloc_T  dealloc,
bool  has_ownership 
) [inline]

Construct from a raw pointer, a valid range, and a deallocator.

Parameters:
p[in] Raw array pointer.
lowerOffset[in] Array index at which the range starts (zero if at the beginning of the range).
size[in] Number of array elements in the range.
dealloc[in] Function (or object with an operator()(T*) method) responsible for deallocating the raw array when the reference count goes to zero.
has_ownership[in] True if the ArrayRCP is responsible for deallocating the raw array (using the given deallocator) when the reference count goes to zero. If false, the ArrayRCP does not deallocate the array.
Postcondition:
this->get() == p
this->lowerOffset() == lowerOffset
this->upperOffset() == size + lowerOffset - 1
this->has_ownership() == has_ownership
Warning:
You should avoid manipulating raw pointers and use other methods to construct an ArrayRCP object instead!

Definition at line 226 of file Teuchos_ArrayRCP.hpp.

template<class T>
Teuchos::ArrayRCP< T >::ArrayRCP ( size_type  size,
const T &  val = T() 
) [inline, explicit]

Construct an array with the given number of elements.

Parameters:
size[in] Number of elements in the array.
val[in] Value with which to fill all elements of the array.

This constructor fills the array as if with the following code:

     std::fill_n (begin (), n, val);
Postcondition:
this->lowerOffset() == 0
this->upperOffset() == size - 1
this->has_ownership() == true

Definition at line 129 of file Teuchos_ArrayRCP.hpp.

template<class T>
Teuchos::ArrayRCP< T >::ArrayRCP ( const ArrayRCP< T > &  r_ptr) [inline]

Initialize from another ArrayRCP<T> object.

After construction, this and r_ptr will reference the same array.

Postcondition:
this->get() == r_ptr.get()
this->count() == r_ptr.count()
this->has_ownership() == r_ptr.has_ownership()
If r_ptr.get() != NULL then r_ptr.count() is incremented by 1.
Note:
To implementers: In compilers that conform to the C++ standard, this copy constructor overload is unnecessary, since the more general templated version of the copy constructor below is sufficient. However, not all compilers have handled this code correctly in the past. This version ensures correct compilation with such compilers, without affecting compilers that correctly implement the C++ standard.

Definition at line 277 of file Teuchos_ArrayRCP.hpp.

template<class T >
Teuchos::ArrayRCP< T >::~ArrayRCP ( ) [inline]

Destructor, that decrements the reference count.

If this->get() == NULL then the destructor does nothing. Otherwise, it decrements the reference count of this and all other references to the array. If the final reference count is zero, it also deallocates the array if owned (i.e., if this->has_ownership() returns true). Deallocation uses the custom deallocator if one was supplied; otherwise it uses delete [].

Definition at line 294 of file Teuchos_ArrayRCP.hpp.


Member Function Documentation

template<class T>
ArrayRCP< T > & Teuchos::ArrayRCP< T >::operator= ( const ArrayRCP< T > &  r_ptr) [inline]

Assignment operator: Makes *this reference the input array.

If the input array is a reference to *this (that is, if this->getRawPtr() == r_ptr.getRawPtr()), then this method does nothing. Otherwise, it does the following:

  1. Decrements the reference count of *this (as if its destructor had been called)
  2. Makes *this a reference to the input array (thus incrementing its reference count)

For example, after the following sample code is done, the array to which x originally pointed on construction will have reference count 2, and the array to which y originally pointed on constructor will have reference count 0 (and will thus be deallocated).

     ArrayRCP<T> x = arcp<T> (10);
     ArrayRCP<T> y = arcp<T> (42);
     x = y;
Postcondition:
this->get() == r_ptr.get()
this->count() == r_ptr.count()
this->has_ownership() == r_ptr.has_ownership()
If r_ptr.get() != NULL then r_ptr.count() is incremented by 1

Definition at line 301 of file Teuchos_ArrayRCP.hpp.

template<class T >
bool Teuchos::ArrayRCP< T >::is_null ( ) const [inline]

True if the underlying pointer is null, else false.

Definition at line 335 of file Teuchos_ArrayRCP.hpp.

template<class T >
T * Teuchos::ArrayRCP< T >::operator-> ( ) const [inline]

Pointer (->) access to members of underlying object for current position.

Precondition:
this->get() != NULL
this->lowerOffset() <= 0
this->upperOffset() >= 0

Definition at line 346 of file Teuchos_ArrayRCP.hpp.

template<class T >
T & Teuchos::ArrayRCP< T >::operator* ( ) const [inline]

Dereference the underlying object for the current pointer position.

Precondition:
this->get() != NULL
this->lowerOffset() <= 0
this->upperOffset() >= 0

Definition at line 363 of file Teuchos_ArrayRCP.hpp.

template<class T >
T * Teuchos::ArrayRCP< T >::get ( ) const [inline]

Get the raw C++ pointer to the underlying object.

Precondition:
[*this != null] this->lowerOffset() <= 0
[*this != null] this->upperOffset() >= 0

Definition at line 380 of file Teuchos_ArrayRCP.hpp.

template<class T >
T * Teuchos::ArrayRCP< T >::getRawPtr ( ) const [inline]

Get the raw C++ pointer to the underlying object.

Precondition:
[*this != null] this->lowerOffset() <= 0
[*this != null] this->upperOffset() >= 0

Definition at line 401 of file Teuchos_ArrayRCP.hpp.

template<class T >
T & Teuchos::ArrayRCP< T >::operator[] ( size_type  offset) const [inline]

Random object access.

Precondition:
this->get() != NULL
this->lowerOffset() <= offset && offset <= this->upperOffset()

Definition at line 412 of file Teuchos_ArrayRCP.hpp.

template<class T >
ArrayRCP< T > & Teuchos::ArrayRCP< T >::operator++ ( ) [inline]

Prefix increment of pointer (i.e. ++ptr).

Does nothing if this->get() == NULL.

Postcondition:
[this->get()!=NULL] this->get() is incremented by 1
[this->get()!=NULL] this->lowerOffset() is decremented by 1
[this->get()!=NULL] this->upperOffset() is decremented by 1

Definition at line 432 of file Teuchos_ArrayRCP.hpp.

template<class T >
ArrayRCP< T > Teuchos::ArrayRCP< T >::operator++ ( int  ) [inline]

Postfix increment of pointer (i.e. ptr++).

Does nothing if this->get() == NULL.

Postcondition:
this->get() is incremented by 1
this->lowerOffset() is decremented by 1
this->upperOffset() is decremented by 1

Definition at line 453 of file Teuchos_ArrayRCP.hpp.

template<class T >
ArrayRCP< T > & Teuchos::ArrayRCP< T >::operator-- ( ) [inline]

Prefix decrement of pointer (i.e. --ptr).

Does nothing if this->get() == NULL.

Postcondition:
[this->get()!=NULL] this->get() is decremented by 1
[this->get()!=NULL] this->lowerOffset() is incremented by 1
[this->get()!=NULL] this->upperOffset() is incremented by 1

Definition at line 472 of file Teuchos_ArrayRCP.hpp.

template<class T >
ArrayRCP< T > Teuchos::ArrayRCP< T >::operator-- ( int  ) [inline]

Postfix decrement of pointer (i.e. ptr--).

Does nothing if this->get() == NULL.

Postcondition:
this->get() is decremented by 1
this->lowerOffset() is incremented by 1
this->upperOffset() is incremented by 1

Definition at line 493 of file Teuchos_ArrayRCP.hpp.

template<class T >
ArrayRCP< T > & Teuchos::ArrayRCP< T >::operator+= ( size_type  offset) [inline]

Pointer integer increment (i.e. ptr+=offset).

Does nothing if this->get() == NULL.

Postcondition:
[this->get()!=NULL] this->get() is incremented by offset
[this->get()!=NULL] this->lowerOffset() is decremented by offset
[this->get()!=NULL] this->upperOffset() is decremented by offset

Definition at line 512 of file Teuchos_ArrayRCP.hpp.

template<class T >
ArrayRCP< T > & Teuchos::ArrayRCP< T >::operator-= ( size_type  offset) [inline]

Pointer integer increment (i.e. ptr-=offset).

Does nothing if this->get() == NULL.

Postcondition:
[this->get()!=NULL] this->get() is decremented by offset
[this->get()!=NULL] this->lowerOffset() is incremented by offset
[this->get()!=NULL] this->upperOffset() is incremented by offset

Definition at line 533 of file Teuchos_ArrayRCP.hpp.

template<class T >
ArrayRCP< T > Teuchos::ArrayRCP< T >::operator+ ( size_type  offset) const [inline]

Pointer integer increment (i.e. ptr+offset).

Returns a null pointer if this->get() == NULL.

Postcondition:
[this->get()!=NULL] return->get() == this->get() + offset
[this->get()!=NULL] return->lowerOffset() == this->lowerOffset() - offset
[this->get()!=NULL] return->upperOffset() == this->upperOffset() - offset

Note that since implicit conversion of ArrayRCP<T> objects is not allowed that it does not help at all to make this function into a non-member function.

Definition at line 554 of file Teuchos_ArrayRCP.hpp.

template<class T >
ArrayRCP< T > Teuchos::ArrayRCP< T >::operator- ( size_type  offset) const [inline]

Pointer integer decrement (i.e. ptr-offset).

Returns a null pointer if this->get() == NULL.

Postcondition:
[this->get()!=NULL] return->get() == this->get() - offset
[this->get()!=NULL] return->lowerOffset() == this->lowerOffset() + offset
[this->get()!=NULL] return->upperOffset() == this->upperOffset() + offset

Note that since implicit conversion of ArrayRCP<T> objects is not allowed that it does not help at all to make this function into a non-member function.

Definition at line 571 of file Teuchos_ArrayRCP.hpp.

template<class T >
ArrayRCP< T >::iterator Teuchos::ArrayRCP< T >::begin ( ) const [inline]

Return an iterator to beginning of the array of data.

If HAVE_TEUCHOS_ARRAY_BOUNDSCHECK is defined then the iterator returned is an ArrayRCP<T> object and all operations are checked at runtime. When HAVE_TEUCHOS_ARRAY_BOUNDSCHECK is not defined, the a raw pointer T* is returned for fast execution.

Postcondition:
[this->get()!=NULL] &*return == this->get()
[this->get()==NULL] return == (null or NULL)

Definition at line 591 of file Teuchos_ArrayRCP.hpp.

template<class T >
ArrayRCP< T >::iterator Teuchos::ArrayRCP< T >::end ( ) const [inline]

Return an iterator to past the end of the array of data.

If HAVE_TEUCHOS_ARRAY_BOUNDSCHECK is defined then the iterator returned is an ArrayRCP<T> object and all operations are checked at runtime. When HAVE_TEUCHOS_ARRAY_BOUNDSCHECK is not defined, the a raw pointer T* is returned for fast execution.

Postcondition:
[this->get()!=NULL] &*end == this->get()+(this->upperOffset()+1)
[this->get()==NULL] return == (null or NULL)

Definition at line 614 of file Teuchos_ArrayRCP.hpp.

template<class T >
ArrayRCP< const T > Teuchos::ArrayRCP< T >::getConst ( ) const [inline]

Return object for only const access to data.

This function should only compile successfully if the type T is not already declared const!

Definition at line 640 of file Teuchos_ArrayRCP.hpp.

template<class T >
ArrayRCP< T > Teuchos::ArrayRCP< T >::persistingView ( size_type  lowerOffset,
size_type  size 
) const [inline]

Return a persisting view of a contiguous range of elements.

Precondition:
this->get() != NULL
this->lowerOffset() <= lowerOffset
lowerOffset + size - 1 <= this->upperOffset()
Postcondition:
return->get() == this->get() + lowerOffset
return->lowerOffset() == 0
return->upperOffset() == size-1
Note:
A size==0 view of even a null ArrayRCP is allowed. It returns a null view in that case.

Definition at line 659 of file Teuchos_ArrayRCP.hpp.

template<class T >
ArrayRCP< T >::size_type Teuchos::ArrayRCP< T >::lowerOffset ( ) const [inline]

Return the lower offset to valid data.

Definition at line 695 of file Teuchos_ArrayRCP.hpp.

template<class T >
ArrayRCP< T >::size_type Teuchos::ArrayRCP< T >::upperOffset ( ) const [inline]

Return the upper offset to valid data.

Definition at line 712 of file Teuchos_ArrayRCP.hpp.

template<class T >
ArrayRCP< T >::size_type Teuchos::ArrayRCP< T >::size ( ) const [inline]

The total number of entries in the array.

x.upperOffset() - x.lowerOffset() + 1 == x.size() for any ArrayRCP x.

Definition at line 729 of file Teuchos_ArrayRCP.hpp.

template<class T >
ArrayView< T > Teuchos::ArrayRCP< T >::view ( size_type  lowerOffset,
size_type  size 
) const [inline]

Return a nonpersisting view of a contiguous range of elements.

Precondition:
this->get() != NULL
this->lowerOffset() <= lowerOffset
lowerOffset + size - 1 <= this->upperOffset()
Postcondition:
return->get() == this->get() + lowerOffset
return->lowerOffset() == 0
return->upperOffset() == size-1
Note:
A size==0 view of even a null ArrayRCP is allowed. It returns a null view in that case.

Definition at line 748 of file Teuchos_ArrayRCP.hpp.

template<class T >
ArrayView< T > Teuchos::ArrayRCP< T >::operator() ( size_type  lowerOffset,
size_type  size 
) const [inline]

Return a nonpersisting view of a contiguous range of elements.

This is equivalent to calling view (offset, size).

Definition at line 782 of file Teuchos_ArrayRCP.hpp.

template<class T >
ArrayView< T > Teuchos::ArrayRCP< T >::operator() ( ) const [inline]

Return a nonpersisting view of *this.

Note:
This will return a null ArrayView if this->size() == 0.

Definition at line 796 of file Teuchos_ArrayRCP.hpp.

template<class T >
Teuchos::ArrayRCP< T >::operator ArrayRCP< const T > ( ) const [inline]

Convert from ArrayRCP<T> to ArrayRCP<const T>.

Note:
This conversion operator does not exist if T is already a const type (that is, if T is const T' for some type T'). In that case, the assignment operator and copy constructor achieve the same syntactic effect.

Definition at line 818 of file Teuchos_ArrayRCP.hpp.

template<class T>
void Teuchos::ArrayRCP< T >::assign ( size_type  n,
const T &  val 
) [inline]

Resize and assign n elements of val.

size() == n

Definition at line 839 of file Teuchos_ArrayRCP.hpp.

template<class T >
template<class Iter >
void Teuchos::ArrayRCP< T >::assign ( Iter  first,
Iter  last 
) [inline]

Resize and assign to iterator sequence [first, last)

size() == std::distance(first, last)

This will not change the underlying pointer array if the size does not change.

Definition at line 848 of file Teuchos_ArrayRCP.hpp.

template<class T>
void Teuchos::ArrayRCP< T >::deepCopy ( const ArrayView< const T > &  av) [inline]

Deep copy the elements from one ArrayView object into this object.

This is equivalent to calling assign (av.begin (), av.end ())

Definition at line 925 of file Teuchos_ArrayRCP.hpp.

template<class T>
void Teuchos::ArrayRCP< T >::resize ( const size_type  n,
const T &  val = T() 
) [inline]

Resize and append new elements if necessary.

Definition at line 858 of file Teuchos_ArrayRCP.hpp.

template<class T >
void Teuchos::ArrayRCP< T >::clear ( ) [inline]

Resize to zero.

size()==0

Definition at line 911 of file Teuchos_ArrayRCP.hpp.

template<class T >
ERCPStrength Teuchos::ArrayRCP< T >::strength ( ) const [inline]

Strength of the pointer.

Return values:

  • RCP_STRONG: Underlying reference-counted object will be deleted when *this is destroyed if strong_count()==1.
  • RCP_WEAK: Underlying reference-counted object will not be deleted when *this is destroyed if strong_count() > 0.
  • RCP_STRENGTH_INVALID: *this is not strong or weak but is null.

Definition at line 939 of file Teuchos_ArrayRCP.hpp.

template<class T >
bool Teuchos::ArrayRCP< T >::is_valid_ptr ( ) const [inline]

Return whether the underlying object pointer is still valid.

The underlying object will not be valid if the strong count has gone to zero but the weak count has not.

NOTE: Null is a valid object pointer. If you want to know if there is a non-null object and it is valid then !is_null() && is_valid_ptr() will be true.

Definition at line 950 of file Teuchos_ArrayRCP.hpp.

template<class T >
int Teuchos::ArrayRCP< T >::strong_count ( ) const [inline]

Return the number of active RCP<> objects that have a "strong" reference to the underlying reference-counted object.

Returns:
If this->get() == NULL then this function returns 0.

Definition at line 967 of file Teuchos_ArrayRCP.hpp.

template<class T >
int Teuchos::ArrayRCP< T >::weak_count ( ) const [inline]

Return the number of active RCP<> objects that have a "weak" reference to the underlying reference-counted object.

Returns:
If this->get() == NULL then this function returns 0.

Definition at line 980 of file Teuchos_ArrayRCP.hpp.

template<class T >
int Teuchos::ArrayRCP< T >::total_count ( ) const [inline]

Total count (strong_count() + weak_count()).

Definition at line 993 of file Teuchos_ArrayRCP.hpp.

template<class T >
void Teuchos::ArrayRCP< T >::set_has_ownership ( ) [inline]

Give this and other ArrayRCP<> objects ownership of the underlying referenced array to delete it.

See ~ArrayRCP() above. This function does nothing if this->get() == NULL.

Postconditions:

Definition at line 1006 of file Teuchos_ArrayRCP.hpp.

template<class T >
bool Teuchos::ArrayRCP< T >::has_ownership ( ) const [inline]

Returns true if this has ownership of object pointed to by this->get() in order to deallocate it.

See the above documentation for the destructor.

Returns:
If this->get() == NULL then this function always returns false. Otherwise the value returned from this function depends on which function was called most recently, if any; set_has_ownership() (true) or release() (false).

Definition at line 1019 of file Teuchos_ArrayRCP.hpp.

template<class T >
T * Teuchos::ArrayRCP< T >::release ( ) [inline]

Release the ownership of the underlying array.

After this function is called then the client is responsible for deleting the returned pointer no matter how many ref_count_ptr<T> objects have a reference to it. If this->get() == NULL, then this call is meaningless.

Note that this function does not have the exact same semantics as does auto_ptr<T>::release(). In auto_ptr<T>::release(), this is set to NULL while here in ArrayRCP<T>:: release() only an ownership flag is set and this still points to the same array. It would be difficult to duplicate the behavior of auto_ptr<T>::release() for this class.

Postconditions:

Returns:
Returns the value of this->get()

Definition at line 1032 of file Teuchos_ArrayRCP.hpp.

template<class T >
ArrayRCP< T > Teuchos::ArrayRCP< T >::create_weak ( ) const [inline]

Create a new weak reference from another (strong) reference.

A "weak" reference gives access to the array, without incrementing its (strong) reference count. This lets you have access to the array, without affecting when it gets deallocated.

Precondition:
returnVal.is_valid_ptr()==true
Postcondition:
returnVal.get() == this->get()
returnVal.strong_count() == this->strong_count()
returnVal.weak_count() == this->weak_count()+1
returnVal.strength() == RCP_WEAK
returnVal.has_ownership() == this->has_ownership()

Definition at line 1049 of file Teuchos_ArrayRCP.hpp.

template<class T >
ArrayRCP< T > Teuchos::ArrayRCP< T >::create_strong ( ) const [inline]

Create a new strong RCP object from another (weak) RCP object.

A "weak" reference gives access to the array, without incrementing its (strong) reference count. This method lets you "promote" a weak reference into a strong reference. If the array has been deallocated, the returned reference is null.

Precondition:
returnVal.is_valid_ptr()==true
Postcondition:
returnVal.get() == this->get()
returnVal.strong_count() == this->strong_count()+1
returnVal.weak_count() == this->weak_count()
returnVal.strength() == RCP_STRONG
returnVal.has_ownership() == this->has_ownership()

Definition at line 1062 of file Teuchos_ArrayRCP.hpp.

template<class T >
template<class T2 >
bool Teuchos::ArrayRCP< T >::shares_resource ( const ArrayRCP< T2 > &  r_ptr) const [inline]

Returns true if the smart pointers share the same underlying reference-counted object.

This method does more than just check if this->get() == r_ptr.get(). It also checks to see if the underlying reference counting machinery is the same.

Definition at line 1077 of file Teuchos_ArrayRCP.hpp.

template<class T >
const ArrayRCP< T > & Teuchos::ArrayRCP< T >::assert_not_null ( ) const [inline]

Throws NullReferenceError if this->get()==NULL, otherwise returns reference to *this.

Definition at line 1102 of file Teuchos_ArrayRCP.hpp.

template<class T >
const ArrayRCP< T > & Teuchos::ArrayRCP< T >::assert_in_range ( size_type  lowerOffset,
size_type  size 
) const [inline]

Throws NullReferenceError if this->get()==NULL orthis->get()!=NULL, throws RangeError if (lowerOffset < this->lowerOffset() || this->upperOffset() < upperOffset, otherwise returns reference to *this

Definition at line 1141 of file Teuchos_ArrayRCP.hpp.

template<class T >
const ArrayRCP< T > & Teuchos::ArrayRCP< T >::assert_valid_ptr ( ) const [inline]

If the object pointer is non-null, assert that it is still valid.

If is_null()==false && strong_count()==0, this will throw DanglingReferenceErorr with a great error message.

If is_null()==true, then this will not throw any exception.

In this context, null is a valid object.

Definition at line 1121 of file Teuchos_ArrayRCP.hpp.

template<class T >
int Teuchos::ArrayRCP< T >::count ( ) const [inline]

Returns strong_count() [deprecated].

Definition at line 1185 of file Teuchos_ArrayRCP.hpp.


Friends And Related Function Documentation

template<class T >
ArrayRCP< T > arcp ( const RCP< Array< T > > &  v) [related]

Wrap an RCP<Array<T> > object as an ArrayRCP<T> object.

Examples:
ArrayRCP_test.cpp.

Definition at line 509 of file Teuchos_Array.hpp.

template<class T >
ArrayRCP< const T > arcp ( const RCP< const Array< T > > &  v) [related]

Wrap a RCP<const Array<T> > object as an ArrayRCP<const T> object.

Definition at line 526 of file Teuchos_Array.hpp.

template<class T >
ArrayRCP< T > arcpFromArray ( Array< T > &  a) [related]

Wrap an Array<T> object as a non-owning ArrayRCP<T> object.

Definition at line 543 of file Teuchos_Array.hpp.

template<class T >
ArrayRCP< const T > arcpFromArray ( const Array< T > &  a) [related]

Wrap a const Array<T> object as a non-owning ArrayRCP<T> object.

Definition at line 561 of file Teuchos_Array.hpp.

template<class T >
ArrayRCP< T > arcp ( T *  p,
typename ArrayRCP< T >::size_type  lowerOffset,
typename ArrayRCP< T >::size_type  size,
bool  owns_mem = true 
) [related]

Wraps a preallocated array of data with the assumption to call the array version of delete.

template<class T , class Dealloc_T >
ArrayRCP< T > arcp ( T *  p,
typename ArrayRCP< T >::size_type  lowerOffset,
typename ArrayRCP< T >::size_type  size,
Dealloc_T  dealloc,
bool  owns_mem 
) [related]

Wraps a preallocated array of data and uses a templated deallocation strategy object to define deletion .

template<class T >
ArrayRCP< T > arcp ( typename ArrayRCP< T >::size_type  size) [related]

Allocate a new array just given a dimension.

Warning! The memory is allocated using new T[size] and is *not* initialized (unless there is a default constructor for a user-defined type).

When called with 'size == 0' it returns a null ArrayRCP object.

template<class T >
ArrayRCP< T > arcpCloneNode ( const ArrayRCP< T > &  a) [related]

Allocate a new ArrayRCP object with a new RCPNode with memory pointing to the initial node.

The purpose of this function is to create a new "handle" to the array of memory with its own seprate reference count. The new ArrayRCP object will have a new RCPNodeTmpl object that has a copy of the input ArrayRCP object embedded in it. This maintains the correct reference counting behaviors but now gives a private count. One would want to use arcpCloneNode(...) whenever it is important to keep a private reference count which is needed for some types of use cases.

template<class T >
ArrayRCP< T > arcpClone ( const ArrayView< const T > &  v) [related]

Allocate a new array by cloning data from an input array view.

template<class T , class Embedded >
ArrayRCP< T > arcpWithEmbeddedObjPreDestroy ( T *  p,
typename ArrayRCP< T >::size_type  lowerOffset,
typename ArrayRCP< T >::size_type  size,
const Embedded &  embedded,
bool  owns_mem = true 
) [related]

Create an ArrayRCP with and also put in an embedded object.

In this case the embedded object is destroyed (by setting to Embedded()) before the object at *p is destroyed.

The embedded object can be extracted using getEmbeddedObj() and getNonconstEmbeddedObject().

template<class T , class Embedded >
ArrayRCP< T > arcpWithEmbeddedObjPostDestroy ( T *  p,
typename ArrayRCP< T >::size_type  lowerOffset,
typename ArrayRCP< T >::size_type  size,
const Embedded &  embedded,
bool  owns_mem = true 
) [related]

Create an ArrayRCP with and also put in an embedded object.

In this case the embedded object is destroyed (by setting to Embedded()) after the object at *p is destroyed.

The embedded object can be extracted using getEmbeddedObj() and getNonconstEmbeddedObject().

template<class T , class Embedded >
ArrayRCP< T > arcpWithEmbeddedObj ( T *  p,
typename ArrayRCP< T >::size_type  lowerOffset,
typename ArrayRCP< T >::size_type  size,
const Embedded &  embedded,
bool  owns_mem = true 
) [related]

Create an ArrayRCP with and also put in an embedded object.

This function should be called when it is not important when the embedded object is destroyed (by setting to Embedded()) with respect to when *p is destroyed.

The embedded object can be extracted using getEmbeddedObj() and getNonconstEmbeddedObject().

template<class T >
ArrayRCP< T > arcp ( const RCP< std::vector< T > > &  v) [related]

Wrap an std::vector<T> object as an ArrayRCP<T> object.

template<class T >
ArrayRCP< const T > arcp ( const RCP< const std::vector< T > > &  v) [related]

Wrap a const std::vector<T> object as an ArrayRCP<const T> object.

template<class T >
ArrayRCP< T > arcpFromArrayView ( const ArrayView< T > &  av) [related]

Get an ArrayRCP object out of an ArrayView object.

This conversion is required an proper in certain types of situations. In a debug build, a dangling reference will be detected with an exception being thrown.

template<class T >
RCP< std::vector< T > > get_std_vector ( const ArrayRCP< T > &  ptr) [related]

Get an std::vector<T> object out of an ArrayRCP<T> object that was created using the arcp() above to wrap the std::vector in the first place..

template<class T >
RCP< const std::vector< T > > get_std_vector ( const ArrayRCP< const T > &  ptr) [related]

Get a const std::vector<T> object out of an ArrayRCP<const T> object that was created using the arcp() above to wrap the std::vector in the first place.

template<class T >
bool is_null ( const ArrayRCP< T > &  p) [related]

Returns true if p.get()==NULL.

Examples:
test/MemoryManagement/RCP_test.cpp.
template<class T >
bool nonnull ( const ArrayRCP< T > &  p) [related]

Returns true if p.get()!=NULL.

template<class T >
bool operator== ( const ArrayRCP< T > &  p,
ENull   
) [related]

Returns true if p.get()==NULL.

template<class T >
bool operator!= ( const ArrayRCP< T > &  p,
ENull   
) [related]

Returns true if p.get()!=NULL.

template<class T1 , class T2 >
bool operator== ( const ArrayRCP< T1 > &  p1,
const ArrayRCP< T2 > &  p2 
) [related]

template<class T1 , class T2 >
bool operator!= ( const ArrayRCP< T1 > &  p1,
const ArrayRCP< T2 > &  p2 
) [related]

template<class T1 , class T2 >
bool operator< ( const ArrayRCP< T1 > &  p1,
const ArrayRCP< T2 > &  p2 
) [related]

template<class T1 , class T2 >
bool operator<= ( const ArrayRCP< T1 > &  p1,
const ArrayRCP< T2 > &  p2 
) [related]

template<class T1 , class T2 >
bool operator> ( const ArrayRCP< T1 > &  p1,
const ArrayRCP< T2 > &  p2 
) [related]

template<class T1 , class T2 >
bool operator>= ( const ArrayRCP< T1 > &  p1,
const ArrayRCP< T2 > &  p2 
) [related]

template<class T >
ArrayRCP< T >::difference_type operator- ( const ArrayRCP< T > &  p1,
const ArrayRCP< T > &  p2 
) [related]

Returns difference of two ArrayRCP objects.

template<class T2 , class T1 >
ArrayRCP< T2 > arcp_const_cast ( const ArrayRCP< T1 > &  p1) [related]

Const cast of underlying ArrayRCP type from const T* to T*.

The function will compile only if the following code compiles:

 T2* p2 = const_cast<T2*> (p1.get ());
Examples:
ArrayRCP_test.cpp.
template<class T2 , class T1 >
ArrayRCP< T2 > arcp_reinterpret_cast ( const ArrayRCP< T1 > &  p1) [related]

Reinterpret cast of underlying ArrayRCP type from T1* to T2*.

The function will compile only if the following code compiles:

 T2* p2 = reinterpret_cast<T2*> (p1.get ());
Warning:
This function is only for advanced users.
Examples:
ArrayRCP_test.cpp.
template<class T2 , class T1 >
ArrayRCP< T2 > arcp_reinterpret_cast_nonpod ( const ArrayRCP< T1 > &  p1,
const T2 &  val = T2() 
) [related]

Reinterpret cast of underlying ArrayRCP type from T1* to T2* where T2 is a non-POD (non-plain-old-data).

The function will compile only if (reinterpret_cast<T2*>(p1.get());) compiles.

This function is used to reinterpret-cast an array of plain-old-data (POD) (e.g. int or char) into an array of objects of type T2, which is not a plain-old-data type. The constructors will be called on each of the memory locations with placement new and the destructors will get called when the last ArrayRCP goes away.

Warning:
This function is only for advanced users.
template<class T2 , class T1 >
ArrayRCP< T2 > arcp_implicit_cast ( const ArrayRCP< T1 > &  p1) [related]

Implicit case the underlying ArrayRCP type from T1* to T2*.

The function will compile only if (T2 *p = p1.get();) compiles.

Warning! Do not use this function unless you absolutely know what you are doing. While implicit casting of pointers to single objects is usually 100% safe, implicit casting pointers to arrays of objects can be very dangerous. One std::exception that is always safe is when you are implicit casting an array of pointers to non-const objects to an array of const pointers to const objects. For example, the following implicit conversion from a array pointer objects aptr1 of type ArrayRCP<T*> to

 ArrayRCP<const T * const>
 aptr2 = arcp_implicit_cast<const T * const>(ptr1);

is always legal and safe to do.

template<class T1 , class T2 >
void set_extra_data ( const T1 &  extra_data,
const std::string &  name,
const Ptr< ArrayRCP< T2 > > &  p,
EPrePostDestruction  destroy_when = POST_DESTROY,
bool  force_unique = true 
) [related]

Set extra data associated with a ArrayRCP object.

Parameters:
extra_data[in] Data object that will be set (copied)
name[in] The name given to the extra data. The value of name together with the data type T1 of the extra data must be unique from any other such data or the other data will be overwritten.
p[out] On output, will be updated with the input extra_data
destroy_when[in] Determines when extra_data will be destroyed in relation to the underlying reference-counted object. If destroy_when==PRE_DESTROY then extra_data will be deleted before the underlying reference-counted object. If destroy_when==POST_DESTROY (the default) then extra_data will be deleted after the underlying reference-counted object.
force_unique[in] Determines if this type and name pair must be unique in which case if an object with this same type and name already exists, then an std::exception will be thrown. The default is true for safety.

If there is a call to this function with the same type of extra data T1 and same arguments p and name has already been made, then the current piece of extra data already set will be overwritten with extra_data. However, if the type of the extra data T1 is different, then the extra data can be added and not overwrite existing extra data. This means that extra data is keyed on both the type and name. This helps to minimize the chance that clients will unexpectedly overwrite data by accident.

When the last RefcountPtr object is removed and the reference-count node is deleted, then objects are deleted in the following order: (1) All of the extra data that where added with destroy_when==PRE_DESTROY are first, (2) then the underlying reference-counted object is deleted, and (3) the rest of the extra data that was added with destroy_when==PRE_DESTROY is then deleted. The order in which the objects are destroyed is not guaranteed. Therefore, clients should be careful not to add extra data that has deletion dependencies (instead consider using nested ArrayRCP objects as extra data which will guarantee the order of deletion).

Preconditions:

  • p->get() != NULL (throws NullReferenceError)
  • If this function has already been called with the same template type T1 for extra_data and the same std::string name and force_unique==true, then an std::invalid_argument std::exception will be thrown.

Note, this function is made a non-member function to be consistent with the non-member get_extra_data() functions.

Examples:
test/MemoryManagement/RCP_test.cpp.
template<class T1 , class T2 >
T1 & get_extra_data ( ArrayRCP< T2 > &  p,
const std::string &  name 
) [related]

Get a non-const reference to extra data associated with a ArrayRCP object.

Parameters:
p[in] Smart pointer object that extra data is being extracted from.
name[in] Name of the extra data.
Returns:
Returns a non-const reference to the extra_data object.

Preconditions:

Note, this function must be a non-member function since the client must manually select the first template argument.

Examples:
test/MemoryManagement/RCP_test.cpp.
template<class T1 , class T2 >
const T1 & get_extra_data ( const ArrayRCP< T2 > &  p,
const std::string &  name 
) [related]

Get a const reference to extra data associated with a ArrayRCP object.

Parameters:
p[in] Smart pointer object that extra data is being extracted from.
name[in] Name of the extra data.
Returns:
Returns a const reference to the extra_data object.

Preconditions:

Note, this function must be a non-member function since the client must manually select the first template argument.

Also note that this const version is a false sense of security since a client can always copy a const ArrayRCP object into a non-const object and then use the non-const version to change the data. However, its presence will help to avoid some types of accidental changes to this extra data.

template<class T1 , class T2 >
T1 * get_optional_extra_data ( ArrayRCP< T2 > &  p,
const std::string &  name 
) [related]

Get a pointer to non-const extra data (if it exists) associated with a ArrayRCP object.

Parameters:
p[in] Smart pointer object that extra data is being extracted from.
name[in] Name of the extra data.
Returns:
Returns a non-const pointer to the extra_data object.

Preconditions:

Postconditions:

  • If name and T1 have been used in a previous call to set_extra_data() then return !=NULL and otherwise return == NULL.

Note, this function must be a non-member function since the client must manually select the first template argument.

Examples:
test/MemoryManagement/RCP_test.cpp.
template<class T1 , class T2 >
const T1 * get_optional_extra_data ( const ArrayRCP< T2 > &  p,
const std::string &  name 
) [related]

Get a pointer to const extra data (if it exists) associated with a ArrayRCP object.

Parameters:
p[in] Smart pointer object that extra data is being extracted from.
name[in] Name of the extra data.
Returns:
Returns a const pointer to the extra_data object if it exists.

Preconditions:

Postconditions:

  • If name and T1 have been used in a previous call to set_extra_data() then return !=NULL and otherwise return == NULL.

Note, this function must be a non-member function since the client must manually select the first template argument.

Also note that this const version is a false sense of security since a client can always copy a const ArrayRCP object into a non-const object and then use the non-const version to change the data. However, its presence will help to avoid some types of accidental changes to this extra data.

template<class Dealloc_T , class T >
Dealloc_T & get_nonconst_dealloc ( const ArrayRCP< T > &  p) [related]

Return a non-const reference to the underlying deallocator object.

Preconditions:

template<class Dealloc_T , class T >
const Dealloc_T & get_dealloc ( const ArrayRCP< T > &  p) [related]

Return a const reference to the underlying deallocator object.

Preconditions:

Note that the const version of this function provides only a very ineffective attempt to avoid accidental changes to the deallocation object. A client can always just create a new non-const ArrayRCP<T> object from any const ArrayRCP<T> object and then call the non-const version of this function.

template<class Dealloc_T , class T >
const Dealloc_T * get_optional_dealloc ( const ArrayRCP< T > &  p) [related]

Return a pointer to the underlying non-const deallocator object if it exists.

Preconditions:

Postconditions:

  • If the deallocator object type used to construct p is same as Dealloc_T then return!=NULL, otherwise return==NULL
Examples:
test/MemoryManagement/RCP_test.cpp.
template<class Dealloc_T , class T >
Dealloc_T * get_optional_nonconst_dealloc ( const ArrayRCP< T > &  p) [related]

Return a pointer to the underlying const deallocator object if it exists.

Preconditions:

Postconditions:

  • If the deallocator object type used to construct p is same as Dealloc_T then return!=NULL, otherwise return==NULL

Note that the const version of this function provides only a very ineffective attempt to avoid accidental changes to the deallocation object. A client can always just create a new non-const ArrayRCP<T> object from any const ArrayRCP<T> object and then call the non-const version of this function.

Examples:
test/MemoryManagement/RCP_test.cpp.
template<class TOrig , class Embedded , class T >
const Embedded & getEmbeddedObj ( const ArrayRCP< T > &  p) [related]

Get a const reference to an embedded object that was set by calling arcpWithEmbeddedObjPreDestroy(), arcpWithEmbeddedObjPostDestory(), or arcpWithEmbeddedObj().

template<class TOrig , class Embedded , class T >
Embedded & getNonconstEmbeddedObj ( const ArrayRCP< T > &  p) [related]

Get a const reference to an embedded object that was set by calling arcpWithEmbeddedObjPreDestroy(), arcpWithEmbeddedObjPostDestory(), or arcpWithEmbeddedObj().

template<class T >
std::ostream & operator<< ( std::ostream &  out,
const ArrayRCP< T > &  p 
) [related]

Output stream inserter.

The implementation of this function just print pointer addresses and therefore puts not restrictions on the data types involved.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines