gum::List< Val, Alloc > Class Template Reference

Generic doubly linked lists. More...

#include <agrum/tools/core/list.h>

Public Member Functions
template<typename OtherAlloc >
INLINE	List (const List< Val, OtherAlloc > &src)
template<typename OtherAlloc >
INLINE List< Val, Alloc > &	operator= (const List< Val, OtherAlloc > &src)
template<typename... Args>
INLINE ListBucket< Val > *	createEmplaceBucket__ (Args &&... args) const
template<typename... Args>
INLINE Val &	push_front (Args &&... args)
template<typename... Args>
INLINE Val &	emplaceFront (Args &&... args)
template<typename... Args>
INLINE Val &	push_back (Args &&... args)
template<typename... Args>
INLINE Val &	emplaceBack (Args &&... args)
template<typename... Args>
INLINE Val &	emplace (const const_iterator &iter, Args &&... args)
template<typename... Args>
INLINE Val &	emplace (const const_iterator_safe &iter, Args &&... args)
template<typename OtherAlloc >
INLINE bool	operator== (const List< Val, OtherAlloc > &src) const
template<typename OtherAlloc >
INLINE bool	operator!= (const List< Val, OtherAlloc > &src) const
Constructors / Destructors
	List ()
	A basic constructor that creates an empty list. More...
	List (const List< Val, Alloc > &src)
	Copy constructor. More...
template<typename OtherAlloc >
	List (const List< Val, OtherAlloc > &src)
	Ceneralized copy constructor. More...
	List (List< Val, Alloc > &&src)
	Move constructor. More...
	List (std::initializer_list< Val > list)
	Initializer_list constructor. More...
	~List ()
	Class destructor. More...
Iterators
const const_iterator_safe &	cendSafe () const noexcept
	Returns a safe const iterator pointing to the end of the List. More...
const iterator_safe &	endSafe () noexcept
	Returns a safe iterator pointing to the end of the List. More...
const const_iterator_safe &	crendSafe () const noexcept
	Return a safe const iterator pointing just before the beginning of the List. More...
const iterator_safe &	rendSafe () noexcept
	Returns a safe iterator pointing just before the beginning of the List. More...
const_iterator_safe	cbeginSafe () const
	Returns a safe const iterator pointing to the beginning of the List. More...
iterator_safe	beginSafe ()
	Returns a safe iterator pointing to the beginning of the List. More...
const_iterator_safe	crbeginSafe () const
	Returns a safe const iterator pointing to the last element of the List. More...
iterator_safe	rbeginSafe ()
	Returns a safe iterator pointing to the last element of the List. More...
const const_iterator &	cend () const noexcept
	Returns an unsafe const iterator pointing to the end of the List. More...
const iterator &	end () noexcept
	Returns an unsafe iterator pointing to the end of the List. More...
const const_iterator &	end () const noexcept
	Returns an unsafe const iterator pointing to the end of the List. More...
const const_iterator &	crend () const noexcept
	Returns an unsafe const iterator pointing just before the beginning of the List. More...
const iterator &	rend () noexcept
	Returns an unsafe iterator pointing just before the beginning of the List. More...
const const_iterator &	rend () const noexcept
	Returns an unsafe const iterator pointing just before the beginning of the List. More...
const_iterator	cbegin () const
	Returns an unsafe const iterator pointing to the beginning of the List. More...
iterator	begin ()
	Returns an unsafe iterator pointing to the beginning of the List. More...
const_iterator	begin () const
	Returns an unsafe const iterator pointing to the beginning of the List. More...
const_iterator	crbegin () const
	Returns an unsafe const iterator pointing to the last element of the List. More...
iterator	rbegin ()
	Returns an unsafe iterator pointing to the last element of the List. More...
const_iterator	rbegin () const
	Returns an unsafe const iterator pointing to the last element of the List. More...
Accessors / Modifiers
Val &	pushFront (const Val &val)
	Inserts a new element (a copy) at the beginning of the chained list. More...
Val &	pushFront (Val &&val)
	Inserts a new element (a move) at the beginning of the chained list. More...
template<typename... Args>
Val &	push_front (Args &&... args)
	An alias for pushFront used for STL compliance. More...
template<typename... Args>
Val &	emplaceFront (Args &&... args)
	Emplace elements at the beginning of the chained list. More...
Val &	pushBack (const Val &val)
	Inserts a new element (a copy) at the end of the chained list. More...
Val &	pushBack (Val &&val)
	Inserts a new element (a move) at the end of the chained list. More...
template<typename... Args>
Val &	push_back (Args &&... args)
	An alias for pushBack used for STL compliance. More...
template<typename... Args>
Val &	emplaceBack (Args &&... args)
	Emplace elements at the end of the chained list. More...
Val &	insert (const Val &val)
	Inserts a new element at the end of the chained list (alias of pushBack). More...
Val &	insert (Val &&val)
	Inserts a new element at the end of the chained list (alias of pushBack). More...
Val &	insert (Size pos, const Val &val)
	Inserts a new element at the ith pos of the chained list. More...
Val &	insert (Size pos, Val &&val)
	Insert an rvalue at the ith pos of the chained list. More...
Val &	insert (const const_iterator_safe &iter, const Val &val, location place=location::BEFORE)
	Inserts a new element before or after a given iterator. More...
Val &	insert (const const_iterator_safe &iter, Val &&val, location place=location::BEFORE)
	Inserts an rvalue before or after a given iterator. More...
Val &	insert (const const_iterator &iter, const Val &val, location place=location::BEFORE)
	Inserts a new element before or after a given iterator. More...
Val &	insert (const const_iterator &iter, Val &&val, location place=location::BEFORE)
	Inserts an rvalue before or after a given iterator. More...
template<typename... Args>
Val &	emplace (const const_iterator &iter, Args &&... args)
	Emplace a new element before a given iterator. More...
template<typename... Args>
Val &	emplace (const const_iterator_safe &iter, Args &&... args)
	Emplace a new element before a given safe iterator. More...
Val &	front () const
	Returns a reference to first element of a list, if any. More...
Val &	back () const
	Returns a reference to last element of a list, if any. More...
Size	size () const noexcept
	Returns the number of elements in the list. More...
bool	exists (const Val &val) const
	Checks whether there exists a given element in the list. More...
void	erase (Size i)
	Erases the ith element of the List (the first one is in position 0). More...
void	erase (const iterator_safe &iter)
	Erases the element of the List pointed to by the safe iterator. More...
void	erase (const const_iterator_safe &iter)
	Erases the element of the List pointed to by the safe const iterator. More...
void	eraseByVal (const Val &val)
	erases the first element encountered with a given value. More...
void	eraseAllVal (const Val &val)
	erases all the elements encountered with a given value More...
void	popBack ()
	Removes the last element of a List, if any. More...
void	popFront ()
	Removes the first element of a List, if any. More...
void	clear ()
	Deletes all the elements of a chained list. More...
bool	empty () const noexcept
	Returns a boolean indicating whether the chained list is empty. More...
void	swap (List &other_list)
	Swap the current list with another one. More...
std::string	toString () const
	Converts a list into a string. More...
template<typename Mount , typename OtherAlloc = std::allocator< Mount >>
List< Mount, OtherAlloc >	map (Mount(*f)(Val)) const
	Creates a list of mountains from a list of val. More...
template<typename Mount , typename OtherAlloc = std::allocator< Mount >>
List< Mount, OtherAlloc >	map (Mount(*f)(Val &)) const
	Creates a list of mountains from a list of val. More...
template<typename Mount , typename OtherAlloc = std::allocator< Mount >>
List< Mount, OtherAlloc >	map (Mount(*f)(const Val &)) const
	Creates a list of mountains from a list of val. More...
template<typename Mount , typename OtherAlloc = std::allocator< Mount >>
List< Mount, OtherAlloc >	map (const Mount &mount) const
	Creates a list of mountains with a given value from a list of val. More...
Operators
List< Val, Alloc > &	operator= (const List< Val, Alloc > &src)
	Copy operator. More...
template<typename OtherAlloc >
List< Val, Alloc > &	operator= (const List< Val, OtherAlloc > &src)
	Generalized copy operator. More...
List< Val, Alloc > &	operator= (List< Val, Alloc > &&src)
	Move operator. More...
Val &	operator+= (const Val &val)
	Inserts a new element at the end of the list (alias of pushBack). More...
Val &	operator+= (Val &&val)
	Inserts a new element at the end of the list (alias of pushBack). More...
template<typename OtherAlloc >
bool	operator== (const List< Val, OtherAlloc > &src) const
	Checks whether two lists are identical (same elements in the same order). More...
template<typename OtherAlloc >
bool	operator!= (const List< Val, OtherAlloc > &src) const
	Checks whether two lists are different (different elements or orders). More...
Val &	operator[] (const Size i)
	Returns the ith element in the current chained list. More...
const Val &	operator[] (const Size i) const
	Returns the const ith element in the current chained list. More...

Public Types
enum	location { location::BEFORE, location::AFTER }
	Locations around iterators where insertions of new elements can take / place. More...
using	BucketAllocator = typename Alloc::template rebind< ListBucket< Val > >::other
	Type of the allocator for ListBuckets. More...
using	value_type = Val
	Types for STL compliance. More...
using	reference = Val &
	Types for STL compliance. More...
using	const_reference = const Val &
	Types for STL compliance. More...
using	pointer = Val *
	Types for STL compliance. More...
using	const_pointer = const Val *
	Types for STL compliance. More...
using	size_type = Size
	Types for STL compliance. More...
using	difference_type = std::ptrdiff_t
	Types for STL compliance. More...
using	allocator_type = Alloc
	Types for STL compliance. More...
using	iterator = ListIterator< Val >
	Types for STL compliance. More...
using	const_iterator = ListConstIterator< Val >
	Types for STL compliance. More...
using	iterator_safe = ListIteratorSafe< Val >
	Types for STL compliance. More...
using	const_iterator_safe = ListConstIteratorSafe< Val >
	Types for STL compliance. More...

Friends
class	ListIterator< Val >
	ListIterator should be a friend to optimize access to elements. More...
class	ListConstIterator< Val >
	ListIterator should be a friend to optimize access to elements. More...
