Detailed Description
template<typename Data>
class Util::PArray< Data >
An array that only holds pointers to its elements.
A PArray<Data> is an array that is implemented by storing pointers to Data objects, rather than actual Data objects. The array suscript operator [] returns a reference to an associated Data object, as for Array<Data>. A PArray<Data> is not responsible for destroying the associated Data objects.
A PArray cannot be instantiated, because its constructor is protected. PArray is a base class for DPArray and for ArraySet.
#include <PArray.h>
Public Member Functions | |
| virtual | ~PArray () |
| Destructor. More... | |
| int | capacity () const |
| Return allocated size. More... | |
| int | size () const |
| Return logical size. More... | |
| void | begin (PArrayIterator< Data > &iterator) const |
| Set a PArrayIterator to the beginning of this PArray. More... | |
| void | begin (ConstPArrayIterator< Data > &iterator) const |
| Set a ConstPArrayIterator to the beginning of this PArray. More... | |
| Data & | operator[] (int i) const |
| Mimic C array subscripting. More... | |
Protected Member Functions | |
| PArray () | |
| Constructor (protected to prevent instantiation). More... | |
Protected Attributes | |
| Data ** | ptrs_ |
| PArray of of pointers to Data objects. More... | |
| int | capacity_ |
| Allocated size of ptrs_ array. More... | |
| int | size_ |
| Logical size (number of elements with initialized data). More... | |
Constructor & Destructor Documentation
|
virtual |
|
inlineprotected |
Member Function Documentation
|
inline |
Return allocated size.
- Returns
- Number of elements allocated in array.
Definition at line 130 of file PArray.h.
References Util::PArray< Data >::capacity_.
Referenced by Util::DPArray< Data >::allocate(), Util::ArraySet< Data >::allocate(), and Util::GPArray< Data >::reserve().
|
inline |
Return logical size.
- Returns
- logical size of this array.
Definition at line 137 of file PArray.h.
References Util::PArray< Data >::size_.
Referenced by DdMd::AtomMap::clearGhosts(), and Util::ArraySet< Data >::isValid().
|
inline |
Set a PArrayIterator to the beginning of this PArray.
Set an PArrayIterator to the beginning of this PArray.
- Parameters
-
iterator PArrayIterator, initialized on output.
Definition at line 146 of file PArray.h.
References Util::PArray< Data >::ptrs_, Util::PArrayIterator< Data >::setCurrent(), Util::PArrayIterator< Data >::setEnd(), Util::PArrayIterator< Data >::setNull(), and Util::PArray< Data >::size_.
Referenced by DdMd::AtomMap::clearGhosts().
|
inline |
Set a ConstPArrayIterator to the beginning of this PArray.
Set an ConstPArrayIterator to the beginning of this PArray.
- Parameters
-
iterator PArrayIterator, initialized on output. iterator ConstPArrayIterator, initialized on output.
Definition at line 162 of file PArray.h.
References Util::PArray< Data >::ptrs_, Util::ConstPArrayIterator< Data >::setCurrent(), Util::ConstPArrayIterator< Data >::setEnd(), Util::ConstPArrayIterator< Data >::setNull(), and Util::PArray< Data >::size_.
|
inline |
Mimic C array subscripting.
Subscript - return a reference.
- Parameters
-
i array index
- Returns
- reference to element i
Definition at line 179 of file PArray.h.
References Util::PArray< Data >::ptrs_, and Util::PArray< Data >::size_.
Member Data Documentation
|
protected |
PArray of of pointers to Data objects.
Definition at line 87 of file PArray.h.
Referenced by Util::DPArray< Data >::allocate(), Util::ArraySet< Data >::allocate(), Util::GPArray< Data >::append(), Util::DPArray< Data >::append(), Util::ArraySet< Data >::append(), Util::PArray< Data >::begin(), Util::ArraySet< Data >::clear(), Util::GPArray< Data >::deallocate(), Util::DPArray< Data >::DPArray(), Util::GPArray< Data >::GPArray(), Util::DPArray< Data >::isAllocated(), Util::GPArray< Data >::isAllocated(), Util::ArraySet< Data >::isAllocated(), Util::ArraySet< Data >::isValid(), Util::DPArray< Data >::operator=(), Util::PArray< Data >::operator[](), Util::ArraySet< Data >::pop(), Util::ArraySet< Data >::remove(), Util::GPArray< Data >::reserve(), Util::ArraySet< Data >::~ArraySet(), Util::DPArray< Data >::~DPArray(), and Util::GPArray< Data >::~GPArray().
|
protected |
Allocated size of ptrs_ array.
Definition at line 90 of file PArray.h.
Referenced by Util::DPArray< Data >::allocate(), Util::ArraySet< Data >::allocate(), Util::GPArray< Data >::append(), Util::DPArray< Data >::append(), Util::ArraySet< Data >::append(), Util::PArray< Data >::capacity(), Util::ArraySet< Data >::clear(), Util::GPArray< Data >::deallocate(), Util::DPArray< Data >::DPArray(), Util::GPArray< Data >::GPArray(), Util::ArraySet< Data >::index(), Util::ArraySet< Data >::isValid(), Util::DPArray< Data >::operator=(), Util::ArraySet< Data >::remove(), Util::GPArray< Data >::reserve(), Util::ArraySet< Data >::~ArraySet(), Util::DPArray< Data >::~DPArray(), and Util::GPArray< Data >::~GPArray().
|
protected |
Logical size (number of elements with initialized data).
Definition at line 93 of file PArray.h.
Referenced by Util::ArraySet< Data >::allocate(), Util::GPArray< Data >::append(), Util::DPArray< Data >::append(), Util::ArraySet< Data >::append(), Util::PArray< Data >::begin(), Util::DPArray< Data >::clear(), Util::GPArray< Data >::clear(), Util::ArraySet< Data >::clear(), Util::GPArray< Data >::deallocate(), Util::DPArray< Data >::DPArray(), Util::GPArray< Data >::GPArray(), Util::ArraySet< Data >::isValid(), Util::GPArray< Data >::operator=(), Util::DPArray< Data >::operator=(), Util::PArray< Data >::operator[](), Util::ArraySet< Data >::pop(), Util::ArraySet< Data >::remove(), Util::GPArray< Data >::reserve(), Util::PArray< Data >::size(), Util::DPArray< Data >::~DPArray(), and Util::GPArray< Data >::~GPArray().
The documentation for this class was generated from the following file:
