A resizable array. More...

#include <dynamic_array.hpp>

Public Types
using	value_type = Any

using	size_type = typename underlying_type::size_type

using	difference_type = std::ptrdiff_t

using	allocator_type = typename underlying_type::allocator_type

using	reference = value_type &

using	const_reference = const value_type &

using	pointer = typename allocator_type::pointer

using	const_pointer = typename allocator_type::const_pointer

using	iterator = typename underlying_type::iterator

using	const_iterator = typename underlying_type::const_iterator

using	reverse_iterator = std::reverse_iterator< iterator >

using	const_reverse_iterator = std::reverse_iterator< const_iterator >

Public Member Functions
constexpr	dynamic_array () noexcept(noexcept(underlying_type{}))=default
	Default constructor.

constexpr	dynamic_array (size_type count, const_reference value)
	Construct the container with count copies of elements with value value. More...

constexpr	dynamic_array (std::initializer_list< Any > init)
	Construct the container with the contents of the initializer list init. More...

template<std::input_iterator InputIt>
constexpr	dynamic_array (InputIt first, InputIt last)
	Construct the container with the contents of the range [first, last) More...

constexpr auto	operator= (std::initializer_list< Any > init_list) -> dynamic_array &
	Replaces the contents with those identified by initializer list init_list. More...

constexpr auto	allocator () const noexcept -> allocator_type
	Returns the allocator associated with the container. More...

constexpr auto	lookup (size_type index) -> reference
	Access the object stored at a specific index. More...

constexpr auto	lookup (size_type index) const -> const_reference
	Access the object stored at a specific index. More...

constexpr auto	data () noexcept -> pointer
	Access the data stored by the container. More...

constexpr auto	data () const noexcept -> const_pointer
	Access the data stored by the container. More...

constexpr auto	begin () noexcept -> iterator
	Returns an iterator to the first element of the basic_dynamic_array. More...

constexpr auto	begin () const noexcept -> const_iterator
	Returns an iterator to the first element of the basic_dynamic_array. More...

constexpr auto	cbegin () const noexcept -> const_iterator
	Returns an iterator to the first element of the basic_dynamic_array. More...

constexpr auto	end () noexcept -> iterator
	Get an iterator to the element following the last element of the basic_dynamic_array. More...

constexpr auto	end () const noexcept -> const_iterator
	Return an iterator to the element following the last element of the basic_dynamic_array. More...

constexpr auto	cend () const noexcept -> const_iterator
	Returns an it iterator to the element following the last element of the basic_dynamic_array. More...

constexpr auto	rbegin () noexcept -> reverse_iterator
	Returns a reverse iterator to the first element of the reversed basic_dynamic_array. It corresponds to the last element of the non-reversed basic_dynamic_array. If the basic_dynamic_array is empty, the returned iterator is equal to rend(). More...

constexpr auto	rbegin () const noexcept -> const_reverse_iterator
	Returns a reverse_iterator to the first element of the reversed basic_dynamic_array. It corresponds to the last element of the non-reversed basic_dynamic_array. If the basic_dynamic_array is empty, the returned iterator is equal to rend(). More...

constexpr auto	rcbegin () const noexcept -> const_reverse_iterator
	Returns a reverse iterator to the first element of the reversed basic_dynamic_array. It corresponds to the last element of the non-reversed basic_dynamic_array. If the basic_dynamic_array is empty, the returned iterator is equal to rend(). More...

constexpr auto	rend () noexcept -> reverse_iterator
	Returns a reverse iterator to the element following the last element of the reversed basic_dynamic_array. It corresponds to the element preceding the first element of the non-reversed basic_dynamic_array. This element acts as a placeholder, attempting to access it results in UB. More...

constexpr auto	rend () const noexcept -> const_reverse_iterator
	Returns a reverse iterator to the element following the last element of the reversed basic_dynamic_array. It corresponds to the element preceding the first element of the non-reversed basic_dynamic_array. This element acts as a placeholder, attempting to access it results in UB. More...

