关于

maxon::BaseList is a class template for double linked lists. Elements of such a list should typically be access with iterators and not with indices.

Creation

A new list object can simply be created using the class template:

// This example creates and fills a new BaseList.

maxon::BaseList<maxon::Int> list;

列表。 Append (1) iferr_return ; 列表。 Append (2) iferr_return ;

The complete content of the BaseList can be deleted with:

maxon::BaseList::Reset() : Deletes all elements of the list.
maxon::BaseList::Flush() : Deletes all elements of the list.

数据

A maxon::BaseList stores maxon::BaseListNode elements. Such nodes contain the actual stored value and also references to the previous and next node.

New elements are added to the list with:

maxon::BaseList::Append() : Adds a new element with the given value to the list.
maxon::BaseList::AppendNode() : Adds the given node to the list.
maxon::BaseList::Insert() : Inserts a new element at the given position into the list.
maxon::BaseList::InsertNode() : Inserts the given node at the given position into the list.

// This example creates a BaseList and adds elements to it. maxon::BaseList<maxon::Int> list;

// append elements 列表。 Append (1) iferr_return ; 列表。 Append (2) iferr_return ;

// insert object at the beginning auto it = list. Begin (); 列表。 Insert (it, 3) iferr_return ;

If a given maxon::BaseList contains any elements can be checked with:

maxon::BaseList::IsEmpty() : Returns true if the list contains no elements.
maxon::BaseList::IsPopulated() : Returns true if the list contains some elements.

// This example checks if the given BaseList is empty. // If not it is flushed.

if (!list. IsEmpty ()) 列表。 Flush (); if (!list. IsPopulated ()) DiagnosticOutput ( "List is empty." );

A specific element stored in the maxon::BaseList can be accessed by its index:

maxon::BaseList::GetCount() : Returns the number of elements stored in the list.
maxon::BaseList::operator[]() : Returns the value stored in the element at the given index.
maxon::BaseList::GetIndex() : Returns the index of the given value.

// This example loops through all elements of the BaseList based on the element index. const maxon::Int cnt = list. GetCount (); for ( maxon::Int i = 0; i < cnt; ++i) { const maxon::Int value = list[i]; DiagnosticOutput ( "Value: @" , value); }

Single elements of the maxon::BaseList can be removed with:

maxon::BaseList::Erase() : Deletes the element or elements at the given position.
maxon::BaseList::SwapErase() : The same as maxon::BaseList::Erase() .
maxon::BaseList::Pop() : Deletes the last element of the list.
maxon::BaseList::PopNode() : Removes the last node and returns the pointer to it.

// This example deletes the first two elements of the given BaseList.

// deletes the first two elements const auto begin = list. Begin (); 列表。 Erase ( begin , 2);

The overall maxon::BaseList can be resized with:

maxon::BaseList::Resize() : Resizes the list to the given number of elements.

Iterate

Using iterators it is easily possible to iterate over all elements stored in the maxon::BaseList :

maxon::BaseList::Begin() : Returns the iterator pointing at the start of the list.
maxon::BaseList::End() : Returns the iterator pointing at the end of the list.
maxon::BaseList::Swap() : Swaps the elements stored at the given iterators.

// This example switches the first and last element of the BaseList // and loops through the list using the iterator.

// swap first and last element const auto begin = list. Begin (); auto end = list. End (); end --; 列表。 Swap ( begin , end );

// list all values for ( const maxon::Int it : list) DiagnosticOutput ( "Value: @" , it);

Utility

Utility functions are:

maxon::BaseList::CopyFrom() : Copies the data of the given list.
maxon::BaseList::GetBlock() : Determines a contiguous block of list elements which contains the element at the given index.
maxon::BaseList::GetMemorySize() : Calculates the memory usage for this list if the element class provides a GetMemorySize() function.
maxon::BaseList::GetAllocator() : Returns the allocator as reference.