Teuchos - Trilinos Tools Package Version of the Day
Loading...
Searching...
No Matches
Teuchos::ArrayRCP< void > Class Reference

Full specialization of ArrayRCP for T = void. More...

#include <Teuchos_ArrayRCPDecl.hpp>

Public Types

typedef void * pointer
Public typedefs
typedef void & reference
 Type of a (nonconstant) reference to an array element.
typedef const void & const_reference
 Type of a (constant) reference to an array element.
typedef void * iterator
 Nonconstant iterator type used if bounds checking is disabled.
typedef const void * const_iterator
 Constant iterator type used if bounds checking is disabled.

Public Member Functions

 ArrayRCP ()
 Default constructor; thows an exception.
Constructors/Destructors/Initializers
 ~ArrayRCP ()
 Destructor, that decrements the reference count.
ArrayRCP< void > & operator= (const ArrayRCP< void > &r_ptr)
 Assignment operator: Makes *this reference the input array.
Object/Pointer Access Functions
void * operator-> () const
 Pointer (->) access to members of underlying object for current position.
void & operator* () const
 Dereference the underlying object for the current pointer position.
void * get () const
 Get the raw C++ pointer to the underlying object.
void * getRawPtr () const
 Get the raw C++ pointer to the underlying object.
void & operator[] (size_type offset) const
 Random object access.
Pointer Arithmetic Functions
ArrayRCP< void > & operator++ ()
 Prefix increment of pointer (i.e. ++ptr).
ArrayRCP< void > & operator-- ()
 Prefix decrement of pointer (i.e. –ptr).
ArrayRCP< void > & operator+= (size_type offset)
 Pointer integer increment (i.e. ptr+=offset).
ArrayRCP< void > & operator-= (size_type offset)
 Pointer integer increment (i.e. ptr-=offset).