constexpr auto	rcend () const noexcept -> const_reverse_iterator
	Returns a reverse iterator to the element following the last element of the reversed basic_dynamic_array. It corresponds to the element preceding the first element of the non-reversed basic_dynamic_array. This element acts as a placeholder, attempting to access it results in UB. More...

constexpr auto	empty () const noexcept -> bool
	Check if the basic_dynamic_array is empty. More...

constexpr auto	size () const noexcept -> size_type
	Check the number of elements stored in the basic_dynamic_array. More...

constexpr auto	capacity () const noexcept -> size_type
	Check the number of elements that the basic_dynamic_array has currently allocated space for. More...

constexpr void	reserve (size_type new_cap)
	Increase the capacity of the vector to a value that's greater or equal to new_cap. If new_ap is greater than the current capacity(), new storage is allocated, otherwise the method does nothing. If reallocated occurs, all current iterators are invalidated. More...

constexpr void	clear () noexcept
	Erases all elements from the container, After this call, size() returs zero.

constexpr auto	insert (const_iterator pos, const_reference value) -> iterator
	Inserts an element value at the position before pos in the container. More...

constexpr auto	insert (const_iterator pos, value_type &&value) -> iterator
	Inserts an element value at the position before pos in the container. More...

template<typename... Args>
constexpr auto	insert (const_iterator pos, Args... args) -> iterator
	Insert a new element into the container directly before pos. The element is constructed in-place using the arguments Args... that are forwarded to the constructor. More...

constexpr auto	insert (const_iterator pos, size_type count, const_reference value) -> iterator
	Inserts count elements from a specified value. More...

template<std::input_iterator InputIt>
constexpr auto	insert (const_iterator pos, InputIt first, InputIt last) -> iterator
	Inserts elements from a range [first, last) before pos. More...

constexpr auto	insert (const_iterator pos, std::initializer_list< value_type > init_list) -> iterator
	Insert elements from an initializer_list before the position pos. More...

constexpr auto	erase (const_iterator pos) -> iterator
	Erases the specified element from the container. More...

constexpr auto	erase (const_iterator first, const_iterator last) -> iterator
	Erases the specified elements from the container. More...

constexpr void	append (const value_type &value)
	Appends the given element value to the end of the container. The new element is initialized as a copy of value. More...

constexpr void	append (value_type &&value)
	Appends the given element value to the end of the container. Value is moved into the new element. More...

template<typename... Args>
requires constexpr std::constructible_from< value_type, Args... > auto	append (in_place_t, Args &&... args) -> reference
	Appends the given element value to the end of the container. The element is constructed in-place using the arguments Args... that are forwarded to the constructor. More...

constexpr void	pop_back ()
	Removes the last element in the container. More...

constexpr void	resize (size_type count)
	Resizes the container to contain count elements. If the current size is greater than count, the container is reduced to its first count elements. If the current size is less than count, default constructed elements are appended. More...

constexpr void	resize (size_type count, const_reference value)
	Resizes the container to contain count elements. If the current size is greater than count, the container is reduced to its first count elements. If the current size is less than count, additional copies of value are appended. More...

Detailed Description

template<typename Any>
class caramel::dynamic_array< Any >

A resizable array.

Author: wmbat wmbat.nosp@m.@pro.nosp@m.tonma.nosp@m.il.c.nosp@m.om

Date: Sunday, 13th of december 2020

Copyright: MIT License

Template Parameters

Any	The type of the elements

Constructor & Destructor Documentation

◆ dynamic_array() [1/3]

template<typename Any >

constexpr caramel::dynamic_array< Any >::dynamic_array	(	size_type	count,
		const_reference	value
	)

inlineconstexpr

Construct the container with count copies of elements with value value.

Parameters

[in]	count	The size of the container.
[in]	The	value to initialize elements from.

◆ dynamic_array() [2/3]

template<typename Any >

