#include <tpl_arrayQueue.H>

Inheritance diagram for Aleph::ArrayQueue< T >:

Collaboration diagram for Aleph::ArrayQueue< T >:

Classes
struct	Iterator

Public Types
using	Item_Type = T

using	iterator = StlIterator< SetName >

using	const_iterator = StlConstIterator< SetName >

Public Member Functions
void	swap (ArrayQueue &q) noexcept
	Swap `this` with `q`

	ArrayQueue (const size_t sz=8)

	ArrayQueue (const ArrayQueue &q)
	Copy constructor.

	ArrayQueue (ArrayQueue &&q)
	Move constructor.

	Special_Ctors (ArrayQueue, T)

ArrayQueue &	operator= (const ArrayQueue &q)
	Copy assign.

ArrayQueue &	operator= (ArrayQueue &&q)
	Move assign.

T &	put (const T &item)

T &	put (T &&item)

T &	append (const T &item)

T &	append (T &&item)

T &	insert (const T &item)

T &	insert (T &&item)

T &	putn (size_t sz)

T	get ()

T &	getn (const size_t i)

T &	front (const size_t i=0) const

T &	rear (const size_t i=0) const

template<class Operation >
bool	traverse (Operation &operation)

template<class Operation >
bool	traverse (Operation &operation) const

template<class Operation >
bool	traverse (Operation &&operation) const

template<class Operation >
bool	traverse (Operation &&operation)

T *	get_ptr () const noexcept
	Return the current base of array.

const size_t &	get_dim () const noexcept
	Return the current dimension of array.

size_t	capacity () const noexcept
	The type of element of array. More...

size_t	size () const noexcept
	Return the number of elements.

bool	is_empty () const noexcept
	Return `true` is the array is empty.

void	swap (MemArray &a) noexcept
	Swap in constant time `this` with `a`

void	empty ()
	Empty the container. The array is not contracted.

void	empty_and_release ()
	Empty the array and release all memory.

T &	push (const T &item)

T &	push (T &&item)

T &	top () const

T	remove_first ()
	Remove first item. Gap is closed.

T	pop ()
	pop() the most recently pushed item

T &	append (T &item)

MemArray &	append (const MemArray &a)

T &	insert (T &item)

void	reserve (const size_t cap)

T	get (size_t i=1)

T	get_ne (size_t i=1) noexcept

T	remove_last ()

T &	last () const
	Return a modifiable reference to the last element.

T &	first () const
	Return a modifiable reference to the first element.

T &	get_first () const

T &	get_last () const

MemArray &	reverse ()
	Reverse the order of items in array.

T &	access (const size_t i) const noexcept

T &	operator[] (const size_t i) const

T &	operator() (const size_t i) const noexcept

bool	is_valid () const noexcept

auto	get_it () const

auto	get_it (size_t pos) const

auto	get_itor () const

T &	nth_ne (const size_t n) noexcept

const T &	nth_ne (const size_t n) const noexcept

T &	nth (const size_t n)

const T &	nth (const size_t n) const

T *	find_ptr (Operation &operation) noexcept(noexcept(operation))

const T *	find_ptr (Operation &operation) const noexcept(noexcept(operation))

const T *	find_ptr (Operation &&operation) const noexcept(noexcept(operation))

T *	find_ptr (Operation &&operation) noexcept(noexcept(operation))

size_t	find_index (Operation &operation) const noexcept(noexcept(operation))

size_t	find_index (Operation &&operation) const noexcept(noexcept(operation))

std::tuple< bool, T >	find_item (Operation &operation) noexcept(noexcept(operation))

std::tuple< bool, T >	find_item (Operation &operation) const noexcept(noexcept(operation))

std::tuple< bool, T >	find_item (Operation &&operation) noexcept(noexcept(operation))

std::tuple< bool, T >	find_item (Operation &&operation) const noexcept(noexcept(operation))

void	emplace (Args &&... args)

void	emplace_end (Args &&... args)

void	emplace_ins (Args &&... args)

size_t	ninsert (Args ... args)

size_t	nappend (Args ... args)

void	for_each (Operation &operation) noexcept(noexcept(operation))

void	for_each (Operation &operation) const noexcept(noexcept(operation))

void	for_each (Operation &&operation) const noexcept(noexcept(operation))

void	for_each (Operation &&operation) noexcept(noexcept(operation))

void	each (Operation &operation) noexcept(noexcept(operation))

void	each (Operation &operation) const noexcept(noexcept(operation))

void	each (Operation &&operation) const noexcept(noexcept(operation))

void	each (Operation &&operation) noexcept(noexcept(operation))

void	each (size_t pos, size_t slice, Operation &operation) const

void	each (size_t pos, size_t slice, Operation &&operation) const

void	mutable_for_each (Operation &operation) noexcept(noexcept(operation))

void	mutable_for_each (Operation &&operation) noexcept(noexcept(operation))

bool	all (Operation &operation) const noexcept(noexcept(operation))

bool	all (Operation &&operation) const noexcept(noexcept(operation))

bool	exists (Operation &op) const noexcept(noexcept(op))

bool	exists (Operation &&op) const noexcept(noexcept(op))

DynList< __T >	maps (Operation &op) const

DynList< __T >	maps (Operation &&op) const

DynList< __T >	maps_if (Prop prop, Operation &op) const

DynList< __T >	maps_if (Prop prop, Operation &&op) const

DynList< T >	to_dynlist () const

__T	foldl (const __T &init, Op &op) const noexcept(noexcept(op))

__T	foldl (const __T &init, Op &&op=Op()) const noexcept(noexcept(op))

T	fold (const T &init, Operation &operation) const noexcept(noexcept(operation))

T	fold (const T &init, Operation &&operation) const noexcept(noexcept(operation))

DynList< T >	filter (Operation &operation) const

DynList< T >	filter (Operation &&operation) const

DynList< const T *>	ptr_filter (Operation &operation) const

DynList< const T *>	ptr_filter (Operation &&operation) const

DynList< std::tuple< T, size_t > >	pfilter (Operation &operation) const

DynList< std::tuple< T, size_t > >	pfilter (Operation &&operation) const

std::pair< DynList< T >, DynList< T > >	partition (Operation &op) const

std::pair< DynList< T >, DynList< T > >	partition (Operation &&op) const

std::pair< DynList< T >, DynList< T > >	partition (size_t n) const

std::tuple< DynList< T >, DynList< T > >	tpartition (Operation &op) const

std::tuple< DynList< T >, DynList< T > >	tpartition (Operation &&op) const

size_t	length () const noexcept

DynList< T >	rev () const

DynList< T >	take (const size_t n) const

DynList< T >	take (size_t i, size_t j, size_t step=1) const

DynList< T >	drop (const size_t n) const

void	mutable_drop (size_t n)

DynList< T >	items () const

DynList< T >	keys () const

bool	equal_to (const ArrayQueue< T > &r) const noexcept

bool	operator== (const ArrayQueue< T > &r) const noexcept

bool	operator!= (const ArrayQueue< T > &r) const noexcept
	Negation of are_equal()

iterator	begin () noexcept

const_iterator	begin () const noexcept

iterator	end () noexcept

const_iterator	end () const noexcept

const_iterator	cbegin () const noexcept

const_iterator	cbegin () noexcept

const_iterator	cend () const noexcept

const_iterator	cend () noexcept

Public Attributes
size_t	contract_threshold

Static Public Attributes
static constexpr size_t	Min_Dim = 4

Protected Member Functions
void	allocate ()
	Allocate memory for the current dimension.

bool	expand (const size_t first=0)

bool	contract (const size_t first=0)

void	init_dim (size_t d) noexcept

Protected Attributes
T *	ptr = nullptr

size_t	dim = Min_Dim

size_t	n = 0

Detailed Description

template<typename T>
class Aleph::ArrayQueue< T >

Queue implemented with a single dynamic array.

ArrayQueue<T> represents a queue if elements of generic type T which is stored in single dynamic. In this queue, modifiying operations test arrays bounds.

The array is allocated with new operator and dynamically grows according to the size.

Note: If you are sure of knowing the bounds, then use FixedStack, which is faster because it does not perform bound checks,

Constructor & Destructor Documentation

◆ ArrayQueue()

template<typename T >

Aleph::ArrayQueue< T >::ArrayQueue ( const size_t sz = 8 )

inline

Construct a queue with capacity sz

Parameters

[in] sz initial capacity

Exceptions

bad_alloc if there is no enough memory

Member Function Documentation

◆ access()

template<typename T>

T& Aleph::MemArray< T >::access ( const size_t i ) const

inlinenoexceptinherited

Return a modifiable reference to the ith element. No bound check is performed

Here is the caller graph for this function:

◆ all() [1/2]

bool Aleph::FunctionalMethods< ArrayQueue< T > , T >::all ( Operation & operation ) const

inlinenoexceptinherited

Check if all the elements of container satisfy a condition.

all(operation) checks if for each element item of container operation(item) returns true.

This method has complexity $O(n)$ in average and worst case.

Parameters

[in] operation to be used as condition

Returns: true if all the elements satisfy the criteria: false otherwise.

Exceptions

anything that could throw operation

◆ all() [2/2]

bool Aleph::FunctionalMethods< ArrayQueue< T > , T >::all ( Operation && operation ) const

inlinenoexceptinherited

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ append() [1/3]

template<typename T >

T& Aleph::ArrayQueue< T >::append ( const T & item )

inline

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Here is the call graph for this function:

◆ append() [2/3]

template<typename T >

T& Aleph::ArrayQueue< T >::append ( T && item )

inline

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Here is the call graph for this function:

◆ append() [3/3]

template<typename T>

T& Aleph::MemArray< T >::append ( T & item )

inlineinherited

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Here is the caller graph for this function:

◆ capacity()

template<typename T>

size_t Aleph::MemArray< T >::capacity ( ) const

inlinenoexceptinherited

The type of element of array.

Return the capacity of array (its dimension)

Here is the caller graph for this function:

◆ contract()

template<typename T>

bool Aleph::MemArray< T >::contract ( const size_t first = 0 )

inlineprotectedinherited

Test if n is lesser than contract_threshold and eventually contract the array half long and copies its content.

contract(first) first testes n with contract_threshold. If it is lesser, then a new array half as long is allocated and the n elements from first are copied.

Parameters

[in] first index of first element

Returns: true if the array is reallocated

Here is the caller graph for this function:

◆ drop()

DynList<T> Aleph::FunctionalMethods< ArrayQueue< T > , T >::drop ( const size_t n ) const

inlineinherited

Drop the first n elements seen in the container during its traversal.

The complexity of this method is $O(N)$ where N always is the number of elements of container.

Returns: A DynList<T> having the remainder elements according to traversal order.

Exceptions

bad_alloc if there is no enough memory or out_of_range if n is greater or equal than N (the number of elements in the container).

◆ each() [1/6]

void Aleph::FunctionalMethods< ArrayQueue< T > , T >::each ( Operation & operation )

inlinenoexceptinherited

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ each() [2/6]

void Aleph::FunctionalMethods< ArrayQueue< T > , T >::each ( Operation & operation ) const

inlinenoexceptinherited

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ each() [3/6]

void Aleph::FunctionalMethods< ArrayQueue< T > , T >::each ( Operation && operation ) const

inlinenoexceptinherited

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ each() [4/6]

void Aleph::FunctionalMethods< ArrayQueue< T > , T >::each ( Operation && operation )

inlinenoexceptinherited

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ each() [5/6]

void Aleph::FunctionalMethods< ArrayQueue< T > , T >::each	(	size_t	pos,
		size_t	slice,
		Operation &	operation
	)		const

inlineinherited

Traverse all the container and performs a mutable operation on each element.

mutable_for_each(operation) traverses the container and on each element item is performed operation(item).

operation could have the following signature:

void operation(T & item)

Be very careful with the fact that this method allows to modify the elements themselves, what could badly alter the internal state of container. This would be the case for heaps, binary trees and hash tables.

Parameters

[in] <tt>operation</tt> to be done on each element.

Returns: an reference to this

Exceptions

anything that can throw operation

◆ each() [6/6]

void Aleph::FunctionalMethods< ArrayQueue< T > , T >::each	(	size_t	pos,
		size_t	slice,
		Operation &&	operation
	)		const

inlineinherited

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ emplace()

void Aleph::FunctionalMethods< ArrayQueue< T > , T >::emplace ( Args &&... args )

inlineinherited

Appends a new element into the container by constructing it in-place with the given args.

emplace(args) tries to match a constructor T(args). If this exists, then this is constructed in-place and directly forwarded to the method append() of container. If all on the container and T` is adequately done, then the object is constructed once time, successively forwarded and at its target place in the container is moved, avoiding thus unnecessary copies.

Note: The semantic of append depends of container. In general, this has some sense for lists and arrays and it means insertion at the end of sequence. On other type of container append() is equivalent to insert().

Parameters

[in] args variadic arguments list

Exceptions

bad_alloc if there is no enough memory

◆ emplace_end()

void Aleph::FunctionalMethods< ArrayQueue< T > , T >::emplace_end ( Args &&... args )

inlineinherited

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ emplace_ins()

void Aleph::FunctionalMethods< ArrayQueue< T > , T >::emplace_ins ( Args &&... args )

inlineinherited

Insert a new element into the container by constructing it in-place with the given args.

emplace_ins(args) tries to match a constructor T(args). If this exists, then this is constructed in-place and directly forwarded to the method insert() of container. If all on the container and T` is adequately done, then the object is constructed once time, successively forwarded and finally, at its target place in the container, is moved, avoiding thus unnecessary copies.

Note: The semantic of insert() depends of container. In general, this has some sense for lists and arrays and it means insertion at the beginning of sequence. On other type of container append() is equivalent to insert().

Parameters

[in] args variadic arguments list

Exceptions

bad_alloc if there is no enough memory

◆ equal_to()

bool Aleph::EqualToMethod< ArrayQueue< T > >::equal_to ( const ArrayQueue< T > & r ) const

inlinenoexceptinherited

Test if elements of this are exactly contained in another container.

This method serves for testing if two containers contain the same elements. First, the container sizes are tested for equality. If they have the same size, then the testing is done by traversing this. Each seen element is searched in the another container with the method search(). So the container r must export the search() method, which frequently is the case for containers oriented to fast retrieval.

Warning: On some container, concretely DynList, the size is computed, not retrieved. So take in account this fact.

Parameters

[in] r container on which the searches will be performed.

Returns: true if the container have the same size and all the elements of this are present in r

◆ exists() [1/2]

bool Aleph::FunctionalMethods< ArrayQueue< T > , T >::exists ( Operation & op ) const

inlinenoexceptinherited

Test for existence in the container of an element satisfying a criteria.

exists(op) returns true if it exists any element item in container for which op(item) return true.

This method has complexity $O(n)$ in average and worst case.

Parameters

[in] op operation for testing existence

Returns: true if it exists an item for which op return true; false otherwise.

Exceptions

anything that could throw op

◆ exists() [2/2]

bool Aleph::FunctionalMethods< ArrayQueue< T > , T >::exists ( Operation && op ) const

inlinenoexceptinherited

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ expand()

template<typename T>

bool Aleph::MemArray< T >::expand ( const size_t first = 0 )

inlineprotectedinherited

Test is array is full and if affrimative, then expand the array twice as long and copy the content by swapping.

This method first allocates a chunck of 2*dim and then copies from first index the n contained entries to the new chunck.

Parameters

[in] first index where is found the first item of array

Returns: true if the array was full and then a new twice as long was allocated

Exceptions

bad_alloc if there is no enough memory

Here is the caller graph for this function:

◆ filter() [1/2]

DynList<T> Aleph::FunctionalMethods< ArrayQueue< T > , T >::filter ( Operation & operation ) const

inlineinherited

Filter the elements of a container according to a matching criteria.

This method builds a dynamic list with copies of items of container matching a criteria defined by operation, which should have the following signature:

bool operation(const T & item)

If operation return true then item matches the criteria; otherwise, operation must return false.

For example, if the container has integer, the the following code snippet would return a list containing the items greater than 100:

c.filter([] (auto item) { return item > 100; });

Parameters

[in] operation defining the flter criteria

Returns: a DynList<T> with the matched elements.

Exceptions

anything that could throw operation or bad_alloc if there is no enough memory

◆ filter() [2/2]

DynList<T> Aleph::FunctionalMethods< ArrayQueue< T > , T >::filter ( Operation && operation ) const

inlineinherited

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ find_index() [1/2]

size_t Aleph::LocateFunctions< ArrayQueue< T > , T >::find_index ( Operation & operation ) const

inlinenoexceptinherited

Find the position of an item in the container according to a searching criteria.

find_index(operation) traverses the container and on each item perform operation(item). If the result of operation is true, then the traversal is stopped and the position of the current item (which mathes operation) is returned.

operation must have the following signature:

bool operation(const typename Container::Item_Type & item)

Warning: Frequent use of this method will definitively degrade the performance. Try not to use this method inside loops. In general, if you falls in this situation, the consider your design and use a faster approach.

Parameters

[in] <tt>operation</tt> to be performed on each item for matching a searching criteria.

Returns: the last seen position. If the item is not found, then the number of items is returned.

◆ find_index() [2/2]

size_t Aleph::LocateFunctions< ArrayQueue< T > , T >::find_index ( Operation && operation ) const

inlinenoexceptinherited

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ find_item() [1/4]

std::tuple<bool, T > Aleph::LocateFunctions< ArrayQueue< T > , T >::find_item ( Operation & operation )

inlinenoexceptinherited

Safe sequential searching of an item matching a criteria.

find_item(operation) traverses the container and on each item perform operation(item). If the result of operation is true, then the traversal is stopped and duple containg a copy of found item is returned.

The method is said safe because returns a copy of item.

operation must have the following signature:

bool operation(const typename Container::Item_Type & item)

Parameters

[in] <tt>operation</tt> to be used as searching criteria

Returns: a duple tuple<bool, Type>. The first field indicates if the item was found and the second contains a copy of found item. If no item is found, then the first field is false and the second is the result of default constructor on the type stored in the container.

◆ find_item() [2/4]

std::tuple<bool, T > Aleph::LocateFunctions< ArrayQueue< T > , T >::find_item ( Operation & operation ) const

inlinenoexceptinherited

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ find_item() [3/4]

std::tuple<bool, T > Aleph::LocateFunctions< ArrayQueue< T > , T >::find_item ( Operation && operation )

inlinenoexceptinherited

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ find_item() [4/4]

std::tuple<bool, T > Aleph::LocateFunctions< ArrayQueue< T > , T >::find_item ( Operation && operation ) const

inlinenoexceptinherited

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ find_ptr() [1/4]

T * Aleph::LocateFunctions< ArrayQueue< T > , T >::find_ptr ( Operation & operation )

inlinenoexceptinherited

Find a pointer to an item in the container according to a searching criteria.

find_ptr(operation) traverses the container and on each item perform operation(item). If the result of operation is true, then the traversal is stopped and a pointer to the current item (which mathes operation) is returned.

operation must have the following signature:

bool operation(const typename Container::Item_Type & item)

Warning: Frequent use of this method will definitively degrade the performance. Try not to use this method inside loops. In general, if you falls in thie situation, the consider your design and to use an faster approach.

Parameters

[in] <tt>operation</tt> to be performed on each item for matching a searching criteria.

Returns: a valid pointer to an item if this was found or nullptr otherwise.

◆ find_ptr() [2/4]

const T * Aleph::LocateFunctions< ArrayQueue< T > , T >::find_ptr ( Operation & operation ) const

inlinenoexceptinherited

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ find_ptr() [3/4]

const T * Aleph::LocateFunctions< ArrayQueue< T > , T >::find_ptr ( Operation && operation ) const

inlinenoexceptinherited

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ find_ptr() [4/4]

T * Aleph::LocateFunctions< ArrayQueue< T > , T >::find_ptr ( Operation && operation )

inlinenoexceptinherited

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ fold() [1/2]

T Aleph::FunctionalMethods< ArrayQueue< T > , T >::fold	(	const T &	init,
		Operation &	operation
	)		const

inlinenoexceptinherited

Simplified version of foldl() where the folded type is the same type of elements stored in the container.

See also: foldl(const __T & init, Op & op)

◆ fold() [2/2]

T Aleph::FunctionalMethods< ArrayQueue< T > , T >::fold	(	const T &	init,
		Operation &&	operation
	)		const

inlinenoexceptinherited

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ foldl() [1/2]

__T Aleph::FunctionalMethods< ArrayQueue< T > , T >::foldl	(	const __T &	init,
		Op &	op
	)		const

inlinenoexceptinherited

Fold the elements of the container to a specific result.

foldl(init, op) set an internal variable acc of type __T to init value. Then it traverses the container and on each item it performs:

acc = op(acc, op(acc, item);

So acc serves as a sort of accumulator.

op should have the following signature:

__T op(__T acc, const T & item);

Since foldl is overloaded with several operation structures, there is a certain flexibility with the parameter qualifiers. You could, for example, to declare acc and/or item by value.

The method is a template. The first template parameter __T specifies the final folded type. By default, this type is T (the type of elements stored in the container). The second parameter is the operation. If the folded type is the same than T (the type of item stored), the you can simply write a foldl(). For example, if the container stores integer, in order to determine the maximum of all elements you could do:

c.foldl(std::numeric_limits<int>::min(), [] (int acc, int item)
  {
    return std::min(acc, item);
  });

When the folded type is different than T, then you must specify the folded type as template parameter. For example, if you want to compute the sum of inversed elements, the you could do it as follows:

c.template foldl<double>(0, [] (double acc, int item)
  {
    return acu + 1.0/item;
  });

Parameters

[in]	init	initial value of folded value (or accumulator).
[in]	op	operation to be performed on each item and used for folding.

Returns: the final folded computation.

Exceptions

anything that could throw op

◆ foldl() [2/2]

__T Aleph::FunctionalMethods< ArrayQueue< T > , T >::foldl	(	const __T &	init,
		Op &&	op = `Op()`
	)		const

inlinenoexceptinherited

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ for_each() [1/4]

void Aleph::FunctionalMethods< ArrayQueue< T > , T >::for_each ( Operation & operation )

inlinenoexceptinherited

Traverse all the container and performs an operation on each element.

for_each(operation) traverses the container and on each element item is performed operation(item).

operation must have the following signature:

void operation(const T & item)

Overloadings of this method allow that that the signature can be lightly different; for example, remove the reference or the const.

Parameters

[in] <tt>operation</tt> to be done on each element.

Returns: an reference to this

Exceptions

anything that can throw operation

◆ for_each() [2/4]

void Aleph::FunctionalMethods< ArrayQueue< T > , T >::for_each ( Operation & operation ) const

inlinenoexceptinherited

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ for_each() [3/4]

void Aleph::FunctionalMethods< ArrayQueue< T > , T >::for_each ( Operation && operation ) const

inlinenoexceptinherited

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ for_each() [4/4]

void Aleph::FunctionalMethods< ArrayQueue< T > , T >::for_each ( Operation && operation )

inlinenoexceptinherited

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ front()

template<typename T >

T& Aleph::ArrayQueue< T >::front ( const size_t i = 0 ) const

inline

Return the i-th oldest item of the queue.

Parameters

[in] i position to access

Returns: a modifiable reference to the oldest i-th item of the queue

Exceptions

range_error if i is greater than the number of items

Here is the call graph for this function:

◆ get() [1/2]

template<typename T >

T Aleph::ArrayQueue< T >::get ( )

inline

Remove the oldest item of the queue and return a copy.

Returns: a copy of extracted item

Exceptions

underflow_error if the queue is empty

Here is the call graph for this function:

◆ get() [2/2]

template<typename T>

T Aleph::MemArray< T >::get ( size_t i = 1 )

inlineinherited

Remove i elements from the end. Return the value of the last removed element

Here is the caller graph for this function:

◆ get_first()

template<typename T>

T& Aleph::MemArray< T >::get_first ( ) const

inlineinherited

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ get_it() [1/2]

auto Aleph::LocateFunctions< ArrayQueue< T > , T >::get_it ( ) const

inlineinherited

Return an properly initialized iterator positioned at the first item on the container

◆ get_it() [2/2]

auto Aleph::LocateFunctions< ArrayQueue< T > , T >::get_it ( size_t pos ) const

inlineinherited

Return an properly initialized iterator positioned at the pos item on the container

◆ get_itor()

auto Aleph::LocateFunctions< ArrayQueue< T > , T >::get_itor ( ) const

inlineinherited

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ get_last()

template<typename T>

T& Aleph::MemArray< T >::get_last ( ) const

inlineinherited

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ getn()

template<typename T >

T& Aleph::ArrayQueue< T >::getn ( const size_t i )

inline

Remove the i oldest items of the queue.

Parameters

[in] i number of items to remove

Returns: a modifiable reference to the oldest remaining item

Exceptions

underflow_error if i is greater than the number of items

Here is the call graph for this function:

◆ insert() [1/3]

template<typename T >

T& Aleph::ArrayQueue< T >::insert ( const T & item )

inline

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Here is the call graph for this function:

◆ insert() [2/3]

template<typename T >

T& Aleph::ArrayQueue< T >::insert ( T && item )

inline

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Here is the call graph for this function:

◆ insert() [3/3]

template<typename T>

T& Aleph::MemArray< T >::insert ( T & item )

inlineinherited

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ items()

template<class Container, typename T>

DynList<T> Aleph::GenericItems< Container, T >::items ( ) const

inlineinherited

Return a list of all the elements of a container sorted by traversal order.

Returns: a DynList<T> containing all the elements of the container

Exceptions

bad_alloc if there is no enough memory

◆ keys()

template<class Container, typename T>

DynList<T> Aleph::GenericItems< Container, T >::keys ( ) const

inlineinherited

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Here is the caller graph for this function:

◆ length()

size_t Aleph::FunctionalMethods< ArrayQueue< T > , T >::length ( ) const

inlinenoexceptinherited

Count the number of elements of a container.

This method counts the number of elements stored in the container.

Note: Take in account that this method computes; it does not retrieve. Consequently it always takes . However, for many containers this number is already stored and retrievable in through the methos size()

Returns: the number of elements stored in the container.

◆ maps() [1/2]

DynList<__T> Aleph::FunctionalMethods< ArrayQueue< T > , T >::maps ( Operation & op ) const

inlineinherited

Map the elements of the container.

maps(op) produces a dynamic list resulting of mapping of each element of container item to the result of operation op(item).

maps() is a template method which receives as template parameters the type __T, which is the type of target or range of mapping, and the transforming operation. By default __T is the same type of the elements stored in the container.

operation should have the following signature:

__T operation(const T & item)

So, operation(item) performs a transformation of item towards the type __T.

If __T ==T`, which is common and by default, then you could specify a mapping without need of template specification. For example, if the container has integer values, the a mapping of item multiplied by 4 could be very simply written as follows:

c.maps([] (int item) { return 4*i; });

In contrast, if the range type is different than the domain type, then it is necessary to specify the template keyword in the method call. For example, if the range is double and you want to return the elements divided by 4, the could do as follows:

c.template maps<double>([] (int item) { return 1.0*item/4; });

Parameters

[in] op operation to be performed in order to do the transformation on an item

Returns: a `DynList<__T> object containing the mapped items. The order of resulting list is the same than the order of visit of the iterator for the container.

Exceptions

anything that could throw op or bad_alloc if there is no enough memory

◆ maps() [2/2]

DynList<__T> Aleph::FunctionalMethods< ArrayQueue< T > , T >::maps ( Operation && op ) const

inlineinherited

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ maps_if() [1/2]

DynList<__T> Aleph::FunctionalMethods< ArrayQueue< T > , T >::maps_if	(	Prop	prop,
		Operation &	op
	)		const

inlineinherited

Conditional mapping of the elements of the container.

maps_if(prop, op) traverses each item of container, on each item it tests the proposition prop. If this last is true, then the item is mapped through the function op(item).

Parameters

[in]	op	operation to be perfomed in order to do the transformation on an `item`.
[in]	prop	a lambda returning a `bool` which perform the logical test.

Returns: a `DynList<__T> object containing the mapped items. The order of resulting list is the same than the order of visit of the iterator for the container.

Exceptions

anything that could throw op or bad_alloc if there is no enough memory

◆ maps_if() [2/2]

DynList<__T> Aleph::FunctionalMethods< ArrayQueue< T > , T >::maps_if	(	Prop	prop,
		Operation &&	op
	)		const

inlineinherited

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ mutable_drop()

void Aleph::FunctionalMethods< ArrayQueue< T > , T >::mutable_drop ( size_t n )

inlineinherited

Drop the first n elements seen from container.

The complexity of this method is $O(N)$ where N always is the number of elements of container.

Exceptions

out_of_range if n is greater or equal than N (the number of elements in the container).

◆ mutable_for_each()

void Aleph::FunctionalMethods< ArrayQueue< T > , T >::mutable_for_each ( Operation && operation )

inlinenoexceptinherited

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ nappend()

size_t Aleph::FunctionalMethods< ArrayQueue< T > , T >::nappend ( Args ... args )

inlineinherited

Append n variadic items

Parameters

[in] args items to be appended

Returns: the number of appended items

◆ ninsert()

size_t Aleph::FunctionalMethods< ArrayQueue< T > , T >::ninsert ( Args ... args )

inlineinherited

Insert n variadic items

Parameters

[in] args items to be inserted

Returns: the number of inserted items

◆ nth() [1/2]

T & Aleph::LocateFunctions< ArrayQueue< T > , T >::nth ( const size_t n )

inlineinherited

Return the n-th item of container.

The notion of ordinal depends of type of container. On list, probably will be the insertion order. On binary search trees will be the nth smaller item. On hash tables will be pseudo random.

Warning: Frequent use of this method will definitively degrade the performance. Try not to use this method inside loops. In general, if you falls in this situation, then consider your design and to use an faster approach.

Parameters

[in] n the nth item to find

Returns: a valid reference to the item into the container.

Exceptions

out_of_range if n is greater or equal that the size of container.

◆ nth() [2/2]

const T & Aleph::LocateFunctions< ArrayQueue< T > , T >::nth ( const size_t n ) const

inlineinherited

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ nth_ne()

const T & Aleph::LocateFunctions< ArrayQueue< T > , T >::nth_ne ( const size_t n ) const

inlinenoexceptinherited

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ operator()()

template<typename T>

T& Aleph::MemArray< T >::operator() ( const size_t i ) const

inlinenoexceptinherited

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ operator==()

bool Aleph::EqualToMethod< ArrayQueue< T > >::operator== ( const ArrayQueue< T > & r ) const

inlinenoexceptinherited

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ operator[]()

template<typename T>

T& Aleph::MemArray< T >::operator[] ( const size_t i ) const

inlineinherited

Return a reference to the ith element. Throws out_of_range if i is out of range

◆ partition() [1/3]

std::pair<DynList<T>, DynList<T> > Aleph::FunctionalMethods< ArrayQueue< T > , T >::partition ( Operation & op ) const

inlineinherited

Exclusive partition of container according to a filter criteria.

partition(op) traverses the container and filters its elements according to the filter criteria defined by op. The filtered elements are copied to a first list and the not filtered ones to a second list. When all the container is traversed, a pair containing these lists is returned.

The op requirements are the same than for filter().

Parameters

[in] op operation instrumenting the filter criteria

Returns: a std::pair<DynList<T>, DynList<T>>.firstcontains the filtered elements andsecondthe non-filtered ones. \throw anything that could throw op orbad_alloc` if there is no enough memory

See also: filter()

◆ partition() [2/3]

std::pair<DynList<T>, DynList<T> > Aleph::FunctionalMethods< ArrayQueue< T > , T >::partition ( Operation && op ) const

inlineinherited

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ partition() [3/3]

std::pair<DynList<T>, DynList<T> > Aleph::FunctionalMethods< ArrayQueue< T > , T >::partition ( size_t n ) const

inlineinherited

Exclusive partition of container in the nth item

partition(n) traverses the container and produces a pair of lists. The first one contains the first n elements and the second one the this->size() - n remaining elements.

Parameters

[in] n the first n items of the first list

Exceptions

anything that could throw op or bad_alloc if there is no enough memory

◆ pfilter() [1/2]

DynList<std::tuple<T, size_t> > Aleph::FunctionalMethods< ArrayQueue< T > , T >::pfilter ( Operation & operation ) const

inlineinherited

Filter the elements of a container according to a matching criteria and determine its positions respect to the traversal of container.

pfilter(operation) is very similar to filter(), but instead of building a list of filtered elements, it builds a list of pairs with form (item, pos), where item is a copy of filtered element and pos is its position respect to the traversal order. The position is relative to the container type.

The pair is defined with a tuple:

std::tuple<T, size_t>

Parameters

[in] operation that defines the filter criteria

Returns: a DynList

Exceptions

bad_alloc if there is no enough memory

See also: filter(Operation & operation)

◆ pfilter() [2/2]

DynList<std::tuple<T, size_t> > Aleph::FunctionalMethods< ArrayQueue< T > , T >::pfilter ( Operation && operation ) const

inlineinherited

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ ptr_filter()

DynList<const T*> Aleph::FunctionalMethods< ArrayQueue< T > , T >::ptr_filter ( Operation & operation ) const

inlineinherited

Filter the elements of a container according to a matching criteria an return pointer to the matched items in the container.

This method builds a dynamic list with stores pointers to the items of matching a criteria defined by operation, which should have the followgin signature:

bool operation(const T & item)

If operation return true then item matches the criteria; otherwise, operation must return false.

For example, if the container has integer, the the following code snippet would return a list containing the items greater than 100:

c.ptr_filter([] (auto item) { return item > 100; });

Parameters

[in] operation defining the flter criteria

Returns: a DynList<const T*> with the pointers to the matched elements.

Exceptions

anything that could throw operation or bad_alloc if there is no enough memory

◆ push() [1/2]

template<typename T>

T& Aleph::MemArray< T >::push ( const T & item )

inlineinherited

Push a copy of item at the begining of sequence. The array expands if this is already full

Here is the caller graph for this function:

◆ push() [2/2]

template<typename T>

T& Aleph::MemArray< T >::push ( T && item )

inlineinherited

Push a copy of item at the begining of sequence. The array expands if this is already full

◆ put() [1/2]

template<typename T >

T& Aleph::ArrayQueue< T >::put ( const T & item )

inline

Copy and put an item in the queue

Parameters

[in] item to put

Returns: a modifiable reference to the copied item

Exceptions

bad_alloc if there is no enough memory

Here is the call graph for this function:

Here is the caller graph for this function:

◆ put() [2/2]

template<typename T >

T& Aleph::ArrayQueue< T >::put ( T && item )

inline

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Here is the call graph for this function:

◆ putn()

template<typename T >

T& Aleph::ArrayQueue< T >::putn ( size_t sz )

inline

Put in constant time sz empty entries to the stack.

putn(n) puts sz entries to the stack in an functionally equivalent way to sz pushes, except that the operation takes constant time.

The maximum value of sz is bounded by 2*capacity() - size().

Parameters

[in] sz number of cells to push

Returns: a modifiabÃ±pe reference to the stack's top

Exceptions

overflow_error	if `sz > 2*capacity() - size()`
bad_alloc	if there is no enough memory

Here is the call graph for this function:

◆ rear()

template<typename T >

T& Aleph::ArrayQueue< T >::rear ( const size_t i = 0 ) const

inline

Return the i-th youngest item of the queue.

Parameters

[in] i position to access

Returns: a modifiable reference to the i-th youngest item of the queue

Exceptions

range_error if i is greater than the number of items

◆ remove_last()

template<typename T>

T Aleph::MemArray< T >::remove_last ( )

inlineinherited

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Here is the caller graph for this function:

◆ reserve()

template<typename T>

void Aleph::MemArray< T >::reserve ( const size_t cap )

inlineinherited

Reserves cap cells into the array.

Parameters

[in] cap new dimension

Exceptions

bad_alloc if there is no enough memory

Here is the caller graph for this function:

◆ rev()

DynList<T> Aleph::FunctionalMethods< ArrayQueue< T > , T >::rev ( ) const

inlineinherited

Return a list with the elements of container in reverse order respect to its traversal order.

Returns: a DynList<T> inversely ordered accordirg to the traversal order.

Exceptions

bad_alloc if there is no enough memory

◆ take() [1/2]

DynList<T> Aleph::FunctionalMethods< ArrayQueue< T > , T >::take ( const size_t n ) const

inlineinherited

Return a list with the first n elements seen in the container during its traversal.

The complexity of this method is $O(n)$ where n can be less than the number of elements of container.

Returns: A DynList<T> having the first n elements according to its traversal order.

Exceptions

bad_alloc if there is no enough memory or out_of_range if n is greater or equal than the number of elements in the container.

◆ take() [2/2]

DynList<T> Aleph::FunctionalMethods< ArrayQueue< T > , T >::take	(	size_t	i,
		size_t	j,
		size_t	step = `1`
	)		const

inlineinherited

Return a list with elements seen in the container between i and j position respect to its traversal.

The complexity of this method is $O(n)$ where n can be less than the number of elements of container.

Returns: A DynList<T> having the first n elements according to its traversal order.

Exceptions

bad_alloc if there is no enough memory or out_of_range if n is greater or equal than the number of elements in the container.

◆ tpartition() [1/2]

std::tuple<DynList<T>, DynList<T> > Aleph::FunctionalMethods< ArrayQueue< T > , T >::tpartition ( Operation & op ) const

inlineinherited

Exclusive partition of container according to a filter criteria.

This methos has exactly the same semantic than partition(Operation & op), excepts than instead of returning a std::pair it returns a std::tuple.

Parameters

[in] op operation instrumenting the filter criteria

Returns: a std::tuple<DynList<T>, DynList<T>>.firstcontains the filteres elements andsecondthe non-filtered ones. \throw anything that could throw op orbad_alloc` if there is no enough memory

See also: partition(Operation & op)

◆ tpartition() [2/2]

std::tuple<DynList<T>, DynList<T> > Aleph::FunctionalMethods< ArrayQueue< T > , T >::tpartition ( Operation && op ) const

inlineinherited

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ traverse() [1/4]

template<typename T >

template<class Operation >

bool Aleph::ArrayQueue< T >::traverse ( Operation & operation )

inline

Traverse all the elements from the youngest to the oldest and execute operation on each on them.

Parameters

[in] operation to be performed on each element

Returns: true if operation was executed on all elements; false otherwise.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ traverse() [2/4]

template<typename T >

template<class Operation >

bool Aleph::ArrayQueue< T >::traverse ( Operation & operation ) const

inline

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Here is the call graph for this function:

◆ traverse() [3/4]

template<typename T >

template<class Operation >

bool Aleph::ArrayQueue< T >::traverse ( Operation && operation ) const

inline

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ traverse() [4/4]

template<typename T >

template<class Operation >

bool Aleph::ArrayQueue< T >::traverse ( Operation && operation )

inline

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

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

tpl_arrayQueue.H

Classes

Public Types

Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

template<typename T> class Aleph::ArrayQueue< T >

Constructor & Destructor Documentation

◆ ArrayQueue()

Member Function Documentation

◆ access()

◆ all() [1/2]

◆ all() [2/2]

◆ append() [1/3]

◆ append() [2/3]

◆ append() [3/3]

◆ capacity()

◆ contract()

◆ drop()

◆ each() [1/6]

◆ each() [2/6]

◆ each() [3/6]

◆ each() [4/6]

◆ each() [5/6]

◆ each() [6/6]

◆ emplace()

◆ emplace_end()

◆ emplace_ins()

◆ equal_to()

◆ exists() [1/2]

◆ exists() [2/2]

◆ expand()

◆ filter() [1/2]

◆ filter() [2/2]

◆ find_index() [1/2]

◆ find_index() [2/2]

◆ find_item() [1/4]

◆ find_item() [2/4]

◆ find_item() [3/4]

◆ find_item() [4/4]

◆ find_ptr() [1/4]

◆ find_ptr() [2/4]

◆ find_ptr() [3/4]

◆ find_ptr() [4/4]

◆ fold() [1/2]

◆ fold() [2/2]

◆ foldl() [1/2]

◆ foldl() [2/2]

◆ for_each() [1/4]

◆ for_each() [2/4]

◆ for_each() [3/4]

◆ for_each() [4/4]

◆ front()

◆ get() [1/2]

◆ get() [2/2]

◆ get_first()

◆ get_it() [1/2]

◆ get_it() [2/2]

◆ get_itor()

◆ get_last()

◆ getn()

◆ insert() [1/3]

◆ insert() [2/3]

◆ insert() [3/3]

◆ items()

◆ keys()

◆ length()

◆ maps() [1/2]

◆ maps() [2/2]

◆ maps_if() [1/2]

◆ maps_if() [2/2]

◆ mutable_drop()

◆ mutable_for_each()

◆ nappend()

◆ ninsert()

◆ nth() [1/2]

◆ nth() [2/2]

◆ nth_ne()

template<typename T>
class Aleph::ArrayQueue< T >