ArrayRCP< void > operator+ (size_type offset) const
 Pointer integer increment (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 void > getConst () const
 Return object for only const access to data.
ArrayRCP< void > 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< void > view (size_type lowerOffset, size_type size) const
 Return a nonpersisting view of a contiguous range of elements.
ArrayView< void > operator() (size_type lowerOffset, size_type size) const
 Return a nonpersisting view of a contiguous range of elements.
Implicit conversions
 operator ArrayRCP< const void > () const
 Convert from ArrayRCP<T> to ArrayRCP<const T>.
std::vector like and other misc functions
void assign (size_type n, const void &val)
 Resize and assign n elements of val.
void deepCopy (const ArrayView< const void > &av)
 Deep copy the elements from one ArrayView object into this object.
void resize (const size_type n, const void &val=void())
 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.
void * release ()
 Release the ownership of the underlying array.
ArrayRCP< void > create_weak () const
 Create a new weak reference from another (strong) reference.
ArrayRCP< void > create_strong () const
 Create a new strong RCP object from another (weak) RCP object.
bool shares_resource (const ArrayRCP< T2 > &r_ptr) const
 Returns true if the smart pointers share the same underlying reference-counted object.

(Note that these are not member symbols.)

ArrayRCP< void > arcp (const RCP< Array< void > > &v)
 Wrap an RCP<Array<T> > object as an ArrayRCP<T> object.
ArrayRCP< const void > arcp (const RCP< const Array< void > > &v)
 Wrap a RCP<const Array<T> > object as an ArrayRCP<const T> object.
ArrayRCP< void > arcpFromArray (Array< void > &a)
 Wrap an Array<T> object as a non-owning ArrayRCP<T> object.
ArrayRCP< const void > arcpFromArray (const Array< void > &a)
 Wrap a const Array<T> object as a non-owning ArrayRCP<T> object.
ArrayRCP< void > arcp (void *p, typename ArrayRCP< void >::size_type lowerOffset, typename ArrayRCP< void >::size_type size, bool owns_mem=true)
 Wraps a preallocated array of data with the assumption to call the array version of delete.
ArrayRCP< void > arcp (void *p, typename ArrayRCP< void >::size_type lowerOffset, typename ArrayRCP< void >::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 .
ArrayRCP< void > arcp (typename ArrayRCP< void >::size_type size)
 Allocate a new array just given a dimension.
ArrayRCP< void > arcpCloneNode (const ArrayRCP< void > &a)
 Allocate a new ArrayRCP object with a new RCPNode with memory pointing to the initial node.
ArrayRCP< void > arcpClone (const ArrayView< const void > &v)
 Allocate a new array by cloning data from an input array view.
ArrayRCP< void > arcpWithEmbeddedObjPreDestroy (void *p, typename ArrayRCP< void >::size_type lowerOffset, typename ArrayRCP< void >::size_type size, const Embedded &embedded, bool owns_mem=true)
 Create an ArrayRCP with and also put in an embedded object.
ArrayRCP< void > arcpWithEmbeddedObjPostDestroy (void *p, typename ArrayRCP< void >::size_type lowerOffset, typename ArrayRCP< void >::size_type size, const Embedded &embedded, bool owns_mem=true)
 Create an ArrayRCP with and also put in an embedded object.
ArrayRCP< void > arcpWithEmbeddedObj (void *p, typename ArrayRCP< void >::size_type lowerOffset, typename ArrayRCP< void >::size_type size, const Embedded &embedded, bool owns_mem=true)
 Create an ArrayRCP with and also put in an embedded object.
ArrayRCP< void > arcp (const RCP< std::vector< void > > &v)
 Wrap an std::vector<T> object as an ArrayRCP<T> object.
ArrayRCP< const void > arcp (const RCP< const std::vector< void > > &v)
 Wrap a const std::vector<T> object as an ArrayRCP<const T> object.
ArrayRCP< void > arcpFromArrayView (const ArrayView< void > &av)
 Get an ArrayRCP object out of an ArrayView object.
RCP< std::vector< void > > get_std_vector (const ArrayRCP< void > &ptr)
 Get an std::vector<T> object out of an ArrayRCP<T> object that was created using the arcp() function above to wrap the std::vector in the first place..
RCP< const std::vector< void > > get_std_vector (const ArrayRCP< const void > &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< void > &p)
 Returns true if p.get()==NULL.
bool nonnull (const ArrayRCP< void > &p)
 Returns true if p.get()!=NULL.
bool operator== (const ArrayRCP< void > &p, ENull)
 Returns true if p.get()==NULL.
bool operator!= (const ArrayRCP< void > &p, ENull)
 Returns true if p.get()!=NULL.
bool operator== (const ArrayRCP< T1 > &p1, const ArrayRCP< T2 > &p2)
 Compare two ArrayRCP objects for equality (by pointers).
bool operator!= (const ArrayRCP< T1 > &p1, const ArrayRCP< T2 > &p2)
 Compare two ArrayRCP objects for inequality (by pointers).
bool operator< (const ArrayRCP< T1 > &p1, const ArrayRCP< T2 > &p2)
 Compare the two ArrayRCP objects' pointers using <.
bool operator<= (const ArrayRCP< T1 > &p1, const ArrayRCP< T2 > &p2)
 Compare the two ArrayRCP objects' pointers using <=.
bool operator> (const ArrayRCP< T1 > &p1, const ArrayRCP< T2 > &p2)
 Compare the two ArrayRCP objects' pointers using >.
bool operator>= (const ArrayRCP< T1 > &p1, const ArrayRCP< T2 > &p2)
 Compare the two ArrayRCP objects' pointers using >=.
ArrayRCP< void >::difference_type operator- (const ArrayRCP< void > &p1, const ArrayRCP< void > &p2)
 Return the difference of two ArrayRCP objects.
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_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).
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, const Ptr< 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< void > &p)
 Return a non-const reference to the underlying deallocator object.
const Dealloc_T & get_dealloc (const ArrayRCP< void > &p)
 Return a const reference to the underlying deallocator object.
const Dealloc_T * get_optional_dealloc (const ArrayRCP< void > &p)
 Return a pointer to the underlying non-const deallocator object if it exists.
Dealloc_T * get_optional_nonconst_dealloc (const ArrayRCP< void > &p)
 Return a pointer to the underlying const deallocator object if it exists.
const Embedded & getEmbeddedObj (const ArrayRCP< void > &p)
 Get a const reference to an embedded object that was set by calling arcpWithEmbeddedObjPreDestroy(), arcpWithEmbeddedObjPostDestory(), or arcpWithEmbeddedObj().
Embedded & getNonconstEmbeddedObj (const ArrayRCP< void > &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< void > &p)
 Output stream inserter.

Assertion Functions.

const ArrayRCP< void > & assert_not_null () const
 Throws NullReferenceError if this->get()==NULL, otherwise returns reference to *this.
const ArrayRCP< void > & 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< void > & assert_valid_ptr () const
 If the object pointer is non-null, assert that it is still valid.

Detailed Description

Full specialization of ArrayRCP for T = void.

The generic implementation of ArrayRCP<T> does not make syntactic sense for T = void, because the reference and const_reference typedefs would resolve to the invalid "types" void& resp. const void&. This full template specialization ArrayRCP<void> neglects these invalid "types."

Definition at line 948 of file Teuchos_ArrayRCPDecl.hpp.

