TArray::HeapPush

Adds a new element to the heap.

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
(
    const ElementType & InItem,
    const PREDICATE_CLASS & Predicate
)

Remarks

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

Returns

The index of the new element.

Parameters

Parameter

Description

InItem

Item to be added.

Predicate

Predicate class instance.

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback