#include <Teuchos_ArrayViewDecl.hpp>
Inheritance diagram for Teuchos::ArrayView< T >:
Public Types | |
std::vector typedefs | |
| typedef Teuchos_Index | Ordinal |
| | |
| typedef T | value_type |
| | |
| typedef T * | pointer |
| | |
| typedef const T * | const_pointer |
| | |
| typedef T & | reference |
| | |
| typedef const T & | const_reference |
| | |
| typedef pointer | iterator |
| | |
| typedef size_t | size_type |
| | |
| typedef ptrdiff_t | difference_type |
| | |
Public Member Functions | |
Constructors/Destructors | |
| ArrayView (ENull null_arg=null) | |
| Initialize to NULL (implicitly or explicitly). | |
| ArrayView (T *p, Ordinal size) | |
| Initialize view from raw memory. | |
| ArrayView (const ArrayView< T > &array) | |
Initialize from another ArrayView<T> object. | |
| ArrayView (std::vector< typename ConstTypeTraits< T >::NonConstType > &vec) | |
| Non-const view of an std::vector<T> . | |
| ArrayView (const std::vector< typename ConstTypeTraits< T >::NonConstType > &vec) | |
| Const view of an std::vector<T> . | |
| ArrayView< T > & | operator= (const ArrayView< T > &array) |
| Shallow copy assignment operator. | |
| ~ArrayView () | |
| Destroy the array view object. | |
General query functions | |
| bool | is_null () const |
| Returns true if the underlying pointer is null. | |
| Ordinal | size () const |
| The total number of items in the managed array. | |
| std::string | toString () const |
Convert an ArrayView<T> to an std::string. | |
Element Access Functions | |
| T * | getRawPtr () const |
| Return a raw pointer to beginning of array or NULL if unsized. | |
| T & | operator[] (Ordinal i) const |
| Random object access. | |
| T & | front () const |
| Get the first element. | |
| T & | back () const |
| Get the last element. | |
Views | |
| ArrayView< T > | view (Ordinal offset, Ordinal size) const |
| Return a view of a contiguous range of elements. | |
| ArrayView< T > | operator() (Ordinal offset, Ordinal size) const |
| Return a view of a contiguous range of elements (calls view(offset,size)). | |
| const ArrayView< T > & | operator() () const |
| Return a *this (just for compatibility with Array and ArrayPtr). | |
| ArrayView< const T > | getConst () const |
| Return an ArrayView<const T> of an ArrayView<T> object. | |
| operator ArrayView () const | |
| Impliict conversion from ArrayView<T> to ArrayView<const T>. | |
Assignment | |
| void | assign (const ArrayView< const T > &array) const |
| Copy the data from one array view object to this array view object. | |
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. | |
Assertion Functions. | |
| const ArrayView< T > & | assert_not_null () const |
Throws NullReferenceError if this->get()==NULL, otherwise returns reference to *this. | |
| const ArrayView< T > & | assert_in_range (Ordinal offset, Ordinal size) const |
Throws NullReferenceError if this->get()==NULL orthis->get()!=NULL, throws RangeError if (offset < 0 || this->size() < offset+size, otherwise returns reference to *this. | |
Related Functions | |
| (Note that these are not member functions.) | |
| ArrayView< T > | arrayView (T *p, typename ArrayView< T >::Ordinal size) |
| Construct a const or non-const view to const or non-const data. | |
| ArrayView< T > | arrayViewFromVector (std::vector< T > &vec) |
| Construct a non-const view of an std::vector. | |
| ArrayView< const T > | arrayViewFromVector (const std::vector< T > &vec) |
| Construct a const view of an std::vector. | |
| std::vector< T > | createVector (const ArrayView< T > &av) |
Get a new std::vector<T> object out of an ArrayView<T> object. | |
| std::vector< T > | createVector (const ArrayView< const T > &av) |
Get a new std::vector<T> object out of an ArrayView<const T> object. | |
| bool | is_null (const ArrayView< T > &av) |
Returns true if av.is_null()==true. | |
| std::ostream & | operator<< (std::ostream &out, const ArrayView< T > &av) |
| Output stream inserter. | |
| ArrayView< T2 > | av_reinterpret_cast (const ArrayView< T1 > &p1) |
Reinterpret cast of underlying ArrayView type from T1* to T2*. | |
This class is designed to be used as a substitute for array arguments to functions. It aggregates a pointer to a contiguous array of data and the size of that array. In debug mode, it will perform runtime checks of all usage.
The ArrayView class has the same shallow copy semantics of the # Ptr class. ArrayView is to ArrayRCP as Ptr is to RCP.
| typedef Teuchos_Index Teuchos::ArrayView< T >::Ordinal |
| typedef T Teuchos::ArrayView< T >::value_type |
| typedef T* Teuchos::ArrayView< T >::pointer |
| typedef const T* Teuchos::ArrayView< T >::const_pointer |
| typedef T& Teuchos::ArrayView< T >::reference |
| typedef const T& Teuchos::ArrayView< T >::const_reference |
| typedef pointer Teuchos::ArrayView< T >::iterator |
| typedef size_t Teuchos::ArrayView< T >::size_type |
| typedef ptrdiff_t Teuchos::ArrayView< T >::difference_type |
| Teuchos::ArrayView< T >::ArrayView | ( | ENull | null_arg = null |
) | [inline] |
Initialize to NULL (implicitly or explicitly).
| Teuchos::ArrayView< T >::ArrayView | ( | T * | p, | |
| Ordinal | size | |||
| ) | [inline] |
Initialize view from raw memory.
| p | [in] Pointer to array of typed memory of size size. If p==0, then *this is a null view. Note that the memory pointed to by p can not go away until this view object is destoryed! | |
| size | [in] The size of the array that *this will represent pointer to by p. If p==0 then size must be 0! |
p!=0] size > 0 p==0] size == 0 Postconditions:
| Teuchos::ArrayView< T >::ArrayView | ( | const ArrayView< T > & | array | ) | [inline] |
Initialize from another ArrayView<T> object.
After construction, this and array 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:
| Teuchos::ArrayView< T >::ArrayView | ( | std::vector< typename ConstTypeTraits< T >::NonConstType > & | vec | ) | [inline] |
Non-const view of an std::vector<T> .
| Teuchos::ArrayView< T >::ArrayView | ( | const std::vector< typename ConstTypeTraits< T >::NonConstType > & | vec | ) | [inline] |
Const view of an std::vector<T> .
| Teuchos::ArrayView< T >::~ArrayView | ( | ) | [inline] |
Destroy the array view object.
| ArrayView< T > & Teuchos::ArrayView< T >::operator= | ( | const ArrayView< T > & | array | ) | [inline] |
Shallow copy assignment operator.
| bool Teuchos::ArrayView< T >::is_null | ( | ) | const [inline] |
Returns true if the underlying pointer is null.
| ArrayView< T >::Ordinal Teuchos::ArrayView< T >::size | ( | ) | const [inline] |
The total number of items in the managed array.
| std::string Teuchos::ArrayView< T >::toString | ( | ) | const |
Convert an ArrayView<T> to an std::string.
| T * Teuchos::ArrayView< T >::getRawPtr | ( | ) | const [inline] |
Return a raw pointer to beginning of array or NULL if unsized.
| T & Teuchos::ArrayView< T >::operator[] | ( | Ordinal | i | ) | const [inline] |
| T & Teuchos::ArrayView< T >::front | ( | ) | const [inline] |
Get the first element.
| T & Teuchos::ArrayView< T >::back | ( | ) | const [inline] |
Get the last element.
| ArrayView< T > Teuchos::ArrayView< T >::view | ( | Ordinal | offset, | |
| Ordinal | size | |||
| ) | const [inline] |
Return a view of a contiguous range of elements.
Preconditions:
this->get() != NULL 0 <= offset && offset + size <= this->size() Postconditions:
returnVal.size() == size | ArrayView< T > Teuchos::ArrayView< T >::operator() | ( | Ordinal | offset, | |
| Ordinal | size | |||
| ) | const [inline] |
Return a view of a contiguous range of elements (calls view(offset,size)).
| const ArrayView< T > & Teuchos::ArrayView< T >::operator() | ( | ) | const [inline] |
Return a *this (just for compatibility with Array and ArrayPtr).
| ArrayView< const T > Teuchos::ArrayView< T >::getConst | ( | ) | const [inline] |
Return an ArrayView<const T> of an ArrayView<T> object.
WARNING! If T is already const (e.g. const double) then do not try to instantiate this function since it will not compile!
| Teuchos::ArrayView< T >::operator ArrayView< const T > | ( | ) | const [inline] |
Impliict conversion from ArrayView<T> to ArrayView<const T>.
WARNING! If T is already const (e.g. const double) then do not try to instantiate this function since it will not compile!
| void Teuchos::ArrayView< T >::assign | ( | const ArrayView< const T > & | array | ) | const |
Copy the data from one array view object to this array view object.
Preconditions:
this->size() == array.size()
WARNING! If T is a const type (e.g. const double) then do not try to instantiate this function since it will not compile!
NOTE: This function is really like an operator=() function except that it is declared const. This is the correct behavior since a const ArrayView simply means that we can not change what *this points to. The type of the template argument always determines if the underlyihng data is const or not.
| ArrayView< T >::iterator Teuchos::ArrayView< 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:
&*return == this->get() this->get()==NULL] return == (null or NULL) | ArrayView< T >::iterator Teuchos::ArrayView< 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 ArrayView<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:
this->get()!=NULL] &*end == this->get()+(this->upperOffset()+1) this->get()==NULL] return == (null or NULL) | const ArrayView< T > & Teuchos::ArrayView< T >::assert_not_null | ( | ) | const |
Throws NullReferenceError if this->get()==NULL, otherwise returns reference to *this.
| const ArrayView< T > & Teuchos::ArrayView< T >::assert_in_range | ( | Ordinal | offset, | |
| Ordinal | size | |||
| ) | const |
Throws NullReferenceError if this->get()==NULL orthis->get()!=NULL, throws RangeError if (offset < 0 || this->size() < offset+size, otherwise returns reference to *this.
| ArrayView< T > arrayView | ( | T * | p, | |
| typename ArrayView< T >::Ordinal | size | |||
| ) | [related] |
Construct a const or non-const view to const or non-const data.
| ArrayView< T > arrayViewFromVector | ( | std::vector< T > & | vec | ) | [related] |
Construct a non-const view of an std::vector.
| ArrayView< const T > arrayViewFromVector | ( | const std::vector< T > & | vec | ) | [related] |
Construct a const view of an std::vector.
| std::vector< T > createVector | ( | const ArrayView< T > & | av | ) | [related] |
Get a new std::vector<T> object out of an ArrayView<T> object.
Note that a copy of data is made!
| std::vector< T > createVector | ( | const ArrayView< const T > & | av | ) | [related] |
Get a new std::vector<T> object out of an ArrayView<const T> object.
Note that a copy of data is made!
| bool is_null | ( | const ArrayView< T > & | av | ) | [related] |
Returns true if av.is_null()==true.
| std::ostream & operator<< | ( | std::ostream & | out, | |
| const ArrayView< T > & | av | |||
| ) | [related] |
Output stream inserter.
The implementation of this function just prints pointer addresses and therefore puts no restrictions on the data types involved.
Reinterpret cast of underlying ArrayView 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.
1.4.7