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

---

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

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

SortedArray< MYSELF, ARRAY, FLAGS, PARALLEL > Class Template Reference Data Structures

#include <sortedarray.h>

Inheritance diagram for SortedArray< MYSELF, ARRAY, FLAGS, PARALLEL >:

[ legend ]

详细描述

template<typename MYSELF, typename ARRAY, BASESORTFLAGS FLAGS = BASESORTFLAGS::NONE, Bool PARALLEL = false>
class maxon::SortedArray< MYSELF, ARRAY, FLAGS, PARALLEL >

Sorted array. The class can be combined with any standard array type. Sorting is done on first read access, e.g. if you access the array by using the index operator. Note that sorted arrays will be extremely slow if read and write access is constantly alternating, as for every write access a sort needs to be done, which needs O(log n) time. In those cases other datastructures will be better suited. Please also take into consideration that sorted arrays are not thread-safe, even for read-access unless you call Sort() once before multiple threads start reading the data (if the array was in a non-sorted state the first read-access will sort it otherwise, which will obviously cause problems)

If the data type to be sorted is unknown to DefaultCompare you should inherit from SortedArray and define a LessThan() 和 IsEqual() method for comparison of elements. For example:

class MySortedArray : public SortedArray <MySortedArray, BaseArray<MyType>> { public : static Bool LessThan ( const MyType& a, const MyType& b) { return a < b; } static Bool IsEqual ( const MyType& a, const MyType& b) { return a == b; } }; MySortedArray a; a.Append(x) iferr_return ; a.Append(y) iferr_return ;

注意

Note that the classes that will be sorted have special requirements regarding copy and move constructors .

Note that the comparison must fulfill the condition (a < b) == !(b < a). If this is not the case the sort algorithm will crash. To avoid mistakes when comparing tuples use LexicographicalCompare.

Template Parameters

MYSELF	The class itself.
ARRAY	The used array, e.g. BaseArray , BlockArray or PointerArray .
FLAGS	See BASESORTFLAGS, normally can be left at default.
PARALLEL	Use parallel sorting, for details see parallelsort.h .

注意

Note that the array element class has special requirements regarding copy and move constructors .

Public Types
using	TYPE = typename ARRAY::ValueType
using	Iterator = typename ARRAY::Iterator
using	ConstIterator = typename ARRAY::ConstIterator
Public Types inherited from Collection< SortedArray< MYSELF, ARRAY, BASESORTFLAGS::NONE, false >, ARRAY::ValueType, EmptyClass >
using	Super = BaseCollection < SortedArray < MYSELF, ARRAY , BASESORTFLAGS::NONE, false >, EmptyClass >
using	ValueType = ARRAY::ValueType
Public Types inherited from BaseCollection< SortedArray< MYSELF, ARRAY, BASESORTFLAGS::NONE, false >, EmptyClass >
using	IsCollection = std::true_type

公共成员函数
	SortedArray ()
	SortedArray (const typename ARRAY::AllocatorType &a)
	~SortedArray ()
	SortedArray ( SortedArray && src )
	MAXON_OPERATOR_MOVE_ASSIGNMENT ( SortedArray )
void	重置 ()
void	Flush ()
ResultMem	SetCapacityHint ( Int requestedCapacity, COLLECTION_RESIZE_FLAGS resizeFlags= COLLECTION_RESIZE_FLAGS::ON_GROW_RESERVE_CAPACITY )
Int	GetCount () const
Int	GetCapacityCount () const
const TYPE &	operator[] ( Int idx) const
ResultRef < TYPE >	Append ()
ResultRef < TYPE >	Append (const TYPE &x)
ResultRef < TYPE >	Append ( TYPE &&x)
ResultPtr < TYPE >	AppendPtr ( TYPE *x)
Bool	PopPtr ( TYPE **dst)
ResultRef < TYPE >	Insert ( Int position)
ResultPtr < TYPE >	InsertPtr ( Int position, TYPE *x)
ResultMemT < Iterator >	Insert ( Iterator position)
ResultRef < TYPE >	Insert ( Int position, const TYPE &x)
ResultMemT < Iterator >	Insert ( Iterator position, const TYPE &x)
ResultRef < TYPE >	Insert ( Int position, TYPE &&x)
ResultMemT < Iterator >	Insert ( Iterator position, TYPE &&x)
ResultPtr < TYPE >	Insert ( Int position, const Block < const TYPE > &values)
ResultMemT < Iterator >	Insert ( Iterator position, const Block < const TYPE > &values)
ResultPtr < TYPE >	Erase ( Int position, Int eraseCnt=1)
ResultPtr < TYPE >	ErasePtr ( Int position, TYPE **dst)
ResultMem	SwapErase ( Int position, Int eraseCnt=1)
Iterator	SwapErase ( Iterator position, Int eraseCnt=1)
template<Bool STRIDED>
Int	GetBlock ( Int position, Block < TYPE , STRIDED > &block)
template<Bool STRIDED>
Int	GetBlock ( Int position, Block < const TYPE , STRIDED > &block) const
Iterator	Erase ( Iterator position, Int eraseCnt=1)
template<typename SEARCH >
Bool	EraseKey (const SEARCH &key)
const TYPE *	GetFirst () const
TYPE *	GetFirst ()
const TYPE *	GetLast () const
TYPE *	GetLast ()
ResultMem	Resize ( Int newCnt, COLLECTION_RESIZE_FLAGS resizeFlags= COLLECTION_RESIZE_FLAGS::DEFAULT )
Bool	Pop ( TYPE *dst=nullptr)
Int	GetIndex (const TYPE &x) const
Result < void >	CopyFrom (const SortedArray & src )
template<typename COLLECTION2 , typename = typename std::enable_if<!STD_IS_REPLACEMENT(same, typename std::decay<COLLECTION2>::type, SortedArray)>::type>
Result < void >	CopyFrom (COLLECTION2 &&other)
void	Swap ( Iterator a, Iterator b)
Int	GetMemorySize () const
ConstIterator	Begin () const
Iterator	Begin ()
ConstIterator	End () const
Iterator	End ()
void	SortChanged ()
void	Sort ()
template<typename SEARCH >
TYPE *	FindValue (const SEARCH &key)
template<typename SEARCH >
const TYPE *	FindValue (const SEARCH &key) const
template<typename SEARCH >
Int	FindIndex (const SEARCH &key) const
template<typename SEARCH >
ResultRef < TYPE >	InsertValue (const SEARCH &key)
template<typename SEARCH >
ResultRef < TYPE >	InsertValue (const SEARCH &key, Bool &newElement, Int *index=nullptr)
ARRAY &	GetUnderlyingArray ()
const ARRAY &	GetUnderlyingArray () const
Public Member Functions inherited from ArrayBase< SortedArray< MYSELF, ARRAY, BASESORTFLAGS::NONE, false >, ARRAY::ValueType, EmptyClass, MYSELF >
MAXON_ATTRIBUTE_FORCE_INLINE	ArrayBase (ARGS &&... args)
ArrayImpl < SortedArray < MYSELF, ARRAY , BASESORTFLAGS::NONE, false > & >	ToArray ()
ArrayImpl < const SortedArray < MYSELF, ARRAY , BASESORTFLAGS::NONE, false > & >	ToArray () const
MAXON_ATTRIBUTE_FORCE_INLINE	operator ArrayImpl< SortedArray< MYSELF, ARRAY, BASESORTFLAGS::NONE, false > & > ()
MAXON_ATTRIBUTE_FORCE_INLINE	operator ArrayImpl< const SortedArray< MYSELF, ARRAY, BASESORTFLAGS::NONE, false > & > () const
Public Member Functions inherited from ArrayBase0< SortedArray< MYSELF, ARRAY, BASESORTFLAGS::NONE, false >, ARRAY::ValueType, EmptyClass, MYSELF >
MAXON_ATTRIBUTE_FORCE_INLINE	ArrayBase0 (ARGS &&... args)
Bool	IsValidIndex ( Int index) const
Result < void >	CheckValidIndex ( Int index) const
Int	FindIndex (typename ByValueParam < ARRAY::ValueType >:: type v, Int start) const
Int	FindLastIndex (typename ByValueParam < ARRAY::ValueType >:: type v) const
Int	FindLastIndex (typename ByValueParam < ARRAY::ValueType >:: type v, Int start) const
Bool	EraseFirst (typename ByValueParam < ARRAY::ValueType >:: type v)
Int	EraseAll (typename ByValueParam < ARRAY::ValueType >:: type v)
Result < void >	AppendAllImpl (COLLECTION2 &&other, COLLECTION_RESIZE_FLAGS resizeFlags, Bool overwrite, OverloadRank0 )
Result < void >	InsertAll ( Int index, COLLECTION2 &&other, COLLECTION_RESIZE_FLAGS resizeFlags= COLLECTION_RESIZE_FLAGS::ON_GROW_RESERVE_CAPACITY )
Result < void >	添加 (COLLECTION2 &&other, COLLECTION_RESIZE_FLAGS resizeFlags= COLLECTION_RESIZE_FLAGS::ON_GROW_RESERVE_CAPACITY )
Result < void >	SubtractImpl (COLLECTION2 &&other, OverloadRank0 )
Bool	IsEqualImpl (const COLLECTION2 &other, COMPARE &&cmp, OverloadRank0 ) const
HashInt	GetHashCode () const
MAXON_ATTRIBUTE_FORCE_INLINE AutoIterator < SortedArray < MYSELF, ARRAY , BASESORTFLAGS::NONE, false > >	切片 ( Int start)
MAXON_ATTRIBUTE_FORCE_INLINE AutoIterator < const SortedArray < MYSELF, ARRAY , BASESORTFLAGS::NONE, false > >	切片 ( Int start) const
MAXON_ATTRIBUTE_FORCE_INLINE AutoIterator < SortedArray < MYSELF, ARRAY , BASESORTFLAGS::NONE, false > >	切片 ( Int start, Int end)
MAXON_ATTRIBUTE_FORCE_INLINE AutoIterator < const SortedArray < MYSELF, ARRAY , BASESORTFLAGS::NONE, false > >	切片 ( Int start, Int end) const
BlockIterator < SortedArray < MYSELF, ARRAY , BASESORTFLAGS::NONE, false >, ARRAY::ValueType, false, false >	GetBlocks ()
BlockIterator < SortedArray < MYSELF, ARRAY , BASESORTFLAGS::NONE, false >, ARRAY::ValueType, true, false >	GetBlocks () const
BlockIterator < SortedArray < MYSELF, ARRAY , BASESORTFLAGS::NONE, false >, ARRAY::ValueType, false, true >	GetStridedBlocks ()
BlockIterator < SortedArray < MYSELF, ARRAY , BASESORTFLAGS::NONE, false >, ARRAY::ValueType, true, true >	GetStridedBlocks () const
Public Member Functions inherited from Collection< SortedArray< MYSELF, ARRAY, BASESORTFLAGS::NONE, false >, ARRAY::ValueType, EmptyClass >
MAXON_ATTRIBUTE_FORCE_INLINE	Collection (ARGS &&... args)
ResultOk < void >	VariadicAppend ()
Result < void >	VariadicAppend (V &&value, VALUES &&... rest)
	operator ValueReceiver< const ARRAY::ValueType & > ()
	operator ValueReceiver< ARRAY::ValueType && > ()
	operator ValueReceiver< typename std::conditional< STD_IS_REPLACEMENT (scalar, ARRAY::ValueType)
DummyParamType &	type ()
Result < Bool >	ForEach (FN &&callback) const
Result < Bool >	ForEach (FN &&callback)
H::Iterator	Find (typename ByValueParam < ARRAY::ValueType >:: type v)
H::ConstIterator	Find (typename ByValueParam < ARRAY::ValueType >:: type v) const
Int	FindIndex (typename ByValueParam < ARRAY::ValueType >:: type v) const
MAXON_ATTRIBUTE_FORCE_INLINE Bool	Contains (typename ByValueParam < ARRAY::ValueType >:: type v) const
Public Member Functions inherited from BaseCollection< SortedArray< MYSELF, ARRAY, BASESORTFLAGS::NONE, false >, EmptyClass >
MAXON_ATTRIBUTE_FORCE_INLINE	BaseCollection (ARGS &&... args)
MAXON_ATTRIBUTE_FORCE_INLINE std::enable_if< maxon::IsCollection< COLLECTION2 >::value, Bool >::type	operator== (const COLLECTION2 &other) const
MAXON_ATTRIBUTE_FORCE_INLINE std::enable_if< maxon::IsCollection< COLLECTION2 >::value, Bool >::type	operator!= (const COLLECTION2 &other) const
MAXON_ATTRIBUTE_FORCE_INLINE std::enable_if< maxon::IsCollection< COLLECTION2 >::value &&! STD_IS_REPLACEMENT (same, typename std::decay< COMPARE >::type, EQUALITY ), Bool >::type	IsEqual (const COLLECTION2 &other, COMPARE &&cmp=COMPARE()) const
MAXON_ATTRIBUTE_FORCE_INLINE Result < void >	AppendAll (COLLECTION2 &&other, COLLECTION_RESIZE_FLAGS resizeFlags= COLLECTION_RESIZE_FLAGS::ON_GROW_RESERVE_CAPACITY )
MAXON_ATTRIBUTE_FORCE_INLINE Result < void >	CopyFrom (COLLECTION2 &&other, COLLECTION_RESIZE_FLAGS resizeFlags= COLLECTION_RESIZE_FLAGS::FIT_TO_SIZE )
MAXON_ATTRIBUTE_FORCE_INLINE Result < void >	Subtract (COLLECTION2 &&other)
MAXON_ATTRIBUTE_FORCE_INLINE Result < void >	Intersect (const COLLECTION2 &other)
Bool	Intersects (const COLLECTION2 &other) const
MAXON_ATTRIBUTE_FORCE_INLINE Result < void >	CopyFromImpl (COLLECTION2 &&other, COLLECTION_RESIZE_FLAGS resizeFlags, OverloadRank0 )
Result < void >	AppendAllImpl (COLLECTION2 &&other, COLLECTION_RESIZE_FLAGS resizeFlags, Bool overwrite, OverloadRank0 )
Result < void >	IntersectImpl (COLLECTION2 &&other, OverloadRank0 )
MAXON_ATTRIBUTE_FORCE_INLINE Bool	IsEmpty () const
MAXON_ATTRIBUTE_FORCE_INLINE Bool	IsPopulated () const
String	ToString (const FormatStatement *formatStatement=nullptr) const
MAXON_ATTRIBUTE_FORCE_INLINE Bool	ContainsAll (COLLECTION2 &&other) const
Bool	ContainsAllImpl (COLLECTION2 &&other, OverloadRank0 ) const

Additional Inherited Members
Static Public Member Functions inherited from Collection< SortedArray< MYSELF, ARRAY, BASESORTFLAGS::NONE, false >, ARRAY::ValueType, EmptyClass >
static const ARRAY::ValueType &	GetMapKey (const ARRAY::ValueType &key)
Public Attributes inherited from Collection< SortedArray< MYSELF, ARRAY, BASESORTFLAGS::NONE, false >, ARRAY::ValueType, EmptyClass >
	VALUETYPE
Static Public Attributes inherited from ArrayBase0< SortedArray< MYSELF, ARRAY, BASESORTFLAGS::NONE, false >, ARRAY::ValueType, EmptyClass, MYSELF >
static const COLLECTION_KIND	KIND

Member Typedef Documentation

◆  TYPE

◆  Iterator

The SortedArray iterator is just a type alias for the underlying array's iterator. This means that using the iterator to access array elements will not sort the array or mark it as being modified.

◆  ConstIterator

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

◆  SortedArray() [1/3]

Default constructor. Creates an empty arry.

◆  SortedArray() [2/3]

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

◆  ~SortedArray()

Destructs the array with all its elements.

◆  SortedArray() [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, but doesn't free memory (calls destructors though).

◆  SetCapacityHint()

Prepares the internal buffer(s) to hold at least the given number of elements with as few further memory allocations as possible.

注意

This is just a hint. It does not guarantee that the collection will be able to store the number of indicated elements.

参数

[in]	requestedCapacity	The desired internal capacity.
[in]	resizeFlags	If ON_GROW_FIT_TO_SIZE is set, the collection will use only as much memory as needed to hold the data.

返回

False if allocation failed.

◆  GetCount()

Gets the number of array elements.

返回

Number of array elements.

◆  GetCapacityCount()

Gets the number of elements for which memory has been allocated (this is usually bigger than GetCount() ).

返回

Number of array elements for which memory has been allocated.

◆  operator[]()

Array (subscript) operator for const objects.

参数

[in]

idx

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

返回

Array element.

◆  Append() [1/3]

Adds a new element at the end of the array.

返回

Element pointer or OutOfMemoryError if the allocation failed.

◆  Append() [2/3]

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

参数

[in]

x

Value to be copied.

返回

Element pointer or OutOfMemoryError if the allocation failed.

◆  Append() [3/3]

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

参数

[in]

x

Value to be moved.

返回

Element pointer or OutOfMemoryError if the allocation failed.

◆  AppendPtr()

PointerArray specific: Adds a pointer to the new element at the end of the array.

参数

[in]

x

Pointer to new element ( SortedArray will take ownership of it).

返回

Element pointer or OutOfMemoryError if the allocation failed.

◆  PopPtr()

PointerArray specific: Removes the last element and returns the pointer.

参数

[out]

dst

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

返回

True if successful.

◆  Insert() [1/8]

Inserts a new default element at index position.

参数

[in]

position

Insert index (the array size will increase and the existing elements are moved).

返回

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

◆  InsertPtr()

PointerArray specific: Inserts a pointer to a new element at index position.

参数

[in]	position	Insert index (the array size will increase and the existing elements are moved).
[in]	x	Pointer to new element ( SortedArray will take ownership of it).

返回

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

◆  Insert() [2/8]

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 is out of boundaries).

◆  Insert() [3/8]

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

参数

[in]	position	Insert index (the array size will increase and the existing elements are moved).
[in]	x	Value to be copied.

返回

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

◆  Insert() [4/8]

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/8]

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

参数

[in]	position	Insert index (the array size will increase and the existing elements are moved).
[in]	x	Value to be moved.

返回

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

◆  Insert() [6/8]

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).

◆  Insert() [7/8]

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

参数

[in]	position	Insert index (the array size will increase and the existing elements are moved).
[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/8]

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).

◆  Erase() [1/2]

Erases (removes and deletes) elements.

参数

[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).

◆  ErasePtr()

PointerArray specific: Extracts a single element from the list and returns its pointer. The caller takes ownership of the element.

参数

[in]	position	Erase index ( Erase() will fail if out of bounds and return nullptr).
[in,out]	dst	Used to return pointer to the erased element (must not be null).

返回

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

◆  SwapErase() [1/2]

Erases elements within the array. For sorted arrays this is identical to the Erase function.

参数

[in]	position	Erase position.
[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]

Erases elements within the array. For sorted arrays this is identical to the Erase function.

参数

[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/2]

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

参数

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

返回

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

◆  GetBlock() [2/2]

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.

◆  Erase() [2/2]

Erases (removes and deletes) elements.

参数

[in]	position	Erase position.
[in]	eraseCnt	Number of elements to be erased (if eraseCnt is higher than what is available at position Erase() will succeed, but remove only the number of available elements).

返回

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

◆  EraseKey()

Erases (remove and delete) an element.

参数

[in]

key

The key that the array is searched for.

返回

True if key was found.

◆  GetFirst() [1/2]

Returns the first element of the array.

返回

Pointer to the first element (nullptr if the array is empty).

◆  GetFirst() [2/2]

Returns the first element of the array.

返回