constexpr caramel::dynamic_array< Any >::dynamic_array ( std::initializer_list< Any > init )

inlineconstexpr

Construct the container with the contents of the initializer list init.

Parameters

[in] init Initializer list to initialize the elements of the container with.

◆ dynamic_array() [3/3]

template<typename Any >

template<std::input_iterator InputIt>

constexpr caramel::dynamic_array< Any >::dynamic_array	(	InputIt	first,
		InputIt	last
	)

inlineconstexpr

Construct the container with the contents of the range [first, last)

Parameters

[in]	first	The first element of the range to copy from.
[in]	last	One past the last element of the range to copy from.

Member Function Documentation

◆ allocator()

template<typename Any >

constexpr auto caramel::dynamic_array< Any >::allocator ( ) const -> allocator_type

inlineconstexprnoexcept

Returns the allocator associated with the container.

Returns: The associated allocator.

◆ append() [1/3]

template<typename Any >

constexpr void caramel::dynamic_array< Any >::append ( const value_type & value )

inlineconstexpr

Appends the given element value to the end of the container. The new element is initialized as a copy of value.

Parameters

[in] value The value of the element to append.

◆ append() [2/3]

template<typename Any >

template<typename... Args>

requires constexpr std::constructible_from<value_type, Args...> auto caramel::dynamic_array< Any >::append	(	in_place_t	,
		Args &&...	args
	)		-> reference

inlineconstexpr

Appends the given element value to the end of the container. The element is constructed in-place using the arguments Args... that are forwarded to the constructor.

Parameters

[in] args Arguments to forward to the constructor of the element.

◆ append() [3/3]

template<typename Any >

constexpr void caramel::dynamic_array< Any >::append ( value_type && value )

inlineconstexpr

Appends the given element value to the end of the container. Value is moved into the new element.

Parameters

[in] value The value of the element to append.

◆ begin() [1/2]

template<typename Any >

constexpr auto caramel::dynamic_array< Any >::begin ( ) const -> const_iterator

inlineconstexprnoexcept

Returns an iterator to the first element of the basic_dynamic_array.

Returns: A const_iterator to the first element of the basic_dynamic_array. If the basic_dynamic_array is empty, the const_iterator will be equal to end().

◆ begin() [2/2]

template<typename Any >

constexpr auto caramel::dynamic_array< Any >::begin ( ) -> iterator

inlineconstexprnoexcept

Returns an iterator to the first element of the basic_dynamic_array.

Returns: An iterator to the first element of the basic_dynamic_array. If the basic_dynamic_array is empty, the iterator will be equal to end().

◆ capacity()

template<typename Any >

constexpr auto caramel::dynamic_array< Any >::capacity ( ) const -> size_type

inlineconstexprnoexcept

Check the number of elements that the basic_dynamic_array has currently allocated space for.

Returns: Capacity of the currently allocated storage.

◆ cbegin()

template<typename Any >

constexpr auto caramel::dynamic_array< Any >::cbegin ( ) const -> const_iterator

inlineconstexprnoexcept

Returns an iterator to the first element of the basic_dynamic_array.

Returns: iterator to the first element. If the basic_dynamic_array is empty, the const_iterator will be equal to end().

◆ cend()

template<typename Any >

constexpr auto caramel::dynamic_array< Any >::cend ( ) const -> const_iterator

inlineconstexprnoexcept

Returns an it iterator to the element following the last element of the basic_dynamic_array.

Returns: iterator to the element following the last element. Attempting to access it results in undefined behaviour.

◆ data() [1/2]

template<typename Any >

constexpr auto caramel::dynamic_array< Any >::data ( ) const -> const_pointer

inlineconstexprnoexcept

Access the data stored by the container.

Returns: A const_pointer to the first element in the container. If no elements are in the container, the pointer will be null.

◆ data() [2/2]

template<typename Any >

constexpr auto caramel::dynamic_array< Any >::data ( ) -> pointer

inlineconstexprnoexcept

Access the data stored by the container.

Returns: A pointer to the first element in the container. If no elements are in the container, the pointer will be null.

◆ empty()

template<typename Any >

constexpr auto caramel::dynamic_array< Any >::empty ( ) const -> bool

inlineconstexprnoexcept

Check if the basic_dynamic_array is empty.

Returns: True if the container is empty, false otherwise.

◆ end() [1/2]

template<typename Any >

constexpr auto caramel::dynamic_array< Any >::end ( ) const -> const_iterator

inlineconstexprnoexcept

Return an iterator to the element following the last element of the basic_dynamic_array.

Returns: iterator to the element following the last element. Attempting to access it results in undefined behaviour.

◆ end() [2/2]

template<typename Any >

constexpr auto caramel::dynamic_array< Any >::end ( ) -> iterator

inlineconstexprnoexcept

Get an iterator to the element following the last element of the basic_dynamic_array.

Returns: iterator to the element following the last element. Attempting to access it results in undefined behaviour.

◆ erase() [1/2]

template<typename Any >

constexpr auto caramel::dynamic_array< Any >::erase	(	const_iterator	first,
		const_iterator	last
	)		-> iterator

inlineconstexpr

Erases the specified elements from the container.

Precondition: first >= begin(); last <= end(); first >= last

Parameters

[in]	first	The first element of the range to copy from.
[in]	last	One past the last element of the range to copy from.

Returns: Iterator following the last removed element. If last == end() prior to removal, then the updated end() iterator is returned. If [first, last) is an empty range, the last iterator is returned.

◆ erase() [2/2]

template<typename Any >

constexpr auto caramel::dynamic_array< Any >::erase ( const_iterator pos ) -> iterator

inlineconstexpr

Erases the specified element from the container.

Precondition: pos >= begin(); pos <= end()

Parameters

[in] pos Iterator to the element to remove.

◆ insert() [1/6]

template<typename Any >

template<typename... Args>

constexpr auto caramel::dynamic_array< Any >::insert	(	const_iterator	pos,
		Args...	args
	)		-> iterator

inlineconstexpr

Insert a new element into the container directly before pos. The element is constructed in-place using the arguments Args... that are forwarded to the constructor.

Precondition: pos >= begin(); pos <= end()

Parameters

[in]	pos	Iterator before which the content will be inserted. pos may be the end()
[in]	args	Arguments to forward to the constructor of the element.

Returns: Iterator pointing to the inserted value.

◆ insert() [2/6]

template<typename Any >

constexpr auto caramel::dynamic_array< Any >::insert	(	const_iterator	pos,
		const_reference	value
	)		-> iterator

inlineconstexpr

Inserts an element value at the position before pos in the container.

Precondition: pos >= begin(); pos <= end()

Parameters

[in]	pos	Iterator before which the content will be inserted. pos may be the end() iterator.
[in]	value	Element value to insert.

Returns: Iterator pointing to the inserted value.

◆ insert() [3/6]

template<typename Any >

template<std::input_iterator InputIt>

constexpr auto caramel::dynamic_array< Any >::insert	(	const_iterator	pos,
		InputIt	first,
		InputIt	last
	)		-> iterator

inlineconstexpr

Inserts elements from a range [first, last) before pos.

Precondition: pos >= begin(); pos <= end()

Parameters

[in]	pos	Iterator before which the content will be inserted. pos may be the end() iterator.
[in]	first	The first value to insert
[in]	last	One past the last value to insert.

Returns: Iterator pointing to the first element inserted.

◆ insert() [4/6]

template<typename Any >

constexpr auto caramel::dynamic_array< Any >::insert	(	const_iterator	pos,
		size_type	count,
		const_reference	value
	)		-> iterator

inlineconstexpr

Inserts count elements from a specified value.

Precondition: pos >= begin(); pos <= end()

Parameters

[in]	pos	Iterator before which the content will be inserted. pos may be the end() iterator.
[in]	count	The number of elements to insert.
[in]	value	Element value to insert.

