TArrayG

Templated dynamic array

API > API/Runtime > API/Runtime/uLangCore > API/Runtime/uLangCore/uLang > API/Runtime/uLangCore/uLang/Common > API/Runtime/uLangCore/uLang/Common/Containers

References

   
Module uLangCore
Header /Engine/Source/Runtime/Solaris/uLangCore/Public/uLang/Common/Containers/Array.h
Include #include "uLang/Common/Containers/Array.h"

Syntax

template<typename InElementType, typename InElementAllocatorType, typename... RawAllocatorArgsType>  
class TArrayG

Remarks

Templated dynamic array

A dynamically sized array of typed elements. Makes the assumption that your elements are relocate-able; i.e. that they can be transparently moved to new memory without a copy constructor. The main implication is that pointers to elements in the TArrayG may be invalidated by adding or removing other elements to the array. Removal of elements is O(N) and invalidates the indices of subsequent elements.

Caution: as noted below some methods are not safe for element types that require constructors.

Variables

  Type Name Description
Protected variable int32_t _ArrayMax  
Protected variable int32_t _ArrayNum  
Protected variable ElementStorageType _ElementStorage  

Constructors

  Type Name Description
Public function ULANG_FORCEINLINE

TArrayG ( RawAllocatorArgsType&&... RawAllocatorArgs
)

 Constructor with given raw allocator arguments (none required for heap allocator).
Public function  

TArrayG ( TArrayG&& Other,
int32_t ExtraSlack
)

 Move constructor.
Public function ULANG_FORCEINLINE

TArrayG ( const ElementType* Ptr,
int32_t Count,
RawAllocatorArgsType&&... RawAllocatorArgs
)

 Constructor from a raw array of elements.
Public function ULANG_FORCEINLINE

TArrayG ( int32_t Count,
const ElementType& Value,
RawAllocatorArgsType&&... RawAllocatorArgs
)

  
Public function ULANG_FORCEINLINE

TArrayG ( const typename ElementAllocatorType::RawAllocatorType& RawAllocator
)

 Constructor with given raw allocator.
Public function ULANG_FORCEINLINE

TArrayG ( const TArrayG& Other
)

 Copy constructor. Use the common routine to perform the copy.
Public function ULANG_FORCEINLINE

TArrayG ( TArrayG&& Other
)

 Move constructor.
Public function ULANG_FORCEINLINE

TArrayG ( TArrayG< ElementType, OtherElementAllocatorType, OtherRawAllocatorArgsType... >&& Other
)

 Move constructor.
Public function  

TArrayG ( std::initializer_list< InElementType > InitList,
RawAllocatorArgsType&&... RawAllocatorArgs
)

 Initializer list constructor
Public function  

TArrayG ( std::initializer_list< OtherElementType > InitList,
RawAllocatorArgsType&&... RawAllocatorArgs
)

  
Public function ULANG_FORCEINLINE

TArrayG ( const TArrayG< OtherElementType, OtherElementAllocatorType, OtherRawAllocatorArgsType... >& Other,
RawAllocatorArgsType&&... RawAllocatorArgs
)

 Copy constructor with changed allocator. Use the common routine to perform the copy.
Public function ULANG_FORCEINLINE

TArrayG ( const TArrayG& Other,
int32_t ExtraSlack
)

 Copy constructor. Use the common routine to perform the copy.

Destructors

  Type Name Description
Public function   Destructor.

Functions

  Type Name Description
Public function ULANG_FORCEINLINE int32_t

Add ( const ElementType& Item
)

 Adds a new item to the end of the array, possibly reallocating the whole array to fit.
Public function ULANG_FORCEINLINE int32_t

Add ( ElementType&& Item
)

 Adds a new item to the end of the array, possibly reallocating the whole array to fit.
Public function ULANG_FORCEINLINEElementType &

Add_GetRef ( const ElementType& Item
)

 Adds a new item to the end of the array, possibly reallocating the whole array to fit.
Public function ULANG_FORCEINLINEElementType &

Add_GetRef ( ElementType&& Item
)

 Adds a new item to the end of the array, possibly reallocating the whole array to fit.
Public function int32_t

AddDefaulted ( int32_t Count
)

 Adds new items to the end of the array, possibly reallocating the whole array to fit.
Public function ElementType & Add a new item to the end of the array, possibly reallocating the whole array to fit.
Public function ULANG_FORCEINLINE int32_t