Pointer to the first element (nullptr if the array is empty).

◆  GetLast() [1/2]

Returns the last element of the array.

返回

Pointer to the last element (nullptr if the array is empty).

◆  GetLast() [2/2]

Returns the last element of the array.

返回

Pointer to the last element (nullptr if the array is empty).

◆  Resize()

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

参数

[in]	newCnt	New array size.
[in]	resizeFlags	See COLLECTION_RESIZE_FLAGS (support depends on the inherited array).

返回

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.

◆  GetIndex()

Gets the index of the element. The element must be part of the array, otherwise (e.g. if x is a copy of an array element) InvalidArrayIndex will be returned.

返回

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

◆  CopyFrom() [1/2]

Copies an array.

参数

[in]

src

Source array.

返回

OK on success.

◆  CopyFrom() [2/2]

Makes this collection a copy of other . If copying doesn't succeed for all entries, the collection will be left in a valid, but intermediate state with only some entries from other added.

参数

[in]	other	Another collection, may be any iterable object.
[in]	resizeFlags	If ON_GROW_FIT_TO_SIZE is set, the collection will use only as much memory as needed to hold the data.

返回

OK on success.

◆  Swap()

Swaps elements a and b (equivalent to global Swap(array[a], array[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 array Begin() will change, it is not a constant value.

返回

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

◆  Begin() [2/2]

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

返回

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

◆  End() [1/2]

Gets an iterator for the end ( End() - 1 is the last element if the array is not empty). When you modify the array End() will change, it is not a constant value.

返回

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

◆  End() [2/2]

Gets an iterator for the end ( End() - 1 is the last element if the array is not empty). When you modify the array End() will change, it is not a constant value.

返回

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

◆  SortChanged()

Marks the array as non-sorted. Sorting will happen upon the next read access.

◆  Sort()

Manually sorts the array.

◆  FindValue() [1/2]

Finds an element in an array. The time for searching will be O(log(n)).

参数

[in]

key

The key that the array is searched for.

返回

If an element is found a pointer to it will be returned, otherwise the result is nullptr. If multiple elements have the same key value the first of those elements will be returned.

◆  FindValue() [2/2]

Finds an element in an array. The time for searching will be O(log(n)).

参数

[in]

key

The key that the array is searched for.

返回

If an element is found a pointer to it will be returned, otherwise the result is nullptr. If multiple elements have the same key value the first of those elements will be returned.

◆  FindIndex()

Finds the index of an element in an array. The time for searching will be O(log(n)).

参数

[in]

key

The key that the array is searched for.

返回

If an element is found its index will be returned, otherwise the result is the bitwise inverse of the index where key would be inserted (which is always negative). If multiple elements have the same key value the index of the first of those elements will be returned.

◆  InsertValue() [1/2]

Finds an element in an array or insert it if it was not found. The time for this operation will be O(log(n)) for searching plus O(n) for inserting. Keep in mind that the resulting pointer will only be valid right after the operation as any additional array operation might shuffle array indices. To use this routine the SortedArray class must define the following member:

参数

[in]

key

The key that the array is searched for.

返回

Element reference or OutOfMemoryError if the allocation failed.

◆  InsertValue() [2/2]

Finds an element in an array or insert it if it was not found. The time for this operation will be O(log(n)) for searching plus O(n) for inserting. Keep in mind that the resulting pointer will only be valid right after the operation as any additional array operation might shuffle array indices. The value should be filled right after the function returns. InitInsertData is not being called.

参数

[in]	key	The key that the array is searched for.
[out]	newElement	Specifies if the element was newly inserted (true) or if it was found in the array (false)
[out]	index	The index of the found or inserted element. May be nullptr.

返回

Element reference or OutOfMemoryError if the allocation failed.

◆  GetUnderlyingArray() [1/2]

Returns the underlying array.

返回

Underlying array.

◆  GetUnderlyingArray() [2/2]

Returns the underlying array.

返回

Underlying array.

◆  CheckSort()

Member Data Documentation

◆  _array

◆  _sorted

• maxon
• SortedArray