Navigation
API > API/Runtime > API/Runtime/Core
Sequential double-ended queue (deque) container class.
A dynamically sized sequential queue of arbitrary size.
| Name | TDeque |
| Type | class |
| Header File | /Engine/Source/Runtime/Core/Public/Containers/Deque.h |
| Include Path | #include "Containers/Deque.h" |
Syntax
template<typename InElementType, typename InAllocatorType>
class TDeque
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
TDeque () |
Containers/Deque.h | ||
| Containers/Deque.h | |||
TDeque
(
std::initializer_list< ElementType > InList |
Containers/Deque.h | ||
| Containers/Deque.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
~TDeque() |
Containers/Deque.h |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| AllocatorType | InAllocatorType | Containers/Deque.h | |
| ConstIteratorType | UE::Deque::Private::TIterator< const ElementType, SizeType > | Containers/Deque.h | |
| ElementAllocatorType | std::conditional_t< AllocatorType::NeedsElementType, typename AllocatorType::template ForElementType< ElementType >, typename AllocatorType::ForAnyElementType > | Containers/Deque.h | |
| ElementType | InElementType | Containers/Deque.h | |
| IteratorType | UE::Deque::Private::TIterator< ElementType, SizeType > | Containers/Deque.h | |
| SizeType | typename InAllocatorType::SizeType | Containers/Deque.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| Capacity | SizeType | Containers/Deque.h | ||
| Count | SizeType | Containers/Deque.h | ||
| Head | SizeType | Containers/Deque.h | ||
| Storage | ElementAllocatorType | Containers/Deque.h | ||
| Tail | SizeType | Containers/Deque.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
ConstIteratorType begin () |
STL IteratorType model compliance methods. | Containers/Deque.h | |
IteratorType begin () |
Containers/Deque.h | ||
ElementType & EmplaceFirst
(
ArgsType&&... Args |
Constructs an element in place using the parameter arguments and adds it at the front of the queue. | Containers/Deque.h | |
ElementType & EmplaceLast
(
ArgsType&&... Args |
Constructs an element in place using the parameter arguments and adds it at the back of the queue. | Containers/Deque.h | |
void Empty() |
Empties the queue effectively destroying all contained elements and releases any acquired storage. | Containers/Deque.h | |
IteratorType end () |
Containers/Deque.h | ||
ConstIteratorType end () |
Containers/Deque.h | ||
ElementType & First () |
Containers/Deque.h | ||
const ElementType & First () |
Containers/Deque.h | ||
SIZE_T GetAllocatedSize () |
Helper function to return the amount of memory allocated by this container. | Containers/Deque.h | |
bool IsEmpty() |
Containers/Deque.h | ||
ElementType & Last () |
Containers/Deque.h | ||
const ElementType & Last () |
Containers/Deque.h | ||
SizeType Max() |
Containers/Deque.h | ||
SizeType Num() |
Containers/Deque.h | ||
void PopFirst() |
Removes the element at the front of the queue. This method requires a non-empty queue. | Containers/Deque.h | |
void PopLast() |
Removes the element at the back of the queue. This method requires a non-empty queue. | Containers/Deque.h | |
void PushFirst
(
ElementType&& Element |
Containers/Deque.h | ||
void PushFirst
(
const ElementType& Element |
Adds the parameter element at the front of the queue. | Containers/Deque.h | |
void PushLast
(
ElementType&& Element |
Containers/Deque.h | ||
void PushLast
(
const ElementType& Element |
Adds the parameter element at the back of the queue. | Containers/Deque.h | |
void Reserve
(
SizeType InCount |
Reserves storage for the parameter element count. | Containers/Deque.h | |
void Reset() |
Destroys all contained elements but doesn't release the container's storage. | Containers/Deque.h | |
bool TryPopFirst
(
ElementType& OutValue |
Removes the element at the front of the queue if existent after copying it to the parameter out value. | Containers/Deque.h | |
bool TryPopLast
(
ElementType& OutValue |
Removes the element at the back of the queue if existent after copying it to the parameter out value. | Containers/Deque.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool operator!=
(
const TDeque& Right |
Containers/Deque.h | ||
const ElementType & operator[]
(
SizeType Index |
Containers/Deque.h | ||
ElementType & operator[]
(
SizeType Index |
Containers/Deque.h | ||
| Containers/Deque.h | |||
| Containers/Deque.h | |||
| Containers/Deque.h | |||
bool operator==
(
const TDeque& Right |
TDeque comparison operators. | Containers/Deque.h |