Member Typedef Documentation

◆ pointer

typedef void* Teuchos::ArrayRCP< void >::pointer

Definition at line 960 of file Teuchos_ArrayRCPDecl.hpp.

◆ reference

typedef void& Teuchos::ArrayRCP< void >::reference

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

Definition at line 118 of file Teuchos_ArrayRCPDecl.hpp.

◆ const_reference

typedef const void& Teuchos::ArrayRCP< void >::const_reference

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

Definition at line 121 of file Teuchos_ArrayRCPDecl.hpp.

◆ iterator

typedef void* Teuchos::ArrayRCP< void >::iterator

Nonconstant iterator type used if bounds checking is disabled.

Definition at line 139 of file Teuchos_ArrayRCPDecl.hpp.

◆ const_iterator

typedef const void* Teuchos::ArrayRCP< void >::const_iterator

Constant iterator type used if bounds checking is disabled.

Definition at line 141 of file Teuchos_ArrayRCPDecl.hpp.

Constructor & Destructor Documentation

◆ ArrayRCP()

Teuchos::ArrayRCP< void >::ArrayRCP ( )
inline

Default constructor; thows an exception.

Definition at line 1217 of file Teuchos_ArrayRCP.hpp.

◆ ~ArrayRCP()

Teuchos::ArrayRCP< void >::~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 259 of file Teuchos_ArrayRCP.hpp.

Member Function Documentation

◆ operator=()

ArrayRCP< const void > & Teuchos::ArrayRCP< void >::operator= ( const ArrayRCP< void > & 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).

x = y;
ArrayRCP()
Default constructor; thows an exception.
ArrayRCP< void > arcp(const RCP< Array< void > > &v)
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 288 of file Teuchos_ArrayRCP.hpp.

◆ operator->()

const void * Teuchos::ArrayRCP< void >::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 304 of file Teuchos_ArrayRCP.hpp.

◆ operator*()

const void & Teuchos::ArrayRCP< void >::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 313 of file Teuchos_ArrayRCP.hpp.

◆ get()

const void * Teuchos::ArrayRCP< void >::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 320 of file Teuchos_ArrayRCP.hpp.

◆ getRawPtr()

const void * Teuchos::ArrayRCP< void >::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 327 of file Teuchos_ArrayRCP.hpp.

◆ operator[]()

const void & Teuchos::ArrayRCP< void >::operator[] ( size_type offset) const
inline

Random object access.

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

Definition at line 334 of file Teuchos_ArrayRCP.hpp.

◆ operator++()

ArrayRCP< const void > & Teuchos::ArrayRCP< void >::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 348 of file Teuchos_ArrayRCP.hpp.

◆ operator--()

ArrayRCP< const void > & Teuchos::ArrayRCP< void >::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 368 of file Teuchos_ArrayRCP.hpp.

◆ operator+=()

ArrayRCP< const void > & Teuchos::ArrayRCP< void >::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 388 of file Teuchos_ArrayRCP.hpp.

◆ operator-=()

ArrayRCP< const void > & Teuchos::ArrayRCP< void >::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 398 of file Teuchos_ArrayRCP.hpp.

◆ operator+()

ArrayRCP< const void > Teuchos::ArrayRCP< void >::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 412 of file Teuchos_ArrayRCP.hpp.

◆ begin()

ArrayRCP< constT >::iterator Teuchos::ArrayRCP< void >::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 442 of file Teuchos_ArrayRCP.hpp.

◆ end()

ArrayRCP< constT >::iterator Teuchos::ArrayRCP< void >::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 454 of file Teuchos_ArrayRCP.hpp.

◆ getConst()

ArrayRCP< const void > Teuchos::ArrayRCP< void >::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 465 of file Teuchos_ArrayRCP.hpp.

◆ persistingView()

ArrayRCP< const void > Teuchos::ArrayRCP< void >::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 480 of file Teuchos_ArrayRCP.hpp.

◆ lowerOffset()

ArrayRCP< constT >::size_type Teuchos::ArrayRCP< void >::lowerOffset ( ) const
inline

Return the lower offset to valid data.

Definition at line 487 of file Teuchos_ArrayRCP.hpp.

◆ upperOffset()

ArrayRCP< constT >::size_type Teuchos::ArrayRCP< void >::upperOffset ( ) const
inline

Return the upper offset to valid data.

Definition at line 490 of file Teuchos_ArrayRCP.hpp.

◆ size()

ArrayRCP< constT >::size_type Teuchos::ArrayRCP< void >::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 496 of file Teuchos_ArrayRCP.hpp.

