TArray::HeapPush

Adds a new element to 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

template<class PREDICATE_CLASS>
SizeType HeapPush
(
    ElementType && InItem,
    const PREDICATE_CLASS & Predicate
)

Remarks

Adds a new element to the heap.

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

Returns

The index of the new element.

Parameters

Parameter

Description

InItem

Item to be added.

Predicate

Predicate class instance.