TArray::HeapPopDiscard

Removes the top element from the heap.

Choose your operating system:

Windows

macOS

Linux

References

Module

Core

Header

/Engine/Source/Runtime/Core/Public/Containers/Array.h

Include

#include "Containers/Array.h"

Syntax

void HeapPopDiscard
(
    bool bAllowShrinking
)

Remarks

Removes the top element from the heap. Assumes < operator is defined for the template type.

@note 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.

Parameters

Parameter

Description

bAllowShrinking

(Optional) Tells if this call can shrink the array allocation if suitable after the discard. Default is true.