class	ListIteratorSafe< Val >
	ListIterator should be a friend to optimize access to elements. More...
class	ListConstIteratorSafe< Val >
	ListIterator should be a friend to optimize access to elements. More...

Detailed Description

template<typename Val, typename Alloc = std::allocator< Val >>
class gum::List< Val, Alloc >

Generic doubly linked lists.

List enables fast and safe manipulation of chained lists. Unless the elements are rvalues, the insertions of new elements into the lists are ALWAYS performed by copy, i.e., each time we add a new element X to the List, a copy of X is actually created and this very copy is stored into the list. For rvalues, move operations are performed.

The List iterators are implemented so as to avoid segmentation faults when elements of the list are deleted while some safe iterators are pointing on them. Moreover they ensure that, when elements are removed from a List, iterators on that list will never access these elements (which is not the case for the iterators in the C++ standard library). Note that this guarantee is ensured at low cost as experimental results show that List and ListIterator are as efficient as their STL counterparts. However, this guarantee can hold only if List is aware of all of the iterators pointing to it: thus, when List erases one element, it can parse the list of its iterators and update those that point toward the now deleted element. When parsing elements without removing any element, you can use unsafe iterators instead of safe ones because they are slightly faster. But those will most certainly segfault if they perform some operations on deleted elements.

Usage example:

// creation of an empty list
List<int> list1;
List<int> list2 { 3, 4, 5 }; // initializer list

// adding elements to the list
list1.pushFront (23);
list1.pushBack (10);
list1 += 25;
list1.insert (12);

// getting the second element of the list
cerr << "10 = " << list1[1] << endl;

// getting the first and last elements
cerr << "first = " << list1.front() << " last = " << list1.back() << endl;

// get the number of elements in the list
cerr << "number of elements = " << list1.size () << endl;

// display the content of the list
cerr << list1 << endl;

// copy the list
List<int> list2 = list1, list3;
list3 = list1;

// delete the second element from the list
list1.erase (1);

// delete the first and last elements
list1.popFront ();
list1.popBack ();

// delete element whose value is 25
list1.eraseByVal (25);

// check whether the list is empty
if (list1.empty()) cerr << "empty list" << endl;

// remove all elements from the list
list1.clear ();

// parse all the elements of a list using unsafe iterators
for (List<int>::iterator iter = list2.begin();
     iter != list2.end(); ++iter)
  cerr << *iter << endl;
for (List<int>::iterator iter = list2.rbegin();
     iter != list2.rend(); --iter)
  cerr << *iter << endl;
for (List<int>::const_iterator iter = list2.cbegin();
     iter != list2.cend(); ++iter)
  cerr << *iter << endl;
for (List<int>::const_iterator iter = list2.crbegin();
     iter != list2.crend(); --iter)
  cerr << *iter << endl;

// parse all the elements of a list using safe iterators
for (List<int>::iterator_safe iter = list2.beginSafe();
     iter != list2.endSafe(); ++iter)
  cerr << *iter << endl;
for (List<int>::iterator_safe iter = list2.rbeginSafe();
     iter != list2.rendSafe(); --iter)
  cerr << *iter << endl;
for (List<int>::const_iterator_safe iter = list2.cbeginSafe();
     iter != list2.cendSafe(); ++iter)
  cerr << *iter << endl;
for (List<int>::const_iterator_safe iter = list2.crbeginSafe();
     iter != list2.crendSafe(); --iter)
  cerr << *iter << endl;

// use an iterator to point the element we wish to erase
List<int>::iterator_safe iter = list2.beginSafe();
List2.erase ( iter );
List<int>::iterator iter2 = list2.begin() + 4; // 5th element of the list
iter2 = iter + 4;

// map a list into another list (assuming function f is defined as
// float f (int x) { return (2.5 * x); } )
List<float> flist = list2.map (f);

Template Parameters

Val	The values type stored in the gum::List.
Alloc	The allocator for the values stored in the gum::List.

Definition at line 372 of file list.h.

Member Typedef Documentation

allocator_type

template<typename Val, typename Alloc = std::allocator< Val >>

using gum::List< Val, Alloc >::allocator_type = Alloc

Types for STL compliance.

Definition at line 383 of file list.h.

BucketAllocator

template<typename Val, typename Alloc = std::allocator< Val >>

using gum::List< Val, Alloc >::BucketAllocator = typename Alloc::template rebind< ListBucket< Val > >::other

Type of the allocator for ListBuckets.

Definition at line 392 of file list.h.

const_iterator

template<typename Val, typename Alloc = std::allocator< Val >>

using gum::List< Val, Alloc >::const_iterator = ListConstIterator< Val >

Types for STL compliance.

Definition at line 385 of file list.h.

const_iterator_safe

template<typename Val, typename Alloc = std::allocator< Val >>

using gum::List< Val, Alloc >::const_iterator_safe = ListConstIteratorSafe< Val >

Types for STL compliance.

Definition at line 387 of file list.h.

const_pointer

template<typename Val, typename Alloc = std::allocator< Val >>

using gum::List< Val, Alloc >::const_pointer = const Val*

Types for STL compliance.

Definition at line 380 of file list.h.

const_reference

template<typename Val, typename Alloc = std::allocator< Val >>

using gum::List< Val, Alloc >::const_reference = const Val&

Types for STL compliance.

Definition at line 378 of file list.h.

difference_type

template<typename Val, typename Alloc = std::allocator< Val >>

using gum::List< Val, Alloc >::difference_type = std::ptrdiff_t

Types for STL compliance.

Definition at line 382 of file list.h.

iterator

template<typename Val, typename Alloc = std::allocator< Val >>

using gum::List< Val, Alloc >::iterator = ListIterator< Val >

Types for STL compliance.

Definition at line 384 of file list.h.

iterator_safe

template<typename Val, typename Alloc = std::allocator< Val >>

using gum::List< Val, Alloc >::iterator_safe = ListIteratorSafe< Val >

Types for STL compliance.

Definition at line 386 of file list.h.

pointer

template<typename Val, typename Alloc = std::allocator< Val >>

using gum::List< Val, Alloc >::pointer = Val*

Types for STL compliance.

Definition at line 379 of file list.h.

reference

template<typename Val, typename Alloc = std::allocator< Val >>

using gum::List< Val, Alloc >::reference = Val&

Types for STL compliance.

Definition at line 377 of file list.h.

size_type

template<typename Val, typename Alloc = std::allocator< Val >>

using gum::List< Val, Alloc >::size_type = Size

Types for STL compliance.

Definition at line 381 of file list.h.

value_type

template<typename Val, typename Alloc = std::allocator< Val >>

using gum::List< Val, Alloc >::value_type = Val

Types for STL compliance.

Definition at line 376 of file list.h.

Member Enumeration Documentation

location

template<typename Val, typename Alloc = std::allocator< Val >>

enum gum::List::location

strong

Locations around iterators where insertions of new elements can take / place.

Enumerator
BEFORE
AFTER

Definition at line 396 of file list.h.

    {
      BEFORE,
      AFTER
    };

Constructor & Destructor Documentation

List() [1/6]

template<typename Val , typename Alloc >

INLINE gum::List< Val, Alloc >::List

(

)

A basic constructor that creates an empty list.

Definition at line 1187 of file list_tpl.h.

                                  {
    // for debugging purposes
    GUM_CONSTRUCTOR(List);

    // reserve space for only the default number of iterators
    safe_iterators__.reserve(GUM_DEFAULT_ITERATOR_NUMBER);
  }

List() [2/6]

template<typename Val, typename Alloc>

INLINE gum::List< Val, Alloc >::List

(

const List< Val, Alloc > &

src

)

Copy constructor.

The new list and that which is copied do not share their elements: the new list contains new instances of the values stored in the list to be copied. Of course if these values are pointers, the new values point toward the same elements. This constructor runs in linear time.

Parameters

src	the list the contents of which is copied into the current one.

Definition at line 1197 of file list_tpl.h.

                                                               {
    // for debugging purposes
    GUM_CONS_CPY(List);

    // copy the elements
    copy_elements__(src);

    // reserve space for only the default number of iterators
    safe_iterators__.reserve(GUM_DEFAULT_ITERATOR_NUMBER);
  }

List() [3/6]

template<typename Val, typename Alloc = std::allocator< Val >>

template<typename OtherAlloc >

gum::List< Val, Alloc >::List

(

const List< Val, OtherAlloc > &

src

)

Ceneralized copy constructor.

The new list and that which is copied do not share their elements: the new list contains new instances of the values stored in the list to be copied. Of course if these values are pointers, the new values point toward the same elements. This constructor runs in linear time.

Parameters

src	the list the contents of which is copied into the current one.

Template Parameters

OtherAlloc

The other allocator.

List() [4/6]

template<typename Val, typename Alloc>

INLINE gum::List< Val, Alloc >::List

(

List< Val, Alloc > &&

src

)

Move constructor.

Parameters

src	The gum::List to move.

Definition at line 1224 of file list_tpl.h.

                                                          :
      deb_list__{std::move(src.deb_list__)}, end_list__{std::move(src.end_list__)},
      nb_elements__{std::move(src.nb_elements__)},
      safe_iterators__{std::move(src.safe_iterators__)}, alloc_bucket__{std::move(
                                                            src.alloc_bucket__)} {
    // for debugging purposes
    GUM_CONS_MOV(List);

    src.deb_list__    = nullptr;
    src.end_list__    = nullptr;
    src.nb_elements__ = 0;
    src.safe_iterators__.clear();
  }

List() [5/6]

template<typename Val, typename Alloc>

INLINE gum::List< Val, Alloc >::List

(

std::initializer_list< Val >

list

)

Initializer_list constructor.

Parameters

list	The initializer list.

Definition at line 1240 of file list_tpl.h.

                                                                 {
    // for debugging purposes
    GUM_CONSTRUCTOR(List);

    // adding all the elements
    for (const auto& val: list) {
      pushBack(val);
    }

    // reserve space for only the default number of iterators
    safe_iterators__.reserve(GUM_DEFAULT_ITERATOR_NUMBER);
  }

~List()

template<typename Val , typename Alloc >

INLINE gum::List< Val, Alloc >::~List

(

)

Class destructor.

Definition at line 1255 of file list_tpl.h.

                                   {
    // for debugging (although this program is bug-free)
    GUM_DESTRUCTOR(List);

    // we detach all the safe iterators attached to the current List and we
    // remove all the elements from the list
    clear();
  }

List() [6/6]

template<typename Val, typename Alloc = std::allocator< Val >>

template<typename OtherAlloc >

INLINE gum::List< Val, Alloc >::List

(

const List< Val, OtherAlloc > &

src

)

Definition at line 1211 of file list_tpl.h.

                                                                    {
    // for debugging purposes
    GUM_CONS_CPY(List);

    // copy the elements
    copy_elements__(src);

    // reserve space for only the default number of iterators
    safe_iterators__.reserve(GUM_DEFAULT_ITERATOR_NUMBER);
  }

Member Function Documentation

back()

template<typename Val , typename Alloc >

INLINE Val & gum::List< Val, Alloc >::back

(

)

const

Returns a reference to last element of a list, if any.

Exceptions

NotFound

exception is thrown if the list is empty.

Definition at line 1846 of file list_tpl.h.

                                             {
    if (nb_elements__ == Size(0)) {
      GUM_ERROR(NotFound, "not enough elements in the chained list");
    }

    return end_list__->val__;
  }

begin() [1/2]

template<typename Val , typename Alloc >

INLINE ListIterator< Val > gum::List< Val, Alloc >::begin

(

)

Returns an unsafe iterator pointing to the beginning of the List.

Unsafe iterators are a little bit faster than safe iterators and they consume less memory. However, if the element they point to is erased, their dereference or their increment/decrement will produce a mess, probably a segfault. You should use them only when performance is an issue and if you are sure that they will never point to an element erased.

Returns

Returns an unsafe iterator pointing to the beginning of the List.

Definition at line 1418 of file list_tpl.h.

                                                       {
    return ListIterator< Val >{*this};
  }

begin() [2/2]

template<typename Val , typename Alloc >

INLINE ListConstIterator< Val > gum::List< Val, Alloc >::begin

(

)

const

Returns an unsafe const iterator pointing to the beginning of the List.

Unsafe const iterators are a little bit faster than safe const iterators and they consume less memory. However, if the element they point to is erased, their dereference or their increment/decrement will produce a mess, probably a segfault. You should use them only when performance is an issue and if you are sure that they will never point to an element erased.

Returns an unsafe const iterator pointing to the beginning of the List.

Definition at line 1424 of file list_tpl.h.

                                                                  {
    return ListConstIterator< Val >{*this};
  }

beginSafe()

template<typename Val , typename Alloc >

INLINE ListIteratorSafe< Val > gum::List< Val, Alloc >::beginSafe

(

)

Returns a safe iterator pointing to the beginning of the List.

Safe iterators are iterators whose state is updated by the list when the element they point to is erased. As such, in this case, they can throw an exception when we try to derefence them and they are able to perform a valid ++ or – step.

Returns

Returns a safe iterator pointing to the beginning of the List.

Definition at line 1406 of file list_tpl.h.

                                                               {
    return ListIteratorSafe< Val >{*this};
  }

cbegin()

template<typename Val , typename Alloc >

INLINE ListConstIterator< Val > gum::List< Val, Alloc >::cbegin

(

)

const

Returns an unsafe const iterator pointing to the beginning of the List.

Unsafe const iterators are a little bit faster than safe const iterators and they consume less memory. However, if the element they point to is erased, their dereference or their increment/decrement will produce a mess, probably a segfault. You should use them only when performance is an issue and if you are sure that they will never point to an element erased.

Returns

Returns an unsafe const iterator pointing to the beginning of the List.

Definition at line 1412 of file list_tpl.h.

                                                                   {
    return ListConstIterator< Val >{*this};
  }

cbeginSafe()

template<typename Val , typename Alloc >

INLINE ListConstIteratorSafe< Val > gum::List< Val, Alloc >::cbeginSafe

(

)

const

Returns a safe const iterator pointing to the beginning of the List.

Safe const iterators are const iterators whose state is updated by the list when the element they point to is erased. As such, in this case, they can throw an exception when we try to derefence them and they are able to perform a valid ++ or – step.

Returns

Returns a safe const iterator pointing to the beginning of the List.

Definition at line 1400 of file list_tpl.h.

                                                                           {
    return ListConstIteratorSafe< Val >{*this};
  }

cend()

template<typename Val , typename Alloc >

INLINE const ListConstIterator< Val > & gum::List< Val, Alloc >::cend ( ) const

noexcept

Returns an unsafe const iterator pointing to the end of the List.

Unsafe const iterators are a little bit faster than safe const iterators and they consume less memory. However, if the element they point to is erased, their dereference or their increment/decrement will produce a mess, probably a segfault. You should use them only when performance is an issue and if you are sure that they will never point to an element erased.

Returns an unsafe const iterator pointing to the end of the List.

Definition at line 1348 of file list_tpl.h.

                                                       {
    return *(reinterpret_cast< const ListConstIterator< Val >* >(list_end__));
  }

cendSafe()

template<typename Val , typename Alloc >

INLINE const ListConstIteratorSafe< Val > & gum::List< Val, Alloc >::cendSafe ( ) const

noexcept

Returns a safe const iterator pointing to the end of the List.

Safe const iterators are const iterators whose state is updated by the list when the element they point to is erased. As such, in this case, they can throw an exception when we try to derefence them and they are able to perform a valid ++ or – step

Returns a safe const iterator pointing to the end of the List.

Definition at line 1334 of file list_tpl.h.

                                                           {
    return *(
       reinterpret_cast< const ListConstIteratorSafe< Val >* >(list_end_safe__));
  }

clear()

template<typename Val , typename Alloc >

void gum::List< Val, Alloc >::clear

(

)

Deletes all the elements of a chained list.

All the iterators of the list will be resetted to rend. The method runs in linear time of both the size of the list and the number of iterators attached to the List.

Definition at line 1165 of file list_tpl.h.

                                 {
    // first we update all the safe iterators of the list : they should now
    // point to end/rend
    for (const auto ptr_iter: safe_iterators__) {
      ptr_iter->clear();
    }

    // clear all the values
    for (ListBucket< Val >*ptr = deb_list__, *next_ptr = nullptr; ptr != nullptr;
         ptr = next_ptr) {
      next_ptr = ptr->next__;
      alloc_bucket__.destroy(ptr);
      alloc_bucket__.deallocate(ptr, 1);
    }

    nb_elements__ = 0;
    deb_list__    = nullptr;
    end_list__    = nullptr;
  }

copy_elements__()

template<typename Val, typename Alloc >

template<typename OtherAlloc >

void gum::List< Val, Alloc >::copy_elements__ ( const List< Val, OtherAlloc > &  src )

private

A function used to perform copies of elements of Lists.

Before performing the copy, we assume in this function that the current list (this) is empty (else there would be memory leak).

Template Parameters

OtherAlloc

The other allocator.

Parameters

src	The gum::List to copy.

Definition at line 1115 of file list_tpl.h.

                                                                             {
    ListBucket< Val >* ptr;
    ListBucket< Val >* old_ptr = nullptr;
    ListBucket< Val >* new_elt = nullptr;

    // copy src's list
    try {
      for (ptr = src.deb_list__; ptr != nullptr; ptr = ptr->next__) {
        // create a copy bucket
        new_elt = alloc_bucket__.allocate(1);

        try {
          alloc_bucket__.construct(new_elt, *ptr);
        } catch (...) {
          alloc_bucket__.deallocate(new_elt, 1);
          throw;
        }

        // rechain properly the new list (the next field is already initialized
        // with nullptr)
        new_elt->prev__ = old_ptr;

        if (old_ptr)
          old_ptr->next__ = new_elt;
        else
          deb_list__ = new_elt;

        old_ptr = new_elt;
      }
    } catch (...) {
      // problem: we could not allocate an element in the list => we delete
      // the elements created so far and we throw an exception
      for (; deb_list__ != nullptr;
           deb_list__ = const_cast< ListBucket< Val >* >(ptr)) {
        ptr = deb_list__->next__;
        alloc_bucket__.destroy(deb_list__);
        alloc_bucket__.deallocate(deb_list__, 1);
      }

      deb_list__ = nullptr;
      throw;
    }

    // update properly the end of the chained list and the number of elements
    end_list__    = old_ptr;
    nb_elements__ = src.nb_elements__;
  }

crbegin()

template<typename Val , typename Alloc >

INLINE ListConstIterator< Val > gum::List< Val, Alloc >::crbegin

(

)

const

Returns an unsafe const iterator pointing to the last element of the List.

Unsafe iterators are a little bit faster than safe iterators and they consume less memory. However, if the element they point to is erased, their dereference or their increment/decrement will produce a mess, probably a segfault. You should use them only when performance is an issue and if you are sure that they will never point to an element erased.

Returns

Returns an unsafe const iterator pointing to the last element of the List.

Definition at line 1448 of file list_tpl.h.

                                                                    {
    if (nb_elements__)
      return ListConstIterator< Val >{*this, nb_elements__ - 1};
    else
      return ListConstIterator< Val >{};
  }

crbeginSafe()

template<typename Val , typename Alloc >

INLINE ListConstIteratorSafe< Val > gum::List< Val, Alloc >::crbeginSafe

(

)

const

Returns a safe const iterator pointing to the last element of the List.

Safe const iterators are const iterators whose state is updated by the list when the element they point to is erased. As such, in this case, they can throw an exception when we try to derefence them and they are able to perform a valid ++ or – step.

Returns

Returns a safe const iterator pointing to the last element of the List.

Definition at line 1430 of file list_tpl.h.

                                                                            {
    if (nb_elements__)
      return ListConstIteratorSafe< Val >{*this, nb_elements__ - 1};
    else
      return ListConstIteratorSafe< Val >{};
  }

createBucket__() [1/2]

template<typename Val, typename Alloc >

INLINE ListBucket< Val > * gum::List< Val, Alloc >::createBucket__ ( const Val &  val ) const

private

Create a new bucket with a given value.

Parameters

val	The value of the new bucket.

Returns

Returns the bucket holding val.

Definition at line 1476 of file list_tpl.h.

                                                                {
    // create a new bucket (catch allocation and construction exceptions)
    ListBucket< Val >* new_elt = alloc_bucket__.allocate(1);

    try {
      alloc_bucket__.construct(new_elt, val);
    } catch (...) {
      alloc_bucket__.deallocate(new_elt, 1);
      throw;
    }

    return new_elt;
  }

createBucket__() [2/2]

template<typename Val, typename Alloc >

INLINE ListBucket< Val > * gum::List< Val, Alloc >::createBucket__ ( Val &&  val ) const

private

Create a new bucket with a given value.

Parameters

val	The value of the new bucket.

Returns

Returns the bucket holding val.

Definition at line 1492 of file list_tpl.h.

                                                                              {
    // create a new bucket (catch allocation and construction exceptions)
    ListBucket< Val >* new_elt = alloc_bucket__.allocate(1);

    try {
      alloc_bucket__.construct(new_elt, std::move(val));
    } catch (...) {
      alloc_bucket__.deallocate(new_elt, 1);
      throw;
    }

    return new_elt;
  }

createEmplaceBucket__() [1/2]

template<typename Val, typename Alloc = std::allocator< Val >>

template<typename... Args>

ListBucket< Val >* gum::List< Val, Alloc >::createEmplaceBucket__ ( Args &&...  args ) const

private

Create an emplace bucket.

Template Parameters

Args	The emplace arguments types.

Parameters

args	The emplace arguments.

Returns

Returns the bucket holding the new value.

createEmplaceBucket__() [2/2]

template<typename Val, typename Alloc = std::allocator< Val >>

template<typename... Args>

INLINE ListBucket< Val >* gum::List< Val, Alloc >::createEmplaceBucket__

(

Args &&...

args

)

const

Definition at line 1510 of file list_tpl.h.

                                                                       {
    // create a new bucket (catch allocation and construction exceptions)
    ListBucket< Val >* new_elt = alloc_bucket__.allocate(1);

    try {
      alloc_bucket__.construct(new_elt,
                               ListBucket< Val >::Emplace::EMPLACE,
                               std::forward< Args >(args)...);
    } catch (...) {
      alloc_bucket__.deallocate(new_elt, 1);
      throw;
    }

    return new_elt;
  }

crend()

template<typename Val , typename Alloc >

INLINE const ListConstIterator< Val > & gum::List< Val, Alloc >::crend ( ) const

noexcept

Returns an unsafe const iterator pointing just before the beginning of the List.

Unsafe const iterators are a little bit faster than safe const iterators and they consume less memory. However, if the element they point to is erased, their dereference or their increment/decrement will produce a mess, probably a segfault. You should use them only when performance is an issue and if you are sure that they will never point to an element erased.

Returns

Returns an unsafe const iterator pointing just before the beginning of the List

Definition at line 1381 of file list_tpl.h.

                                                        {
    return *(reinterpret_cast< const ListConstIterator< Val >* >(list_end__));
  }

crendSafe()

template<typename Val , typename Alloc >

INLINE const ListConstIteratorSafe< Val > & gum::List< Val, Alloc >::crendSafe ( ) const

noexcept

Return a safe const iterator pointing just before the beginning of the List.

Safe const iterators are const iterators whose state is updated by the list when the element they point to is erased. As such, in this case, they can throw an exception when we try to derefence them and they are able to perform a valid ++ or – step.

Return a safe const iterator pointing just before the beginning of the List.

Definition at line 1367 of file list_tpl.h.

                                                            {
    return *(
       reinterpret_cast< const ListConstIteratorSafe< Val >* >(list_end_safe__));
  }

emplace() [1/4]

template<typename Val, typename Alloc = std::allocator< Val >>

template<typename... Args>

Val& gum::List< Val, Alloc >::emplace	(	const const_iterator &	iter,
		Args &&...	args
	)

Emplace a new element before a given iterator.

Emplace is a method that allows to construct directly an element of type Val by passing to its constructor all the arguments it needs. The first element of the list is at pos 0. After the insert, the element is placed precisely at pos if pos is less than the size of the list before insertion, else it is inserted at the end of the list.

Parameters

iter	The position in the list
args	The arguments passed to the constructor

Returns

Returns a reference on the copy inserted into the list.

emplace() [2/4]

template<typename Val, typename Alloc = std::allocator< Val >>

template<typename... Args>

Val& gum::List< Val, Alloc >::emplace	(	const const_iterator_safe &	iter,
		Args &&...	args
	)

Emplace a new element before a given safe iterator.

Emplace is a method that allows to construct directly an element of type Val by passing to its constructor all the arguments it needs. The first element of the list is at pos 0. After the insert, the element is placed precisely at pos if pos is less than the size of the list before insertion, else it is inserted at the end of the list.

Parameters

iter	The position in the list.
args	the arguments passed to the constructor.

Returns

Returns a reference on the copy inserted into the list.

emplace() [3/4]

template<typename Val, typename Alloc = std::allocator< Val >>

template<typename... Args>

INLINE Val& gum::List< Val, Alloc >::emplace	(	const const_iterator &	iter,
		Args &&...	args
	)

Definition at line 1817 of file list_tpl.h.

                                                          {
    return insert__(iter,
                    createEmplaceBucket__(std::forward< Args >(args)...),
                    location::BEFORE);
  }

emplace() [4/4]

template<typename Val, typename Alloc = std::allocator< Val >>

template<typename... Args>

INLINE Val& gum::List< Val, Alloc >::emplace	(	const const_iterator_safe &	iter,
		Args &&...	args
	)

Definition at line 1827 of file list_tpl.h.

                                                          {
    return insert__(iter,
                    createEmplaceBucket__(std::forward< Args >(args)...),
                    location::BEFORE);
  }

emplaceBack() [1/2]

template<typename Val, typename Alloc = std::allocator< Val >>

template<typename... Args>

Val& gum::List< Val, Alloc >::emplaceBack

(

Args &&...

args

)

Emplace elements at the end of the chained list.

Emplace is a method that allows to construct directly an element of type Val by passing to its constructor all the arguments it needs

Template Parameters

Args	The emplaced arguments types.

Parameters

args	The arguments passed to the constructor

Returns

A reference on the copy inserted into the list.

emplaceBack() [2/2]

template<typename Val, typename Alloc = std::allocator< Val >>

template<typename... Args>

INLINE Val& gum::List< Val, Alloc >::emplaceBack

(

Args &&...

args

)

Definition at line 1613 of file list_tpl.h.

                                                            {
    return pushBack__(createEmplaceBucket__(std::forward< Args >(args)...));
  }

emplaceFront() [1/2]

template<typename Val, typename Alloc = std::allocator< Val >>

template<typename... Args>

Val& gum::List< Val, Alloc >::emplaceFront

(

Args &&...

args

)

Emplace elements at the beginning of the chained list.

Emplace is a method that allows to construct directly an element of type Val by passing to its constructor all the arguments it needs

Parameters

args	The arguments passed to the constructor.

Returns

Returns a reference on the copy inserted into the list.

emplaceFront() [2/2]

template<typename Val, typename Alloc = std::allocator< Val >>

template<typename... Args>

INLINE Val& gum::List< Val, Alloc >::emplaceFront

(

Args &&...

args

)

Definition at line 1587 of file list_tpl.h.

                                                             {
    return pushFront__(createEmplaceBucket__(std::forward< Args >(args)...));
  }

empty()

template<typename Val , typename Alloc >

INLINE bool gum::List< Val, Alloc >::empty ( ) const

noexcept

Returns a boolean indicating whether the chained list is empty.

Returns

Returns a boolean indicating whether the chained list is empty.

Definition at line 1975 of file list_tpl.h.

                                                       {
    return (nb_elements__ == Size(0));
  }

end() [1/2]

template<typename Val , typename Alloc >

INLINE const ListIterator< Val > & gum::List< Val, Alloc >::end ( )

noexcept

Returns an unsafe iterator pointing to the end of the List.

Unsafe iterators are a little bit faster than safe iterators and they consume less memory. However, if the element they point to is erased, their dereference or their increment/decrement will produce a mess, probably a segfault. You should use them only when performance is an issue and if you are sure that they will never point to an element erased.

Returns

Returns an unsafe iterator pointing to the end of the List.

Definition at line 1354 of file list_tpl.h.

                                                                     {
    return *(reinterpret_cast< const ListIterator< Val >* >(list_end__));
  }

end() [2/2]

template<typename Val , typename Alloc >

INLINE const ListConstIterator< Val > & gum::List< Val, Alloc >::end ( ) const

noexcept

Returns an unsafe const iterator pointing to the end of the List.

Unsafe const iterators are a little bit faster than safe const iterators and they consume less memory. However, if the element they point to is erased, their dereference or their increment/decrement will produce a mess, probably a segfault. You should use them only when performance is an issue and if you are sure that they will never point to an element erased.

Returns

Returns an unsafe const iterator pointing to the end of the List.

Definition at line 1360 of file list_tpl.h.

                                                                                {
    return *(reinterpret_cast< const ListConstIterator< Val >* >(list_end__));
  }

endSafe()

template<typename Val , typename Alloc >

INLINE const ListIteratorSafe< Val > & gum::List< Val, Alloc >::endSafe ( )

noexcept

Returns a safe iterator pointing to the end of the List.

Safe iterators are iterators whose state is updated by the list when the element they point to is erased. As such, in this case, they can throw an exception when we try to derefence them and they are able to perform a valid ++ or – step.

Ceturns a safe iterator pointing to the end of the List.

Definition at line 1341 of file list_tpl.h.

                                                                             {
    return *(reinterpret_cast< const ListIteratorSafe< Val >* >(list_end_safe__));
  }

erase() [1/3]

template<typename Val , typename Alloc >

INLINE void gum::List< Val, Alloc >::erase

(

Size

i

)

Erases the ith element of the List (the first one is in position 0).

If the element cannot be found, the function returns without throwing any exception. It runs in linear time in the size of the list.

Parameters

i	The position in the list of the element we wish to remove.

Definition at line 1914 of file list_tpl.h.

                                              {
    if (i >= nb_elements__) return;

    // erase the ith bucket
    erase__(getIthBucket__(i));
  }

erase() [2/3]

template<typename Val , typename Alloc >

INLINE void gum::List< Val, Alloc >::erase

(

const iterator_safe &

iter

)

Erases the element of the List pointed to by the safe iterator.

If the element cannot be found, i.e., it has already been erased or the iterator points to end/rend, the function returns without throwing any exception. It runs in linear time in the size of the list.

Parameters

iter	An iterator pointing to the element to remove.

Definition at line 1923 of file list_tpl.h.

                                                                 {
    erase__(iter.getBucket__());
  }

erase() [3/3]

template<typename Val , typename Alloc >

INLINE void gum::List< Val, Alloc >::erase

(

const const_iterator_safe &

iter

)

Erases the element of the List pointed to by the safe const iterator.

If the element cannot be found, i.e., it has already been erased or the iterator points to end/rend, the function returns without throwing any exception. It runs in linear time in the size of the list.

Parameters

iter	An iterator pointing to the element to remove.

Definition at line 1929 of file list_tpl.h.

                                                                       {
    erase__(iter.getBucket__());
  }

erase__()

template<typename Val, typename Alloc >

INLINE void gum::List< Val, Alloc >::erase__ ( ListBucket< Val > *  bucket )

private

Removes an element from a chained list.

If parameter bucket is equal to 0, then the method does not perform anything, else the bucket is deleted. In the latter case, no test is ever performed to check that the bucket does actually belong to the List. The method runs in constant time.

Parameters

bucket

A pointer on the bucket in the chained list we wish to remove.

Definition at line 1871 of file list_tpl.h.

                                                                   {
    // perform deletion only if there is a bucket to remove
    if (bucket != nullptr) {
      // update the iterators pointing on this element
      for (const auto ptr_iter: safe_iterators__) {
        if (ptr_iter->bucket__ == bucket) {
          ptr_iter->next_current_bucket__ = bucket->prev__;
          ptr_iter->prev_current_bucket__ = bucket->next__;
          ptr_iter->bucket__              = nullptr;
          ptr_iter->null_pointing__       = true;
        } else {
          if (ptr_iter->null_pointing__) {
            if (ptr_iter->next_current_bucket__ == bucket)
              ptr_iter->next_current_bucket__ = bucket->prev__;

            if (ptr_iter->prev_current_bucket__ == bucket)
              ptr_iter->prev_current_bucket__ = bucket->next__;
          }
        }
      }

      // set properly the begin and end of the chained list (the other chainings
      // will be performed by operator delete)
      if (bucket->prev__ == nullptr)
        deb_list__ = bucket->next__;
      else
        bucket->prev__->next__ = bucket->next__;

      if (bucket->next__ == nullptr)
        end_list__ = bucket->prev__;
      else
        bucket->next__->prev__ = bucket->prev__;

      // remove the current element src the list
      alloc_bucket__.destroy(bucket);
      alloc_bucket__.deallocate(bucket, 1);

      --nb_elements__;
    }
  }

eraseAllVal()

template<typename Val, typename Alloc >

INLINE void gum::List< Val, Alloc >::eraseAllVal

(

const Val &

val

)

erases all the elements encountered with a given value

If no element equal to val can be found, the function returns without throwing any exception.

Comparisons between Val instances are performed through == operators.

Parameters

val	the value of the element we wish to remove.

Definition at line 1951 of file list_tpl.h.

                                                            {
    for (ListBucket< Val >*iter = deb_list__, *next_bucket = nullptr;
         iter != nullptr;
         iter = next_bucket) {
      next_bucket = iter->next__;

      if (val == iter->val__) erase__(iter);
    }
  }

eraseByVal()

template<typename Val, typename Alloc >

INLINE void gum::List< Val, Alloc >::eraseByVal

(

const Val &

val

)

erases the first element encountered with a given value.

If no element equal to val can be found, the function returns without throwing any exception. It runs in linear time both in the size of the list and in the number of iterators referenced in the list. Comparisons between Val instances are performed through == operators.

Parameters

val	The value of the element we wish to remove.

Definition at line 1945 of file list_tpl.h.

                                                           {
    erase__(getBucket__(val));
  }

exists()

template<typename Val, typename Alloc >

INLINE bool gum::List< Val, Alloc >::exists

(

const Val &

val

)

const

Checks whether there exists a given element in the list.

This method runs in linear time.

Comparisons between Val instances are performed through == operators.

Parameters

val	the value of the element we wish to check the existence of.

Returns

Returns true if val is in the gum::List.

Definition at line 1862 of file list_tpl.h.

                                                             {
    for (ListBucket< Val >* ptr = deb_list__; ptr != nullptr; ptr = ptr->next__)
      if (ptr->val__ == val) return true;

    return false;
  }

front()

template<typename Val , typename Alloc >

INLINE Val & gum::List< Val, Alloc >::front

(

)

const

Returns a reference to first element of a list, if any.

Exceptions

NotFound

exception is thrown if the list is empty.

Definition at line 1836 of file list_tpl.h.

                                              {
    if (nb_elements__ == Size(0)) {
      GUM_ERROR(NotFound, "not enough elements in the chained list");
    }

    return deb_list__->val__;
  }

getBucket__()

template<typename Val, typename Alloc >

INLINE ListBucket< Val > * gum::List< Val, Alloc >::getBucket__ ( const Val &  val ) const

privatenoexcept

Returns the bucket corresponding to a given value.

Actually, this is the first bucket of value val encountered in the list, if any, that is returned. If the element cannot be found, 0 is returned. This method enables fast removals of buckets. It runs in linear time.

Comparisons between Val instances are performed through == operators.

Parameters

val	The value of the element the bucket of which we wish to return.

Returns

Returns the bucket corresponding to a given value.

Definition at line 1936 of file list_tpl.h.

                                                                      {
    for (ListBucket< Val >* ptr = deb_list__; ptr != nullptr; ptr = ptr->next__)
      if (ptr->val__ == val) return ptr;

    return nullptr;
  }

getIthBucket__()

template<typename Val , typename Alloc >

INLINE ListBucket< Val > * gum::List< Val, Alloc >::getIthBucket__ ( Size  i ) const

privatenoexcept

Returns the bucket corresponding to the ith position in the list.

This method assumes that the list contains at least i+1 elements. The index of the first element of the list is 0.

Parameters

i	The position of the returned element.

Returns

Returns the gum::ListBucket of the ith element.

Definition at line 1633 of file list_tpl.h.

                                                                 {
    ListBucket< Val >* ptr;

    if (i < nb_elements__ / 2) {
      for (ptr = deb_list__; i; --i, ptr = ptr->next__) {}
    } else {
      for (ptr = end_list__, i = nb_elements__ - i - 1; i;
           --i, ptr            = ptr->prev__) {}
    }

    return ptr;
  }

insert() [1/8]

template<typename Val, typename Alloc >

INLINE Val & gum::List< Val, Alloc >::insert

(

const Val &

val

)

Inserts a new element at the end of the chained list (alias of pushBack).

Parameters

val	The value inserted.

Returns

a reference on the copy inserted into the list.

Warning

Note that val is not actually inserted into the list. Rather, it is a copy of val that is inserted.

Definition at line 1620 of file list_tpl.h.

                                                       {
    return pushBack(val);
  }

insert() [2/8]

template<typename Val, typename Alloc >

INLINE Val & gum::List< Val, Alloc >::insert

(

Val &&

val

)

Inserts a new element at the end of the chained list (alias of pushBack).

Parameters

val	The value inserted.

Returns

a reference on the copy inserted into the list.

Warning

Note that val is not actually inserted into the list. Rather, it is a copy of val that is inserted.

Definition at line 1626 of file list_tpl.h.

                                                  {
    return pushBack(std::move(val));
  }

insert() [3/8]

template<typename Val, typename Alloc >

INLINE Val & gum::List< Val, Alloc >::insert	(	Size	pos,
		const Val &	val
	)

Inserts a new element at the ith pos of the chained list.

The first element of the list is at pos 0. After the insert, the element is placed precisely at pos if pos is less than the size of the list before insertion, else it is inserted at the end of the list.

Parameters

pos	The position where to inser the new element.
val	The value to insert.

Returns

a reference on the copy inserted into the list.

Warning

Note that val is not actually inserted into the list. Rather, it is a copy of val that is inserted.

Definition at line 1688 of file list_tpl.h.

                                                                 {
    // if ther are fewer elements than pos, put the value at the end of the list
    if (nb_elements__ <= pos) { return pushBack(val); }

    return insertBefore__(createBucket__(val), getIthBucket__(pos));
  }

insert() [4/8]

template<typename Val, typename Alloc >

INLINE Val & gum::List< Val, Alloc >::insert	(	Size	pos,
		Val &&	val
	)

Insert an rvalue at the ith pos of the chained list.

The first element of the list is at pos 0. After the insert, the element is placed precisely at pos if pos is less than the size of the list before insertion, else it is inserted at the end of the list.

Parameters

pos	The position where to inser the new element.
val	The value to insert.

Returns

Returns a reference on the copy inserted into the list.

Definition at line 1697 of file list_tpl.h.

                                                            {
    // if ther are fewer elements than pos, put the value at the end of the list
    if (nb_elements__ <= pos) { return pushBack(std::move(val)); }

    return insertBefore__(createBucket__(std::move(val)), getIthBucket__(pos));
  }

insert() [5/8]

template<typename Val, typename Alloc >

INLINE Val & gum::List< Val, Alloc >::insert	(	const const_iterator_safe &	iter,
		const Val &	val,
		location	place = location::BEFORE
	)

Inserts a new element before or after a given iterator.

Parameters

iter	The iterator pointing where to inser the new element.
val	The value to insert.
place	Defines where to insert the new element relatively to iter.

Returns

Returns a reference on the copy inserted into the list.

Warning

Note that val is not actually inserted into the list. Rather, it is a copy of val that is inserted.

Definition at line 1769 of file list_tpl.h.

                                                                           {
    // if the iterator does not point to the list, raise an exception
    if (iter.list__ != this) {
      GUM_ERROR(InvalidArgument,
                "the iterator does not point to the correct list");
    }

    return insert__(iter, createBucket__(val), place);
  }

insert() [6/8]

template<typename Val, typename Alloc >

INLINE Val & gum::List< Val, Alloc >::insert	(	const const_iterator_safe &	iter,
		Val &&	val,
		location	place = location::BEFORE
	)

Inserts an rvalue before or after a given iterator.

Parameters

iter	The iterator pointing where to inser the new element.
val	The value to insert.
place	Defines where to insert the new element relatively to iter.

Returns

Returns a reference on the copy inserted into the list.

Warning

Note that val is not actually inserted into the list. Rather, it is a copy of val that is inserted.

Definition at line 1784 of file list_tpl.h.

                                                                           {
    // if the iterator does not point to the list, raise an exception
    if (iter.list__ != this) {
      GUM_ERROR(InvalidArgument,
                "the iterator does not point to the correct list");
    }

    return insert__(iter, createBucket__(std::move(val)), place);
  }

insert() [7/8]

template<typename Val, typename Alloc >

INLINE Val & gum::List< Val, Alloc >::insert	(	const const_iterator &	iter,
		const Val &	val,
		location	place = location::BEFORE
	)

Inserts a new element before or after a given iterator.

Parameters

iter	The iterator pointing where to inser the new element.
val	The value to insert.
place	Defines where to insert the new element relatively to iter.

Returns

Returns a reference on the copy inserted into the list.

Warning

Note that val is not actually inserted into the list. Rather, it is a copy of val that is inserted.

Definition at line 1799 of file list_tpl.h.

                                                                      {
    return insert__(iter, createBucket__(val), place);
  }

insert() [8/8]

template<typename Val, typename Alloc >

INLINE Val & gum::List< Val, Alloc >::insert	(	const const_iterator &	iter,
		Val &&	val,
		location	place = location::BEFORE
	)

Inserts an rvalue before or after a given iterator.

Parameters

iter	The iterator pointing where to inser the new element.
val	The value to insert.
place	Defines where to insert the new element relatively to iter.

Returns

Returns a reference on the copy inserted into the list.

Warning

Note that val is not actually inserted into the list. Rather, it is a copy of val that is inserted.

Definition at line 1808 of file list_tpl.h.

                                                                      {
    return insert__(iter, createBucket__(std::move(val)), place);
  }

insert__() [1/2]

template<typename Val, typename Alloc >

INLINE Val & gum::List< Val, Alloc >::insert__ ( const const_iterator_safe &  iter, ListBucket< Val > *  new_elt, location  place  )

private

Inserts a new bucket before or after the location pointed to by an iterator.

Parameters

iter	An iterator pointing where to insert a new element.
new_elt	The new element ot insert in the gum::List.
place	Where to insert the new element relatively to the iterator.

Returns

Returns a reference over the value stored in the gum::List.

Definition at line 1707 of file list_tpl.h.

                                                                             {
    // find the location around which the new element should be inserted
    ListBucket< Val >* ptr;

    if (iter.null_pointing__) {
      if (place == location::BEFORE) {
        ptr = iter.next_current_bucket__;
      } else {
        ptr = iter.prev_current_bucket__;
      }
    } else {
      ptr = iter.getBucket__();
    }

    if (ptr == nullptr) {
      // here, we are at the end of the list
      return pushBack__(new_elt);
    } else {
      switch (place) {
        case location::BEFORE:
          return insertBefore__(new_elt, ptr);

        case location::AFTER:
          return insertAfter__(new_elt, ptr);

        default:
          GUM_ERROR(FatalError, "List insertion for this location unimplemented");
      }
    }
  }

insert__() [2/2]

template<typename Val, typename Alloc >

INLINE Val & gum::List< Val, Alloc >::insert__ ( const const_iterator &  iter, ListBucket< Val > *  new_elt, location  place  )

private

Inserts a new bucket before or after the location pointed to by an iterator.

Parameters

iter	An iterator pointing where to insert a new element.
new_elt	The new element ot insert in the gum::List.
place	Where to insert the new element relatively to the iterator.

Returns

Returns a reference over the value stored in the gum::List.

Definition at line 1743 of file list_tpl.h.

                                                                        {
    // find the location around which the new element should be inserted
    ListBucket< Val >* ptr = iter.getBucket__();

    if (ptr == nullptr) {
      // here, we are at the end of the list
      return pushBack__(new_elt);
    } else {
      switch (place) {
        case location::BEFORE:
          return insertBefore__(new_elt, ptr);

        case location::AFTER:
          return insertAfter__(new_elt, ptr);

        default:
          GUM_ERROR(FatalError, "List insertion for this location unimplemented");
      }
    }
  }

insertAfter__()

template<typename Val, typename Alloc >

INLINE Val & gum::List< Val, Alloc >::insertAfter__ ( ListBucket< Val > *  new_elt, ListBucket< Val > *  current_elt  )

private

Insert a new bucket after another one.

Parameters

new_elt	The new element to insert in the gum::List.
current_elt	The element before which new_elt will be inserted.

Returns

Returns a reference over the value stored in the gum::List.

Definition at line 1668 of file list_tpl.h.

                                                                                {
    new_elt->prev__     = current_elt;
    new_elt->next__     = current_elt->next__;
    current_elt->next__ = new_elt;

    if (new_elt->next__ == nullptr)
      end_list__ = new_elt;
    else
      new_elt->next__->prev__ = new_elt;

    // update the number of elements
    ++nb_elements__;

    // returns the current value
    return new_elt->val__;
  }

insertBefore__()

template<typename Val, typename Alloc >

INLINE Val & gum::List< Val, Alloc >::insertBefore__ ( ListBucket< Val > *  new_elt, ListBucket< Val > *  current_elt  )

private

Insert a new bucket before another one.

Parameters

new_elt	The new element to insert in the gum::List.
current_elt	The element before which new_elt will be inserted.

Returns

Returns a reference over the value stored in the gum::List.

Definition at line 1648 of file list_tpl.h.

                                                                                 {
    new_elt->next__     = current_elt;
    new_elt->prev__     = current_elt->prev__;
    current_elt->prev__ = new_elt;

    if (new_elt->prev__ == nullptr)
      deb_list__ = new_elt;
    else
      new_elt->prev__->next__ = new_elt;

    // update the number of elements
    ++nb_elements__;

    // returns the current value
    return new_elt->val__;
  }

map() [1/4]

template<typename Val, typename Alloc >

template<typename Mount , typename OtherAlloc >

List< Mount, OtherAlloc > gum::List< Val, Alloc >::map

(

Mount(*)(Val)

f

)

const

Creates a list of mountains from a list of val.

Parameters

f	A function that maps any Val element into a Mount

Returns

Returns a lsit of mountains.

Template Parameters

Mount	The type of mountains.
OtherAlloc	The mountains type allocator.

Definition at line 2001 of file list_tpl.h.

                                                                         {
    // create a new empty list
    List< Mount, OtherAlloc > list;

    // fill the new list
    for (const_iterator iter = begin(); iter != end(); ++iter) {
      list.pushBack(f(*iter));
    }

    return list;
  }

map() [2/4]

template<typename Val, typename Alloc >

template<typename Mount , typename OtherAlloc >

List< Mount, OtherAlloc > gum::List< Val, Alloc >::map

(

Mount(*)(Val &)

f

)

const

Creates a list of mountains from a list of val.

Parameters

f	A function that maps any Val element into a Mount

Returns

Returns a lsit of mountains.

Template Parameters

Mount	The type of mountains.
OtherAlloc	The mountains type allocator.

Definition at line 2016 of file list_tpl.h.

                                                                          {
    // create a new empty list
    List< Mount, OtherAlloc > list;

    // fill the new list
    for (const_iterator iter = begin(); iter != end(); ++iter) {
      list.pushBack(f(*iter));
    }

    return list;
  }

map() [3/4]

template<typename Val, typename Alloc >

template<typename Mount , typename OtherAlloc >

List< Mount, OtherAlloc > gum::List< Val, Alloc >::map

(

Mount(*)(const Val &)

f

)

const

Creates a list of mountains from a list of val.

Parameters

f	A function that maps any Val element into a Mount

Returns

Returns a lsit of mountains.

Template Parameters

Mount	The type of mountains.
OtherAlloc	The mountains type allocator.

Definition at line 2031 of file list_tpl.h.

                                                                                {
    // create a new empty list
    List< Mount, OtherAlloc > list;

    // fill the new list
    for (const_iterator iter = begin(); iter != end(); ++iter) {
      list.pushBack(f(*iter));
    }

    return list;
  }

map() [4/4]

template<typename Val, typename Alloc >

template<typename Mount , typename OtherAlloc >

List< Mount, OtherAlloc > gum::List< Val, Alloc >::map

(

const Mount &

mount

)

const

Creates a list of mountains with a given value from a list of val.

Parameters

mount

the value taken by all the elements of the resulting list

Returns

Returns a lsit of mountains.

Template Parameters

Mount	The type of mountains.
OtherAlloc	The mountains type allocator.

Definition at line 2046 of file list_tpl.h.

                                                                            {
    // create a new empty list
    List< Mount, OtherAlloc > list;

    // fill the new list
    for (Size i = Size(0); i < nb_elements__; ++i)
      list.pushBack(mount);

    return list;
  }

operator!=() [1/2]

template<typename Val, typename Alloc = std::allocator< Val >>

template<typename OtherAlloc >

bool gum::List< Val, Alloc >::operator!=

(

const List< Val, OtherAlloc > &

src

)

const

Checks whether two lists are different (different elements or orders).

This method runs in time linear in the number of elements of the list.

Returns

Returns true if src and this gum::List are identical.

Template Parameters

OtherAlloc

The other allocator.

operator!=() [2/2]

template<typename Val, typename Alloc = std::allocator< Val >>

template<typename OtherAlloc >

INLINE bool gum::List< Val, Alloc >::operator!=

(

const List< Val, OtherAlloc > &

src

)

const

Definition at line 2092 of file list_tpl.h.

                                                                            {
    return !operator==(src);
  }

operator+=() [1/2]

template<typename Val, typename Alloc >

INLINE Val & gum::List< Val, Alloc >::operator+=

(

const Val &

val

)

Inserts a new element at the end of the list (alias of pushBack).

This enables writing code like list += xxx; to add element xxx to the list.

Warning

Note that val is not actually inserted into the list. Rather, it is a copy of val that is inserted.

Parameters

val	Tha value inserted int the list.

Returns

Returns a reference on the copy inserted into the list.

Definition at line 2060 of file list_tpl.h.

                                                           {
    return pushBack(val);
  }

operator+=() [2/2]

template<typename Val, typename Alloc >

INLINE Val & gum::List< Val, Alloc >::operator+=

(

Val &&

val

)

Inserts a new element at the end of the list (alias of pushBack).

This enables writing code like list += xxx; to add element xxx to the list.

Warning

Note that val is not actually inserted into the list. Rather, it is a copy of val that is inserted.

Parameters

val	Tha value inserted int the list.

Returns

Returns a reference on the copy inserted into the list.

Definition at line 2067 of file list_tpl.h.

                                                      {
    return pushBack(std::move(val));
  }

operator=() [1/4]

template<typename Val, typename Alloc>

INLINE List< Val, Alloc > & gum::List< Val, Alloc >::operator=

(

const List< Val, Alloc > &

src

)

Copy operator.

The new list and that which is copied do not share the elements: the new list contains new instances of the values stored in the list to be copied. Of course if these values are pointers, the new values point toward the same elements. The List on which the operator is applied keeps its iterator's list. Of course, if it previously contained some elements, those are removed prior to the copy. This operator runs in linear time.

Warning

If the current List previously contained iterators, those will be resetted to end()/rend().

Parameters

src	the list the content of which will be copied into the current List.

Returns

Returns this gum::List.

Definition at line 1267 of file list_tpl.h.

                                                                {
    // avoid self assignment
    if (this != &src) {
      // for debugging purposes
      GUM_OP_CPY(List);

      // remove the old content of 'this' and update accordingly the iterators
      clear();

      // perform the copy
      copy_elements__(src);
    }

    return *this;
  }

operator=() [2/4]

template<typename Val, typename Alloc = std::allocator< Val >>

template<typename OtherAlloc >

List< Val, Alloc >& gum::List< Val, Alloc >::operator=

(

const List< Val, OtherAlloc > &

src

)

Generalized copy operator.

The new list and that which is copied do not share the elements: the new list contains new instances of the values stored in the list to be copied. Of course if these values are pointers, the new values point toward the same elements. The List on which the operator is applied keeps its iterator's list. Of course, if it previously contained some elements, those are removed prior to the copy. This operator runs in linear time.

Warning

If the current List previously contained iterators, those will be resetted to end()/rend().

Parameters

src	the list the content of which will be copied into the current List.

Returns

Returns this gum::List.

operator=() [3/4]

template<typename Val, typename Alloc>

INLINE List< Val, Alloc > & gum::List< Val, Alloc >::operator=

(

List< Val, Alloc > &&

src

)

Move operator.

Parameters

src	The gum::List to move.

Returns

Returns this gum::List.

Definition at line 1306 of file list_tpl.h.

                                                           {
    // avoid self assignment
    if (this != &src) {
      // for debugging purposes
      GUM_OP_MOV(List);

      // remove the old content of 'this' and update accordingly the iterators
      clear();

      // perform the move
      deb_list__       = std::move(src.deb_list__);
      end_list__       = std::move(src.end_list__);
      nb_elements__    = std::move(src.nb_elements__);
      safe_iterators__ = std::move(src.safe_iterators__);
      alloc_bucket__   = std::move(src.alloc_bucket__);

      src.deb_list__    = nullptr;
      src.end_list__    = nullptr;
      src.nb_elements__ = 0;
      src.safe_iterators__.clear();
    }

    return *this;
  }

operator=() [4/4]

template<typename Val, typename Alloc = std::allocator< Val >>

template<typename OtherAlloc >

INLINE List< Val, Alloc >& gum::List< Val, Alloc >::operator=

(

const List< Val, OtherAlloc > &

src

)

Definition at line 1287 of file list_tpl.h.

                                                                     {
    // avoid self assignment
    if (this != reinterpret_cast< List< Val, Alloc >* >(&src)) {
      // for debugging purposes
      GUM_OP_CPY(List);

      // remove the old content of 'this' and update accordingly the iterators
      clear();

      // perform the copy
      copy_elements__(src);
    }

    return *this;
  }

operator==() [1/2]

template<typename Val, typename Alloc = std::allocator< Val >>

template<typename OtherAlloc >

bool gum::List< Val, Alloc >::operator==

(

const List< Val, OtherAlloc > &

src

)

const

Checks whether two lists are identical (same elements in the same order).

This method runs in time linear in the number of elements of the list.

Returns

Returns true if src and this gum::List are identical.

Template Parameters

OtherAlloc

The other allocator.

operator==() [2/2]

template<typename Val, typename Alloc = std::allocator< Val >>

template<typename OtherAlloc >

INLINE bool gum::List< Val, Alloc >::operator==

(

const List< Val, OtherAlloc > &

src

)

const

Definition at line 2075 of file list_tpl.h.

                                                                            {
    // check if the two lists have at least the same number of elements
    if (nb_elements__ != src.nb_elements__) return false;

    // parse the two lists
    for (ListBucket< Val >*iter1 = deb_list__, *iter2 = src.deb_list__;
         iter1 != nullptr;
         iter1 = iter1->next__, iter2 = iter2->next__)
      if (*iter1 != *iter2) return false;

    return true;
  }

operator[]() [1/2]

template<typename Val , typename Alloc >

INLINE Val & gum::List< Val, Alloc >::operator[]

(

const Size

i

)

Returns the ith element in the current chained list.

The first of the list element has index 0.

This method runs in linear time.

Parameters

i	The position of the element in the list (0 = first element).

Exceptions

NotFound

Raised if the element to be retrieved does not exist.

Returns

Returns a reference on the element stored at the ith position in the list.

Definition at line 2098 of file list_tpl.h.

                                                         {
    // check if we can return the element we ask for
    if (i >= nb_elements__) {
      GUM_ERROR(NotFound, "not enough elements in the chained list");
    }

    return **getIthBucket__(i);
  }

operator[]() [2/2]

template<typename Val , typename Alloc >

INLINE const Val & gum::List< Val, Alloc >::operator[]

(

const Size

i

)

const

Returns the const ith element in the current chained list.

The first of the list element has index 0.

This method runs in linear time.

Parameters

i	the position of the element in the list (0 = first element).

Exceptions

NotFound

Raised if the element to be retrieved does not exist.

Returns

Returns a reference on the element stored at the ith position in the list.

Definition at line 2109 of file list_tpl.h.

                                                                     {
    // check if we can return the element we ask for
    if (i >= nb_elements__) {
      GUM_ERROR(NotFound, "not enough elements in the chained list");
    }

    return **getIthBucket__(i);
  }

popBack()

template<typename Val , typename Alloc >

INLINE void gum::List< Val, Alloc >::popBack

(

)

Removes the last element of a List, if any.

When the list is empty, it does not do anything.

Definition at line 1963 of file list_tpl.h.

                                          {
    erase__(end_list__);
  }

popFront()

template<typename Val , typename Alloc >

INLINE void gum::List< Val, Alloc >::popFront

(

)

Removes the first element of a List, if any.

When the list is empty, it does not do anything.

Definition at line 1969 of file list_tpl.h.

                                           {
    erase__(deb_list__);
  }

push_back() [1/2]

template<typename Val, typename Alloc = std::allocator< Val >>

template<typename... Args>

Val& gum::List< Val, Alloc >::push_back

(

Args &&...

args

)

An alias for pushBack used for STL compliance.

Defining push_back allows using, for instance, BackInserters.

Template Parameters

Args	The emplace arguments type.

Parameters

args	The emplace arguments values.

Returns

Returns a reference on the copy inserted into the list.

push_back() [2/2]

template<typename Val, typename Alloc = std::allocator< Val >>

template<typename... Args>

INLINE Val& gum::List< Val, Alloc >::push_back

(

Args &&...

args

)

Definition at line 1606 of file list_tpl.h.

                                                          {
    return pushBack(std::forward< Args >(args)...);
  }

push_front() [1/2]

template<typename Val, typename Alloc = std::allocator< Val >>

template<typename... Args>

Val& gum::List< Val, Alloc >::push_front

(

Args &&...

args

)

An alias for pushFront used for STL compliance.

Defining push_front allows using, for instance, FrontInserters.

Template Parameters

Args	The emplace values type.

Parameters

args	The emplace values.

Returns

Returns a reference on the copy inserted into the list.

push_front() [2/2]

template<typename Val, typename Alloc = std::allocator< Val >>

template<typename... Args>

INLINE Val& gum::List< Val, Alloc >::push_front

(

Args &&...

args

)

Definition at line 1580 of file list_tpl.h.

                                                           {
    return pushFront(std::forward< Args >(args)...);
  }

pushBack() [1/2]

template<typename Val, typename Alloc >

INLINE Val & gum::List< Val, Alloc >::pushBack

(

const Val &

val

)

Inserts a new element (a copy) at the end of the chained list.

The value passed in argument is not actually inserted into the list: this is a copy of this value that is inserted. The method runs in constant time.

Parameters

val	The value pushed back.

Returns

Returns a reference on the copy inserted into the list.

Warning

Note that val is not actually inserted into the list. Rather, it is a copy of val that is inserted.

Definition at line 1593 of file list_tpl.h.

                                                         {
    return pushBack__(createBucket__(val));
  }

pushBack() [2/2]

template<typename Val, typename Alloc >

INLINE Val & gum::List< Val, Alloc >::pushBack

(

Val &&

val

)

Inserts a new element (a move) at the end of the chained list.

The value passed in argument is not actually inserted into the list: this is a copy of this value that is inserted. The method runs in constant time.

Parameters

val	The value pushed back.

Returns

Returns a reference on the copy inserted into the list.

Warning

Note that val is not actually inserted into the list. Rather, it is a copy of val that is inserted.

Definition at line 1599 of file list_tpl.h.

                                                    {
    return pushBack__(createBucket__(std::move(val)));
  }

pushBack__()

template<typename Val, typename Alloc >

INLINE Val & gum::List< Val, Alloc >::pushBack__ ( ListBucket< Val > *  new_elt )

private

Insert a bucket at the end of the list.

Parameters

new_elt

The new element pushed at the end of the gum::List.

Returns

Returns a refefence over the value stored in the gum::List.

Definition at line 1547 of file list_tpl.h.

                                                                       {
    // place the bucket at the end of the list
    new_elt->prev__ = end_list__;

    if (end_list__ != nullptr)
      end_list__->next__ = new_elt;
    else
      deb_list__ = new_elt;

    end_list__ = new_elt;

    // update the number of elements
    ++nb_elements__;

    // returns the current value
    return new_elt->val__;
  }

pushFront() [1/2]

template<typename Val, typename Alloc >

INLINE Val & gum::List< Val, Alloc >::pushFront

(

const Val &

val

)

Inserts a new element (a copy) at the beginning of the chained list.

The value passed in argument is not actually inserted into the list: this is a copy of this value that is inserted. The method runs in constant time.

Parameters

val	The valus pushed at the front.

Returns

Returns a reference on the copy inserted into the list.

Warning

Note that val is not actually inserted into the list. Rather, it is a copy of val that is inserted.

Definition at line 1567 of file list_tpl.h.

                                                          {
    return pushFront__(createBucket__(val));
  }

pushFront() [2/2]

template<typename Val, typename Alloc >

INLINE Val & gum::List< Val, Alloc >::pushFront

(

Val &&

val

)

Inserts a new element (a move) at the beginning of the chained list.

Parameters

val	The valus pushed at the front.

Returns

Returns a reference on the copy inserted into the list.

Warning

Note that val is not actually inserted into the list. Rather, it is a copy of val that is inserted.

Definition at line 1573 of file list_tpl.h.

                                                     {
    return pushFront__(createBucket__(std::move(val)));
  }

pushFront__()

template<typename Val, typename Alloc >

INLINE Val & gum::List< Val, Alloc >::pushFront__ ( ListBucket< Val > *  new_elt )

private

Insert a bucket at the front of the list.

Parameters

new_elt

The new element pushed at the front of the gum::List.

Returns

Returns a refefence over the value stored in the gum::List.

Definition at line 1528 of file list_tpl.h.

                                                                        {
    new_elt->next__ = deb_list__;

    if (deb_list__ != nullptr)
      deb_list__->prev__ = new_elt;
    else
      end_list__ = new_elt;

    deb_list__ = new_elt;

    // update the number of elements
    ++nb_elements__;

    // return the inserted element
    return new_elt->val__;
  }

rbegin() [1/2]

template<typename Val , typename Alloc >

INLINE ListIterator< Val > gum::List< Val, Alloc >::rbegin

(

)

Returns an unsafe iterator pointing to the last element of the List.

Unsafe iterators are a little bit faster than safe iterators and they consume less memory. However, if the element they point to is erased, their dereference or their increment/decrement will produce a mess, probably a segfault. You should use them only when performance is an issue and if you are sure that they will never point to an element erased.

Returns

Returns an unsafe iterator pointing to the last element of the List.

Definition at line 1457 of file list_tpl.h.

                                                        {
    if (nb_elements__)
      return ListIterator< Val >{*this, nb_elements__ - 1};
    else
      return ListIterator< Val >{};
  }

rbegin() [2/2]

template<typename Val , typename Alloc >

INLINE ListConstIterator< Val > gum::List< Val, Alloc >::rbegin

(

)

const

Returns an unsafe const iterator pointing to the last element of the List.

Unsafe iterators are a little bit faster than safe iterators and they consume less memory. However, if the element they point to is erased, their dereference or their increment/decrement will produce a mess, probably a segfault. You should use them only when performance is an issue and if you are sure that they will never point to an element erased.

Returns

Returns an unsafe const iterator pointing to the last element of the List.

Definition at line 1466 of file list_tpl.h.

                                                                   {
    if (nb_elements__)
      return ListConstIterator< Val >{*this, nb_elements__ - 1};
    else
      return ListConstIterator< Val >{};
  }

rbeginSafe()

template<typename Val , typename Alloc >

INLINE ListIteratorSafe< Val > gum::List< Val, Alloc >::rbeginSafe

(

)

Returns a safe iterator pointing to the last element of the List.

Safe iterators are iterators whose state is updated by the list when the element they point to is erased. As such, in this case, they can throw an exception when we try to derefence them and they are able to perform a valid ++ or – step.

Returns

Returns a safe iterator pointing to the last element of the List.

Definition at line 1439 of file list_tpl.h.

                                                                {
    if (nb_elements__)
      return ListIteratorSafe< Val >{*this, nb_elements__ - 1};
    else
      return ListIteratorSafe< Val >{};
  }

rend() [1/2]

template<typename Val , typename Alloc >

INLINE const ListIterator< Val > & gum::List< Val, Alloc >::rend ( )

noexcept

Returns an unsafe iterator pointing just before the beginning of the List.

Unsafe iterators are a little bit faster than safe iterators and they consume less memory. However, if the element they point to is erased, their dereference or their increment/decrement will produce a mess, probably a segfault. You should use them only when performance is an issue and if you are sure that they will never point to an element erased.

Returns an unsafe iterator pointing just before the beginning of the List.

Definition at line 1387 of file list_tpl.h.

                                                                      {
    return *(reinterpret_cast< const ListIterator< Val >* >(list_end__));
  }

rend() [2/2]

template<typename Val , typename Alloc >

INLINE const ListConstIterator< Val > & gum::List< Val, Alloc >::rend ( ) const

noexcept

Returns an unsafe const iterator pointing just before the beginning of the List.

Unsafe const iterators are a little bit faster than safe const iterators and they consume less memory. However, if the element they point to is erased, their dereference or their increment/decrement will produce a mess, probably a segfault. You should use them only when performance is an issue and if you are sure that they will never point to an element erased.

Returns

Returns an unsafe const iterator pointing just before the beginning of the List.

Definition at line 1394 of file list_tpl.h.

                                                       {
    return *(reinterpret_cast< const ListConstIterator< Val >* >(list_end__));
  }

rendSafe()

template<typename Val , typename Alloc >

INLINE const ListIteratorSafe< Val > & gum::List< Val, Alloc >::rendSafe ( )

noexcept

Returns a safe iterator pointing just before the beginning of the List.

Safe iterators are iterators whose state is updated by the list when the element they point to is erased. As such, in this case, they can throw an exception when we try to derefence them and they are able to perform a valid ++ or – step.

Returns

Returns a safe iterator pointing just before the beginning of the List.

Definition at line 1374 of file list_tpl.h.

                                                                              {
    return *(reinterpret_cast< const ListIteratorSafe< Val >* >(list_end_safe__));
  }

size()

template<typename Val , typename Alloc >

INLINE Size gum::List< Val, Alloc >::size ( ) const

noexcept

Returns the number of elements in the list.

This method runs in constant time.

Definition at line 1856 of file list_tpl.h.

                                                      {
    return nb_elements__;
  }

swap()

template<typename Val , typename Alloc >

INLINE void gum::List< Val, Alloc >::swap

(

List< Val, Alloc > &

other_list

)

Swap the current list with another one.

Parameters

other_list

The list to swap elements with.

Definition at line 2120 of file list_tpl.h.

                                                       {
    std::swap(deb_list__, other_list.deb_list__);
    std::swap(end_list__, other_list.end_list__);
    std::swap(nb_elements__, other_list.nb_elements__);
    std::swap(safe_iterators__, other_list.safe_iterators__);
    std::swap(alloc_bucket__, other_list.alloc_bucket__);
  }

toString()

template<typename Val , typename Alloc >

std::string gum::List< Val, Alloc >::toString

(

)

const

Converts a list into a string.

Returns

Returns a std::string representation of the gum::List.

Definition at line 1981 of file list_tpl.h.

                                               {
    bool              deja = false;
    std::stringstream stream;
    stream << "[";

    for (ListBucket< Val >* ptr = deb_list__; ptr != nullptr;
         ptr = ptr->next__, deja = true) {
      if (deja) stream << " --> ";

      stream << ptr->val__;
    }

    stream << "]";

    return stream.str();
  }

Friends And Related Function Documentation

ListConstIterator< Val >

template<typename Val, typename Alloc = std::allocator< Val >>

friend class ListConstIterator< Val >

friend

ListIterator should be a friend to optimize access to elements.

Definition at line 1452 of file list.h.

ListConstIteratorSafe< Val >

template<typename Val, typename Alloc = std::allocator< Val >>

friend class ListConstIteratorSafe< Val >

friend

ListIterator should be a friend to optimize access to elements.

Definition at line 1454 of file list.h.

ListIterator< Val >

template<typename Val, typename Alloc = std::allocator< Val >>

friend class ListIterator< Val >

friend

ListIterator should be a friend to optimize access to elements.

Definition at line 1451 of file list.h.

ListIteratorSafe< Val >

template<typename Val, typename Alloc = std::allocator< Val >>

friend class ListIteratorSafe< Val >

friend

ListIterator should be a friend to optimize access to elements.

Definition at line 1453 of file list.h.

Member Data Documentation

alloc_bucket__

template<typename Val, typename Alloc = std::allocator< Val >>

BucketAllocator gum::List< Val, Alloc >::alloc_bucket__

mutableprivate

The allocator for the buckets.

Definition at line 1318 of file list.h.

deb_list__

template<typename Val, typename Alloc = std::allocator< Val >>

ListBucket< Val >* gum::List< Val, Alloc >::deb_list__ {nullptr}

private

A pointer on the first element of the chained list.

Definition at line 1306 of file list.h.

end_list__

template<typename Val, typename Alloc = std::allocator< Val >>

ListBucket< Val >* gum::List< Val, Alloc >::end_list__ {nullptr}

private

A pointer on the last element of the chained list.

Definition at line 1309 of file list.h.

nb_elements__

template<typename Val, typename Alloc = std::allocator< Val >>

Size gum::List< Val, Alloc >::nb_elements__ {Size(0)}

private

The number of elements in the list.

Definition at line 1312 of file list.h.

safe_iterators__

template<typename Val, typename Alloc = std::allocator< Val >>

std::vector< const_iterator_safe* > gum::List< Val, Alloc >::safe_iterators__

mutableprivate

The list of "safe" iterators attached to the list.

Definition at line 1315 of file list.h.

---

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

• agrum/tools/core/list.h
• agrum/tools/core/list_tpl.h