TSlateElementSortedArray< InElementType, InSortPredicate > Class Template Reference

#include <SlateElementSortedArray.h>

Public Types
using	SizeType = typename DataType::SizeType
using	ElementType = InElementType
using	ElementParamType = typename TCallTraits< ElementType >::ParamType
using	SortPredicate = TLess<>
using	RangedForConstIteratorType = typename DataType::RangedForConstIteratorType

Public Member Functions
FORCEINLINE ElementParamType	operator[] (SizeType Index) const
FORCEINLINE void	Empty (SizeType ExpectedNumElements=0)
FORCEINLINE bool	IsValidIndex (SizeType Index) const
FORCEINLINE SizeType	Num () const
SizeType	Find (ElementParamType Item) const
bool	Contains (ElementParamType Item) const
SizeType	FindLowerBound (ElementParamType Value) const
SizeType	FindUpperBound (ElementParamType Value) const
SizeType	InsertUnique (ElementParamType Item)
FORCEINLINE SizeType	AddUnsorted (ElementType Item)
SizeType	RemoveSingle (ElementParamType Item)
template<typename CountType >
FORCEINLINE void	RemoveAt (SizeType Index, CountType Count)
void	Sort ()
FORCEINLINE RangedForConstIteratorType	begin () const
FORCEINLINE RangedForConstIteratorType	end () const

Detailed Description

template<typename InElementType, typename InSortPredicate = TLess<>>
class TSlateElementSortedArray< InElementType, InSortPredicate >

An Array of elements that are always sorted.

Member Typedef Documentation

ElementParamType

template<typename InElementType , typename InSortPredicate = TLess<>>

using TSlateElementSortedArray< InElementType, InSortPredicate >::ElementParamType = typename TCallTraits<ElementType>::ParamType

ElementType

template<typename InElementType , typename InSortPredicate = TLess<>>

using TSlateElementSortedArray< InElementType, InSortPredicate >::ElementType = InElementType

RangedForConstIteratorType

template<typename InElementType , typename InSortPredicate = TLess<>>

using TSlateElementSortedArray< InElementType, InSortPredicate >::RangedForConstIteratorType = typename DataType::RangedForConstIteratorType

DO NOT USE DIRECTLY STL-like iterators to enable range-based for loop support.

SizeType

template<typename InElementType , typename InSortPredicate = TLess<>>

using TSlateElementSortedArray< InElementType, InSortPredicate >::SizeType = typename DataType::SizeType

SortPredicate

template<typename InElementType , typename InSortPredicate = TLess<>>

using TSlateElementSortedArray< InElementType, InSortPredicate >::SortPredicate = TLess<>

Member Function Documentation

AddUnsorted()

template<typename InElementType , typename InSortPredicate = TLess<>>

FORCEINLINE SizeType TSlateElementSortedArray< InElementType, InSortPredicate >::AddUnsorted ( ElementType  Item )

inline

Adds a new item to the end of the array. The array needs to be sorted manually after. Use when multiple insertion is needed and it would be faster to sort the array once.

Parameters

Item	The item to add

Returns

Index to the new item

begin()

template<typename InElementType , typename InSortPredicate = TLess<>>

FORCEINLINE RangedForConstIteratorType TSlateElementSortedArray< InElementType, InSortPredicate >::begin ( ) const

inline

Contains()

template<typename InElementType , typename InSortPredicate = TLess<>>

bool TSlateElementSortedArray< InElementType, InSortPredicate >::Contains ( ElementParamType  Item ) const

inline

Checks if this array contains the element.

Parameters

Item	Item to look for.

Returns

True if found. False otherwise.

Empty()

template<typename InElementType , typename InSortPredicate = TLess<>>

FORCEINLINE void TSlateElementSortedArray< InElementType, InSortPredicate >::Empty ( SizeType  ExpectedNumElements = 0 )

inline

Removes all elements from the array, potentially leaving space allocated for an expected number of elements about to be added.

end()

template<typename InElementType , typename InSortPredicate = TLess<>>

FORCEINLINE RangedForConstIteratorType TSlateElementSortedArray< InElementType, InSortPredicate >::end ( ) const

inline

Find()

template<typename InElementType , typename InSortPredicate = TLess<>>

SizeType TSlateElementSortedArray< InElementType, InSortPredicate >::Find ( ElementParamType  Item ) const

inline

Binary searches the element within the array.

Parameters

Item	Item to look for.

Returns

Index of the found element. INDEX_NONE otherwise.

FindLowerBound()

template<typename InElementType , typename InSortPredicate = TLess<>>

SizeType TSlateElementSortedArray< InElementType, InSortPredicate >::FindLowerBound ( ElementParamType  Value ) const

inline

Returns

the index of the first element >= value, or INDEX_NONE if no such element is found.

FindUpperBound()

template<typename InElementType , typename InSortPredicate = TLess<>>

SizeType TSlateElementSortedArray< InElementType, InSortPredicate >::FindUpperBound ( ElementParamType  Value ) const

inline

Returns

the index of the first element > value, or INDEX_NONE if no such element if found.

InsertUnique()

template<typename InElementType , typename InSortPredicate = TLess<>>

SizeType TSlateElementSortedArray< InElementType, InSortPredicate >::InsertUnique ( ElementParamType  Item )

inline

Adds a new item to the array at the sorted location if it doesn't exist, possibly reallocating the whole array to fit.

Parameters

Item	The item to add

Returns

Index to the new item

IsValidIndex()

template<typename InElementType , typename InSortPredicate = TLess<>>

FORCEINLINE bool TSlateElementSortedArray< InElementType, InSortPredicate >::IsValidIndex ( SizeType  Index ) const

inline

Returns

True if index is valid. False otherwise.

Num()

template<typename InElementType , typename InSortPredicate = TLess<>>

FORCEINLINE SizeType TSlateElementSortedArray< InElementType, InSortPredicate >::Num ( ) const

inline

Returns

The number of elements in the array.

operator[]()

template<typename InElementType , typename InSortPredicate = TLess<>>

FORCEINLINE ElementParamType TSlateElementSortedArray< InElementType, InSortPredicate >::operator[] ( SizeType  Index ) const

inline

Returns

Reference to indexed element.

RemoveAt()

template<typename InElementType , typename InSortPredicate = TLess<>>

template<typename CountType >

FORCEINLINE void TSlateElementSortedArray< InElementType, InSortPredicate >::RemoveAt ( SizeType  Index, CountType  Count  )

inline

Removes an element (or elements) at given location optionally shrinking the array.

Parameters

Index	Location in array of the element to remove.
Count	(Optional) Number of elements to remove. Default is 1.
bAllowShrinking	(Optional) Tells if this call can shrink array if suitable after remove. Default is true.

RemoveSingle()

template<typename InElementType , typename InSortPredicate = TLess<>>

SizeType TSlateElementSortedArray< InElementType, InSortPredicate >::RemoveSingle ( ElementParamType  Item )

inline

Removes the first occurrence of the specified item in the array, maintaining order but not indices.

Parameters

Item	The item to remove.

Returns

The number of items removed. For RemoveSingle, this is always either 0 or 1.

Sort()

template<typename InElementType , typename InSortPredicate = TLess<>>

void TSlateElementSortedArray< InElementType, InSortPredicate >::Sort ( )

inline

Sorts the array using the SortPredicate.

---

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

• Engine/Source/Runtime/SlateCore/Private/FastUpdate/SlateElementSortedArray.h