Description:

template<typename TElement>
struct alib::lang::BidiListHook< TElement >

This struct, together with sibling struct BidiNodeBase provide the tools to implement a doubly linked list of TElement instances.

Template type TElement has to extend struct BidiNodeBase<TElement>.

See also: Types SidiNodeBase,
SidiListHook, and
BidiNodeBase.

Template Parameters

TElement The "final" custom type that (by contract) is derived from BidiNodeBase.

Definition at line 122 of file bidilist.inl.

Public Type Index:
using	TFNode = SidiNodeBase<TElement>
	An alias for the base type of the node type of this list.
using	TNode = BidiNodeBase<TElement>
	An alias for the node type of this list.

Public Field Index:
TNode	hook
	The root node. Points twice to itself when the list is empty.

Public Method Index:
	BidiListHook () noexcept
	Default constructor. Initializes this list to be empty.
	BidiListHook (BidiListHook &&move) noexcept
	BidiListHook (const BidiListHook &)=delete
	Deleted copy constructor.
	BidiListHook (TElement *first) noexcept
	BidiListHook (TElement first, TElement last) noexcept
integer	count (const TNode *end=nullptr) const noexcept
TElement *	end () const noexcept
TElement *	first () const noexcept
bool	isEmpty () const noexcept
bool	isFirst (const TElement *elem) const noexcept
bool	isLast (const TElement *elem) const noexcept
TElement *	last () const noexcept
BidiListHook &	operator= (BidiListHook &&) noexcept=default
BidiListHook &	operator= (const BidiListHook &)=delete
TElement *	popEnd () noexcept
TElement *	popFront () noexcept
void	pushEnd (TElement *elem) noexcept
void	pushEnd (TElement first, TElement last) noexcept
void	pushFront (TElement *elem) noexcept
void	pushFront (TElement first, TElement last) noexcept
void	reset () noexcept
	Resets this list to zero elements.

Type Definition Details:

◆ TFNode

template<typename TElement>

using alib::lang::BidiListHook< TElement >::TFNode = SidiNodeBase<TElement>

An alias for the base type of the node type of this list.

Definition at line 125 of file bidilist.inl.

◆ TNode

template<typename TElement>

using alib::lang::BidiListHook< TElement >::TNode = BidiNodeBase<TElement>

An alias for the node type of this list.

Definition at line 128 of file bidilist.inl.

Field Details:

◆ hook

template<typename TElement>

TNode alib::lang::BidiListHook< TElement >::hook

The root node. Points twice to itself when the list is empty.

Definition at line 131 of file bidilist.inl.

Constructor(s) / Destructor Details:

◆ BidiListHook() [1/4]

template<typename TElement>

alib::lang::BidiListHook< TElement >::BidiListHook ( )

inlinenoexcept

Default constructor. Initializes this list to be empty.

Definition at line 134 of file bidilist.inl.

◆ BidiListHook() [2/4]

template<typename TElement>

alib::lang::BidiListHook< TElement >::BidiListHook ( BidiListHook< TElement > && move )

inlinenoexcept

Move constructor. Takes elements of move and sets move to empty.

Parameters

move	The list to move.

Definition at line 141 of file bidilist.inl.

◆ BidiListHook() [3/4]

template<typename TElement>

alib::lang::BidiListHook< TElement >::BidiListHook ( TElement * first )

inlineexplicitnoexcept

Constructor accepting a pointer to the first element.

Parameters

first The element to use as the first element of this list.

Definition at line 161 of file bidilist.inl.

◆ BidiListHook() [4/4]

template<typename TElement>

alib::lang::BidiListHook< TElement >::BidiListHook	(	TElement *	first,
		TElement *	last )

inlinenoexcept

Constructor accepting a pointer to the first and last element.

Parameters

first	The element to use as the first element of this list.
last	The element to use as the last element of this list.

Definition at line 171 of file bidilist.inl.

Method Details:

◆ count()

template<typename TElement>

integer alib::lang::BidiListHook< TElement >::count ( const TNode * end = nullptr ) const

inlinenodiscardnoexcept

Counts the number of elements found in the range starting with this list's first element and ending with the element before end.

Parameters

end	The element after the last one to count. Defaults to a `nullptr` marking the end of the list.

Returns: The number of elements in the range.

Definition at line 255 of file bidilist.inl.

◆ end()

template<typename TElement>

TElement * alib::lang::BidiListHook< TElement >::end ( ) const

inlinenoexcept

Returns a pointer to the hook node cast to a pointer to a mutable element. This method must only be used in cases where such conversion is allowed i.e., with iterator types that use this pointer exclusively for pointer value comparison but do not allow (by contract) to dereference or otherwise use this pointer.

Returns: The first element of this list.

Definition at line 191 of file bidilist.inl.

◆ first()

template<typename TElement>

TElement * alib::lang::BidiListHook< TElement >::first ( ) const

inlinenodiscardnoexcept

Returns the first element of this list.

Returns: The first element of this list.

Definition at line 198 of file bidilist.inl.

◆ isEmpty()

template<typename TElement>

bool alib::lang::BidiListHook< TElement >::isEmpty ( ) const

inlinenodiscardnoexcept

Tests if this list is empty.

Returns: false if the list is empty, true otherwise.

Definition at line 181 of file bidilist.inl.

◆ isFirst()

template<typename TElement>

bool alib::lang::BidiListHook< TElement >::isFirst ( const TElement * elem ) const

inlinenodiscardnoexcept

Tests if given elem is the first element of this list.

Parameters

elem	The element to test for being the first.

Returns: true if elem is the first element of this list, false otherwise.

Definition at line 209 of file bidilist.inl.

◆ isLast()

template<typename TElement>

bool alib::lang::BidiListHook< TElement >::isLast ( const TElement * elem ) const

inlinenodiscardnoexcept

Tests if given elem is the last element of this list.

Parameters

elem	The element to test for being the last.

Returns: true if elem is the last element of this list, false otherwise.

Definition at line 215 of file bidilist.inl.

◆ last()

template<typename TElement>

TElement * alib::lang::BidiListHook< TElement >::last ( ) const

inlinenodiscardnoexcept

Returns the last element of this list.

Returns: The last element of this list.

Definition at line 203 of file bidilist.inl.

◆ operator=() [1/2]

template<typename TElement>

BidiListHook & alib::lang::BidiListHook< TElement >::operator= ( BidiListHook< TElement > && )

defaultnoexcept

Defaulted move assignment operator.

Returns: A reference to this list object.

◆ operator=() [2/2]

template<typename TElement>

BidiListHook & alib::lang::BidiListHook< TElement >::operator= ( const BidiListHook< TElement > & )

delete

Deleted copy assignment operator.

Returns: A reference to this list object.

◆ popEnd()

template<typename TElement>

TElement * alib::lang::BidiListHook< TElement >::popEnd ( )

inlinenoexcept

Removes and returns the last element from this list. Must not be invoked on empty lists.

Returns: A pointer to the last element (which was removed).

Definition at line 243 of file bidilist.inl.

◆ popFront()

template<typename TElement>

TElement * alib::lang::BidiListHook< TElement >::popFront ( )

inlinenoexcept

Removes and returns the first element from this list. Must not be invoked on empty lists.

Returns: A pointer to the first element (which was removed).

Definition at line 238 of file bidilist.inl.

◆ pushEnd() [1/2]

template<typename TElement>

void alib::lang::BidiListHook< TElement >::pushEnd ( TElement * elem )

inlinenoexcept

Hooks the given element to the end of this list.

Parameters

elem	The element to insert to at the start.

Definition at line 228 of file bidilist.inl.

◆ pushEnd() [2/2]

template<typename TElement>

void alib::lang::BidiListHook< TElement >::pushEnd	(	TElement *	first,
		TElement *	last )

inlinenoexcept

Hooks the given range of elements to the end of this list.

Parameters

first	The first element of the range to insert.
last	The last element of the range to insert.

Definition at line 233 of file bidilist.inl.

◆ pushFront() [1/2]

template<typename TElement>

void alib::lang::BidiListHook< TElement >::pushFront ( TElement * elem )

inlinenoexcept

Hooks the given element to the beginning of this list.

Parameters

elem	The element to insert to at the start.

Definition at line 219 of file bidilist.inl.

◆ pushFront() [2/2]

template<typename TElement>

void alib::lang::BidiListHook< TElement >::pushFront	(	TElement *	first,
		TElement *	last )

inlinenoexcept

Hooks the given range of elements to the front of this list.

Parameters

first	The first element of the range to insert.
last	The last element of the range to insert.

Definition at line 224 of file bidilist.inl.

◆ reset()

template<typename TElement>

void alib::lang::BidiListHook< TElement >::reset ( )

inlinenoexcept

Resets this list to zero elements.

Definition at line 184 of file bidilist.inl.

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

bidilist.inl

Description:

Public Type Index:

Public Field Index:

Public Method Index:

Type Definition Details:

◆ TFNode

◆ TNode

Field Details:

◆ hook

Constructor(s) / Destructor Details:

◆ BidiListHook() [1/4]

◆ BidiListHook() [2/4]

◆ BidiListHook() [3/4]

◆ BidiListHook() [4/4]

Method Details:

◆ count()

◆ end()

◆ first()

◆ isEmpty()

◆ isFirst()

◆ isLast()

◆ last()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ popEnd()

◆ popFront()

◆ pushEnd() [1/2]

◆ pushEnd() [2/2]

◆ pushFront() [1/2]

◆ pushFront() [2/2]

◆ reset()