Teuchos Package Browser (Single Doxygen Collection) Version of the Day
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Private Member Functions | Private Attributes | List of all members
Teuchos::ArrayRCP< const T > Class Template Reference

Partial specialization of ArrayRCP for const T. More...

#include <Teuchos_ArrayRCPDecl.hpp>

Public Types

typedef Teuchos_Ordinal Ordinal
 
typedef Ordinal size_type
 
typedef Ordinal difference_type
 
typedef std::random_access_iterator_tag iterator_category
 
typedef const T * iterator_type
 
typedef const T value_type
 
typedef const T & reference
 
typedef const T & const_reference
 
typedef const T * pointer
 
typedef const T * const_pointer
 
typedef const T element_type
 
typedef const T * iterator
 
typedef const T * const_iterator
 

Public Member Functions

 ArrayRCP (ENull null_arg=null)
 
 ArrayRCP (const T *p, size_type lowerOffset, size_type size, bool has_ownership, const ERCPNodeLookup rcpNodeLookup=RCP_ENABLE_NODE_LOOKUP)
 
template<class Dealloc_T >
 ArrayRCP (const T *p, size_type lowerOffset, size_type size, Dealloc_T dealloc, bool has_ownership)
 
 ArrayRCP (size_type size, const T &val=T())
 
 ArrayRCP (const ArrayRCP< const T > &r_ptr)
 
 ~ArrayRCP ()
 
ArrayRCP< const T > & operator= (const ArrayRCP< const T > &r_ptr)
 
bool is_null () const
 
const T * operator-> () const
 
const T & operator* () const
 
const T * get () const
 
const T * getRawPtr () const
 
const T & operator[] (size_type offset) const
 
ArrayRCP< const T > & operator++ ()
 
ArrayRCP< const T > operator++ (int)
 
ArrayRCP< const T > & operator-- ()
 
ArrayRCP< const T > operator-- (int)
 
ArrayRCP< const T > & operator+= (size_type offset)
 
ArrayRCP< const T > & operator-= (size_type offset)
 
ArrayRCP< const T > operator+ (size_type offset) const
 
ArrayRCP< const T > operator- (size_type offset) const
 
iterator begin () const
 
iterator end () const
 
ArrayRCP< const T > getConst () const
 Return const reference to the array.
 
ArrayRCP< const T > persistingView (size_type lowerOffset, size_type size) const
 
size_type lowerOffset () const
 
size_type upperOffset () const
 
size_type size () const
 
ArrayView< const T > view (size_type lowerOffset, size_type size) const
 
ArrayView< const T > operator() (size_type lowerOffset, size_type size) const
 
ArrayView< const T > operator() () const
 
void resize (const size_type n, const T &val=T())
 
void clear ()
 
ERCPStrength strength () const
 
bool is_valid_ptr () const
 
int strong_count () const
 
int weak_count () const
 
int total_count () const
 
void set_has_ownership ()
 
bool has_ownership () const
 
const T * release ()
 
ArrayRCP< const T > create_weak () const
 
ArrayRCP< const T > create_strong () const
 
template<class T2 >
bool shares_resource (const ArrayRCP< T2 > &r_ptr) const
 
const ArrayRCP< const T > & assert_not_null () const
 
const ArrayRCP< const T > & assert_in_range (size_type lowerOffset, size_type size) const
 
const ArrayRCP< const T > & assert_valid_ptr () const
 

Private Member Functions

void debug_assert_not_null () const
 
void debug_assert_in_range (size_type lowerOffset_in, size_type size_in) const
 
void debug_assert_valid_ptr () const
 

Private Attributes

const T * ptr_
 
RCPNodeHandle node_
 
size_type lowerOffset_
 
size_type upperOffset_
 

Detailed Description

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

Partial specialization of ArrayRCP for const T.

The main documentation for ArrayRCP explains why this class needs a partial specialization for const types.

Definition at line 838 of file Teuchos_ArrayRCPDecl.hpp.

Member Typedef Documentation

◆ Ordinal

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

Definition at line 840 of file Teuchos_ArrayRCPDecl.hpp.

◆ size_type

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

Definition at line 841 of file Teuchos_ArrayRCPDecl.hpp.

◆ difference_type

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

Definition at line 842 of file Teuchos_ArrayRCPDecl.hpp.

◆ iterator_category

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

Definition at line 843 of file Teuchos_ArrayRCPDecl.hpp.

◆ iterator_type

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

Definition at line 844 of file Teuchos_ArrayRCPDecl.hpp.

◆ value_type

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

Definition at line 845 of file Teuchos_ArrayRCPDecl.hpp.

◆ reference

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

Definition at line 846 of file Teuchos_ArrayRCPDecl.hpp.

◆ const_reference

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

Definition at line 847 of file Teuchos_ArrayRCPDecl.hpp.

◆ pointer

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

Definition at line 848 of file Teuchos_ArrayRCPDecl.hpp.

◆ const_pointer

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

Definition at line 849 of file Teuchos_ArrayRCPDecl.hpp.

◆ element_type

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

Definition at line 850 of file Teuchos_ArrayRCPDecl.hpp.

◆ iterator

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

Definition at line 856 of file Teuchos_ArrayRCPDecl.hpp.

◆ const_iterator

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

Definition at line 857 of file Teuchos_ArrayRCPDecl.hpp.

Constructor & Destructor Documentation

◆ ArrayRCP() [1/5]

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

◆ ArrayRCP() [2/5]

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

◆ ArrayRCP() [3/5]

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

◆ ArrayRCP() [4/5]

template<class T >
Teuchos::ArrayRCP< const T >::ArrayRCP ( size_type  size,
const T &  val = T() 
)
inlineexplicit

◆ ArrayRCP() [5/5]

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

◆ ~ArrayRCP()

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

Member Function Documentation

◆ operator=()

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

◆ is_null()

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

◆ operator->()

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

◆ operator*()

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

◆ get()

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

◆ getRawPtr()

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

◆ operator[]()

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

◆ operator++() [1/2]

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

◆ operator++() [2/2]

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

◆ operator--() [1/2]

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

◆ operator--() [2/2]

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

◆ operator+=()

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

◆ operator-=()

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

◆ operator+()

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

◆ operator-()

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

◆ begin()

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

◆ end()

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

◆ getConst()

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

Return const reference to the array.

This method has a trivial implementation for the const T specialization of ArrayRCP.

◆ persistingView()

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

◆ lowerOffset()

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

◆ upperOffset()

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

◆ size()

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

◆ view()

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

◆ operator()() [1/2]

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

◆ operator()() [2/2]

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

◆ resize()

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

◆ clear()

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

◆ strength()

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

◆ is_valid_ptr()

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

◆ strong_count()

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

◆ weak_count()

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

◆ total_count()

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

◆ set_has_ownership()

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

◆ has_ownership()

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

◆ release()

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

◆ create_weak()

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

◆ create_strong()

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

◆ shares_resource()

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

◆ assert_not_null()

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

◆ assert_in_range()

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

◆ assert_valid_ptr()

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

◆ debug_assert_not_null()

template<class T >
void Teuchos::ArrayRCP< const T >::debug_assert_not_null ( ) const
inlineprivate

Definition at line 934 of file Teuchos_ArrayRCPDecl.hpp.

◆ debug_assert_in_range()

template<class T >
void Teuchos::ArrayRCP< const T >::debug_assert_in_range ( size_type  lowerOffset_in,
size_type  size_in 
) const
inlineprivate

Definition at line 941 of file Teuchos_ArrayRCPDecl.hpp.

◆ debug_assert_valid_ptr()

template<class T >
void Teuchos::ArrayRCP< const T >::debug_assert_valid_ptr ( ) const
inlineprivate

Definition at line 950 of file Teuchos_ArrayRCPDecl.hpp.

Member Data Documentation

◆ ptr_

template<class T >
const T* Teuchos::ArrayRCP< const T >::ptr_
private

Definition at line 929 of file Teuchos_ArrayRCPDecl.hpp.

◆ node_

template<class T >
RCPNodeHandle Teuchos::ArrayRCP< const T >::node_
private

Definition at line 930 of file Teuchos_ArrayRCPDecl.hpp.

◆ lowerOffset_

template<class T >
size_type Teuchos::ArrayRCP< const T >::lowerOffset_
private

Definition at line 931 of file Teuchos_ArrayRCPDecl.hpp.

◆ upperOffset_

template<class T >
size_type Teuchos::ArrayRCP< const T >::upperOffset_
private

Definition at line 932 of file Teuchos_ArrayRCPDecl.hpp.


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