A Vector class with statically reserved memory. More...

#include <dune/common/reservedvector.hh>

Public Types

typedef storage_type::value_type	value_type
	The type of object, T, stored in the vector.
typedef storage_type::pointer	pointer
	Pointer to T.
typedef storage_type::const_pointer	const_pointer
	Const pointer to T.
typedef storage_type::reference	reference
	Reference to T.
typedef storage_type::const_reference	const_reference
	Const reference to T.
typedef storage_type::size_type	size_type
	An unsigned integral type.
typedef storage_type::difference_type	difference_type
	A signed integral type.
typedef storage_type::iterator	iterator
	Iterator used to iterate through a vector.
typedef storage_type::const_iterator	const_iterator
	Const iterator used to iterate through a vector.
typedef std::reverse_iterator< iterator >	reverse_iterator
	Reverse iterator.
typedef std::reverse_iterator< const_iterator >	const_reverse_iterator
	Const reverse iterator.

Public Member Functions

constexpr	ReservedVector () noexcept(std::is_nothrow_default_constructible_v< value_type >)
	Constructs an empty vector.
constexpr	ReservedVector (size_type count) noexcept(std::is_nothrow_default_constructible_v< value_type >)
	Constructs the vector with count elements that will be default-initialized.
constexpr	ReservedVector (size_type count, const value_type &value) noexcept(std::is_nothrow_copy_assignable_v< value_type > &&noexcept(ReservedVector(count)))
	Constructs the vector with count copies of elements with value value.
template<class InputIt, std::enable_if_t< std::is_convertible_v< typename std::iterator_traits< InputIt >::value_type, value_type >, int > = 0>
constexpr	ReservedVector (InputIt first, InputIt last) noexcept(std::is_nothrow_copy_assignable_v< value_type > &&noexcept(ReservedVector()))
	Constructs the vector from an iterator range [first,last).
constexpr	ReservedVector (std::initializer_list< value_type > const &l) noexcept(std::is_nothrow_copy_assignable_v< value_type > &&noexcept(ReservedVector(l.begin(), l.end())))
	Constructs the vector from an initializer list.

constexpr bool	operator== (const ReservedVector &that) const noexcept
	Compares the values in the vector this with that for equality.
constexpr auto	operator<=> (const ReservedVector &that) const noexcept
	Lexicographically compares the values in the vector this with that.

constexpr void	clear () noexcept
	Erases all elements.
constexpr void	resize (size_type s) noexcept
	Specifies a new size for the vector.
constexpr void	push_back (const value_type &t) noexcept(std::is_nothrow_copy_assignable_v< value_type >)
	Appends an element to the end of a vector, up to the maximum size n, O(1) time.
constexpr void	push_back (value_type &&t) noexcept(std::is_nothrow_move_assignable_v< value_type >)
	Appends an element to the end of a vector by moving the value, up to the maximum size n, O(1) time.
template<class... Args>
reference	emplace_back (Args &&... args) noexcept(std::is_nothrow_constructible_v< value_type, decltype(args)... >)
	Appends an element to the end of a vector by constructing it in place.
constexpr void	pop_back () noexcept
	Erases the last element of the vector, O(1) time.

constexpr iterator	begin () noexcept
	Returns a iterator pointing to the beginning of the vector.
constexpr const_iterator	begin () const noexcept
	Returns a const_iterator pointing to the beginning of the vector.
constexpr const_iterator	cbegin () const noexcept
	Returns a const_iterator pointing to the beginning of the vector.
constexpr reverse_iterator	rbegin () noexcept
	Returns a const reverse-iterator pointing to the end of the vector.
constexpr const_reverse_iterator	rbegin () const noexcept
	Returns a const reverse-iterator pointing to the end of the vector.
constexpr const_reverse_iterator	crbegin () const noexcept
	Returns a const reverse-iterator pointing to the end of the vector.
constexpr iterator	end () noexcept
	Returns an iterator pointing to the end of the vector.
constexpr const_iterator	end () const noexcept
	Returns a const_iterator pointing to the end of the vector.
constexpr const_iterator	cend () const noexcept
	Returns a const_iterator pointing to the end of the vector.
constexpr reverse_iterator	rend () noexcept
	Returns a const reverse-iterator pointing to the begin of the vector.
constexpr const_reverse_iterator	rend () const noexcept
	Returns a const reverse-iterator pointing to the begin of the vector.
constexpr const_reverse_iterator	crend () const noexcept
	Returns a const reverse-iterator pointing to the begin of the vector.

constexpr reference	at (size_type i)
	Returns reference to the i'th element.
constexpr const_reference	at (size_type i) const
	Returns a const reference to the i'th element.
constexpr reference	operator[] (size_type i) noexcept
	Returns reference to the i'th element.
