Chemical Data Processing Library C++ API - Version 1.2.0
Public Types | List of all members
CDPL::Math::VectorArray< V > Class Template Reference

An array for storing generic vector objects. More...

#include <VectorArray.hpp>

+ Inheritance diagram for CDPL::Math::VectorArray< V >:

Public Types

typedef V ValueType
 
typedef std::shared_ptr< VectorArraySharedPointer
 A reference-counted smart pointer [SHPTR] for dynamically allocated VectorArray instances. More...
 
- Public Types inherited from CDPL::Util::Array< V >
typedef std::vector< V > StorageType
 
typedef std::shared_ptr< ArraySharedPointer
 A reference-counted smart pointer [SHPTR] for dynamically allocated Array instances. More...
 
typedef V ElementType
 The type of objects stored by the array. More...
 
typedef std::size_t SizeType
 The type of objects stored by the array. More...
 
typedef Array BaseType
 Specifies for derived classes the type of the Array base class. More...
 
typedef StorageType::const_iterator ConstElementIterator
 A constant random access iterator used to iterate over the elements of the array. More...
 
typedef StorageType::const_reverse_iterator ConstReverseElementIterator
 A constant random access iterator used to iterate over the elements of the array in reverse order. More...
 
typedef StorageType::iterator ElementIterator
 A mutable random access iterator used to iterate over the elements of the array. More...
 
typedef StorageType::reverse_iterator ReverseElementIterator
 A mutable random access iterator used to iterate over the elements of the array in reverse order. More...
 

Additional Inherited Members

- Public Member Functions inherited from CDPL::Util::Array< V >
 Array ()
 Creates an empty array. More...
 
 Array (std::size_t num_elem, const V &value=V())
 Creates and initializes the array with num_elem copies of value. More...
 
 Array (const InputIter &first, const InputIter &last)
 Creates and initializes the array with copies of the elements in the range [first, last). More...
 
virtual ~Array ()
 Virtual destructor. More...
 
StorageTypegetData ()
 
const StorageTypegetData () const
 
BaseTypegetBase ()
 Returns a non-const reference to itself. More...
 
const BaseTypegetBase () const
 Returns a const reference to itself. More...
 
std::size_t getSize () const
 Returns the number of elements stored in the array. More...
 
std::size_t size () const
 Returns the number of elements stored in the array. More...
 
bool isEmpty () const
 Tells whether the array is empty (getSize() == 0). More...
 
void resize (std::size_t num_elem, const V &value=V())
 Inserts or erases elements at the end so that the size becomes num_elem. More...
 
void reserve (std::size_t num_elem)
 Preallocates memory for (at least) num_elem elements. More...
 
std::size_t getCapacity () const
 Returns the number of elements for which memory has been allocated. More...
 
void clear ()
 Erases all elements. More...
 
void swap (Array &array)
 Swaps the contents with array. More...
 
void assign (std::size_t num_elem, const V &value=V())
 This function fills the array with num_elem copies of the given value. More...
 
void assign (const InputIter &first, const InputIter &last)
 This function fills a vector with copies of the elements in the range [first, last). More...
 
void addElement (const V &value=V())
 Inserts a new element at the end of the array. More...
 
void insertElement (std::size_t idx, const V &value=V())
 Inserts a new element before the location specified by the index idx. More...
 
ElementIterator insertElement (const ElementIterator &it, const V &value=V())
 Inserts a new element before the location specified by the iterator it. More...
 
void insertElements (std::size_t idx, std::size_t num_elem, const V &value=V())
 Inserts num_elem copies of value before the location specified by the index idx. More...
 
void insertElements (const ElementIterator &it, std::size_t num_elem, const V &value=V())
 Inserts num_elem copies of value before the location specified by the iterator it. More...
 
void insertElements (std::size_t idx, const InputIter &first, const InputIter &last)
 Inserts the range of elements [first, last) before the location specified by the index idx. More...
 
void insertElements (const ElementIterator &it, const InputIter &first, const InputIter &last)
 Inserts the range of elements [first, last) before the location specified by the iterator it. More...
 
void popLastElement ()
 Removes the last element of the array. More...
 
void removeElement (std::size_t idx)
 Removes the element at the position specified by the index idx. More...
 
ElementIterator removeElement (const ElementIterator &it)
 Removes the element at the position specified by the iterator it. More...
 
ElementIterator removeElements (const ElementIterator &first, const ElementIterator &last)
 Removes the elements pointed to by the iterators in the range [first, last). More...
 
const V & getFirstElement () const
 Returns a const reference to the first element of the array. More...
 
V & getFirstElement ()
 Returns a non-const reference to the first element of the array. More...
 
const V & getLastElement () const
 Returns a const reference to the last element of the array. More...
 
V & getLastElement ()
 Returns a non-const reference to the last element of the array. More...
 
ConstElementIterator getElementsBegin () const
 Returns a constant iterator pointing to the beginning of the array. More...
 
ElementIterator getElementsBegin ()
 Returns a mutable iterator pointing to the beginning of the array. More...
 
ConstElementIterator getElementsEnd () const
 Returns a constant iterator pointing to the end of the array. More...
 
ElementIterator getElementsEnd ()
 Returns a mutable iterator pointing to the end of the array. More...
 
ConstElementIterator begin () const
 Returns a constant iterator pointing to the beginning of the array. More...
 
ElementIterator begin ()
 Returns a mutable iterator pointing to the beginning of the array. More...
 
ConstElementIterator end () const
 Returns a constant iterator pointing to the end of the array. More...
 
ElementIterator end ()
 Returns a mutable iterator pointing to the end of the array. More...
 
ConstReverseElementIterator getElementsReverseBegin () const
 Returns a constant iterator pointing to the beginning of the reversed array. More...
 
ReverseElementIterator getElementsReverseBegin ()
 Returns a mutable iterator pointing to the beginning of the reversed array. More...
 
ConstReverseElementIterator getElementsReverseEnd () const
 Returns a constant iterator pointing to the end of the reversed array. More...
 
ReverseElementIterator getElementsReverseEnd ()
 Returns a mutable iterator pointing to the end of the reversed array. More...
 
const V & getElement (std::size_t idx) const
 Returns a const reference to the element at index idx. More...
 
V & getElement (std::size_t idx)
 Returns a non-const reference to the element at index idx. More...
 
void setElement (std::size_t idx, const V &value=V())
 Assigns a new value to the element specified by the index idx. More...
 
const V & operator[] (std::size_t idx) const
 Returns a const reference to the element at index idx. More...
 
V & operator[] (std::size_t idx)
 Returns a non-const reference to the element at index idx. More...
 
- Protected Member Functions inherited from CDPL::Util::Array< V >
void checkIfNonEmpty () const
 
void checkIndex (std::size_t idx, bool allow_end) const
 
void checkIterator (const ElementIterator &it, bool allow_end)
 
void checkIterator (const ConstElementIterator &it, bool allow_end) const
 

Detailed Description

template<typename V>
class CDPL::Math::VectorArray< V >

An array for storing generic vector objects.

Member Typedef Documentation

◆ ValueType

template<typename V >
typedef V CDPL::Math::VectorArray< V >::ValueType

◆ SharedPointer

template<typename V >
typedef std::shared_ptr<VectorArray> CDPL::Math::VectorArray< V >::SharedPointer

A reference-counted smart pointer [SHPTR] for dynamically allocated VectorArray instances.


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