◆ view()

ArrayView< const void > Teuchos::ArrayRCP< void >::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 515 of file Teuchos_ArrayRCP.hpp.

◆ operator()()

ArrayView< const void > Teuchos::ArrayRCP< void >::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 521 of file Teuchos_ArrayRCP.hpp.

◆ operator ArrayRCP< const void >()

Teuchos::ArrayRCP< void >::operator ArrayRCP< const void > ( ) 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 539 of file Teuchos_ArrayRCP.hpp.

◆ assign()

void Teuchos::ArrayRCP< void >::assign ( size_type n,
const void & val )
inline

Resize and assign n elements of val.

\postconditions size() == n

Definition at line 549 of file Teuchos_ArrayRCP.hpp.

◆ deepCopy()

void Teuchos::ArrayRCP< void >::deepCopy ( const ArrayView< const void > & 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 566 of file Teuchos_ArrayRCP.hpp.

◆ resize()

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

Resize and append new elements if necessary.

Definition at line 569 of file Teuchos_ArrayRCP.hpp.

◆ clear()

void Teuchos::ArrayRCP< void >::clear ( )
inline

Resize to zero.

\postconditions size()==0

Definition at line 575 of file Teuchos_ArrayRCP.hpp.

◆ strength()

ERCPStrength Teuchos::ArrayRCP< void >::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 592 of file Teuchos_ArrayRCP.hpp.

◆ is_valid_ptr()

bool Teuchos::ArrayRCP< void >::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 603 of file Teuchos_ArrayRCP.hpp.

◆ strong_count()

int Teuchos::ArrayRCP< void >::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 610 of file Teuchos_ArrayRCP.hpp.

◆ weak_count()

int Teuchos::ArrayRCP< void >::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 617 of file Teuchos_ArrayRCP.hpp.

◆ total_count()

int Teuchos::ArrayRCP< void >::total_count ( ) const
inline

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

Definition at line 620 of file Teuchos_ArrayRCP.hpp.

◆ set_has_ownership()

void Teuchos::ArrayRCP< void >::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 639 of file Teuchos_ArrayRCP.hpp.

◆ has_ownership()

bool Teuchos::ArrayRCP< void >::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 652 of file Teuchos_ArrayRCP.hpp.

◆ release()

const void * Teuchos::ArrayRCP< void >::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 674 of file Teuchos_ArrayRCP.hpp.

◆ create_weak()

ArrayRCP< const void > Teuchos::ArrayRCP< void >::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 690 of file Teuchos_ArrayRCP.hpp.

◆ create_strong()

ArrayRCP< const void > Teuchos::ArrayRCP< void >::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 707 of file Teuchos_ArrayRCP.hpp.

◆ shares_resource()

bool Teuchos::ArrayRCP< void >::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 716 of file Teuchos_ArrayRCP.hpp.

◆ assert_not_null()

const ArrayRCP< const void > & Teuchos::ArrayRCP< void >::assert_not_null ( ) const
inline

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

Definition at line 725 of file Teuchos_ArrayRCP.hpp.

◆ assert_in_range()

const ArrayRCP< const void > & Teuchos::ArrayRCP< void >::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 732 of file Teuchos_ArrayRCP.hpp.

◆ assert_valid_ptr()

const ArrayRCP< const void > & Teuchos::ArrayRCP< void >::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 743 of file Teuchos_ArrayRCP.hpp.

◆ arcp() [1/7]

ArrayRCP< void > arcp ( const RCP< Array< void > > & v)
related

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

Definition at line 512 of file Teuchos_Array.hpp.

◆ arcp() [2/7]

ArrayRCP< const void > arcp ( const RCP< const Array< void > > & v)
related

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

Definition at line 529 of file Teuchos_Array.hpp.

◆ arcpFromArray() [1/2]

ArrayRCP< void > arcpFromArray ( Array< void > & a)
related

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

Definition at line 546 of file Teuchos_Array.hpp.

◆ arcpFromArray() [2/2]

ArrayRCP< const void > arcpFromArray ( const Array< void > & a)
related

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

Definition at line 564 of file Teuchos_Array.hpp.

◆ arcp() [3/7]

ArrayRCP< void > arcp ( void * p,
typename ArrayRCP< void >::size_type lowerOffset,
typename ArrayRCP< void >::size_type size,
bool owns_mem = true )
related

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

◆ arcp() [4/7]

ArrayRCP< void > arcp ( void * p,
typename ArrayRCP< void >::size_type lowerOffset,
typename ArrayRCP< void >::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 .

◆ arcp() [5/7]

ArrayRCP< void > arcp ( typename ArrayRCP< void >::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.

◆ arcpCloneNode()

ArrayRCP< void > arcpCloneNode ( const ArrayRCP< void > & 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.

◆ arcpClone()

ArrayRCP< void > arcpClone ( const ArrayView< const void > & v)
related

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

◆ arcpWithEmbeddedObjPreDestroy()

ArrayRCP< void > arcpWithEmbeddedObjPreDestroy ( void * p,
typename ArrayRCP< void >::size_type lowerOffset,
typename ArrayRCP< void >::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().

◆ arcpWithEmbeddedObjPostDestroy()

ArrayRCP< void > arcpWithEmbeddedObjPostDestroy ( void * p,
typename ArrayRCP< void >::size_type lowerOffset,
typename ArrayRCP< void >::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().

◆ arcpWithEmbeddedObj()

ArrayRCP< void > arcpWithEmbeddedObj ( void * p,
typename ArrayRCP< void >::size_type lowerOffset,
typename ArrayRCP< void >::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().

◆ arcp() [6/7]

ArrayRCP< void > arcp ( const RCP< std::vector< void > > & v)
related

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

◆ arcp() [7/7]

ArrayRCP< const void > arcp ( const RCP< const std::vector< void > > & v)
related

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

◆ arcpFromArrayView()

ArrayRCP< void > arcpFromArrayView ( const ArrayView< void > & av)
related

Get an ArrayRCP object out of an ArrayView object.

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

◆ get_std_vector() [1/2]

RCP< std::vector< void > > get_std_vector ( const ArrayRCP< void > & ptr)
related

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

◆ get_std_vector() [2/2]

RCP< const std::vector< void > > get_std_vector ( const ArrayRCP< const void > & 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.

◆ is_null()

bool is_null ( const ArrayRCP< void > & p)
related

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

◆ nonnull()

bool nonnull ( const ArrayRCP< void > & p)
related

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

◆ operator==() [1/2]

bool operator== ( const ArrayRCP< void > & p,
ENull  )
related

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

◆ operator!=() [1/2]

bool operator!= ( const ArrayRCP< void > & p,
ENull  )
related

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

◆ operator==() [2/2]

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

Compare two ArrayRCP objects for equality (by pointers).

◆ operator!=() [2/2]

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

Compare two ArrayRCP objects for inequality (by pointers).

◆ operator<()

bool operator< ( const ArrayRCP< T1 > & p1,
const ArrayRCP< T2 > & p2 )
related

Compare the two ArrayRCP objects' pointers using <.

◆ operator<=()

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

Compare the two ArrayRCP objects' pointers using <=.

◆ operator>()

bool operator> ( const ArrayRCP< T1 > & p1,
const ArrayRCP< T2 > & p2 )
related

Compare the two ArrayRCP objects' pointers using >.

◆ operator>=()

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

Compare the two ArrayRCP objects' pointers using >=.

◆ operator-()

ArrayRCP< void >::difference_type operator- ( const ArrayRCP< void > & p1,
const ArrayRCP< void > & p2 )
related

Return the difference of two ArrayRCP objects.

The difference of two ArrayRCP objects is the difference of their two pointers.

◆ arcp_const_cast()

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 ());

◆ arcp_reinterpret_cast()

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.

◆ arcp_reinterpret_cast_nonpod()

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.

◆ arcp_implicit_cast()

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< T2 > arcp_implicit_cast(const ArrayRCP< T1 > &p1)

is always legal and safe to do.

◆ set_extra_data()

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.

◆ get_extra_data() [1/2]

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.

◆ get_extra_data() [2/2]

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.

◆ get_optional_extra_data() [1/2]

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.

◆ get_optional_extra_data() [2/2]

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.

◆ get_nonconst_dealloc()

Dealloc_T & get_nonconst_dealloc ( const ArrayRCP< void > & p)
related

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

Preconditions:

◆ get_dealloc()

const Dealloc_T & get_dealloc ( const ArrayRCP< void > & 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.

◆ get_optional_dealloc()

const Dealloc_T * get_optional_dealloc ( const ArrayRCP< void > & 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

◆ get_optional_nonconst_dealloc()

Dealloc_T * get_optional_nonconst_dealloc ( const ArrayRCP< void > & 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.

◆ getEmbeddedObj()

const Embedded & getEmbeddedObj ( const ArrayRCP< void > & p)
related

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

◆ getNonconstEmbeddedObj()

Embedded & getNonconstEmbeddedObj ( const ArrayRCP< void > & p)
related

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

◆ operator<<()

std::ostream & operator<< ( std::ostream & out,
const ArrayRCP< void > & 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: