就业培训     下载中心     Wiki     联络 登录   注册

---

1. 首页
2. C4D R23.110 C++ SDK

Classes | Public Types | 公共成员函数 | 静态公共成员函数 | 私有成员函数 | Private Attributes | 所有成员列表

BaseList< T, NODE, HEAD, ALLOCATOR > Class Template Reference Data Structures

#include <baselist.h>

Inheritance diagram for BaseList< T, NODE, HEAD, ALLOCATOR >:

[ legend ]

详细描述

template<typename T, typename NODE = BaseListNode<T>, typename HEAD = BaseListHead<T, NODE>, typename ALLOCATOR = DefaultAllocator>
class maxon::BaseList< T, NODE, HEAD, ALLOCATOR >

Basic list template (double linked).

The BaseList implements the same methods as the arrays. Nonetheless it is highly recommended to use the iterator based methods instead of those taking an index or count as parameter because the latter perform poorly due to the nature of a list.

If you want to control the list nodes themselves or their memory layout you can specify the list node type with NODE instead of using the default template BaseListNode<T> (the same goes for the list head HEAD).

Performance characteristics: Random access to array elements is linear with the index n: O(n) Append or Pop (erase the last) an element is constant: O(1) Insert or Erase an element is constant: O(1)

注意

: Do not rely on the characteristics to pick the right type of collection. Always profile to check real life performance!

Template Parameters

T	Type of the list element content.
NODE	A node that encapsulates the element content T and holds the pointers to the next and previous element (see BaseListNode 了解细节)。
HEAD	A list head for nodes of type NODE.
ALLOCATOR	Class for memory allocation.

Classes
class	IteratorTemplate

Public Types
using	ValueType = T
using	AllocatorType = ALLOCATOR
using	Iterator = IteratorTemplate < false >
using	ConstIterator = IteratorTemplate < true >

公共成员函数
	BaseList ()
	BaseList (const ALLOCATOR &a)
	~BaseList ()
	BaseList ( BaseList && src )
	MAXON_OPERATOR_MOVE_ASSIGNMENT ( BaseList )
void	重置 ()
void	Flush ()
MAXON_ATTRIBUTE_FORCE_INLINE Bool	IsEmpty () const
MAXON_ATTRIBUTE_FORCE_INLINE Bool	IsPopulated () const
Int	GetCount () const
const T &	operator[] ( Int idx) const
T &	operator[] ( Int idx)
ResultRef < T >	Append ()
ResultRef < T >	Append (const T &x)
ResultRef < T >	Append (T &&x)
MAXON_ATTRIBUTE_FORCE_INLINE ResultPtr < T >	Append (const Block < const T > &values)
ResultPtr < T >	Append (const std::initializer_list< T > &values)
T *	AppendNode (NODE *node)
ResultRef < T >	Insert ( Int position)
ResultMemT < Iterator >	Insert ( Iterator position)
ResultRef < T >	Insert ( Int position, const T &x)
ResultMemT < Iterator >	Insert ( Iterator position, const T &x)
ResultRef < T >	Insert ( Int position, T &&x)
ResultMemT < Iterator >	Insert ( Iterator position, T &&x)
T *	InsertNode ( Iterator position, NODE *node)
ResultPtr < T >	Insert ( Int position, const Block < const T > &values)
ResultPtr < T >	Insert ( Int position, const std::initializer_list< T > &values)
ResultMemT < Iterator >	Insert ( Iterator position, const Block < const T > &values)
ResultMemT < Iterator >	Insert ( Iterator position, const std::initializer_list< T > &values)
ResultPtr < T >	Erase ( Int position, Int eraseCnt=1)
Iterator	Erase ( Iterator position, Int eraseCnt)
Iterator	Erase ( Iterator position)
ResultMem	SwapErase ( Int position, Int eraseCnt=1)
Iterator	SwapErase ( Iterator position, Int eraseCnt=1)
template<Bool STRIDED>
MAXON_ATTRIBUTE_FORCE_INLINE Iterator	GetBlock ( Iterator position, Block < T, STRIDED > &block)
template<Bool STRIDED>
MAXON_ATTRIBUTE_FORCE_INLINE Iterator	GetBlock ( Iterator position, Block < const T, STRIDED > &block) const
template<Bool STRIDED>
MAXON_ATTRIBUTE_FORCE_INLINE Int	GetBlock ( Int position, Block < T, STRIDED > &block)
template<Bool STRIDED>
MAXON_ATTRIBUTE_FORCE_INLINE Int	GetBlock ( Int position, Block < const T, STRIDED > &block) const
ResultMem	Resize ( Int newCnt, COLLECTION_RESIZE_FLAGS resizeFlags= COLLECTION_RESIZE_FLAGS::DEFAULT )
Bool	Pop (T *dst=nullptr)
Bool	PopNode (NODE **dst)
Int	GetIndex (const T &x) const
template<typename SourceArray >
Result < void >	CopyFrom (const SourceArray & src )
void	Swap ( Iterator a, Iterator b)
Int	GetMemorySize () const
ConstIterator	Begin () const
Iterator	Begin ()
ConstIterator	End () const
Iterator	End ()
ALLOCATOR &	GetAllocator ()