constexpr const_reference	operator[] (size_type i) const noexcept
	Returns a const reference to the i'th element.
constexpr reference	front () noexcept
	Returns reference to first element of vector.
constexpr const_reference	front () const noexcept
	Returns const reference to first element of vector.
constexpr reference	back () noexcept
	Returns reference to last element of vector.
constexpr const_reference	back () const noexcept
	Returns const reference to last element of vector.
constexpr pointer	data () noexcept
	Returns pointer to the underlying memory.
constexpr const_pointer	data () const noexcept
	Returns const pointer to the underlying memory.

constexpr void	fill (const value_type &value) noexcept(std::is_nothrow_copy_assignable_v< value_type >)
	Fill the container with the value.
void	swap (ReservedVector &other) noexcept(std::is_nothrow_swappable_v< value_type >)
	Swap the content with another vector.

Friends
std::ostream &	operator<< (std::ostream &s, const ReservedVector &v)
	Send ReservedVector to an output stream.
std::size_t	hash_value (const ReservedVector &v) noexcept
constexpr size_type	size () const noexcept
	Returns number of elements in the vector.
constexpr bool	empty () const noexcept
	Returns true if vector has no elements.
static constexpr size_type	capacity () noexcept
	Returns current capacity (allocated memory) of the vector.
static constexpr size_type	max_size () noexcept
	Returns the maximum length of the vector.

Detailed Description

template<class T, int n>
class Dune::ReservedVector< T, n >

A Vector class with statically reserved memory.

ReservedVector is something between std::array and std::vector. It is a dynamically sized vector which can be extended and shrunk using methods like push_back and pop_back, but reserved memory is statically predefined.

This implies that the vector cannot grow bigger than the predefined maximum size.

Template Parameters

T	The value type ReservedVector stores.
n	The maximum number of objects the ReservedVector can store.

Member Typedef Documentation

◆ const_iterator

template<class T, int n>

typedef storage_type::const_iterator Dune::ReservedVector< T, n >::const_iterator

Const iterator used to iterate through a vector.

◆ const_pointer

template<class T, int n>

typedef storage_type::const_pointer Dune::ReservedVector< T, n >::const_pointer

Const pointer to T.

◆ const_reference

template<class T, int n>

typedef storage_type::const_reference Dune::ReservedVector< T, n >::const_reference

Const reference to T.

◆ const_reverse_iterator

template<class T, int n>

typedef std::reverse_iterator<const_iterator> Dune::ReservedVector< T, n >::const_reverse_iterator

Const reverse iterator.

◆ difference_type

template<class T, int n>

typedef storage_type::difference_type Dune::ReservedVector< T, n >::difference_type

A signed integral type.

◆ iterator

template<class T, int n>

typedef storage_type::iterator Dune::ReservedVector< T, n >::iterator

Iterator used to iterate through a vector.

◆ pointer

template<class T, int n>

typedef storage_type::pointer Dune::ReservedVector< T, n >::pointer

Pointer to T.

◆ reference

template<class T, int n>

typedef storage_type::reference Dune::ReservedVector< T, n >::reference

Reference to T.

◆ reverse_iterator

template<class T, int n>

typedef std::reverse_iterator<iterator> Dune::ReservedVector< T, n >::reverse_iterator

Reverse iterator.

◆ size_type

template<class T, int n>

typedef storage_type::size_type Dune::ReservedVector< T, n >::size_type

An unsigned integral type.

◆ value_type

template<class T, int n>

typedef storage_type::value_type Dune::ReservedVector< T, n >::value_type

The type of object, T, stored in the vector.

Typedefs

Constructor & Destructor Documentation

◆ ReservedVector() [1/5]

template<class T, int n>

Dune::ReservedVector< T, n >::ReservedVector ( )

inlineconstexprnoexcept

Constructs an empty vector.

Constructors

◆ ReservedVector() [2/5]

template<class T, int n>

Dune::ReservedVector< T, n >::ReservedVector ( size_type count )

inlineexplicitconstexprnoexcept

Constructs the vector with count elements that will be default-initialized.

◆ ReservedVector() [3/5]

template<class T, int n>

Dune::ReservedVector< T, n >::ReservedVector	(	size_type	count,
		const value_type &	value )

inlineconstexprnoexcept

Constructs the vector with count copies of elements with value value.

◆ ReservedVector() [4/5]

template<class T, int n>

template<class InputIt, std::enable_if_t< std::is_convertible_v< typename std::iterator_traits< InputIt >::value_type, value_type >, int > = 0>

Dune::ReservedVector< T, n >::ReservedVector	(	InputIt	first,
		InputIt	last )

inlineconstexprnoexcept