AddUninitialized ( int32_t Count
)

 Adds a given number of uninitialized elements into the array.
Public function ULANG_FORCEINLINE int32_t

AddUnique ( const ElementType& Item
)

 Adds unique element to array if it doesn't exist.
Public function ULANG_FORCEINLINE int32_t

AddUnique ( ElementType&& Item
)

 Adds unique element to array if it doesn't exist.Move semantics version.
Public function int32_t

AddZeroed ( int32_t Count
)

 Adds new items to the end of the array, possibly reallocating the whole array to fit.
Public function ElementType & Adds a new item to the end of the array, possibly reallocating the whole array to fit.
Public function void

Append ( const ElementType* Ptr,
int32_t Count
)

 Adds a raw array of elements to the end of the TArrayG.
Public function ULANG_FORCEINLINE void

Append ( std::initializer_list< ElementType > InitList
)

 Adds an initializer list of elements to the end of the TArrayG.
Public function void

Append ( TArrayG< ElementType, OtherElementAllocatorType, OtherRawAllocatorArgsType... >&& Source
)

 Appends the specified array to this array.
Public function void

Append ( const TArrayG< ElementType, OtherElementAllocatorType, OtherRawAllocatorArgsType... >& Source
)

 Appends the specified array to this array.Allocator changing version.
Public function ULANG_FORCEINLINEElementType *

begin ()

 DO NOT USE DIRECTLY STL-like iterators to enable range-based for loop support.
Public function Const ULANG_FORCEINLINE const ElementType *

begin ()

  
Public function Const ULANG_FORCEINLINE void

CheckAddress ( void const* Addr
)

 Checks that the specified address is not part of an element within the container.
Public function Const ULANG_FORCEINLINE void Checks array invariants: if array size is greater than zero and less than maximum.
Public function Const bool

Contains ( const ComparisonType& Item
)

 Checks if this array contains the element.
Public function Const ULANG_FORCEINLINE bool

ContainsByPredicate ( Predicate Pred
)

 Checks if this array contains element for which the predicate is true.
Public function ULANG_FORCEINLINE int32_t

Emplace ( ArgsType&&... Args
)

 Constructs a new item at the end of the array, possibly reallocating the whole array to fit.
Public function ULANG_FORCEINLINEElementType &

Emplace_GetRef ( ArgsType&&... Args
)

 Constructs a new item at the end of the array, possibly reallocating the whole array to fit.
Public function ULANG_FORCEINLINE void

EmplaceAt ( int32_t Index,
ArgsType&&... Args
)

 Constructs a new item at a specified index, possibly reallocating the whole array to fit.
Public function ULANG_FORCEINLINEElementType &

EmplaceAt_GetRef ( int32_t Index,
ArgsType&&... Args
)

 Constructs a new item at a specified index, possibly reallocating the whole array to fit.
Public function void

Empty ( int32_t Slack
)

 Empties the array. It calls the destructors on held items if needed.
Public function ULANG_FORCEINLINEElementType *

end ()

  
Public function Const ULANG_FORCEINLINE const ElementType *

end ()

  
Public function Const TArrayG

FilterByPredicate ( Predicate Pred
)

 Filters the elements in the array based on a predicate functor.
Public function Const ULANG_FORCEINLINE bool

Find ( const ElementType& Item,
int32_t& Index
)

 Finds element within the array.
Public function Const int32_t

Find ( const ElementType& Item
)

 Finds element within the array.
Public function Const ULANG_FORCEINLINE const ElementType *

FindByKey ( const KeyType& Key
)

 Finds an item by key (assuming the ElementType overloads operator== for the comparison).
Public function ElementType *

FindByKey ( const KeyType& Key
)

 Finds an item by key (assuming the ElementType overloads operator== for the comparison).
Public function Const ULANG_FORCEINLINE const ElementType *

FindByPredicate ( Predicate Pred
)

 Finds an element which matches a predicate functor.
Public function ElementType *

FindByPredicate ( Predicate Pred
)

 Finds an element which matches a predicate functor.
Public function Const int32_t

FindLast ( const ElementType& Item
)

 Finds element within the array starting from the end.
Public function Const ULANG_FORCEINLINE bool

FindLast ( const ElementType& Item,
int32_t& Index
)

 Finds element within the array starting from the end.
Public function Const ULANG_FORCEINLINE int32_t

FindLastByPredicate ( Predicate Pred
)

 Searches the array for the last occurrence of an element which matches the specified predicate.
Public function Const int32_t

