dsa::Vector< T > Class Template Reference

Implements Vector class template for dynamic size container. More...

#include <vector.h>

Public Types
using	value_type = T
	Alias for data type used in class.
using	allocator_type = std::allocator<value_type>
	Alias for memory allocator.
using	size_type = std::size_t
	Alias for size type used in class.
using	difference_type = std::ptrdiff_t
	Alias for pointer difference type.
using	pointer = T*
	Alias for pointer to data type used in class.
using	const_pointer = const T*
	Alias for const pointer to data type used in class.
using	reference = T&
	Alias for reference to data type used in class.
using	const_reference = const T&
	Alias for const reference to data type used in class.
using	iterator = T*
	Alias for iterator to data type used in class.
using	const_iterator = const T*
	Alias for const iterator to data type used in class.
using	reverse_iterator = std::reverse_iterator<iterator>
	Alias for reverse_iterator to data type used in class.
using	const_reverse_iterator = std::reverse_iterator<const_iterator>
	Alias for const reverse_iterator to data type used in class.

Public Member Functions
constexpr	Vector ()
	Construct a new Vector object.
constexpr	Vector (size_type count)
	Construct a new Vector object of size count, using default value of type T.
constexpr	Vector (size_type count, const T &value)
	Construct a new Vector object of size count, using provided value of type T.
template<typename InputIt> requires std::input_iterator<InputIt>
constexpr	Vector (InputIt first, InputIt last)
	Construct a new Vector object using elements from range [ first , last )
constexpr	Vector (const Vector< T > &other)
	Construct a new Vector object using copy constructor.
constexpr	Vector (Vector< T > &&other) noexcept
	Construct a new Vector object using move constructor.
constexpr	Vector (std::initializer_list< T > init_list)
	Construct a new Vector object using initializer list.
	~Vector ()
	Destroy the Vector object.
constexpr auto	operator= (const Vector< T > &other) -> Vector< T > &
	Assign Vector object using copy assignment.
constexpr auto	operator= (Vector< T > &&other) noexcept -> Vector< T > &
	Assign Vector object using move assignment.
constexpr auto	operator= (std::initializer_list< T > init_list) -> Vector< T > &
	Assign Vector object from init_list elements.
constexpr void	assign (size_type count, const T &value)
	Function assign count , elements of value to Vector object.
template<typename InputIt> requires std::input_iterator<InputIt>
constexpr void	assign (InputIt first, InputIt last)
	Function assign elements from range [ first , last ) to Vector object.
constexpr void	assign (std::initializer_list< T > init_list)
	Function assign values of init_list to Vector object.
constexpr auto	get_allocator () const -> allocator_type
	Get the allocator object.
constexpr auto	at (size_type pos) -> reference
	Returns a reference to Vector element at pos index. If pos is outside of container range, an exception std::out_of_range is thrown.
constexpr auto	at (size_type pos) const -> const_reference
	Returns a const_reference to Vector element at pos index. If pos is outside of container range, an exception std::out_of_range is thrown.
constexpr auto	operator[] (size_type pos) -> reference
	Returns a reference to Vector element at pos index. If pos is outside of container range, undefined behaviour occurs.
constexpr auto	operator[] (size_type pos) const -> const_reference
	Returns a const_reference to Vector element at pos index. If pos is outside of container range, undefined behaviour occurs.
constexpr auto	front () -> reference
	Returns reference to first Arary element.
constexpr auto	front () const -> const_reference
	Returns const_reference to first Arary element.
constexpr auto	back () -> reference
	Returns reference to last Arary element.
constexpr auto	back () const -> const_reference
	Returns const_reference to last Arary element.
constexpr auto	data () noexcept -> pointer
	Returns pointer to underlying data container.
constexpr auto	data () const noexcept -> const_pointer
	Returns const_pointer to underlying data container.
constexpr auto	begin () noexcept -> iterator
	Returns iterator to first element.
constexpr auto	begin () const noexcept -> const_iterator
	Returns const_iterator to first element.
constexpr auto	cbegin () const noexcept -> const_iterator
	Returns const_iterator to first element.
constexpr auto	end () noexcept -> iterator
	Returns iterator past last element of underlaying data structure.
constexpr auto	end () const noexcept -> const_iterator
	Returns const_iterator past last element of underlaying data structure.
constexpr auto	cend () const noexcept -> const_iterator
	Returns const_iterator past last element of underlaying data structure.
constexpr auto	rbegin () -> reverse_iterator
	Returns reverse_iterator to the first element of reversed underlaying data structure.
constexpr auto	rbegin () const -> const_reverse_iterator
	Returns const_reverse_iterator to the first element of reversed underlaying data structure.
constexpr auto	crbegin () const noexcept -> const_reverse_iterator
	Returns const_reverse_iterator to the first element of reversed underlaying data structure.
constexpr auto	rend () -> reverse_iterator
	Returns reverse_iterator past the last element of reversed underlaying data structure.
constexpr auto	rend () const -> const_reverse_iterator
	Returns const_reverse_iterator past the last element of reversed underlaying data structure.
constexpr auto	crend () const noexcept -> const_reverse_iterator
	Returns const_reverse_iterator past the last element of reversed underlaying data structure.
constexpr auto	empty () const -> bool
	Checks if container has elements.
constexpr auto	size () const noexcept -> size_type
	Returns number of elements in container.
constexpr auto	max_size () const noexcept -> size_type
	Returns maximum number of elements container can hold.
constexpr void	reserve (size_type new_cap)
	Increase the capacity of the container.
constexpr auto	capacity () -> size_type
	Returns the number of elements allocated for container.
constexpr void	shrink_to_fit ()
	Request to remove of unused capacity.
constexpr void	clear ()
	Erases all elements of the container Does not affect container capacity.
constexpr auto	insert (const_iterator pos, const T &value) -> iterator
	Insert a copy of value before pos.
constexpr auto	insert (const_iterator pos, T &&value) -> iterator
	Insert value before pos possibly using move semantics.
constexpr auto	insert (const_iterator pos, size_type count, const T &value) -> iterator
	Insert count copies of value before pos.
template<typename InputIt> requires std::input_iterator<InputIt>
constexpr auto	insert (const_iterator pos, InputIt first, InputIt last) -> iterator
	Insert elements from range [ first , last ) befor pos.
constexpr auto	insert (const_iterator pos, std::initializer_list< T > init_list) -> iterator
	Insert constent of init_list before pos.
template<typename... Args>
constexpr auto	emplace (const_iterator pos, Args &&... args) -> iterator
	Insert new element into the container before pos.
template<typename... Args>
constexpr auto	emplace_back (Args &&... args) -> reference
	Appends a copy of value at the end of the container.
constexpr auto	erase (iterator pos) -> iterator
	Erases specified element from the container.
constexpr auto	erase (const_iterator pos) -> iterator
	Erases specified element from the container.
constexpr auto	erase (iterator first, iterator last) -> iterator
	Erases elements in range [ first , last ) from the container.
constexpr auto	erase (const_iterator first, const_iterator last) -> iterator
	Erases elements in range [ first , last ) from the container.
constexpr void	push_back (const T &value)
	Appends a copy of value at the end of the container.
constexpr void	push_back (T &&value)
	Appends a copy of value at the end of the container.
constexpr void	pop_back ()
	Removes the last element of the container.
constexpr void	resize (size_type count)
	Resizez the container to contain count elements if count is equal to current size, does nothing if current size is greater than count , container size is reduced if current size is less than count , additional copies of T() are appended.
constexpr void	resize (size_type count, const value_type &value)
	Resizes the container to contain count elements if count is equal to current size, does nothing if current size is greater than count , container size is reduced if current size is less than count , additional copies of value are appended.
constexpr void	swap (Vector< T > &other) noexcept
	Exchanges content of current container with other container.

Detailed Description

template<typename T>
class dsa::Vector< T >

Implements Vector class template for dynamic size container.

Template Parameters

T	type of data stored in container

Note

This template intentionally does not implement a bit-packed specialization for bool, as found in std::vector<bool>. The standard container's specialization breaks reference semantics and replaces bool& with proxy objects. dsa::Vector<bool> behaves like a regular container, without bit-packing. This design choice prioritizes correctness and predictable semantics over memory optimization.

Todo

add non-member specialized erase function

add non-member specialized erase_if function

Definition at line 41 of file vector.h.

Member Typedef Documentation

allocator_type

template<typename T>

using dsa::Vector< T >::allocator_type = std::allocator<value_type>

Alias for memory allocator.

Definition at line 55 of file vector.h.

const_iterator

template<typename T>

using dsa::Vector< T >::const_iterator = const T*

Alias for const iterator to data type used in class.

Definition at line 107 of file vector.h.

const_pointer

template<typename T>

using dsa::Vector< T >::const_pointer = const T*

Alias for const pointer to data type used in class.

Template Parameters

T*	pointer to data type

Definition at line 83 of file vector.h.

const_reference

template<typename T>

using dsa::Vector< T >::const_reference = const T&

Alias for const reference to data type used in class.

Template Parameters

T&	const reference to data type

Definition at line 97 of file vector.h.

const_reverse_iterator

template<typename T>

using dsa::Vector< T >::const_reverse_iterator = std::reverse_iterator<const_iterator>

Alias for const reverse_iterator to data type used in class.

Definition at line 117 of file vector.h.

difference_type

template<typename T>

using dsa::Vector< T >::difference_type = std::ptrdiff_t

Alias for pointer difference type.

Used by STL to define distance between two pointers

Definition at line 69 of file vector.h.

iterator

template<typename T>

using dsa::Vector< T >::iterator = T*

Alias for iterator to data type used in class.

Definition at line 102 of file vector.h.

pointer

template<typename T>

using dsa::Vector< T >::pointer = T*

Alias for pointer to data type used in class.

Template Parameters

T*	pointer to data type

Definition at line 76 of file vector.h.

reference

template<typename T>

using dsa::Vector< T >::reference = T&

Alias for reference to data type used in class.

Template Parameters

T&	reference to data type

Definition at line 90 of file vector.h.

reverse_iterator

template<typename T>

using dsa::Vector< T >::reverse_iterator = std::reverse_iterator<iterator>

Alias for reverse_iterator to data type used in class.

Definition at line 112 of file vector.h.

size_type

template<typename T>

using dsa::Vector< T >::size_type = std::size_t

Alias for size type used in class.

Template Parameters

T

size type

Definition at line 62 of file vector.h.

value_type

template<typename T>

using dsa::Vector< T >::value_type = T

Alias for data type used in class.

Template Parameters

T

data type

Definition at line 50 of file vector.h.

Constructor & Destructor Documentation

Vector() [1/6]

template<typename T>

dsa::Vector< T >::Vector ( size_type count )

constexpr

Construct a new Vector object of size count, using default value of type T.

Parameters

[in]

count

element count

Definition at line 719 of file vector.h.

        : Vector(count, T())
    {
    }

Vector() [2/6]

template<typename T>

dsa::Vector< T >::Vector ( size_type count, const T & value )

constexpr

Construct a new Vector object of size count, using provided value of type T.

Parameters

[in]	count	element count
[in]	value	value for all elements

Definition at line 725 of file vector.h.

    {
        for (size_t i = 0; i < count; i++)
        {
            push_back(value);
        }
    }

Vector() [3/6]

template<typename T>
requires std::input_iterator<InputIt>

template<typename InputIt>
requires std::input_iterator<InputIt>

dsa::Vector< T >::Vector ( InputIt first, InputIt last )

constexpr

Construct a new Vector object using elements from range [ first , last )

Template Parameters

InputIt

Parameters

[in]	first	element defining range of elements to insert
[in]	last	element definig range of elements to insert

Definition at line 736 of file vector.h.

    {
        // do not use const reference to keep arguments the same as in std
        // NOLINTNEXTLINE(performance-unnecessary-value-param)
        assign(first, last);
    }

Vector() [4/6]

template<typename T>

dsa::Vector< T >::Vector ( const Vector< T > & other )

constexpr

Construct a new Vector object using copy constructor.

Parameters

[in]

other

Vector object of type T

Definition at line 744 of file vector.h.

    {
        reserve(other.size());
        for (const auto& item : other)
        {
            push_back(item);
        }
    }

Vector() [5/6]

template<typename T>

dsa::Vector< T >::Vector ( Vector< T > && other )

constexprnoexcept

Construct a new Vector object using move constructor.

Content of other object will be taken by constructed object

Parameters

[in,out]

other

Vector object of type T

Definition at line 754 of file vector.h.

    {
        operator=(std::move(other));
    }

Vector() [6/6]

template<typename T>

dsa::Vector< T >::Vector ( std::initializer_list< T > init_list )

constexpr

Construct a new Vector object using initializer list.

Parameters

[in]

init_list

initializer list of values of type T

Definition at line 760 of file vector.h.

    {
        assign(init_list);
    }

~Vector()

template<typename T>

dsa::Vector< T >::~Vector

(

)

Destroy the Vector object.

Definition at line 766 of file vector.h.

    {
        clear_allocation();
    }

Member Function Documentation

assign() [1/3]

template<typename T>
requires std::input_iterator<InputIt>

template<typename InputIt>
requires std::input_iterator<InputIt>

void dsa::Vector< T >::assign ( InputIt first, InputIt last )

constexpr

Function assign elements from range [ first , last ) to Vector object.

Template Parameters

InputIt

Parameters

[in]	first	element defining range of elements to insert
[in]	last	element definig range of elements to insert

Definition at line 844 of file vector.h.

    {
        const auto count = static_cast<size_type>(std::distance(first, last));
 
        clear_allocation();
        m_capacity = 0;
        m_size = 0;
 
        m_data = allocator_type().allocate(count);
        while (first != last)
        {
            push_back(*first);
            first++;
        }
    }

assign() [2/3]

template<typename T>

void dsa::Vector< T >::assign ( size_type count, const T & value )

constexpr

Function assign count , elements of value to Vector object.

Parameters

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

Definition at line 826 of file vector.h.

    {
        clear_allocation();
        m_capacity = 0;
        m_size = 0;
 
        m_data = allocator_type().allocate(count);
        for (size_t i = 0; i < count; i++)
        {
            push_back(value);
        }
    }

assign() [3/3]

template<typename T>

void dsa::Vector< T >::assign ( std::initializer_list< T > init_list )

constexpr

Function assign values of init_list to Vector object.

Parameters

[in]

init_list

initializer list of values of type T

Definition at line 861 of file vector.h.

    {
        clear_allocation();
        m_capacity = 0;
        m_size = 0;
 
        m_data = allocator_type().allocate(init_list.size());
        for (auto const& item : init_list)
        {
            push_back(item);
        }
    }

at() [1/2]

template<typename T>

auto dsa::Vector< T >::at ( size_type pos ) -> reference

nodiscardconstexpr

Returns a reference to Vector element at pos index. If pos is outside of container range, an exception std::out_of_range is thrown.

Parameters

[in]

pos

index of element to return

Returns

reference to Vector element at pos index

Definition at line 881 of file vector.h.

    {
        if (pos >= m_size)
        {
            throw std::out_of_range("Pos argument outside of container range");
        }
 
        // NOLINTNEXTLINE(cppcoreguidelines-pro-bounds-pointer-arithmetic)
        return m_data[pos];
    }

at() [2/2]

template<typename T>

auto dsa::Vector< T >::at ( size_type pos ) const -> const_reference

nodiscardconstexpr

Returns a const_reference to Vector element at pos index. If pos is outside of container range, an exception std::out_of_range is thrown.

Parameters

[in]

pos

index of element to return

Returns

const_reference to Vector element at pos index

Definition at line 893 of file vector.h.

    {
        if (pos >= m_size)
        {
            throw std::out_of_range("Pos argument outside of container range");
        }
 
        // NOLINTNEXTLINE(cppcoreguidelines-pro-bounds-pointer-arithmetic)
        return m_data[pos];
    }

back() [1/2]

template<typename T>

auto dsa::Vector< T >::back ( ) -> reference

nodiscardconstexpr

Returns reference to last Arary element.

Returns

reference to last element

Definition at line 933 of file vector.h.

    {
        // NOLINTNEXTLINE(cppcoreguidelines-pro-bounds-pointer-arithmetic)
        return m_data[m_size - 1];
    }

back() [2/2]

template<typename T>

auto dsa::Vector< T >::back ( ) const -> const_reference

nodiscardconstexpr

Returns const_reference to last Arary element.

Returns

const_reference to last element

Definition at line 940 of file vector.h.

    {
        // NOLINTNEXTLINE(cppcoreguidelines-pro-bounds-pointer-arithmetic)
        return m_data[m_size - 1];
    }

begin() [1/2]

template<typename T>

auto dsa::Vector< T >::begin ( ) const -> const_iterator

nodiscardconstexprnoexcept

Returns const_iterator to first element.

Note

If container is empty, returned iterator will be equal to end()

Returns

const_iterator to first element

Definition at line 967 of file vector.h.

    {
        return m_data;
    }

begin() [2/2]

template<typename T>

auto dsa::Vector< T >::begin ( ) -> iterator

nodiscardconstexprnoexcept

Returns iterator to first element.

Note

If container is empty, returned iterator will be equal to end()

Returns

iterator to first element

Definition at line 961 of file vector.h.

    {
        return m_data;
    }

capacity()

template<typename T>

auto dsa::Vector< T >::capacity ( ) -> size_type

constexpr

Returns the number of elements allocated for container.

Returns

size_type number of allocated elements

Definition at line 1064 of file vector.h.

    {
        return m_capacity;
    }

cbegin()

template<typename T>

auto dsa::Vector< T >::cbegin ( ) const -> const_iterator

nodiscardconstexprnoexcept

Returns const_iterator to first element.

Note

If container is empty, returned iterator will be equal to end()

Returns

const_iterator to first element

Definition at line 973 of file vector.h.

    {
        return m_data;
    }

cend()

template<typename T>

auto dsa::Vector< T >::cend ( ) const -> const_iterator

nodiscardconstexprnoexcept

Returns const_iterator past last element of underlaying data structure.

Note

Iterator act as a sentinel, it is not guaranteed to be dereferencable

Returns

const_iterator past last element

Definition at line 993 of file vector.h.

    {
        // NOLINTNEXTLINE(cppcoreguidelines-pro-bounds-pointer-arithmetic)
        return m_data + m_size;
    }

clear()

template<typename T>

void dsa::Vector< T >::clear ( )

constexpr

Erases all elements of the container Does not affect container capacity.

Note

Operation invalidates all pointers and references

Definition at line 1079 of file vector.h.

    {
        destroy_elements();
        m_size = 0;
    }

crbegin()

template<typename T>

auto dsa::Vector< T >::crbegin ( ) const -> const_reverse_iterator

nodiscardconstexprnoexcept

Returns const_reverse_iterator to the first element of reversed underlaying data structure.

Note

If container is empty, returned iterator will be equal to end()

Returns

const_reverse_iterator to the first element

Definition at line 1012 of file vector.h.

    {
        return const_reverse_iterator(end());
    }

crend()

template<typename T>

auto dsa::Vector< T >::crend ( ) const -> const_reverse_iterator

nodiscardconstexprnoexcept

Returns const_reverse_iterator past the last element of reversed underlaying data structure.

Note

Iterator act as a sentinel, it is not guaranteed to be dereferencable

Returns

const_reverse_iterator to the element after the last element

Definition at line 1030 of file vector.h.

    {
        return const_reverse_iterator(begin());
    }

data() [1/2]

template<typename T>

auto dsa::Vector< T >::data ( ) const -> const_pointer

nodiscardconstexprnoexcept

Returns const_pointer to underlying data container.

Returns

const_pointer to underlaying data container

Definition at line 954 of file vector.h.

    {
        // NOLINTNEXTLINE(cppcoreguidelines-pro-bounds-pointer-arithmetic)
        return &m_data[0];
    }

data() [2/2]

template<typename T>

auto dsa::Vector< T >::data ( ) -> pointer

nodiscardconstexprnoexcept

Returns pointer to underlying data container.

Returns

pointer to underlaying data container

Definition at line 947 of file vector.h.

    {
        // NOLINTNEXTLINE(cppcoreguidelines-pro-bounds-pointer-arithmetic)
        return &m_data[0];
    }

emplace()

template<typename T>

template<typename... Args>

auto dsa::Vector< T >::emplace ( const_iterator pos, Args &&... args ) -> iterator

constexpr

Insert new element into the container before pos.

Template Parameters

Args

Parameters

[in]	pos	iterator before which new element will be inserted
[in]	args	arguments to forward to the constructor of the element

Returns

iterator pointing to the emplaced element

Note

if no reallocation occurs, all iterators and references before pos remains valid if reallocation occurs, all iterators and references are invalidated

Definition at line 1152 of file vector.h.

    {
        iterator new_pos{ insert_make_space_for_new_elems(pos, 1) };
 
        // emplace new element
        std::allocator_traits<allocator_type>::construct(m_allocator, new_pos, std::forward<Args>(args)...);
 
        return new_pos;
    }

emplace_back()

template<typename T>

template<typename... Args>

auto dsa::Vector< T >::emplace_back ( Args &&... args ) -> reference

constexpr

Appends a copy of value at the end of the container.

Template Parameters

Args

Parameters

[in]

args

arguments to forward to the constructor of the element

Returns

reference to emplaced element

Definition at line 1164 of file vector.h.

    {
        /*
        * If an exception is thrown for any reason, this function has no effect
        * strong exception guarantee by:
        * - reallocate
        * - if construction of new element fails, state of object does not change
        */
 
        if (m_size >= m_capacity)
        {
            reallocate(calc_new_capacity());
        }
        std::allocator_traits<allocator_type>::construct(m_allocator, end(), std::forward<Args>(args)...);
        ++m_size;
 
        // NOLINTNEXTLINE(cppcoreguidelines-pro-bounds-pointer-arithmetic)
        return m_data[m_size - 1];
    }

empty()

template<typename T>

auto dsa::Vector< T >::empty ( ) const -> bool

nodiscardconstexpr

Checks if container has elements.

Returns

true if container is empty

false if container is not empty

Definition at line 1036 of file vector.h.

    {
        return m_size == 0;
    }

end() [1/2]

template<typename T>

auto dsa::Vector< T >::end ( ) const -> const_iterator

nodiscardconstexprnoexcept

Returns const_iterator past last element of underlaying data structure.

Note

Iterator act as a sentinel, it is not guaranteed to be dereferencable

Returns

const_iterator past last element

Definition at line 986 of file vector.h.

    {
        // NOLINTNEXTLINE(cppcoreguidelines-pro-bounds-pointer-arithmetic)
        return m_data + m_size;
    }

end() [2/2]

template<typename T>

auto dsa::Vector< T >::end ( ) -> iterator

nodiscardconstexprnoexcept

Returns iterator past last element of underlaying data structure.

Note

Iterator act as a sentinel, it is not guaranteed to be dereferencable

Returns

iterator past last element

Definition at line 979 of file vector.h.

    {
        // NOLINTNEXTLINE(cppcoreguidelines-pro-bounds-pointer-arithmetic)
        return m_data + m_size;
    }

erase() [1/4]

template<typename T>

auto dsa::Vector< T >::erase ( const_iterator first, const_iterator last ) -> iterator

constexpr

Erases elements in range [ first , last ) from the container.

Parameters

[in]	first	element defining range of elements to insert
[in]	last	element definig range of elements to insert

Returns

iterator iterator to element after last erased element

Note

iterator first does not need to be dereferencable iterators and references at and after first are invalidated

Definition at line 1203 of file vector.h.

    {
        const auto offset_last = static_cast<size_type>(last - cbegin());
        const auto offset_first = static_cast<size_type>(first - cbegin());
        const size_type count{ offset_last - offset_first };
 
        // destroy objects in range [first, last)
        while (first != last)
        {
            std::allocator_traits<allocator_type>::destroy(m_allocator, first);
            ++first;
        }
 
        // move remaining objects into empty space
        // this moves memory in range [last, end()] to addres pointed by `first`, that was already released
        std::move(begin() + offset_last, end(), begin() + offset_first);
 
        m_size -= count;
        return begin() + offset_first;
    }

erase() [2/4]

template<typename T>

auto dsa::Vector< T >::erase ( const_iterator pos ) -> iterator

constexpr

Erases specified element from the container.

Parameters

[in]

pos

iterator to the element to remove

Returns

iterator iterator to element after last erased element

Note

iterator pos must be valid and dereferencable iterators and references at and after pos are invalidated

Definition at line 1191 of file vector.h.

    {
        return erase(pos, pos + 1);
    }

erase() [3/4]

template<typename T>

auto dsa::Vector< T >::erase ( iterator first, iterator last ) -> iterator

constexpr

Erases elements in range [ first , last ) from the container.

Parameters

[in]	first	element defining range of elements to insert
[in]	last	element definig range of elements to insert

Returns

iterator iterator to element after last erased element

Note

iterator first does not need to be dereferencable iterators and references at and after first are invalidated

Definition at line 1197 of file vector.h.

    {
        return erase(static_cast<const_iterator>(first), static_cast<const_iterator>(last));
    }

erase() [4/4]

template<typename T>

auto dsa::Vector< T >::erase ( iterator pos ) -> iterator

constexpr

Erases specified element from the container.

Parameters

[in]

pos

iterator to the element to remove

Returns

iterator iterator to element after last erased element

Note

iterator pos must be valid and dereferencable iterators and references at and after pos are invalidated

Definition at line 1185 of file vector.h.

    {
        return erase(pos, pos + 1);
    }

front() [1/2]

template<typename T>

auto dsa::Vector< T >::front ( ) -> reference

nodiscardconstexpr

Returns reference to first Arary element.

Returns

reference to first element

Definition at line 919 of file vector.h.

    {
        // NOLINTNEXTLINE(cppcoreguidelines-pro-bounds-pointer-arithmetic)
        return m_data[0];
    }

front() [2/2]

template<typename T>

auto dsa::Vector< T >::front ( ) const -> const_reference

nodiscardconstexpr

Returns const_reference to first Arary element.

Returns

const_reference to first element

Definition at line 926 of file vector.h.

    {
        // NOLINTNEXTLINE(cppcoreguidelines-pro-bounds-pointer-arithmetic)
        return m_data[0];
    }

get_allocator()

template<typename T>

auto dsa::Vector< T >::get_allocator ( ) const -> allocator_type

nodiscardconstexpr

Get the allocator object.

Returns

allocator_type type of memory allocator

Definition at line 875 of file vector.h.

    {
        return m_allocator;
    }

insert() [1/5]

template<typename T>

auto dsa::Vector< T >::insert ( const_iterator pos, const T & value ) -> iterator

constexpr

Insert a copy of value before pos.

Parameters

[in]	pos	iterator before which new element will be inserted
[in]	value	element to insert into container

Returns

iterator pointing to inserted element

Definition at line 1086 of file vector.h.

    {
        return insert(pos, 1, value);
    }

insert() [2/5]

template<typename T>
requires std::input_iterator<InputIt>

template<typename InputIt>
requires std::input_iterator<InputIt>

auto dsa::Vector< T >::insert ( const_iterator pos, InputIt first, InputIt last ) -> iterator

constexpr

Insert elements from range [ first , last ) befor pos.

Template Parameters

InputIt

Parameters

[in]	pos	iterator before which new element will be inserted
[in]	first	element defining range of elements to insert
[in]	last	element definig range of elements to insert

Returns

iterator pointing to the first inserted element, or pos if no element was inserted

Note

if no reallocation occurs, all iterators and references before pos remains valid if reallocation occurs, all iterators and references are invalidated

Definition at line 1116 of file vector.h.

    {
        const auto count = static_cast<size_type>(std::distance(first, last));
        iterator new_pos{ insert_make_space_for_new_elems(pos, count) };
 
        // create objects in range [pos, pos + count]
        iterator new_iter{ new_pos };
        while (first != last)
        {
            std::allocator_traits<allocator_type>::construct(m_allocator, new_iter, *first);
            ++new_iter;
            ++first;
        }
 
        return new_pos;
    }

insert() [3/5]

template<typename T>

auto dsa::Vector< T >::insert ( const_iterator pos, size_type count, const T & value ) -> iterator

constexpr

Insert count copies of value before pos.

Parameters

[in]	pos	iterator before which new element will be inserted
[in]	count	number of copies to insert into container
[in]	value	element to insert into container

Returns

iterator pointing to the first inserted element, or pos if no element was inserted

Note

if no reallocation occurs, all iterators and references before pos remains valid if reallocation occurs, all iterators and references are invalidated

Definition at line 1098 of file vector.h.

    {
        iterator new_pos{ insert_make_space_for_new_elems(pos, count) };
 
        // create objects in range [pos, pos + count]
        iterator new_iter{ new_pos };
        for (size_t i = 0; i < count; i++)
        {
            std::allocator_traits<allocator_type>::construct(m_allocator, new_iter, value);
            ++new_iter;
        }
 
        return new_pos;
    }

insert() [4/5]

template<typename T>

auto dsa::Vector< T >::insert ( const_iterator pos, std::initializer_list< T > init_list ) -> iterator

constexpr

Insert constent of init_list before pos.

Parameters

[in]	pos	iterator before which new element will be inserted
[in]	init_list	container to insert befor pos

Returns

iterator pointing to the first inserted element, or pos if no element was inserted

Note

if no reallocation occurs, all iterators and references before pos remains valid if reallocation occurs, all iterators and references are invalidated

Definition at line 1134 of file vector.h.

    {
        const size_type count = init_list.size();
        iterator new_pos{ insert_make_space_for_new_elems(pos, count) };
 
        // create objects in range [pos, pos + count]
        iterator new_iter{ new_pos };
        for (const auto& value : init_list)
        {
            std::allocator_traits<allocator_type>::construct(m_allocator, new_iter, value);
            ++new_iter;
        }
 
        return new_pos;
    }

insert() [5/5]

template<typename T>

auto dsa::Vector< T >::insert ( const_iterator pos, T && value ) -> iterator

constexpr

Insert value before pos possibly using move semantics.

Parameters

[in]	pos	iterator before which new element will be inserted
[in]	value	element to insert into container

Returns

iterator pointing to inserted element

Definition at line 1092 of file vector.h.

    {
        return insert(pos, 1, std::move(value));
    }

max_size()

template<typename T>

auto dsa::Vector< T >::max_size ( ) const -> size_type

nodiscardconstexprnoexcept

Returns maximum number of elements container can hold.

Returns

size_type maximum number of elements

Definition at line 1048 of file vector.h.

    {
        return std::allocator_traits<allocator_type>::max_size(get_allocator());
    }

operator=() [1/3]

template<typename T>

auto dsa::Vector< T >::operator= ( const Vector< T > & other ) -> Vector<T>&

constexpr

Assign Vector object using copy assignment.

Content of other object will be taken by constructed object

Parameters

[in,out]

other

Vector object of type T

Returns

Vector& reference to constructed Vector of type T

Definition at line 772 of file vector.h.

    {
        if (&other != this)
        {
            clear_allocation();
            m_capacity = 0;
            m_size = 0;
 
            m_data = allocator_type().allocate(other.size());
            for (const auto& item : other)
            {
                push_back(item);
            }
        }
 
        return *this;
    }

operator=() [2/3]

template<typename T>

auto dsa::Vector< T >::operator= ( std::initializer_list< T > init_list ) -> Vector<T>&

constexpr

Assign Vector object from init_list elements.

Parameters

[in]

init_list

values to replace Vector with

Returns

Vector& reference to constructed Vector of type T

Definition at line 810 of file vector.h.

    {
        clear_allocation();
        m_capacity = 0;
        m_size = 0;
 
        m_data = allocator_type().allocate(init_list.size());
        for (auto const& item : init_list)
        {
            push_back(item);
        }
 
        return *this;
    }

operator=() [3/3]

template<typename T>

auto dsa::Vector< T >::operator= ( Vector< T > && other ) -> Vector<T>&

constexprnoexcept

Assign Vector object using move assignment.

Content of other object will be taken by constructed object

Parameters

[in,out]

other

Vector object of type T

Returns

Vector& reference to constructed Vector of type T

Definition at line 791 of file vector.h.

    {
        if (&other != this)
        {
            clear_allocation();
 
            m_data = other.m_data;
            m_capacity = other.m_capacity;
            m_size = other.m_size;
 
            other.m_data = nullptr;
            other.m_capacity = 0;
            other.m_size = 0;
        }
 
        return *this;
    }

operator[]() [1/2]

template<typename T>

auto dsa::Vector< T >::operator[] ( size_type pos ) -> reference

nodiscardconstexpr

Returns a reference to Vector element at pos index. If pos is outside of container range, undefined behaviour occurs.

Parameters

[in]

pos

index of element to return

Returns

reference to Vector element

Definition at line 905 of file vector.h.

    {
        // NOLINTNEXTLINE(cppcoreguidelines-pro-bounds-pointer-arithmetic)
        return m_data[pos];
    }

operator[]() [2/2]

template<typename T>

auto dsa::Vector< T >::operator[] ( size_type pos ) const -> const_reference

nodiscardconstexpr

Returns a const_reference to Vector element at pos index. If pos is outside of container range, undefined behaviour occurs.

Parameters

[in]

pos

index of element to return

Returns

const_reference to Vector element

Definition at line 912 of file vector.h.

    {
        // NOLINTNEXTLINE(cppcoreguidelines-pro-bounds-pointer-arithmetic)
        return m_data[pos];
    }

pop_back()

template<typename T>

void dsa::Vector< T >::pop_back ( )

constexpr

Removes the last element of the container.

Note

iterators and references to the last element are invalidated

Definition at line 1250 of file vector.h.

    {
        if (m_size > 0)
        {
            std::allocator_traits<allocator_type>::destroy(m_allocator, end());
            --m_size;
        }
    }

push_back() [1/2]

template<typename T>

void dsa::Vector< T >::push_back ( const T & value )

constexpr

Appends a copy of value at the end of the container.

Parameters

[in]

value

the value of the element to append

Definition at line 1225 of file vector.h.

    {
        if (m_size >= m_capacity)
        {
            reallocate(calc_new_capacity());
        }
 
        std::allocator_traits<allocator_type>::construct(m_allocator, end(), value);
        ++m_size;
    }

push_back() [2/2]

template<typename T>

void dsa::Vector< T >::push_back ( T && value )

constexpr

Appends a copy of value at the end of the container.

Parameters

[in]

value

the value of the element to append

Definition at line 1237 of file vector.h.

    {
        // Some implementations throw std::lengt_error when push_back causes a reallocation that exceeds mas_size()
        if (m_size >= m_capacity)
        {
            reallocate(calc_new_capacity());
        }
 
        std::allocator_traits<allocator_type>::construct(m_allocator, end(), std::move(value));
        ++m_size;
    }

rbegin() [1/2]

template<typename T>

auto dsa::Vector< T >::rbegin ( ) -> reverse_iterator

nodiscardconstexpr

Returns reverse_iterator to the first element of reversed underlaying data structure.

Note

If container is empty, returned iterator will be equal to end()

Returns

reverse_iterator to the first element

Definition at line 1000 of file vector.h.

    {
        return reverse_iterator(end());
    }

rbegin() [2/2]

template<typename T>

auto dsa::Vector< T >::rbegin ( ) const -> const_reverse_iterator

nodiscardconstexpr

Returns const_reverse_iterator to the first element of reversed underlaying data structure.

Note

If container is empty, returned iterator will be equal to end()

Returns

const_reverse_iterator to the first element

Definition at line 1006 of file vector.h.

    {
        return const_reverse_iterator(end());
    }

rend() [1/2]

template<typename T>

auto dsa::Vector< T >::rend ( ) -> reverse_iterator

nodiscardconstexpr

Returns reverse_iterator past the last element of reversed underlaying data structure.

Note

Iterator act as a sentinel, it is not guaranteed to be dereferencable

Returns

reverse_iterator to the element after the last element

Definition at line 1018 of file vector.h.

    {
        return reverse_iterator(begin());
    }

rend() [2/2]

template<typename T>

auto dsa::Vector< T >::rend ( ) const -> const_reverse_iterator

nodiscardconstexpr

Returns const_reverse_iterator past the last element of reversed underlaying data structure.

Note

Iterator act as a sentinel, it is not guaranteed to be dereferencable

Returns

const_reverse_iterator to the element after the last element

Definition at line 1024 of file vector.h.

    {
        return const_reverse_iterator(begin());
    }

reserve()

template<typename T>

void dsa::Vector< T >::reserve ( size_type new_cap )

constexpr

Increase the capacity of the container.

Parameters

[in]

new_cap

new capacity of container, new number of elements the container can store

Definition at line 1054 of file vector.h.

    {
        if (new_cap > capacity())
        {
            // strong exception guarantee by reallocate
            reallocate(new_cap);
        }
    }

resize() [1/2]

template<typename T>

void dsa::Vector< T >::resize ( size_type count )

constexpr

Resizez the container to contain count elements if count is equal to current size, does nothing if current size is greater than count , container size is reduced if current size is less than count , additional copies of T() are appended.

Parameters

[in]

count

new size of the container

Definition at line 1260 of file vector.h.

    {
        resize(count, T{});
    }

resize() [2/2]

template<typename T>

void dsa::Vector< T >::resize ( size_type count, const value_type & value )

constexpr

Resizes the container to contain count elements if count is equal to current size, does nothing if current size is greater than count , container size is reduced if 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 the new element with

Definition at line 1266 of file vector.h.

    {
        if (count >= max_size())
        {
            throw std::length_error("Capacity required by new vector would exceed maximum allowed size");
        }
 
        if (count == m_size)
        {
            return;
        }
 
        if (m_size > count)
        {
            // container is reduced to its count elements
            while (m_size > count)
            {
                pop_back();
            }
        }
 
        if (m_size < count)
        {
            // additional copies of value are appended
            while (m_size < count)
            {
                push_back(value);
            }
        }
    }

shrink_to_fit()

template<typename T>

void dsa::Vector< T >::shrink_to_fit ( )

constexpr

Request to remove of unused capacity.

Note

If request is fulfilled and reallocation occurs, all iterators and all references to the container elements are invalidated

Definition at line 1070 of file vector.h.

    {
        if (m_capacity > m_size)
        {
            reallocate(m_size);
        }
    }

size()

template<typename T>

auto dsa::Vector< T >::size ( ) const -> size_type

nodiscardconstexprnoexcept

Returns number of elements in container.

Returns

size_type number of elements in container

Definition at line 1042 of file vector.h.

    {
        return m_size;
    }

swap()

template<typename T>

void dsa::Vector< T >::swap ( Vector< T > & other )

constexprnoexcept

Exchanges content of current container with other container.

Parameters

[in]

other

container to exchange content with

Definition at line 1298 of file vector.h.

    {
        std::swap(*this, other);
    }

---

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

• include/dsa/vector.h