Teuchos::ArrayRCP< T > Class Template Reference
[Teuchos Memory Management Utilities]

Array reference-counted pointer class. More...

#include <Teuchos_ArrayRCPDecl.hpp>

List of all members.

Public Types

Public types
typedef std::random_access_iterator_tag iterator_category
 
typedef T * iterator_type
 
typedef T value_type
 
typedef T & reference
 
typedef T * pointer
 
typedef ptrdiff_t difference_type
 
typedef T element_type
 
typedef Teuchos_Index Ordinal
 
typedef T * iterator
typedef T * const_iterator

Public Member Functions

Constructors/Initializers
 ArrayRCP (ENull null_arg=null)
 Initialize ArrayRCP<T> to NULL.
 ArrayRCP (const ArrayRCP< T > &r_ptr)
 Initialize from another ArrayRCP<T> object.
 ~ArrayRCP ()
 Removes a reference to a dynamically allocated array and possibly deletes the array if owned.
ArrayRCP< T > & operator= (const ArrayRCP< T > &r_ptr)
 Copy the pointer to the referenced array and increment the reference count.
Object/Pointer Access Functions
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[] (Ordinal 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 deincrement of pointer (i.e. --ptr).
ArrayRCP< T > operator-- (int)
 Postfix deincrement of pointer (i.e. ptr--).
ArrayRCP< T > & operator+= (Ordinal offset)
 Pointer integer increment (i.e. ptr+=offset).
ArrayRCP< T > & operator-= (Ordinal offset)
 Pointer integer increment (i.e. ptr-=offset).
ArrayRCP< T > operator+ (Ordinal offset) const
 Pointer integer increment (i.e. ptr+offset).
ArrayRCP< T > operator- (Ordinal offset) const
 Pointer integer deincrement (i.e. ptr-offset).
Views
ArrayRCP< const T > getConst () const
 Return object for only const access to data.
ArrayRCP< T > persistingView (Ordinal lowerOffset, Ordinal size) const
 Return a persisting view of a contiguous range of elements.
General query functions
int count () const
 Return the number of ArrayRCP<> objects that have a reference to the underlying pointer that is being shared.
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.
Ordinal lowerOffset () const
 Return the lower offset to valid data.
Ordinal upperOffset () const
 Return the upper offset to valid data.
Ordinal size () const
 The total number of items in the managed array (i.e. upperOffset()-lowerOffset()+1).
Standard Container-Like Functions
const_iterator begin () const
 Return an iterator to beginning of the array of data.
const_iterator end () const
 Return an iterator to past the end of the array of data.
ArrayView views
ArrayView< T > view (Ordinal lowerOffset, Ordinal size) const
 Return view of a contiguous range of elements.
ArrayView< T > operator() (Ordinal lowerOffset, Ordinal size) const
 Return a view of a contiguous range of elements (calls view(offset,size)).
ArrayView< T > operator() () const
 Return an ArrayView of *this.
 operator ArrayView () const
 Perform an implicit conversion to a ArrayView (calls operator()()).
 operator ArrayRCP () const
 Convert from ArrayRCP<T> to ArrayRCP<const T>.
Ownership
T * release ()
 Release the ownership of the underlying array.
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 delete it.
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 (Ordinal lowerOffset, Ordinal 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.

Related Functions

(Note that these are not member functions.)

ArrayRCP< T > arcp (const RCP< Array< T > > &v)
 Wrap an Array<T> object as an ArrayRCP<T> object.
ArrayRCP< const T > arcp (const RCP< const Array< T > > &v)
 Wrap a const Array<T> object as an ArrayRCP<const T> object.
ArrayRCP< T > arcp (T *p, typename ArrayRCP< T >::Ordinal lowerOffset, typename ArrayRCP< T >::Ordinal size, bool owns_mem=true)
 Wraps a preallocated array of data with the assumption to call the array version of delete.
ArrayRCP< T > arcp (T *p, typename ArrayRCP< T >::Ordinal lowerOffset, typename ArrayRCP< T >::Ordinal size, Dealloc_T dealloc, bool owns_mem)
 Wraps a preallocated array of data and uses a templated deallocation strategy object to define deletion .
ArrayRCP< T > arcp (typename ArrayRCP< T >::Ordinal size)
 Allocate a new array just given a dimension.
ArrayRCP< T > arcpClone (const ArrayView< const T > &v)
 Allocate a new array by cloning data from an input array view.
ArrayRCP< T > arcpWithEmbeddedObjPreDestroy (T *p, typename ArrayRCP< T >::Ordinal lowerOffset, typename ArrayRCP< T >::Ordinal size, const Embedded &embedded, bool owns_mem=true)
 Create an ArrayRCP with and also put in an embedded object.
ArrayRCP< T > arcpWithEmbeddedObjPostDestroy (T *p, typename ArrayRCP< T >::Ordinal lowerOffset, typename ArrayRCP< T >::Ordinal size, const Embedded &embedded, bool owns_mem=true)
 Create an ArrayRCP with and also put in an embedded object.
ArrayRCP< T > arcpWithEmbeddedObj (T *p, typename ArrayRCP< T >::Ordinal lowerOffset, typename ArrayRCP< T >::Ordinal size, const Embedded &embedded, bool owns_mem=true)
 Create an ArrayRCP with and also put in an embedded object.
ArrayRCP< T > arcp (const RCP< std::vector< T > > &v)
 Wrap an std::vector<T> object as an ArrayRCP<T> object.
ArrayRCP< const T > arcp (const RCP< const std::vector< T > > &v)
 Wrap a const std::vector<T> object as an ArrayRCP<const T> object.
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..
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.
bool is_null (const ArrayRCP< T > &p)
 Returns true if p.get()==NULL.
bool operator== (const ArrayRCP< T > &p, ENull)
 Returns true if p.get()==NULL.
bool operator!= (const ArrayRCP< T > &p, ENull)
 Returns true if p.get()!=NULL.
bool operator== (const ArrayRCP< T1 > &p1, const ArrayRCP< T2 > &p2)
 
bool operator!= (const ArrayRCP< T1 > &p1, const ArrayRCP< T2 > &p2)
 
bool operator< (const ArrayRCP< T1 > &p1, const ArrayRCP< T2 > &p2)
 
bool operator<= (const ArrayRCP< T1 > &p1, const ArrayRCP< T2 > &p2)
 
bool operator> (const ArrayRCP< T1 > &p1, const ArrayRCP< T2 > &p2)
 
bool operator>= (const ArrayRCP< T1 > &p1, const ArrayRCP< T2 > &p2)
 
ArrayRCP< T >::difference_type operator- (const ArrayRCP< T > &p1, const ArrayRCP< T > &p2)
 Returns difference of two ArrayRCP object.
ArrayRCP< T2 > arcp_const_cast (const ArrayRCP< T1 > &p1)
 Const cast of underlying ArrayRCP type from const T* to T*.
ArrayRCP< T2 > arcp_reinterpret_cast (const ArrayRCP< T1 > &p1)
 Reinterpret cast of underlying ArrayRCP type from T1* to T2*.
ArrayRCP< T2 > arcp_implicit_cast (const ArrayRCP< T1 > &p1)
 Implicit case the underlying ArrayRCP type from T1* to T2*.
void set_extra_data (const T1 &extra_data, const std::string &name, ArrayRCP< T2 > *p, EPrePostDestruction destroy_when=POST_DESTROY, bool force_unique=true)
 Set extra data associated with a ArrayRCP object.
T1 & get_extra_data (ArrayRCP< T2 > &p, const std::string &name)
 Get a non-const reference to extra data associated with a ArrayRCP object.
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.
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.
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.
Dealloc_T & get_nonconst_dealloc (const ArrayRCP< T > &p)
 Return a non-const reference to the underlying deallocator object.
const Dealloc_T & get_dealloc (const ArrayRCP< T > &p)
 Return a const reference to the underlying deallocator object.
const Dealloc_T * get_optional_dealloc (const ArrayRCP< T > &p)
 Return a pointer to the underlying non-const deallocator object if it exists.
Dealloc_T * get_optional_nonconst_dealloc (const ArrayRCP< T > &p)
 Return a pointer to the underlying const deallocator object if it exists.
const Embedded & getEmbeddedObj (const ArrayRCP< T > &p)
 Get a const reference to an embedded object that was set by calling arcpWithEmbeddedObjPreDestroy(), arcpWithEmbeddedObjPostDestory(), or arcpWithEmbeddedObj().
Embedded & getNonconstEmbeddedObj (const ArrayRCP< T > &p)
 Get a const reference to an embedded object that was set by calling arcpWithEmbeddedObjPreDestroy(), arcpWithEmbeddedObjPostDestory(), or arcpWithEmbeddedObj().
std::ostream & operator<< (std::ostream &out, const ArrayRCP< T > &p)
 Output stream inserter.


Detailed Description

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

Array reference-counted pointer class.

This is a reference-counted class similar to RCP except that it is designed to use reference counting to manage an array of objects that use value semantics. 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 is a good thing when dealing with pointers to single objects, it is a very bad thing when working with arrays of objects. Therefore, this class contains those capabilities of raw pointers that are good dealing with arrays of objects but excludes those that are bad, such as implicit conversions from derived to base types.

Note that all access will be checked at runtime to avoid reading invalid memory if HAVE_TEUCHOS_ARRAY_BOUNDSCHECK is defined which it is if --enable-teuchos-abc is given to the configure script. In order to be able to check access, every ArrayRCP must be constructed given a range. When HAVE_TEUCHOS_ARRAY_BOUNDSCHECK is defined, this class simply does not give up a raw pointer or raw reference to any internally referenced object if that object does not fall with the range of valid data.

Type T requirements:

ToDo: Finish documentation!

Definition at line 73 of file Teuchos_ArrayRCPDecl.hpp.


Member Typedef Documentation

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

Definition at line 80 of file Teuchos_ArrayRCPDecl.hpp.

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

Definition at line 82 of file Teuchos_ArrayRCPDecl.hpp.

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

Definition at line 84 of file Teuchos_ArrayRCPDecl.hpp.

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

Definition at line 86 of file Teuchos_ArrayRCPDecl.hpp.

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

Definition at line 88 of file Teuchos_ArrayRCPDecl.hpp.

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

Definition at line 90 of file Teuchos_ArrayRCPDecl.hpp.

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

Definition at line 93 of file Teuchos_ArrayRCPDecl.hpp.

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

Definition at line 95 of file Teuchos_ArrayRCPDecl.hpp.


Constructor & Destructor Documentation

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

Initialize ArrayRCP<T> to NULL.

This allows clients to write code like:

   ArrayRCP<int> p = null;
or
   ArrayRCP<int> p;
and construct to NULL

Definition at line 48 of file Teuchos_ArrayRCP.hpp.

template<class T>
REFCOUNTPTR_INLINE Teuchos::ArrayRCP< T >::ArrayRCP ( const ArrayRCP< T > &  r_ptr  ) 

Initialize from another ArrayRCP<T> object.

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

This form of the copy constructor is required even though the below more general templated version is sufficient since some compilers will generate this function automatically which will give an incorrect implementation.

Postconditions:

Definition at line 58 of file Teuchos_ArrayRCP.hpp.

template<class T>
REFCOUNTPTR_INLINE Teuchos::ArrayRCP< T >::~ArrayRCP (  ) 

Removes a reference to a dynamically allocated array and possibly deletes the array if owned.

Deallocates array if this->has_ownership() == true and this->count() == 1. If this->count() == 1 but this->has_ownership() == false then the array is not deleted (usually using delete []). If this->count() > 1 then the internal reference count shared by all the other related ArrayRCP<...> objects for this shared array is deincremented by one. If this->get() == NULL then nothing happens.

Definition at line 69 of file Teuchos_ArrayRCP.hpp.


Member Function Documentation

template<class T>
REFCOUNTPTR_INLINE ArrayRCP< T > & Teuchos::ArrayRCP< T >::operator= ( const ArrayRCP< T > &  r_ptr  ) 

Copy the pointer to the referenced array and increment the reference count.

If this->has_ownership() == true and this->count() == 1 before this operation is called, then the array will be deleted prior to binding to the pointer (possibly NULL) pointed to in r_ptr. Assignment to self (i.e. this->get() == r_ptr.get()) is harmless and this function does nothing.

Postconditions:

Definition at line 83 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.

Preconditions:

Definition at line 107 of file Teuchos_ArrayRCP.hpp.

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

Dereference the underlying object for the current pointer position.

Preconditions:

Definition at line 118 of file Teuchos_ArrayRCP.hpp.

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

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

Preconditions:

Definition at line 129 of file Teuchos_ArrayRCP.hpp.

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

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

Preconditions:

Definition at line 142 of file Teuchos_ArrayRCP.hpp.

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

Random object access.

Preconditions:

Definition at line 150 of file Teuchos_ArrayRCP.hpp.

template<class T>
REFCOUNTPTR_INLINE ArrayRCP< T > & Teuchos::ArrayRCP< T >::operator++ (  ) 

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

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

Postconditions:

Definition at line 164 of file Teuchos_ArrayRCP.hpp.

template<class T>
REFCOUNTPTR_INLINE ArrayRCP< T > Teuchos::ArrayRCP< T >::operator++ ( int   ) 

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

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

Postconditions:

Definition at line 177 of file Teuchos_ArrayRCP.hpp.

template<class T>
REFCOUNTPTR_INLINE ArrayRCP< T > & Teuchos::ArrayRCP< T >::operator-- (  ) 

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

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

Postconditions:

Definition at line 187 of file Teuchos_ArrayRCP.hpp.

template<class T>
REFCOUNTPTR_INLINE ArrayRCP< T > Teuchos::ArrayRCP< T >::operator-- ( int   ) 

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

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

Postconditions:

Definition at line 200 of file Teuchos_ArrayRCP.hpp.

template<class T>
REFCOUNTPTR_INLINE ArrayRCP< T > & Teuchos::ArrayRCP< T >::operator+= ( Ordinal  offset  ) 

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

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

Postconditions:

Definition at line 210 of file Teuchos_ArrayRCP.hpp.

template<class T>
REFCOUNTPTR_INLINE ArrayRCP< T > & Teuchos::ArrayRCP< T >::operator-= ( Ordinal  offset  ) 

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

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

Postconditions:

Definition at line 223 of file Teuchos_ArrayRCP.hpp.

template<class T>
REFCOUNTPTR_INLINE ArrayRCP< T > Teuchos::ArrayRCP< T >::operator+ ( Ordinal  offset  )  const

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

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

Postconditions:

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 236 of file Teuchos_ArrayRCP.hpp.

template<class T>
REFCOUNTPTR_INLINE ArrayRCP< T > Teuchos::ArrayRCP< T >::operator- ( Ordinal  offset  )  const

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

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

Postconditions:

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 246 of file Teuchos_ArrayRCP.hpp.

template<class T>
REFCOUNTPTR_INLINE ArrayRCP< const T > Teuchos::ArrayRCP< T >::getConst (  )  const

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 259 of file Teuchos_ArrayRCP.hpp.

template<class T>
REFCOUNTPTR_INLINE ArrayRCP< T > Teuchos::ArrayRCP< T >::persistingView ( Ordinal  lowerOffset,
Ordinal  size 
) const

Return a persisting view of a contiguous range of elements.

Preconditions:

Postconditions:

Definition at line 269 of file Teuchos_ArrayRCP.hpp.

template<class T>
REFCOUNTPTR_INLINE int Teuchos::ArrayRCP< T >::count (  )  const

Return the number of ArrayRCP<> objects that have a reference to the underlying pointer that is being shared.

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

Definition at line 287 of file Teuchos_ArrayRCP.hpp.

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

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 297 of file Teuchos_ArrayRCP.hpp.

template<class T>
REFCOUNTPTR_INLINE ArrayRCP< T >::Ordinal Teuchos::ArrayRCP< T >::lowerOffset (  )  const

Return the lower offset to valid data.

Definition at line 309 of file Teuchos_ArrayRCP.hpp.

template<class T>
REFCOUNTPTR_INLINE ArrayRCP< T >::Ordinal Teuchos::ArrayRCP< T >::upperOffset (  )  const

Return the upper offset to valid data.

Definition at line 318 of file Teuchos_ArrayRCP.hpp.

template<class T>
REFCOUNTPTR_INLINE ArrayRCP< T >::Ordinal Teuchos::ArrayRCP< T >::size (  )  const

The total number of items in the managed array (i.e. upperOffset()-lowerOffset()+1).

Definition at line 327 of file Teuchos_ArrayRCP.hpp.

template<class T>
REFCOUNTPTR_INLINE ArrayRCP< T >::const_iterator Teuchos::ArrayRCP< T >::begin (  )  const

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.

Postconditions:

Definition at line 338 of file Teuchos_ArrayRCP.hpp.

template<class T>
REFCOUNTPTR_INLINE ArrayRCP< T >::const_iterator Teuchos::ArrayRCP< T >::end (  )  const

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.

Postconditions:

Definition at line 351 of file Teuchos_ArrayRCP.hpp.

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

Return view of a contiguous range of elements.

Preconditions:

Postconditions:

Definition at line 365 of file Teuchos_ArrayRCP.hpp.

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

Return a view of a contiguous range of elements (calls view(offset,size)).

Definition at line 375 of file Teuchos_ArrayRCP.hpp.

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

Return an ArrayView of *this.

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

Definition at line 382 of file Teuchos_ArrayRCP.hpp.

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

Perform an implicit conversion to a ArrayView (calls operator()()).

Definition at line 391 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>.

Definition at line 398 of file Teuchos_ArrayRCP.hpp.

template<class T>
REFCOUNTPTR_INLINE T * Teuchos::ArrayRCP< T >::release (  ) 

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 409 of file Teuchos_ArrayRCP.hpp.

template<class T>
REFCOUNTPTR_INLINE void Teuchos::ArrayRCP< T >::set_has_ownership (  ) 

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 419 of file Teuchos_ArrayRCP.hpp.

template<class T>
REFCOUNTPTR_INLINE bool Teuchos::ArrayRCP< T >::has_ownership (  )  const

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

See ~ArrayRCP() above.

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 428 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 442 of file Teuchos_ArrayRCP.hpp.

template<class T>
const ArrayRCP< T > & Teuchos::ArrayRCP< T >::assert_in_range ( Ordinal  lowerOffset,
Ordinal  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 453 of file Teuchos_ArrayRCP.hpp.


Friends And Related Function Documentation

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

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

Definition at line 485 of file Teuchos_Array.hpp.

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

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

Definition at line 502 of file Teuchos_Array.hpp.

template<class T>
ArrayRCP< T > arcp ( T *  p,
typename ArrayRCP< T >::Ordinal  lowerOffset,
typename ArrayRCP< T >::Ordinal  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>
ArrayRCP< T > arcp ( T *  p,
typename ArrayRCP< T >::Ordinal  lowerOffset,
typename ArrayRCP< T >::Ordinal  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 >::Ordinal  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).

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

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

Definition at line 634 of file Teuchos_ArrayRCP.hpp.

template<class T>
ArrayRCP< T > arcpWithEmbeddedObjPreDestroy ( T *  p,
typename ArrayRCP< T >::Ordinal  lowerOffset,
typename ArrayRCP< T >::Ordinal  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>
ArrayRCP< T > arcpWithEmbeddedObjPostDestroy ( T *  p,
typename ArrayRCP< T >::Ordinal  lowerOffset,
typename ArrayRCP< T >::Ordinal  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>
ArrayRCP< T > arcpWithEmbeddedObj ( T *  p,
typename ArrayRCP< T >::Ordinal  lowerOffset,
typename ArrayRCP< T >::Ordinal  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.

Definition at line 696 of file Teuchos_ArrayRCP.hpp.

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.

Definition at line 710 of file Teuchos_ArrayRCP.hpp.

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..

Definition at line 724 of file Teuchos_ArrayRCP.hpp.

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.

Definition at line 733 of file Teuchos_ArrayRCP.hpp.

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

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

Definition at line 741 of file Teuchos_ArrayRCP.hpp.

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

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

Definition at line 749 of file Teuchos_ArrayRCP.hpp.

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

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

Definition at line 757 of file Teuchos_ArrayRCP.hpp.

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

Definition at line 765 of file Teuchos_ArrayRCP.hpp.

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

Definition at line 773 of file Teuchos_ArrayRCP.hpp.

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

Definition at line 781 of file Teuchos_ArrayRCP.hpp.

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

Definition at line 789 of file Teuchos_ArrayRCP.hpp.

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

Definition at line 798 of file Teuchos_ArrayRCP.hpp.

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

Definition at line 807 of file Teuchos_ArrayRCP.hpp.

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

Returns difference of two ArrayRCP object.

Definition at line 816 of file Teuchos_ArrayRCP.hpp.

template<class T>
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 (const_cast<T2*>(p1.get());) compiles.

Definition at line 844 of file Teuchos_ArrayRCP.hpp.

template<class T>
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 (reinterpret_cast<T2*>(p1.get());) compiles.

Warning! Do not use this function unless you absolutely know what you are doing. Doing a reinterpret cast is always a tricking thing and must only be done by developers who are 100% comfortable with what they are doing.

Definition at line 826 of file Teuchos_ArrayRCP.hpp.

template<class T>
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.

Definition at line 859 of file Teuchos_ArrayRCP.hpp.

template<class T>
void set_extra_data ( const T1 &  extra_data,
const std::string &  name,
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:

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

Definition at line 873 of file Teuchos_ArrayRCP.hpp.

template<class T>
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.

Definition at line 885 of file Teuchos_ArrayRCP.hpp.

template<class T>
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.

Definition at line 894 of file Teuchos_ArrayRCP.hpp.

template<class T>
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:

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

Definition at line 903 of file Teuchos_ArrayRCP.hpp.

template<class T>
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:

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.

Definition at line 914 of file Teuchos_ArrayRCP.hpp.

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

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

Preconditions:

Definition at line 935 of file Teuchos_ArrayRCP.hpp.

template<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.

Definition at line 926 of file Teuchos_ArrayRCP.hpp.

template<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:

Definition at line 956 of file Teuchos_ArrayRCP.hpp.

template<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:

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.

Definition at line 965 of file Teuchos_ArrayRCP.hpp.

template<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().

Definition at line 978 of file Teuchos_ArrayRCP.hpp.

template<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().

Definition at line 986 of file Teuchos_ArrayRCP.hpp.

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.

Definition at line 994 of file Teuchos_ArrayRCP.hpp.


The documentation for this class was generated from the following files:
Generated on Wed May 12 21:40:33 2010 for Teuchos - Trilinos Tools Package by  doxygen 1.4.7