FindLastByPredicate ( Predicate Pred,
int32_t Count
)

 Searches an initial subrange of the array for the last occurrence of an element which matches the specified predicate.
Public function Const ULANG_FORCEINLINE uint32_t Helper function to return the amount of memory allocated by this container.
Public function ULANG_FORCEINLINEElementType *

GetData ()

 Helper function for returning a typed pointer to the first array entry.
Public function Const ULANG_FORCEINLINE const ElementType *

GetData ()

 Helper function for returning a typed pointer to the first array entry.
Public function Const ULANG_FORCEINLINE const ElementAllocatorType::RawAllocatorType & Accesses the raw allocator.
Public function Const ULANG_FORCEINLINE int32_t Returns the amount of slack in this array in elements.
Public function Const ULANG_FORCEINLINE uint32_t Helper function returning the size of the inner type.
Public function Const int32_t

IndexOfByKey ( const KeyType& Key
)

 Finds an item by key (assuming the ElementType overloads operator== for the comparison).
Public function Const int32_t

IndexOfByPredicate ( Predicate Pred
)

 Finds an item by predicate.
Public function void

Init ( const ElementType& Element,
int32_t Number
)

 Sets the size of the array, filling it with the given element.
Public function int32_t

Insert ( std::initializer_list< ElementType > InitList,
const int32_t InIndex
)

 Inserts given elements into the array at given location.
Public function int32_t

Insert ( TArrayG< ElementType, OtherElementAllocatorType, OtherRawAllocatorArgsType... >&& Items,
const int32_t InIndex
)

 Inserts given elements into the array at given location.
Public function int32_t

Insert ( ElementType&& Item,
int32_t Index
)

 Inserts a given element into the array at given location. Move semantics version.
Public function int32_t

Insert ( const ElementType& Item,
int32_t Index
)

 Inserts a given element into the array at given location.
Public function int32_t

Insert ( const ElementType* Ptr,
int32_t Count,
int32_t Index
)

 Inserts a raw array of elements at a particular index in the TArrayG.
Public function int32_t

Insert ( const TArrayG< ElementType, OtherElementAllocatorType, OtherRawAllocatorArgsType... >& Items,
const int32_t InIndex
)

 Inserts given elements into the array at given location.
Public function ElementType &

Insert_GetRef ( ElementType&& Item,
int32_t Index
)

 Inserts a given element into the array at given location. Move semantics version.
Public function ElementType &

Insert_GetRef ( const ElementType& Item,
int32_t Index
)

 Inserts a given element into the array at given location.
Public function void

InsertDefaulted ( int32_t Index,
int32_t Count
)

 Inserts a given number of default-constructed elements into the array at a given location.
Public function ElementType &

InsertDefaulted_GetRef ( int32_t Index
)

 Inserts a default-constructed element into the array at a given location.
Public function void

InsertUninitialized ( int32_t Index,
int32_t Count
)

 Inserts a given number of uninitialized elements into the array at given location.
Public function void

InsertZeroed ( int32_t Index,
int32_t Count
)

 Inserts a given number of zeroed elements into the array at given location.
Public function ElementType &

InsertZeroed_GetRef ( int32_t Index
)

 Inserts a zeroed element into the array at given location.
Public function Const ULANG_FORCEINLINE bool

IsEmpty ()

 Returns true if no elements in array
Public function Const ULANG_FORCEINLINE bool Returns true if any elements in array
Public function Const ULANG_FORCEINLINE bool

IsValidIndex ( int32_t Index
)

 Tests if index is valid, i.e. greater than or equal to zero, and less than the number of elements in the array.
Public function Const ULANG_FORCEINLINE const ElementType &

Last ( int32_t IndexFromTheEnd
)

 Returns n-th last element from the array.Const version of the above.
Public function ULANG_FORCEINLINEElementType &

Last ( int32_t IndexFromTheEnd
)

 Returns n-th last element from the array.
Public function Const ULANG_FORCEINLINE int32_t

Max ()

 Returns maximum number of elements in array.
Public function Const ULANG_FORCEINLINE int32_t

Num ()

 Returns number of elements in array.
Public function ULANG_FORCEINLINEElementType

Pop ( bool bAllowShrinking
)

 Pops element from the array.
Public function ULANG_FORCEINLINE void

Push ( const ElementType& Item
)

 Pushes element into the array.Const ref version of the above.
Public function ULANG_FORCEINLINE void

