Reference documentation for deal.II version Git d51799cb54 2020-09-28 09:22:08 +0200
AlignedVector< T > Class Template Reference

#include <deal.II/base/aligned_vector.h>

Inheritance diagram for AlignedVector< T >:
[legend]

## Public Types

using value_type = T

using pointer = value_type *

using const_pointer = const value_type *

using iterator = value_type *

using const_iterator = const value_type *

using reference = value_type &

using const_reference = const value_type &

using size_type = std::size_t

## Public Member Functions

AlignedVector ()

AlignedVector (const size_type size, const T &init=T())

~AlignedVector ()

AlignedVector (const AlignedVector< T > &vec)

AlignedVector (AlignedVector< T > &&vec) noexcept

AlignedVectoroperator= (const AlignedVector< T > &vec)

AlignedVectoroperator= (AlignedVector< T > &&vec) noexcept

void resize_fast (const size_type size)

void resize (const size_type size_in)

void resize (const size_type size_in, const T &init)

void reserve (const size_type size_alloc)

void clear ()

void push_back (const T in_data)

reference back ()

const_reference back () const

template<typename ForwardIterator >
void insert_back (ForwardIterator begin, ForwardIterator end)

void fill ()

void fill (const T &element)

void swap (AlignedVector< T > &vec)

bool empty () const

size_type size () const

size_type capacity () const

reference operator[] (const size_type index)

const_reference operator[] (const size_type index) const

pointer data ()

const_pointer data () const

iterator begin ()

iterator end ()

const_iterator begin () const

const_iterator end () const

size_type memory_consumption () const

template<class Archive >
void save (Archive &ar, const unsigned int version) const

template<class Archive >
void load (Archive &ar, const unsigned int version)

template<class Archive >
void serialize (Archive &archive, const unsigned int version)

## Private Attributes

T * data_begin

T * data_end

T * allocated_end

## Related Functions

(Note that these are not member functions.)

template<class T >
bool operator== (const AlignedVector< T > &lhs, const AlignedVector< T > &rhs)

template<class T >
bool operator!= (const AlignedVector< T > &lhs, const AlignedVector< T > &rhs)

## Detailed Description

### template<class T> class AlignedVector< T >

This is a replacement class for std::vector to be used in combination with VectorizedArray and derived data types. It allocates memory aligned to addresses of a vectorized data type (in order to avoid segmentation faults when a variable of type VectorizedArray which the compiler assumes to be aligned to certain memory addresses does not actually follow these rules). This could also be achieved by proving std::vector with a user-defined allocator. On the other hand, writing an own small vector class lets us implement parallel copy and move operations with TBB, insert deal.II-style assertions, and cut some unnecessary functionality. Note that this vector is a bit more memory-consuming than std::vector because of alignment, so it is recommended to only use this vector on long vectors.

author Katharina Kormann, Martin Kronbichler, 2011

Definition at line 61 of file aligned_vector.h.

## ◆ value_type

template<class T>
 using AlignedVector< T >::value_type = T

Declare standard types used in all containers. These types parallel those in the C++ standard libraries vector<...> class.

Definition at line 68 of file aligned_vector.h.

## ◆ pointer

template<class T>
 using AlignedVector< T >::pointer = value_type *

Definition at line 69 of file aligned_vector.h.

## ◆ const_pointer

template<class T>
 using AlignedVector< T >::const_pointer = const value_type *

Definition at line 70 of file aligned_vector.h.

## ◆ iterator

template<class T>
 using AlignedVector< T >::iterator = value_type *

Definition at line 71 of file aligned_vector.h.

## ◆ const_iterator

template<class T>
 using AlignedVector< T >::const_iterator = const value_type *

Definition at line 72 of file aligned_vector.h.

## ◆ reference

template<class T>
 using AlignedVector< T >::reference = value_type &

Definition at line 73 of file aligned_vector.h.

## ◆ const_reference

template<class T>
 using AlignedVector< T >::const_reference = const value_type &

Definition at line 74 of file aligned_vector.h.

## ◆ size_type

template<class T>
 using AlignedVector< T >::size_type = std::size_t

Definition at line 75 of file aligned_vector.h.

## ◆ AlignedVector() [1/4]

template<class T>
 AlignedVector< T >::AlignedVector ( )

Empty constructor. Sets the vector size to zero.

## ◆ AlignedVector() [2/4]

template<class T>
 AlignedVector< T >::AlignedVector ( const size_type size, const T & init = T() )

Set the vector size to the given size and initializes all elements with T().

Note
If deal.II is configured with threads, this operation will run multi-threaded by splitting the work into smaller chunks (assuming there is enough work to make this worthwhile).

## ◆ ~AlignedVector()

template<class T>
 AlignedVector< T >::~AlignedVector ( )

Destructor.

## ◆ AlignedVector() [3/4]

template<class T>
 AlignedVector< T >::AlignedVector ( const AlignedVector< T > & vec )

Copy constructor.

Note
If deal.II is configured with threads, this operation will run multi-threaded by splitting the work into smaller chunks (assuming there is enough work to make this worthwhile).

## ◆ AlignedVector() [4/4]

template<class T>
 AlignedVector< T >::AlignedVector ( AlignedVector< T > && vec )
noexcept

Move constructor. Create a new aligned vector by stealing the contents of vec.

## ◆ operator=() [1/2]

template<class T>
 AlignedVector& AlignedVector< T >::operator= ( const AlignedVector< T > & vec )

Assignment to the input vector vec.

Note
If deal.II is configured with threads, this operation will run multi-threaded by splitting the work into smaller chunks (assuming there is enough work to make this worthwhile).

## ◆ operator=() [2/2]

template<class T>
 AlignedVector& AlignedVector< T >::operator= ( AlignedVector< T > && vec )
noexcept

Move assignment operator.

## ◆ resize_fast()

template<class T>
 void AlignedVector< T >::resize_fast ( const size_type size )

Change the size of the vector. It keeps old elements previously available but does not initialize the newly allocated memory, leaving it in an undefined state.

Note
This method can only be invoked for classes T that define a default constructor, T(). Otherwise, compilation will fail.

## ◆ resize() [1/2]

template<class T>
 void AlignedVector< T >::resize ( const size_type size_in )

Change the size of the vector. It keeps old elements previously available, and initializes each newly added element to a default-constructed object of type T.

If the new vector size is shorter than the old one, the memory is not immediately released unless the new size is zero; however, the size of the current object is of course set to the requested value.

Note
If deal.II is configured with threads, this operation will run multi-threaded by splitting the work into smaller chunks (assuming there is enough work to make this worthwhile).

## ◆ resize() [2/2]

template<class T>
 void AlignedVector< T >::resize ( const size_type size_in, const T & init )

Change the size of the vector. It keeps old elements previously available, and initializes each newly added element with the provided initializer.

If the new vector size is shorter than the old one, the memory is not immediately released unless the new size is zero; however, the size of the current object is of course set to the requested value.

Note
This method can only be invoked for classes that define the copy assignment operator. Otherwise, compilation will fail.
If deal.II is configured with threads, this operation will run multi-threaded by splitting the work into smaller chunks (assuming there is enough work to make this worthwhile).

## ◆ reserve()

template<class T>
 void AlignedVector< T >::reserve ( const size_type size_alloc )

Reserve memory space for size elements. If the argument size is set to zero, all previously allocated memory is released.

In order to avoid too frequent reallocation (which involves copy of the data), this function doubles the amount of memory occupied when the given size is larger than the previously allocated size.

## ◆ clear()

template<class T>
 void AlignedVector< T >::clear ( )

Releases all previously allocated memory and leaves the vector in a state equivalent to the state after the default constructor has been called.

## ◆ push_back()

template<class T>
 void AlignedVector< T >::push_back ( const T in_data )

Inserts an element at the end of the vector, increasing the vector size by one. Note that the allocated size will double whenever the previous space is not enough to hold the new element.

## ◆ back() [1/2]

template<class T>
 reference AlignedVector< T >::back ( )

Return the last element of the vector (read and write access).

## ◆ back() [2/2]

template<class T>
 const_reference AlignedVector< T >::back ( ) const

Return the last element of the vector (read-only access).

## ◆ insert_back()

template<class T>
template<typename ForwardIterator >
 void AlignedVector< T >::insert_back ( ForwardIterator begin, ForwardIterator end )

Inserts several elements at the end of the vector given by a range of elements.

## ◆ fill() [1/2]

template<class T>
 void AlignedVector< T >::fill ( )

Fills the vector with size() copies of a default constructed object.

Note
Unlike the other fill() function, this method can also be invoked for classes that do not define a copy assignment operator.
If deal.II is configured with threads, this operation will run multi-threaded by splitting the work into smaller chunks (assuming there is enough work to make this worthwhile).

## ◆ fill() [2/2]

template<class T>
 void AlignedVector< T >::fill ( const T & element )

Fills the vector with size() copies of the given input.

Note
This method can only be invoked for classes that define the copy assignment operator. Otherwise, compilation will fail.
If deal.II is configured with threads, this operation will run multi-threaded by splitting the work into smaller chunks (assuming there is enough work to make this worthwhile).

## ◆ swap()

template<class T>
 void AlignedVector< T >::swap ( AlignedVector< T > & vec )

Swaps the given vector with the calling vector.

## ◆ empty()

template<class T>
 bool AlignedVector< T >::empty ( ) const

Return whether the vector is empty, i.e., its size is zero.

## ◆ size()

template<class T>
 size_type AlignedVector< T >::size ( ) const

Return the size of the vector.

## ◆ capacity()

template<class T>
 size_type AlignedVector< T >::capacity ( ) const

Return the capacity of the vector, i.e., the size this vector can hold without reallocation. Note that capacity() >= size().

## ◆ operator[]() [1/2]

template<class T>
 reference AlignedVector< T >::operator[] ( const size_type index )

Read-write access to entry index in the vector.

## ◆ operator[]() [2/2]

template<class T>
 const_reference AlignedVector< T >::operator[] ( const size_type index ) const

Read-only access to entry index in the vector.

## ◆ data() [1/2]

template<class T>
 pointer AlignedVector< T >::data ( )

Return a pointer to the underlying data buffer.

## ◆ data() [2/2]

template<class T>
 const_pointer AlignedVector< T >::data ( ) const

Return a const pointer to the underlying data buffer.

## ◆ begin() [1/2]

template<class T>
 iterator AlignedVector< T >::begin ( )

Return a read and write pointer to the beginning of the data array.

## ◆ end() [1/2]

template<class T>
 iterator AlignedVector< T >::end ( )

Return a read and write pointer to the end of the data array.

## ◆ begin() [2/2]

template<class T>
 const_iterator AlignedVector< T >::begin ( ) const

Return a read-only pointer to the beginning of the data array.

## ◆ end() [2/2]

template<class T>
 const_iterator AlignedVector< T >::end ( ) const

Return a read-only pointer to the end of the data array.

## ◆ memory_consumption()

template<class T>
 size_type AlignedVector< T >::memory_consumption ( ) const

Return the memory consumption of the allocated memory in this class. If the underlying type T allocates memory by itself, this memory is not counted.

## ◆ save()

template<class T>
template<class Archive >
 void AlignedVector< T >::save ( Archive & ar, const unsigned int version ) const

Write the data of this object to a stream for the purpose of serialization.

template<class T>
template<class Archive >
 void AlignedVector< T >::load ( Archive & ar, const unsigned int version )

Read the data of this object from a stream for the purpose of serialization.

## ◆ serialize()

template<class T>
template<class Archive >
 void AlignedVector< T >::serialize ( Archive & archive, const unsigned int version )

Write and read the data of this object from a stream for the purpose of serialization.

## ◆ operator==()

template<class T >
 bool operator== ( const AlignedVector< T > & lhs, const AlignedVector< T > & rhs )
related

Relational operator == for AlignedVector

Definition at line 1170 of file aligned_vector.h.

## ◆ operator!=()

template<class T >
 bool operator!= ( const AlignedVector< T > & lhs, const AlignedVector< T > & rhs )
related

Relational operator != for AlignedVector

Definition at line 1192 of file aligned_vector.h.

## ◆ data_begin

template<class T>
 T* AlignedVector< T >::data_begin
private

Pointer to actual class data.

Definition at line 348 of file aligned_vector.h.

## ◆ data_end

template<class T>
 T* AlignedVector< T >::data_end
private

Pointer to one past the last valid value.

Definition at line 353 of file aligned_vector.h.

## ◆ allocated_end

template<class T>
 T* AlignedVector< T >::allocated_end
private

Pointer to the end of the allocated memory.

Definition at line 358 of file aligned_vector.h.

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