Constructs the vector from an iterator range [first,last).

◆ ReservedVector() [5/5]

template<class T, int n>

Dune::ReservedVector< T, n >::ReservedVector ( std::initializer_list< value_type > const & l )

inlineconstexprnoexcept

Constructs the vector from an initializer list.

Member Function Documentation

◆ at() [1/2]

template<class T, int n>

reference Dune::ReservedVector< T, n >::at ( size_type i )

inlineconstexpr

Returns reference to the i'th element.

Element access

◆ at() [2/2]

template<class T, int n>

const_reference Dune::ReservedVector< T, n >::at ( size_type i ) const

inlineconstexpr

Returns a const reference to the i'th element.

◆ back() [1/2]

template<class T, int n>

const_reference Dune::ReservedVector< T, n >::back ( ) const

inlineconstexprnoexcept

Returns const reference to last element of vector.

◆ back() [2/2]

template<class T, int n>

reference Dune::ReservedVector< T, n >::back ( )

inlineconstexprnoexcept

Returns reference to last element of vector.

◆ begin() [1/2]

template<class T, int n>

const_iterator Dune::ReservedVector< T, n >::begin ( ) const

inlineconstexprnoexcept

Returns a const_iterator pointing to the beginning of the vector.

◆ begin() [2/2]

template<class T, int n>

iterator Dune::ReservedVector< T, n >::begin ( )

inlineconstexprnoexcept

Returns a iterator pointing to the beginning of the vector.

Iterators

◆ capacity()

template<class T, int n>

constexpr size_type Dune::ReservedVector< T, n >::capacity ( )

inlinestaticconstexprnoexcept

Returns current capacity (allocated memory) of the vector.

◆ cbegin()

template<class T, int n>

const_iterator Dune::ReservedVector< T, n >::cbegin ( ) const

inlineconstexprnoexcept

Returns a const_iterator pointing to the beginning of the vector.

◆ cend()

template<class T, int n>

const_iterator Dune::ReservedVector< T, n >::cend ( ) const

inlineconstexprnoexcept

Returns a const_iterator pointing to the end of the vector.

◆ clear()

template<class T, int n>

void Dune::ReservedVector< T, n >::clear ( )

inlineconstexprnoexcept

Erases all elements.

Modifiers

◆ crbegin()

template<class T, int n>

const_reverse_iterator Dune::ReservedVector< T, n >::crbegin ( ) const

inlineconstexprnoexcept

Returns a const reverse-iterator pointing to the end of the vector.

◆ crend()

template<class T, int n>

const_reverse_iterator Dune::ReservedVector< T, n >::crend ( ) const

inlineconstexprnoexcept

Returns a const reverse-iterator pointing to the begin of the vector.

◆ data() [1/2]

template<class T, int n>

const_pointer Dune::ReservedVector< T, n >::data ( ) const

inlineconstexprnoexcept

Returns const pointer to the underlying memory.

◆ data() [2/2]

template<class T, int n>

pointer Dune::ReservedVector< T, n >::data ( )

inlineconstexprnoexcept

Returns pointer to the underlying memory.

◆ emplace_back()

template<class T, int n>

template<class... Args>

reference Dune::ReservedVector< T, n >::emplace_back ( Args &&... args )

inlinenoexcept

Appends an element to the end of a vector by constructing it in place.

◆ empty()

template<class T, int n>

bool Dune::ReservedVector< T, n >::empty ( ) const

inlineconstexprnoexcept

Returns true if vector has no elements.

◆ end() [1/2]

template<class T, int n>

const_iterator Dune::ReservedVector< T, n >::end ( ) const

inlineconstexprnoexcept

Returns a const_iterator pointing to the end of the vector.

◆ end() [2/2]

template<class T, int n>

iterator Dune::ReservedVector< T, n >::end ( )

inlineconstexprnoexcept

Returns an iterator pointing to the end of the vector.

◆ fill()

template<class T, int n>

void Dune::ReservedVector< T, n >::fill ( const value_type & value )

inlineconstexprnoexcept

Fill the container with the value.

Operations

◆ front() [1/2]

template<class T, int n>

const_reference Dune::ReservedVector< T, n >::front ( ) const

inlineconstexprnoexcept

Returns const reference to first element of vector.

◆ front() [2/2]

template<class T, int n>

reference Dune::ReservedVector< T, n >::front ( )

inlineconstexprnoexcept

Returns reference to first element of vector.

◆ max_size()

template<class T, int n>

constexpr size_type Dune::ReservedVector< T, n >::max_size ( )

inlinestaticconstexprnoexcept

Returns the maximum length of the vector.

◆ operator<=>()

template<class T, int n>

auto Dune::ReservedVector< T, n >::operator<=> ( const ReservedVector< T, n > & that ) const

