UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Types | Public Member Functions | Friends | List of all members
TDeque< InElementType, InAllocatorType > Class Template Reference

#include <Deque.h>

Public Types

using AllocatorType = InAllocatorType
 
using SizeType = typename InAllocatorType::SizeType
 
using ElementType = InElementType
 
using ElementAllocatorType = std::conditional_t< AllocatorType::NeedsElementType, typename AllocatorType::template ForElementType< ElementType >, typename AllocatorType::ForAnyElementType >
 
using ConstIteratorType = UE::Deque::Private::TIterator< const ElementType, SizeType >
 
using IteratorType = UE::Deque::Private::TIterator< ElementType, SizeType >
 

Public Member Functions

 TDeque ()
 
 TDeque (TDeque &&Other)
 
 TDeque (const TDeque &Other)
 
 TDeque (std::initializer_list< ElementType > InList)
 
 ~TDeque ()
 
TDeque & operator= (TDeque &&Other)
 
TDeque & operator= (const TDeque &Other)
 
TDeque & operator= (std::initializer_list< ElementType > InList)
 
const ElementType & operator[] (SizeType Index) const
 
ElementType & operator[] (SizeType Index)
 
const ElementType & Last () const
 
ElementType & Last ()
 
const ElementType & First () const
 
ElementType & First ()
 
UE_FORCEINLINE_HINT bool IsEmpty () const
 
UE_FORCEINLINE_HINT SizeType Max () const
 
UE_FORCEINLINE_HINT SizeType Num () const
 
UE_FORCEINLINE_HINT SIZE_T GetAllocatedSize () const
 
template<typename... ArgsType>
ElementType & EmplaceLast (ArgsType &&... Args)
 
template<typename... ArgsType>
ElementType & EmplaceFirst (ArgsType &&... Args)
 
UE_FORCEINLINE_HINT void PushLast (const ElementType &Element)
 
UE_FORCEINLINE_HINT void PushLast (ElementType &&Element)
 
UE_FORCEINLINE_HINT void PushFirst (const ElementType &Element)
 
UE_FORCEINLINE_HINT void PushFirst (ElementType &&Element)
 
void PopLast ()
 
void PopFirst ()
 
bool TryPopLast (ElementType &OutValue)
 
bool TryPopFirst (ElementType &OutValue)
 
void Reset ()
 
void Empty ()
 
void Reserve (SizeType InCount)
 
UE_FORCEINLINE_HINT ConstIteratorType begin () const
 
UE_FORCEINLINE_HINT IteratorType begin ()
 
UE_FORCEINLINE_HINT ConstIteratorType end () const
 
UE_FORCEINLINE_HINT IteratorType end ()
 
bool operator== (const TDeque &Right) const
 
bool operator!= (const TDeque &Right) const
 

Friends

template<typename AnyElementType , typename AnyAllocatorType >
class TDeque
 

Detailed Description

template<typename InElementType, typename InAllocatorType>
class TDeque< InElementType, InAllocatorType >

Sequential double-ended queue (deque) container class.

A dynamically sized sequential queue of arbitrary size.

Member Typedef Documentation

◆ AllocatorType

template<typename InElementType , typename InAllocatorType >
using TDeque< InElementType, InAllocatorType >::AllocatorType = InAllocatorType

◆ ConstIteratorType

template<typename InElementType , typename InAllocatorType >
using TDeque< InElementType, InAllocatorType >::ConstIteratorType = UE::Deque::Private::TIterator<const ElementType, SizeType>

◆ ElementAllocatorType

template<typename InElementType , typename InAllocatorType >
using TDeque< InElementType, InAllocatorType >::ElementAllocatorType = std::conditional_t< AllocatorType::NeedsElementType, typename AllocatorType::template ForElementType<ElementType>, typename AllocatorType::ForAnyElementType>

◆ ElementType

template<typename InElementType , typename InAllocatorType >
using TDeque< InElementType, InAllocatorType >::ElementType = InElementType

◆ IteratorType