Returns: Iterator pointing to the first element inserted.

◆ insert() [5/6]

template<typename Any >

constexpr auto caramel::dynamic_array< Any >::insert	(	const_iterator	pos,
		std::initializer_list< value_type >	init_list
	)		-> iterator

inlineconstexpr

Insert elements from an initializer_list before the position pos.

Precondition: pos >= begin(); pos <= end()

Parameters

[in]	pos	Iterator before which the content will be inserted. pos may be the end() iterator.
[in]	init_list	Initializer list to insert the values from.

Returns: Iterator pointing to the first element inserted.

◆ insert() [6/6]

template<typename Any >

constexpr auto caramel::dynamic_array< Any >::insert	(	const_iterator	pos,
		value_type &&	value
	)		-> iterator

inlineconstexpr

Inserts an element value at the position before pos in the container.

Precondition: pos >= begin(); pos <= end()

Parameters

[in]	pos	Iterator before which the content will be inserted. pos may be the end() iterator.
[in]	value	Element value to insert.

Returns: Iterator pointing to the inserted value.

◆ lookup() [1/2]

template<typename Any >

constexpr auto caramel::dynamic_array< Any >::lookup ( size_type index ) -> reference

inlineconstexpr

Access the object stored at a specific index.

Precondition: 'index < size()'.; 'index >= 0'.

Parameters

[in] index The position to lookup the object in the array

Returns: A reference to the object stored at index.

◆ lookup() [2/2]

template<typename Any >

constexpr auto caramel::dynamic_array< Any >::lookup ( size_type index ) const -> const_reference

inlineconstexpr

Access the object stored at a specific index.

Precondition: 'index < size()'.; 'index >= 0'.

Parameters

[in] index The position to lookup the object in the array

Returns: A const reference to the object stored at index.

◆ operator=()

template<typename Any >

constexpr auto caramel::dynamic_array< Any >::operator= ( std::initializer_list< Any > init_list ) -> dynamic_array&

inlineconstexpr

Replaces the contents with those identified by initializer list init_list.

Parameters

init_list Initializer list to use as data source.

◆ pop_back()

template<typename Any >

constexpr void caramel::dynamic_array< Any >::pop_back ( )

inlineconstexpr

Removes the last element in the container.

Precondition: size() != 0

◆ rbegin() [1/2]

template<typename Any >

constexpr auto caramel::dynamic_array< Any >::rbegin ( ) const -> const_reverse_iterator

inlineconstexprnoexcept

Returns a reverse_iterator to the first element of the reversed basic_dynamic_array. It corresponds to the last element of the non-reversed basic_dynamic_array. If the basic_dynamic_array is empty, the returned iterator is equal to rend().

Returns: reverse_iterator to the first element.

◆ rbegin() [2/2]

template<typename Any >

constexpr auto caramel::dynamic_array< Any >::rbegin ( ) -> reverse_iterator

inlineconstexprnoexcept

Returns a reverse iterator to the first element of the reversed basic_dynamic_array. It corresponds to the last element of the non-reversed basic_dynamic_array. If the basic_dynamic_array is empty, the returned iterator is equal to rend().

Returns: Reverse iterator to the first element.

◆ rcbegin()

template<typename Any >

constexpr auto caramel::dynamic_array< Any >::rcbegin ( ) const -> const_reverse_iterator

inlineconstexprnoexcept

Returns a reverse iterator to the first element of the reversed basic_dynamic_array. It corresponds to the last element of the non-reversed basic_dynamic_array. If the basic_dynamic_array is empty, the returned iterator is equal to rend().

Returns: Reverse iterator to the first element.

◆ rcend()

template<typename Any >

constexpr auto caramel::dynamic_array< Any >::rcend ( ) const -> const_reverse_iterator

inlineconstexprnoexcept

Returns a reverse iterator to the element following the last element of the reversed basic_dynamic_array. It corresponds to the element preceding the first element of the non-reversed basic_dynamic_array. This element acts as a placeholder, attempting to access it results in UB.

Returns: Reverse iterator to the element following the last element.

◆ rend() [1/2]

template<typename Any >

constexpr auto caramel::dynamic_array< Any >::rend ( ) const -> const_reverse_iterator

inlineconstexprnoexcept

Returns a reverse iterator to the element following the last element of the reversed basic_dynamic_array. It corresponds to the element preceding the first element of the non-reversed basic_dynamic_array. This element acts as a placeholder, attempting to access it results in UB.

Returns: Reverse iterator to the element following the last element.

◆ rend() [2/2]

template<typename Any >

constexpr auto caramel::dynamic_array< Any >::rend ( ) -> reverse_iterator

inlineconstexprnoexcept

Returns a reverse iterator to the element following the last element of the reversed basic_dynamic_array. It corresponds to the element preceding the first element of the non-reversed basic_dynamic_array. This element acts as a placeholder, attempting to access it results in UB.

Returns: Reverse iterator to the element following the last element.

◆ reserve()

template<typename Any >

constexpr void caramel::dynamic_array< Any >::reserve ( size_type new_cap )

inlineconstexpr

Increase the capacity of the vector to a value that's greater or equal to new_cap. If new_ap is greater than the current capacity(), new storage is allocated, otherwise the method does nothing. If reallocated occurs, all current iterators are invalidated.

Parameters

new_cap New capacity of the vector.

Exceptions

If	the undelying allocator failed to allocate memory.

◆ resize() [1/2]

template<typename Any >

constexpr void caramel::dynamic_array< Any >::resize ( size_type count )

inlineconstexpr

Resizes the container to contain count elements. If the current size is greater than count, the container is reduced to its first count elements. If the current size is less than count, default constructed elements are appended.

Parameters

[in] count New size of the container.

◆ resize() [2/2]

template<typename Any >

constexpr void caramel::dynamic_array< Any >::resize	(	size_type	count,
		const_reference	value
	)

inlineconstexpr

Resizes the container to contain count elements. If the current size is greater than count, the container is reduced to its first count elements. If the current size is less than count, additional copies of value are appended.

Parameters

[in]	count	New size of the container.
[in]	value	The value to initialize new elements with.

◆ size()

template<typename Any >

constexpr auto caramel::dynamic_array< Any >::size ( ) const -> size_type

inlineconstexprnoexcept

Check the number of elements stored in the basic_dynamic_array.

Returns: The number of elements in the basic_dynamic_array.

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

libcaramel/containers/dynamic_array.hpp

Public Types

Public Member Functions

Detailed Description

template<typename Any> class caramel::dynamic_array< Any >

Constructor & Destructor Documentation

◆ dynamic_array() [1/3]

◆ dynamic_array() [2/3]

◆ dynamic_array() [3/3]

Member Function Documentation

◆ allocator()

◆ append() [1/3]

◆ append() [2/3]

◆ append() [3/3]

◆ begin() [1/2]

◆ begin() [2/2]

◆ capacity()

◆ cbegin()

◆ cend()

◆ data() [1/2]

◆ data() [2/2]

◆ empty()

◆ end() [1/2]

◆ end() [2/2]

◆ erase() [1/2]

◆ erase() [2/2]

◆ insert() [1/6]

◆ insert() [2/6]

◆ insert() [3/6]

◆ insert() [4/6]

◆ insert() [5/6]

◆ insert() [6/6]

◆ lookup() [1/2]

◆ lookup() [2/2]

◆ operator=()

◆ pop_back()

◆ rbegin() [1/2]

◆ rbegin() [2/2]

◆ rcbegin()

◆ rcend()

◆ rend() [1/2]

◆ rend() [2/2]

◆ reserve()

◆ resize() [1/2]

◆ resize() [2/2]

◆ size()

template<typename Any>
class caramel::dynamic_array< Any >