inlineconstexprnoexcept

Lexicographically compares the values in the vector this with that.

◆ operator==()

template<class T, int n>

bool Dune::ReservedVector< T, n >::operator== ( const ReservedVector< T, n > & that ) const

inlineconstexprnoexcept

Compares the values in the vector this with that for equality.

Comparison

◆ operator[]() [1/2]

template<class T, int n>

const_reference Dune::ReservedVector< T, n >::operator[] ( size_type i ) const

inlineconstexprnoexcept

Returns a const reference to the i'th element.

◆ operator[]() [2/2]

template<class T, int n>

reference Dune::ReservedVector< T, n >::operator[] ( size_type i )

inlineconstexprnoexcept

Returns reference to the i'th element.

◆ pop_back()

template<class T, int n>

void Dune::ReservedVector< T, n >::pop_back ( )

inlineconstexprnoexcept

Erases the last element of the vector, O(1) time.

◆ push_back() [1/2]

template<class T, int n>

void Dune::ReservedVector< T, n >::push_back ( const value_type & t )

inlineconstexprnoexcept

Appends an element to the end of a vector, up to the maximum size n, O(1) time.

◆ push_back() [2/2]

template<class T, int n>

void Dune::ReservedVector< T, n >::push_back ( value_type && t )

inlineconstexprnoexcept

Appends an element to the end of a vector by moving the value, up to the maximum size n, O(1) time.

◆ rbegin() [1/2]

template<class T, int n>

const_reverse_iterator Dune::ReservedVector< T, n >::rbegin ( ) const

inlineconstexprnoexcept

Returns a const reverse-iterator pointing to the end of the vector.

◆ rbegin() [2/2]

template<class T, int n>

reverse_iterator Dune::ReservedVector< T, n >::rbegin ( )

inlineconstexprnoexcept

Returns a const reverse-iterator pointing to the end of the vector.

◆ rend() [1/2]

template<class T, int n>

const_reverse_iterator Dune::ReservedVector< T, n >::rend ( ) const

inlineconstexprnoexcept

Returns a const reverse-iterator pointing to the begin of the vector.

◆ rend() [2/2]

template<class T, int n>

reverse_iterator Dune::ReservedVector< T, n >::rend ( )

inlineconstexprnoexcept

Returns a const reverse-iterator pointing to the begin of the vector.

◆ resize()

template<class T, int n>

void Dune::ReservedVector< T, n >::resize ( size_type s )

inlineconstexprnoexcept

Specifies a new size for the vector.

◆ size()

template<class T, int n>

size_type Dune::ReservedVector< T, n >::size ( ) const

inlineconstexprnoexcept

Returns number of elements in the vector.

Capacity

◆ swap()

template<class T, int n>

void Dune::ReservedVector< T, n >::swap ( ReservedVector< T, n > & other )

inlinenoexcept

Swap the content with another vector.

◆ hash_value

template<class T, int n>

std::size_t hash_value ( const ReservedVector< T, n > & v )

friend

◆ operator<<

template<class T, int n>

std::ostream & operator<<	(	std::ostream &	s,
		const ReservedVector< T, n > &	v )

friend

Send ReservedVector to an output stream.

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

reservedvector.hh

Public Types

Public Member Functions

Friends

Detailed Description

Member Typedef Documentation

◆ const_iterator

◆ const_pointer

◆ const_reference

◆ const_reverse_iterator

◆ difference_type

◆ iterator

◆ pointer

◆ reference

◆ reverse_iterator

◆ size_type

◆ value_type

Constructor & Destructor Documentation

◆ ReservedVector() [1/5]

◆ ReservedVector() [2/5]

◆ ReservedVector() [3/5]

◆ ReservedVector() [4/5]

◆ ReservedVector() [5/5]

Member Function Documentation

◆ at() [1/2]

◆ at() [2/2]

◆ back() [1/2]

◆ back() [2/2]

◆ begin() [1/2]

◆ begin() [2/2]

◆ capacity()

◆ cbegin()

◆ cend()

◆ clear()

◆ crbegin()

◆ crend()

◆ data() [1/2]

◆ data() [2/2]

◆ emplace_back()

◆ empty()

◆ end() [1/2]

◆ end() [2/2]

◆ fill()

◆ front() [1/2]

◆ front() [2/2]

◆ max_size()

◆ operator<=>()

◆ operator==()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ pop_back()

◆ push_back() [1/2]

◆ push_back() [2/2]

◆ rbegin() [1/2]

◆ rbegin() [2/2]

◆ rend() [1/2]

◆ rend() [2/2]

◆ resize()

◆ size()

◆ swap()

Friends And Related Symbol Documentation

◆ hash_value

◆ operator<<