Implements Queue class. More...

#include <queue.h>

Public Types
using	value_type = T
	Alias for 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.

Public Member Functions
	Queue ()=default
	Construct a new Queue object.
	Queue (const std::initializer_list< T > &init_list)
	Construct a new Queue object using initializer list.
	Queue (const Queue< T > &other)
	Construct a new Queue object using copy constructor.
auto	operator= (const Queue< T > &other) -> Queue &
	Constructs Queue using copy assignment.
	Queue (Queue< T > &&other) noexcept
	Construct a new Queue object using move constructor.
auto	operator= (Queue< T > &&other) noexcept -> Queue &
	Assign Queue object using move assignment.
	~Queue ()=default
	Destroy the Queue object.
auto	front () -> reference
	Function returns pointer to Queue first object.
auto	front () const -> const_reference
	Function returns pointer to Queue first object.
auto	back () -> reference
	Function returns pointer to Queue last object.
auto	back () const -> const_reference
	Function returns pointer to Queue last object.
auto	empty () const -> bool
	Function checks if container has no elements.
auto	size () const -> size_t
	Function returns Queue size.
void	push (const_reference value)
	Function add new element at the end of Queue.
void	push (T &&value)
	Function add new element at the end of Queue.
void	pop ()
	Function removes the first element of Queue.
void	swap (Queue< T > &other) noexcept
	Function swaps content of two Queue objects.
auto	operator+= (const Queue< T > &other) -> Queue< T > &
	Function add range of elements at the end of Queue.
auto	operator+= (const std::initializer_list< T > &init_list) -> Queue< T > &
	Function add range of elements at the end of Queue.

Friends
auto	operator== (const Queue< T > &queue1, const Queue< T > &queue2) -> bool
	Forward friend declaration to access internal container comparison operator.
auto	operator< (const Queue< T > &queue1, const Queue< T > &queue2) -> bool
	Forward friend declaration to access internal container comparison operator.

Detailed Description

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

Implements Queue class.

Template Parameters

T	type of data stored in Queue

Todo

add operator<=>

add emplace

add non-member specialized swap function

Definition at line 42 of file queue.h.

Member Typedef Documentation

◆ const_reference

template<typename T>

using dsa::Queue< 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 65 of file queue.h.

◆ reference

template<typename T>

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

Alias for reference to data type used in class.

Template Parameters

T&	reference to data type

Definition at line 58 of file queue.h.

◆ value_type

template<typename T>

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

Alias for data type used in class.

Template Parameters

T data type

Definition at line 51 of file queue.h.

Constructor & Destructor Documentation

◆ Queue() [1/3]

template<typename T>

dsa::Queue< T >::Queue ( const std::initializer_list< T > & init_list )

Construct a new Queue object using initializer list.

Parameters

[in] init_list initializer list of values of type T

Definition at line 218 of file queue.h.

    {
        for (const auto& item : init_list)
        {
            container.push_back(item);
        }
    }

◆ Queue() [2/3]

template<typename T>

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

Construct a new Queue object using copy constructor.

Parameters

[in] other Queue object of type T

Definition at line 227 of file queue.h.

    {
        if (other.size() >= 1)
        {
            for (const auto& item : other.container)
            {
                container.push_back(item);
            }
        }
    }

◆ Queue() [3/3]

template<typename T>

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

noexcept

Construct a new Queue object using move constructor.

Content of other object will be taken by constructed object

Parameters

[in,out] other Queue object of type T

Definition at line 258 of file queue.h.

        : container{ std::move(other.container) }
    {
    }

Member Function Documentation

◆ back() [1/2]

template<typename T>

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

Function returns pointer to Queue last object.

Returns: T& reference to Queue last object

Definition at line 287 of file queue.h.

    {
        return container.back();
    }

◆ back() [2/2]

template<typename T>

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

nodiscard

Function returns pointer to Queue last object.

Returns: const T& const reference to Queue last object

Definition at line 293 of file queue.h.

    {
        return container.back();
    }

◆ empty()

template<typename T>

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

nodiscard

Function checks if container has no elements.

Return values

true	if container is empty
false	if container is not empty

Definition at line 299 of file queue.h.

    {
        return container.size() == 0;
    }

◆ front() [1/2]

template<typename T>

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

Function returns pointer to Queue first object.

Returns: T& reference to Queue first object

Definition at line 275 of file queue.h.

    {
        return container.front();
    }

◆ front() [2/2]

template<typename T>

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

nodiscard

Function returns pointer to Queue first object.

Returns: const T& const reference to Queue first object

Definition at line 281 of file queue.h.

    {
        return container.front();
    }

◆ operator+=() [1/2]

template<typename T>

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

Function add range of elements at the end of Queue.

Parameters

[in] other Queue to read elements from

Returns: Queue<T>& reference to Queue

Definition at line 338 of file queue.h.

    {
        for (const auto& item : other.container)
        {
            push(item);
        }
 
        return *this;
    }

◆ operator+=() [2/2]

template<typename T>

auto dsa::Queue< T >::operator+= ( const std::initializer_list< T > & init_list ) -> Queue< T > &

Function add range of elements at the end of Queue.

Parameters

[in] init_list std::initializer_list to read elements from

Returns: Queue<T>& reference to Queue

◆ operator=() [1/2]

template<typename T>

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

Constructs Queue using copy assignment.

Parameters

[in] other Queue object of type T

Returns: Queue& reference to Queue object

Definition at line 239 of file queue.h.

    {
        if (&other != this)
        {
            while (!container.empty())
            {
                container.pop_front();
            }
 
            for (const auto& item : other.container)
            {
                container.push_back(item);
            }
        }
 
        return *this;
    }

◆ operator=() [2/2]

template<typename T>

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

noexcept

Assign Queue object using move assignment.

Content of other object will be taken by constructed object

Parameters

[in,out] other Queue object of type T

Returns: Queue& reference to Queue object

Definition at line 264 of file queue.h.

    {
        if (&other != this)
        {
            container = std::move(other.container);
        }
 
        return *this;
    }

◆ pop()

template<typename T>

void dsa::Queue< T >::pop ( )

Function removes the first element of Queue.

Definition at line 323 of file queue.h.

    {
        container.pop_front();
    }

◆ push() [1/2]

template<typename T>

void dsa::Queue< T >::push ( const_reference value )

Function add new element at the end of Queue.

Parameters

[in] value element of type T

Definition at line 311 of file queue.h.

    {
        container.push_back(value);
    }

◆ push() [2/2]

template<typename T>

void dsa::Queue< T >::push ( T && value )

Function add new element at the end of Queue.

Parameters

[in] value element of type T

Definition at line 317 of file queue.h.

    {
        container.push_back(std::move(value));
    }

◆ size()

template<typename T>

auto dsa::Queue< T >::size ( ) const -> size_t

nodiscard

Function returns Queue size.

Returns: size_t number of elements in container

Definition at line 305 of file queue.h.

    {
        return container.size();
    }

◆ swap()

template<typename T>

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

noexcept

Function swaps content of two Queue objects.

Parameters

[in,out] other object to swap content with

Definition at line 329 of file queue.h.

    {
        if (&other != this)
        {
            std::swap(container, other.container);
        }
    }

◆ operator<

template<typename T>

auto operator<	(	const Queue< T > &	queue1,
		const Queue< T > &	queue2 ) -> bool

friend

Forward friend declaration to access internal container comparison operator.

Template Parameters

T	type of data stored in Queue

Parameters

[in]	queue1	input container
[in]	queue2	input container

Return values

true	if the content of `queue1` are lexicographically less than the content of `queue2`
false	otherwise

Definition at line 411 of file queue.h.

    {
        return queue1.container < queue2.container;
    }

◆ operator==

template<typename T>

auto operator==	(	const Queue< T > &	queue1,
		const Queue< T > &	queue2 ) -> bool

friend

Forward friend declaration to access internal container comparison operator.

Template Parameters

T	type of data stored in Queue

Parameters

[in]	queue1	input container
[in]	queue2	input container

Return values

true	if containers are equal
false	if containers are not equal

Definition at line 380 of file queue.h.

    {
        return queue1.container == queue2.container;
    }

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

include/dsa/queue.h

Public Types

Public Member Functions

Friends

Detailed Description

Member Typedef Documentation

◆ const_reference

◆ reference

◆ value_type

Constructor & Destructor Documentation

◆ Queue() [1/3]

◆ Queue() [2/3]

◆ Queue() [3/3]

Member Function Documentation

◆ back() [1/2]

◆ back() [2/2]

◆ empty()

◆ front() [1/2]

◆ front() [2/2]

◆ operator+=() [1/2]

◆ operator+=() [2/2]

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ pop()

◆ push() [1/2]

◆ push() [2/2]

◆ size()

◆ swap()

Friends And Related Symbol Documentation

◆ operator<

◆ operator==