静态公共成员函数
static NODE *	RemoveNode ( Iterator position)
static NODE *	RemoveNode (T *x)

私有成员函数
	MAXON_DISALLOW_COPY_AND_ASSIGN ( BaseList )
NODE *	AllocNode ()
void	DeleteNode (NODE *node)

Private Attributes
HEAD	_head

Additional Inherited Members
Static Protected Member Functions inherited from DefaultAllocator
static Int	ComputeArraySize ( Int currentSize, Int increment, Int minChunkSize)
static MAXON_ATTRIBUTE_FORCE_INLINE void *	Alloc ( Int32 s, MAXON_SOURCE_LOCATION_DECLARATION )
static MAXON_ATTRIBUTE_FORCE_INLINE void *	Alloc ( Int64 s, MAXON_SOURCE_LOCATION_DECLARATION )
static MAXON_ATTRIBUTE_FORCE_INLINE void *	AllocClear ( Int32 s, MAXON_SOURCE_LOCATION_DECLARATION )
static MAXON_ATTRIBUTE_FORCE_INLINE void *	AllocClear ( Int64 s, MAXON_SOURCE_LOCATION_DECLARATION )
static MAXON_ATTRIBUTE_FORCE_INLINE void *	Realloc (void *p, Int32 n, MAXON_SOURCE_LOCATION_DECLARATION )
static MAXON_ATTRIBUTE_FORCE_INLINE void *	Realloc (void *p, Int64 n, MAXON_SOURCE_LOCATION_DECLARATION )
template<typename T >
static MAXON_ATTRIBUTE_FORCE_INLINE void	Free (T *&p)
static MAXON_ATTRIBUTE_FORCE_INLINE Bool	IsCompatibleWithDefaultAllocator (void *)
Static Protected Attributes inherited from DefaultAllocator
static const UInt	ALIGNMENT
static const UInt	ALIGNMENT_MASK
static const UInt	MIN_ALIGNMENT_MASK

Member Typedef Documentation

◆  ValueType

using ValueType = T

◆  AllocatorType

◆  Iterator

◆  ConstIterator

构造函数 & 析构函数文档编制

◆  BaseList() [1/3]

Default constructor. Creates an empty list.

◆  BaseList() [2/3]

This constructor has to be used if a list should use a custom allocator with member variables.

◆  ~BaseList()

Destructs the list. If there are still elements they will be deleted.

◆  BaseList() [3/3]

Move constructor.

成员函数文档编制

◆  MAXON_DISALLOW_COPY_AND_ASSIGN()

◆  MAXON_OPERATOR_MOVE_ASSIGNMENT()

Move assignment operator.

◆  Reset()

Deletes all elements (calls destructors and frees memory).

◆  Flush()

Deletes all elements (same as Reset() 为 BaseList ).

◆  IsEmpty()

Checks if the list is empty. This is the same as GetCount() == 0

返回

True if the list does not contain any elements.

◆  IsPopulated()

Checks if the list contains anything. This is the same as GetCount() != 0

返回

True if the list contains any elements.

◆  GetCount()

Gets the number of list elements. This has to iterate over all list elements. You may better want to use iterators directly!

返回

Number of list elements.

◆  operator[]() [1/2]

Array (subscript) operator for const objects. This is very ineffective on a list - better use iterators!

参数

[in]

idx

Element index (if it's out of bounds you will get an error in debug code only, otherwise it will crash).

返回

List element.

◆  operator[]() [2/2]

Array (subscript) operator for non-const objects. This is very ineffective on a list - better use iterators!

参数

[in]

idx

Element index (if it's out of bounds you will get an error in debug code only, otherwise it will crash).

返回

List element.

◆  Append() [1/5]

Adds a new element at the end of the list.

返回

Element reference or OutOfMemoryError if the allocation failed.

◆  Append() [2/5]

Adds a new element at the end of the list and initializes it with a copy of x.

参数

[in]

x

Value to be copied.

返回

Element reference or OutOfMemoryError if the allocation failed.

◆  Append() [3/5]

Adds a new element at the end of the list and moves the content of x to it.

参数

[in]

x

Value to be moved.

返回

Element reference or OutOfMemoryError if the allocation failed.

◆  Append() [4/5]

Appends new elements at the end of the list.

参数

[in]

values

Block with values to be copied. If the block points to nullptr, only its count is used, and you have to call the constructor of the new elements manually.

返回

Element pointer or OutOfMemoryError if the allocation failed.

◆  Append() [5/5]

Appends new elements at the end of the list.

参数

[in]

values

Initializer list with values to be copied.

返回

Element pointer or OutOfMemoryError if the allocation failed.

◆  AppendNode()

BaseList specific: Adds a new list node at the end of the list.

参数

[in]

node

Pointer to new list node ( BaseList will take ownership of it).

返回

Pointer to the appended node's data.

◆  Insert() [1/10]

Inserts a new default element at index position. Use the iterator based Insert() below! This is compatible to the arrays but slow because Insert() has to iterate over the list to find the element corresponding to the index position.

参数

[in]

position

Insert index.

返回

Element reference or OutOfMemoryError if the allocation failed (or position is out of boundaries).

◆  Insert() [2/10]

Inserts a new default element at iterator position.

参数

[in]

position

Insert position.

返回

Iterator for the new element or OutOfMemoryError if the allocation failed (or position out of boundaries).

◆  Insert() [3/10]

Inserts a new element at index position and initializes it with a copy of x. Use the iterator based Insert() below! This is compatible to the arrays but slow because Insert() has to iterate over the list.

参数

[in]	position	Insert index.
[in]	x	Value to be copied.

返回

Element reference or OutOfMemoryError if the allocation failed (or position is out of boundaries).

◆  Insert() [4/10]

Inserts a new element at iterator position and initializes it with a copy of x.

参数

[in]	position	Insert position.
[in]	x	Value to be copied.

返回

Iterator for the new element or OutOfMemoryError if the allocation failed (or position is out of boundaries).

◆  Insert() [5/10]

Inserts a new element at index position and moves the content of x to it. Use the iterator based Insert() below! This is compatible to the arrays but slow because Insert() has to iterate over the list.

参数

[in]	position	Insert index.
[in]	x	Value to be moved.

返回

Element reference or OutOfMemoryError if the allocation failed (or position is out of boundaries).

◆  Insert() [6/10]

Inserts a new element at iterator position and moves the content of x to it.

参数

[in]	position	Insert position.
[in]	x	Value to be moved.

返回

Iterator for the new element or OutOfMemoryError if the allocation failed (or position is out of boundaries).

◆  InsertNode()

BaseList specific: Inserts a new list node at iterator position.

参数

[in]	position	Insert position.
[in]	node	Pointer to new list node ( BaseList will take ownership of it).

返回

Pointer to the inserted node's data.

◆  Insert() [7/10]

Inserts new elements at index position. Use the iterator based Insert() below! This is compatible to the arrays but slow because Insert() has to iterate over the list.

参数

[in]	position	Insert index.
[in]	values	Block with values to be copied. If the block points to nullptr, only its count is used, and you have to call the constructor of the new elements manually.

返回

Element pointer or OutOfMemoryError if the allocation failed (or position is out of boundaries).

◆  Insert() [8/10]

Inserts new elements at index position. Use the iterator based Insert() below! This is compatible to the arrays but slow because Insert() has to iterate over the list.

参数

[in]	position	Insert index.
[in]	values	Initializer list with values to be copied.

返回

Element pointer or OutOfMemoryError if the allocation failed (or position is out of boundaries).

◆  Insert() [9/10]

Inserts new elements at iterator position (all elements from position on are moved by the the count of values ).

参数

[in]	position	Insert position.
[in]	values	Block with values to be copied. If the block points to nullptr, only its count is used, and you have to call the constructor of the new elements manually.

返回

Iterator for the new element or OutOfMemoryError if the allocation failed (or position is out of boundaries).

◆  Insert() [10/10]

Inserts new elements at iterator position (all elements from position on are moved by the the count of values ).

参数

[in]	position	Insert position.
[in]	values	Initializer list with values to be copied.

返回

Iterator for the new element or OutOfMemoryError if the allocation failed (or position is out of boundaries).

◆  Erase() [1/3]

Erases (removes and deletes) elements. Use the iterator based Erase() below! This is compatible to the arrays but slow because Erase() has to iterate over the list.

参数

[in]	position	Erase index ( Erase() will fail if out of bounds and return nullptr).
[in]	eraseCnt	Number of elements to be erased. If eraseCnt is invalid (higher than allowed or negative) a nullptr will be returned.

返回

Pointer to the element that is now at position. If position equals the number of elements after Erase() a valid pointer is returned but you are not allowed to access it. OutOfMemoryError is only returned on failure (position was out of bounds).

◆  Erase() [2/3]

Erases (removes and deletes) elements.

参数

[in]	position	Erase position.
[in]	eraseCnt	Number of elements to be erased. If eraseCnt is invalid (higher than allowed or negative) an invalid iterator will be returned.

返回

Iterator for the element that is now at position (its operator Bool() will return false if something failed).

◆  Erase() [3/3]

Erases (removes and deletes) an element.

参数

[in]

position

Erase position.

返回

Iterator for the element that is now at position (its operator Bool() will return false if something failed).

◆  SwapErase() [1/2]

For a list this is exactly the same as Erase() .

参数

[in]	position	Erase index ( Erase() will fail if out of bounds and return nullptr).
[in]	eraseCnt	Number of elements to be erased. If eraseCnt is invalid (higher than allowed or negative) false will be returned.

返回

False if position was out of bounds.

◆  SwapErase() [2/2]

For a list this is exactly the same as Erase() .

参数

[in]	position	Erase position.
[in]	eraseCnt	Number of elements to be erased. If eraseCnt is invalid (higher than allowed or negative) an invalid iterator will be returned.

返回

Iterator for the element that is now at position (its operator Bool() will return false if something failed).

◆  GetBlock() [1/4]

Determines a contiguous block of array elements which contains the element at position . For a BaseArray , this yields the whole array as a block.

参数

[in]	position	Element position.
[out]	block	Block which contains the element at position .

返回

Start iterator of the block. The requested element can be found within the block at index position - start iterator.

◆  GetBlock() [2/4]

Determines a contiguous block of array elements which contains the element at position . For a BaseArray , this yields the whole array as a block.

参数

[in]	position	Element position.
[out]	block	Block which contains the element at position .

返回

Start iterator of the block. The requested element can be found within the block at index position - start iterator.

◆  GetBlock() [3/4]

Determines a contiguous block of array elements which contains the element at position . For a BaseArray , this yields the whole array as a block.

参数

[in]	position	Element index.
[out]	block	Block which contains the element at position .

返回

Start index of the block. The requested element can be found within the block at position - start index.

◆  GetBlock() [4/4]

Determines a contiguous block of array elements which contains the element at position . For a BaseArray , this yields the whole array as a block.

参数

[in]	position	Element index.
[out]	block	Block which contains the element at position .

返回

Start index of the block. The requested element can be found within the block at position - start index.

◆  Resize()

Resizes the list to contain newCnt elements. If newCnt is smaller than GetCount() all extra elements are being deleted. If it is greater the list is expanded and the default constructor is called for new elements.

参数

[in]	newCnt	New list size.
[in]	resizeFlags	See COLLECTION_RESIZE_FLAGS (flags other than ON_GROW_UNINITIALIZED/POD_UNINITIALIZED result in default behaviour).

返回

False if allocation failed.

◆  Pop()

Deletes the last element.

参数

[out]

dst

Nullptr or pointer to return value.

返回

True if there was at least one element.

◆  PopNode()

BaseList specific: Removes the last node and returns the pointer to it.

参数

[out]

dst

Used to return pointer to the last node (must not be null), the caller will take ownership of the node.

返回

True if successful.

◆  GetIndex()

Gets the index of element. The element must be part of the list, otherwise (e.g. if x is a copy of a list element) InvalidArrayIndex will be returned. This is compatible to the arrays but slow because GetIndex() has to iterate over the list.

返回

Index of element or InvalidArrayIndex (not element of this).

◆  RemoveNode() [1/2]

BaseList specific: Removes the node and returns a pointer to it.

参数

[in]

position

Position of the element to be removed.

返回

Node pointer or null, the caller will take ownership of it.

◆  RemoveNode() [2/2]

BaseList specific: Removes the node and returns a pointer to it.

参数

[in]

x

The element to be removed.

返回

Node pointer or null, the caller will take ownership of it.

◆  CopyFrom()

Copies an array or list.

参数

[in]

src

Source list or array.

返回

OK on success.

◆  Swap()

Swaps elements a and b (just changes the pointers, more efficient than global Swap(list[a], list[b]).

参数

[in]	a	Position of element to be swapped.
[in]	b	Position of element to be swapped.

◆  GetMemorySize()

Calculates the memory usage for this array. The array element class must have a public member GetMemorySize that returns an element's size.

返回

Memory size in bytes.

◆  Begin() [1/2]

Gets an iterator for the first element. When you modify the list Begin() will change, it is not a constant value.

返回

Iterator for the first element (equal to End() if the list is empty).

◆  Begin() [2/2]

Gets an iterator for the first element. When you modify the list Begin() will change, it is not a constant value.

返回

Iterator for the first element (equal to End() if the list is empty).

◆  End() [1/2]

Gets an iterator for the end ( End() - 1 is the last element if the list is not empty). For the BaseList End() is in fact a constant value, it won't change even if you insert or remove elements. That's different from all arrays (where End() will change when you modify the array).

返回

Iterator for the list end (this is behind the last element).

◆  End() [2/2]

Gets an iterator for the end ( End() - 1 is the last element if the list is not empty). For the BaseList End() is in fact a constant value, it won't change even if you insert or remove elements. That's different from all arrays (where End() will change when you modify the array).

返回

Iterator for the list end (this is behind the last element).

◆  GetAllocator()

Returns the allocator as reference. Typically this is used by the arrays and other base classes when multiple of them are "stiched" together as one big object all shall use one main allocator.

返回

Allocator reference.

◆  AllocNode()

◆  DeleteNode()

Member Data Documentation

◆  _head

• maxon
• BaseList