Push ( ElementType&& Item
)

 Pushes element into the array.
Public function Const ULANG_FORCEINLINE void

RangeCheck ( int32_t Index
)

 Checks if index is in array range.
Public function int32_t

Remove ( const OtherElementType& Item
)

 Removes as many instances of Item as there are in the array, maintaining order but not indices.
Public function int32_t

RemoveAll ( const PREDICATE_CLASS& Predicate
)

 Remove all instances that match the predicate, maintaining order but not indices Optimized to work with runs of matches/non-matches
Public function void

RemoveAllSwap ( const PREDICATE_CLASS& Predicate,
bool bAllowShrinking
)

 Remove all instances that match the predicate
Public function ULANG_FORCEINLINE void

RemoveAt ( int32_t Index
)

 Removes an element (or elements) at given location optionally shrinking the array.
Public function ULANG_FORCEINLINE void

RemoveAt ( int32_t Index,
CountType Count,
bool bAllowShrinking
)

 Removes an element (or elements) at given location optionally shrinking the array.
Public function ULANG_FORCEINLINE void

RemoveAtSwap ( int32_t Index
)

 Removes an element (or elements) at given location optionally shrinking the array.
Public function ULANG_FORCEINLINE void

RemoveAtSwap ( int32_t Index,
CountType Count,
bool bAllowShrinking
)

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

RemoveSingle ( const ElementType& Item
)

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

RemoveSingleSwap ( const ElementType& Item,
bool bAllowShrinking
)

 Removes the first occurrence of the specified item in the array.
Public function void Remove successive duplicates. Assumes that elements of the array have ==.
Public function int32_t

RemoveSwap ( const ElementType& Item
)

 Removes item from the array.
Public function int32_t

Replace ( const ElementType& OldItem,
const ElementType& NewItem
)

 Replaces specified element with the supplied element.
Public function ULANG_FORCEINLINE void

Reserve ( int32_t Number
)

 Reserves memory such that the array can contain at least Number elements.
Public function void

Reset ( int32_t NewSize
)

 Same as empty, but doesn't change memory allocations, unless the new size is larger than the current array.
Public function void

SetNum ( int32_t NewNum,
bool bAllowShrinking
)

 Resizes array to given number of elements.
Public function void

SetNumUninitialized ( int32_t NewNum,
bool bAllowShrinking
)

 Resizes array to given number of elements. New elements will be uninitialized.
Public function void

SetNumUnsafeInternal ( int32_t NewNum
)

 Does nothing except setting the new number of elements in the array.
Public function void

SetNumZeroed ( int32_t NewNum,
bool bAllowShrinking
)

 Resizes array to given number of elements. New elements will be zeroed.
Public function ULANG_FORCEINLINE void

Shrink ()

 Shrinks the array's used memory to smallest possible to store elements currently in it.
Public function void

Sort ()

 Sorts the array assuming < operator is defined for the item type.
Public function void

Sort ( const PredicateType& Predicate
)

 Sorts the array using user define predicate class.
Public function ULANG_FORCEINLINEElementType &

Top ()

 Returns the top element, i.e. the last one.
Public function Const ULANG_FORCEINLINE const ElementType &

Top ()

 Returns the top element, i.e. the last one.Const version of the above.

Operators

  Type Name Description
Public function Const ULANG_FORCEINLINE bool

operator!= ( const TArrayG& OtherArray
)

 Inequality operator.
Public function Const ULANG_FORCEINLINE const ElementType &

operator[] ( int32_t Index
)

 Array bracket operator. Returns reference to element at give index.Const version of the above.
Public function ULANG_FORCEINLINEElementType &

operator[] ( int32_t Index
)

 Array bracket operator. Returns reference to element at give index.
Public function TArrayG &

operator+= ( const TArrayG& Other
)

 Appends the specified array to this array. Cannot append to self.
Public function TArrayG &

operator+= ( TArrayG&& Other
)

 Appends the specified array to this array. Cannot append to self.Move semantics version.
Public function TArrayG &

operator+= ( std::initializer_list< ElementType > InitList
)

 Appends the specified initializer list to this array.
Public function TArrayG &

operator= ( const TArrayG& Other
)

 Assignment operator.
Public function TArrayG &

operator= ( TArrayG&& Other
)

 Move assignment operator.
Public function Const bool

operator== ( const TArrayG& OtherArray
)

 Equality operator.

Typedefs

Name Description
ElementAllocatorType  
ElementStorageType  
ElementType  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page