template<typename InElementType , typename InAllocatorType >
using TDeque< InElementType, InAllocatorType >::IteratorType = UE::Deque::Private::TIterator<ElementType, SizeType>

◆ SizeType

template<typename InElementType , typename InAllocatorType >
using TDeque< InElementType, InAllocatorType >::SizeType = typename InAllocatorType::SizeType

Constructor & Destructor Documentation

◆ TDeque() [1/4]

template<typename InElementType , typename InAllocatorType >
TDeque< InElementType, InAllocatorType >::TDeque ( )
inline

◆ TDeque() [2/4]

template<typename InElementType , typename InAllocatorType >
TDeque< InElementType, InAllocatorType >::TDeque ( TDeque< InElementType, InAllocatorType > &&  Other)
inline

◆ TDeque() [3/4]

template<typename InElementType , typename InAllocatorType >
TDeque< InElementType, InAllocatorType >::TDeque ( const TDeque< InElementType, InAllocatorType > &  Other)
inline

◆ TDeque() [4/4]

template<typename InElementType , typename InAllocatorType >
TDeque< InElementType, InAllocatorType >::TDeque ( std::initializer_list< ElementType >  InList)
inline

◆ ~TDeque()

template<typename InElementType , typename InAllocatorType >
TDeque< InElementType, InAllocatorType >::~TDeque ( )
inline

Member Function Documentation

◆ begin() [1/2]

template<typename InElementType , typename InAllocatorType >
UE_FORCEINLINE_HINT IteratorType TDeque< InElementType, InAllocatorType >::begin ( )
inline

◆ begin() [2/2]

template<typename InElementType , typename InAllocatorType >
UE_FORCEINLINE_HINT ConstIteratorType TDeque< InElementType, InAllocatorType >::begin ( ) const
inline

◆ EmplaceFirst()

template<typename InElementType , typename InAllocatorType >
template<typename... ArgsType>
ElementType & TDeque< InElementType, InAllocatorType >::EmplaceFirst ( ArgsType &&...  Args)
inline

◆ EmplaceLast()

template<typename InElementType , typename InAllocatorType >
template<typename... ArgsType>
ElementType & TDeque< InElementType, InAllocatorType >::EmplaceLast ( ArgsType &&...  Args)
inline

◆ Empty()

template<typename InElementType , typename InAllocatorType >
void TDeque< InElementType, InAllocatorType >::Empty ( )
inline

◆ end() [1/2]

template<typename InElementType , typename InAllocatorType >
UE_FORCEINLINE_HINT IteratorType TDeque< InElementType, InAllocatorType >::end ( )
inline

◆ end() [2/2]

template<typename InElementType , typename InAllocatorType >
UE_FORCEINLINE_HINT ConstIteratorType TDeque< InElementType, InAllocatorType >::end ( ) const
inline

◆ First() [1/2]

template<typename InElementType , typename InAllocatorType >
ElementType & TDeque< InElementType, InAllocatorType >::First ( )
inline

◆ First() [2/2]

template<typename InElementType , typename InAllocatorType >
const ElementType & TDeque< InElementType, InAllocatorType >::First ( ) const
inline

◆ GetAllocatedSize()

template<typename InElementType , typename InAllocatorType >
UE_FORCEINLINE_HINT SIZE_T TDeque< InElementType, InAllocatorType >::GetAllocatedSize ( ) const
inline

Helper function to return the amount of memory allocated by this container. Only returns the size of allocations made directly by the container, not the elements themselves.

Returns
Number of bytes allocated by this container.

◆ IsEmpty()

template<typename InElementType , typename InAllocatorType >
UE_FORCEINLINE_HINT bool TDeque< InElementType, InAllocatorType >::IsEmpty ( ) const
inline

◆ Last() [1/2]

template<typename InElementType , typename InAllocatorType >
ElementType & TDeque< InElementType, InAllocatorType >::Last ( )
inline

◆ Last() [2/2]

template<typename InElementType , typename InAllocatorType >
const ElementType & TDeque< InElementType, InAllocatorType >::Last ( ) const
inline

◆ Max()

template<typename InElementType , typename InAllocatorType >
UE_FORCEINLINE_HINT SizeType TDeque< InElementType, InAllocatorType >::Max ( ) const
inline

◆ Num()

template<typename InElementType , typename InAllocatorType >
UE_FORCEINLINE_HINT SizeType TDeque< InElementType, InAllocatorType >::Num ( ) const
inline

◆ operator!=()

template<typename InElementType , typename InAllocatorType >
bool TDeque< InElementType, InAllocatorType >::operator!= ( const TDeque< InElementType, InAllocatorType > &  Right) const
inline

◆ operator=() [1/3]

template<typename InElementType , typename InAllocatorType >
TDeque & TDeque< InElementType, InAllocatorType >::operator= ( const TDeque< InElementType, InAllocatorType > &  Other)
inline

◆ operator=() [2/3]

template<typename InElementType , typename InAllocatorType >
TDeque & TDeque< InElementType, InAllocatorType >::operator= ( std::initializer_list< ElementType >  InList)
inline

◆ operator=() [3/3]

template<typename InElementType , typename InAllocatorType >
TDeque & TDeque< InElementType, InAllocatorType >::operator= ( TDeque< InElementType, InAllocatorType > &&  Other)
inline

◆ operator==()

template<typename InElementType , typename InAllocatorType >
bool TDeque< InElementType, InAllocatorType >::operator== ( const TDeque< InElementType, InAllocatorType > &  Right) const
inline

◆ operator[]() [1/2]

template<typename InElementType , typename InAllocatorType >
ElementType & TDeque< InElementType, InAllocatorType >::operator[] ( SizeType  Index)
inline

◆ operator[]() [2/2]

template<typename InElementType , typename InAllocatorType >
const ElementType & TDeque< InElementType, InAllocatorType >::operator[] ( SizeType  Index) const
inline

◆ PopFirst()

template<typename InElementType , typename InAllocatorType >
void TDeque< InElementType, InAllocatorType >::PopFirst ( )
inline

◆ PopLast()

template<typename InElementType , typename InAllocatorType >
void TDeque< InElementType, InAllocatorType >::PopLast ( )
inline

◆ PushFirst() [1/2]

template<typename InElementType , typename InAllocatorType >
UE_FORCEINLINE_HINT void TDeque< InElementType, InAllocatorType >::PushFirst ( const ElementType &  Element)
inline

◆ PushFirst() [2/2]

template<typename InElementType , typename InAllocatorType >
UE_FORCEINLINE_HINT void TDeque< InElementType, InAllocatorType >::PushFirst ( ElementType &&  Element)
inline

◆ PushLast() [1/2]

template<typename InElementType , typename InAllocatorType >
UE_FORCEINLINE_HINT void TDeque< InElementType, InAllocatorType >::PushLast ( const ElementType &  Element)
inline

◆ PushLast() [2/2]

template<typename InElementType , typename InAllocatorType >
UE_FORCEINLINE_HINT void TDeque< InElementType, InAllocatorType >::PushLast ( ElementType &&  Element)
inline

◆ Reserve()

template<typename InElementType , typename InAllocatorType >
void TDeque< InElementType, InAllocatorType >::Reserve ( SizeType  InCount)
inline

◆ Reset()

template<typename InElementType , typename InAllocatorType >
void TDeque< InElementType, InAllocatorType >::Reset ( )
inline

◆ TryPopFirst()

template<typename InElementType , typename InAllocatorType >
bool TDeque< InElementType, InAllocatorType >::TryPopFirst ( ElementType &  OutValue)
inline

◆ TryPopLast()

template<typename InElementType , typename InAllocatorType >
bool TDeque< InElementType, InAllocatorType >::TryPopLast ( ElementType &  OutValue)
inline

Friends And Related Symbol Documentation

◆ TDeque

template<typename InElementType , typename InAllocatorType >
template<typename AnyElementType , typename AnyAllocatorType >
friend class TDeque
friend
The documentation for this class was generated from the following file: