irr::core::list< T > Class Template Reference

Doubly linked list template. More...

#include <irrList.h>

Classes
class	ConstIterator
	List iterator for const access. More...
class	Iterator
	List iterator. More...

Public Types
typedef T	value_type
typedef u32	size_type

Public Member Functions
	list ()
	Default constructor for empty list. More...
	list (const list< T > &other)
	Copy constructor. More...
	~list ()
	Destructor. More...
void	operator= (const list< T > &other)
	Assignment operator. More...
u32	size () const
	Returns amount of elements in list. More...
u32	getSize () const
void	clear ()
	Clears the list, deletes all elements in the list. More...
bool	empty () const
	Checks for empty list. More...
void	push_back (const T &element)
	Adds an element at the end of the list. More...
void	push_front (const T &element)
	Adds an element at the begin of the list. More...
Iterator	begin ()
	Gets first node. More...
ConstIterator	begin () const
	Gets first node. More...
Iterator	end ()
	Gets end node. More...
ConstIterator	end () const
	Gets end node. More...
Iterator	getLast ()
	Gets last element. More...
ConstIterator	getLast () const
	Gets last element. More...
void	insert_after (const Iterator &it, const T &element)
	Inserts an element after an element. More...
void	insert_before (const Iterator &it, const T &element)
	Inserts an element before an element. More...
Iterator	erase (Iterator &it)
	Erases an element. More...
void	swap (list< T > &other)
	Swap the content of this list container with the content of another list. More...

Detailed Description

template<class T>
class irr::core::list< T >

Doubly linked list template.

Definition at line 20 of file irrList.h.

Member Typedef Documentation

size_type

template<class T>

typedef u32 irr::core::list< T >::size_type

Definition at line 398 of file irrList.h.

value_type

template<class T>

typedef T irr::core::list< T >::value_type

Definition at line 397 of file irrList.h.

Constructor & Destructor Documentation

list() [1/2]

template<class T>

irr::core::list< T >::list ( )

inline

Default constructor for empty list.

Definition at line 132 of file irrList.h.

                : First(0), Last(0), Size(0) {}

list() [2/2]

template<class T>

irr::core::list< T >::list ( const list< T > &  other )

inline

Copy constructor.

Definition at line 137 of file irrList.h.

                                   : First(0), Last(0), Size(0)
        {
                *this = other;
        }

~list()

template<class T>

irr::core::list< T >::~list ( )

inline

Destructor.

Definition at line 144 of file irrList.h.

        {
                clear();
        }

Member Function Documentation

begin() [1/2]

template<class T>

Iterator irr::core::list< T >::begin ( )

inline

Gets first node.

Returns

A list iterator pointing to the beginning of the list.

Definition at line 253 of file irrList.h.

        {
                return Iterator(First);
        }

begin() [2/2]

template<class T>

ConstIterator irr::core::list< T >::begin ( ) const

inline

Gets first node.

Returns

A const list iterator pointing to the beginning of the list.

Definition at line 261 of file irrList.h.

        {
                return ConstIterator(First);
        }

clear()

template<class T>

void irr::core::list< T >::clear ( void  )

inline

Clears the list, deletes all elements in the list.

All existing iterators of this list will be invalid.

Definition at line 183 of file irrList.h.

        {
                while(First)
                {
                        SKListNode * next = First->Next;
                        allocator.destruct(First);
                        allocator.deallocate(First);
                        First = next;
                }

                //First = 0; handled by loop
                Last = 0;
                Size = 0;
        }

empty()

template<class T>

bool irr::core::list< T >::empty ( ) const

inline

Checks for empty list.

Returns

True if the list is empty and false if not.

Definition at line 201 of file irrList.h.

        {
                return (First == 0);
        }

end() [1/2]

template<class T>

Iterator irr::core::list< T >::end ( )

inline

Gets end node.

Returns

List iterator pointing to null.

Definition at line 269 of file irrList.h.

        {
                return Iterator(0);
        }

end() [2/2]

template<class T>

ConstIterator irr::core::list< T >::end ( ) const

inline

Gets end node.

Returns

Const list iterator pointing to null.

Definition at line 277 of file irrList.h.

        {
                return ConstIterator(0);
        }

erase()

template<class T>

Iterator irr::core::list< T >::erase ( Iterator &  it )

inline

Erases an element.

Parameters

it	Iterator pointing to the element which shall be erased.

Returns

Iterator pointing to next element.

Definition at line 350 of file irrList.h.

        {
                // suggest changing this to a const Iterator& and
                // working around line: it.Current = 0 (possibly with a mutable, or just let it be garbage?)

                Iterator returnIterator(it);
                ++returnIterator;

                if(it.Current == First)
                {
                        First = it.Current->Next;
                }
                else
                {
                        it.Current->Prev->Next = it.Current->Next;
                }

                if(it.Current == Last)
                {
                        Last = it.Current->Prev;
                }
                else
                {
                        it.Current->Next->Prev = it.Current->Prev;
                }

                allocator.destruct(it.Current);
                allocator.deallocate(it.Current);
                it.Current = 0;
                --Size;

                return returnIterator;
        }

getLast() [1/2]

template<class T>

Iterator irr::core::list< T >::getLast ( )

inline

Gets last element.

Returns

List iterator pointing to the last element of the list.

Definition at line 285 of file irrList.h.

        {
                return Iterator(Last);
        }

getLast() [2/2]

template<class T>

ConstIterator irr::core::list< T >::getLast ( ) const

inline

Gets last element.

Returns

Const list iterator pointing to the last element of the list.

Definition at line 293 of file irrList.h.

        {
                return ConstIterator(Last);
        }

getSize()

template<class T>

u32 irr::core::list< T >::getSize ( ) const

inline

Definition at line 175 of file irrList.h.

        {
                return Size;
        }

insert_after()

template<class T>

void irr::core::list< T >::insert_after ( const Iterator &  it, const T &  element  )

inline

Inserts an element after an element.

Parameters

it	Iterator pointing to element after which the new element should be inserted.
element	The new element to be inserted into the list.

Definition at line 304 of file irrList.h.

        {
                SKListNode* node = allocator.allocate(1);
                allocator.construct(node, element);

                node->Next = it.Current->Next;

                if (it.Current->Next)
                        it.Current->Next->Prev = node;

                node->Prev = it.Current;
                it.Current->Next = node;
                ++Size;

                if (it.Current == Last)
                        Last = node;
        }

insert_before()

template<class T>

void irr::core::list< T >::insert_before ( const Iterator &  it, const T &  element  )

inline

Inserts an element before an element.

Parameters

it	Iterator pointing to element before which the new element should be inserted.
element	The new element to be inserted into the list.

Definition at line 328 of file irrList.h.

        {
                SKListNode* node = allocator.allocate(1);
                allocator.construct(node, element);

                node->Prev = it.Current->Prev;

                if (it.Current->Prev)
                        it.Current->Prev->Next = node;

                node->Next = it.Current;
                it.Current->Prev = node;
                ++Size;

                if (it.Current == First)
                        First = node;
        }

operator=()

template<class T>

void irr::core::list< T >::operator= ( const list< T > &  other )

inline

Assignment operator.

Definition at line 151 of file irrList.h.

        {
                if(&other == this)
                {
                        return;
                }

                clear();

                SKListNode* node = other.First;
                while(node)
                {
                        push_back(node->Element);
                        node = node->Next;
                }
        }

push_back()

template<class T>

void irr::core::list< T >::push_back ( const T &  element )

inline

Adds an element at the end of the list.

Parameters

element

Element to add to the list.

Definition at line 209 of file irrList.h.

        {
                SKListNode* node = allocator.allocate(1);
                allocator.construct(node, element);

                ++Size;

                if (First == 0)
                        First = node;

                node->Prev = Last;

                if (Last != 0)
                        Last->Next = node;

                Last = node;
        }

push_front()

template<class T>

void irr::core::list< T >::push_front ( const T &  element )

inline

Adds an element at the begin of the list.

Parameters

element

Element to add to the list.

Definition at line 230 of file irrList.h.

        {
                SKListNode* node = allocator.allocate(1);
                allocator.construct(node, element);

                ++Size;

                if (First == 0)
                {
                        Last = node;
                        First = node;
                }
                else
                {
                        node->Next = First;
                        First->Prev = node;
                        First = node;
                }
        }

size()

template<class T>

u32 irr::core::list< T >::size ( ) const

inline

Returns amount of elements in list.

Returns

Amount of elements in the list.

Definition at line 171 of file irrList.h.

        {
                return Size;
        }

swap()

template<class T>

void irr::core::list< T >::swap ( list< T > &  other )

inline

Swap the content of this list container with the content of another list.

Afterward this object will contain the content of the other object and the other object will contain the content of this object. Iterators will afterward be valid for the swapped object.

Parameters

other

Swap content with this object

Definition at line 389 of file irrList.h.

        {
                core::swap(First, other.First);
                core::swap(Last, other.Last);
                core::swap(Size, other.Size);
                core::swap(allocator, other.allocator); // memory is still released by the same allocator used for allocation
        }

---

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

• include/irrlicht/irrList.h