Navigation
API > API/Runtime > API/Runtime/Core > API/Runtime/Core/TArray
Overloads
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void HeapPop
(
ElementType& OutItem, |
Removes the top element from the heap. | Containers/Array.h | |
void HeapPop
(
ElementType& OutItem, |
Containers/Array.h | ||
void HeapPop
(
ElementType& OutItem, |
Removes the top element from the heap. | Containers/Array.h | |
void HeapPop
(
ElementType& OutItem, |
Containers/Array.h |
HeapPop(ElementType &, EAllowShrinking)
Description
- Removes the top element from the heap. Assumes < operator is defined for the template type.
-
If your array contains raw pointers, they will be automatically dereferenced during heapification. Therefore, your array will be heapified by the values being pointed to, rather than the pointers' values. The auto-dereferencing behavior does not occur with smart pointers.
| Name | HeapPop |
| Type | function |
| Header File | /Engine/Source/Runtime/Core/Public/Containers/Array.h |
| Include Path | #include "Containers/Array.h" |
void HeapPop
(
ElementType & OutItem,
EAllowShrinking AllowShrinking
)
Parameters
| Name | Remarks |
|---|---|
| OutItem | The removed item. |
| AllowShrinking | (Optional) Tells if this call can shrink the array allocation if suitable after the pop. Default is yes. |
HeapPop(ElementType &, bool)
| Name | HeapPop |
| Type | function |
| Header File | /Engine/Source/Runtime/Core/Public/Containers/Array.h |
| Include Path | #include "Containers/Array.h" |
void HeapPop
(
ElementType & OutItem,
bool bAllowShrinking
)
HeapPop(ElementType &, const PREDICATE_CLASS &, EAllowShrinking)
Description
- Removes the top element from the heap.
-
If your array contains raw pointers, they will be automatically dereferenced during heapification. Therefore, your predicate will be passed references rather than pointers. The auto-dereferencing behavior does not occur with smart pointers.
| Name | HeapPop |
| Type | function |
| Header File | /Engine/Source/Runtime/Core/Public/Containers/Array.h |
| Include Path | #include "Containers/Array.h" |
template<class PREDICATE_CLASS>
void HeapPop
(
ElementType & OutItem,
const PREDICATE_CLASS & Predicate,
EAllowShrinking AllowShrinking
)
Parameters
| Name | Remarks |
|---|---|
| OutItem | The removed item. |
| Predicate | Predicate class instance. |
| AllowShrinking | Tell if this function can shrink the memory in-use if suitable. |
HeapPop(ElementType &, const PREDICATE_CLASS &, bool)
| Name | HeapPop |
| Type | function |
| Header File | /Engine/Source/Runtime/Core/Public/Containers/Array.h |
| Include Path | #include "Containers/Array.h" |
template<class PREDICATE_CLASS>
void HeapPop
(
ElementType & OutItem,
const PREDICATE_CLASS & Predicate,
bool bAllowShrinking
)