1. Epic GamesDeveloper
  3. TPagedArray

TPagedArray

Fixed size block allocated container class.

API > API/Runtime > API/Runtime/Core > API/Runtime/Core/Containers

References

   
Module Core
Header /Engine/Source/Runtime/Core/Public/Containers/PagedArray.h
Include #include "Containers/PagedArray.h"

Syntax

template<typename InElementType, int32 InPageSizeInBytes, typename InAllocatorType>  
class TPagedArray

Remarks

Fixed size block allocated container class.

This container mimics the behavior of an array without fulfilling the contiguous storage guarantee. Instead, it allocates memory in pages. Each page is a block of memory of the parameter page size in bytes. Elements within a page are guaranteed to be contiguous. Paged arrays have the following advantages v normal arrays:

It's more suited for large sized arrays as they don't require a single contiguous memory block. This make them less vulnerable to memory fragmentation.

The contained elements' addresses are persistent as long as the container isn't resized.

Constructors

  Type Name Description
Public function    
Public function  

TPagedArray ( TPagedArray&& Other
)

  
Public function  

TPagedArray ( const TPagedArray& Other
)

  
Public function  

TPagedArray ( std::initializer_list< ElementType > InList
)

  
Public function  

TPagedArray ( const ElementType* InSource,
SizeType InSize
)

  

Destructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function SizeType

Add ( ElementType&& Element
)

  
Public function SizeType

Add ( const ElementType& Element
)

 Adds the parameter element at the back of the container.
Public function ElementType &

Add_GetRef ( ElementType&& Element
)

  
Public function ElementType &

Add_GetRef ( const ElementType& Element
)

  
Public function void

Append ( const ElementType* InSource,
SizeType InSize
)

 Appends the parameter contiguous range to this container.
Public function void

Append ( const TPagedArray< ElementType, OtherPageSizeInBytes, OtherAllocator >& Other
)

 Appends a compatible paged array to this container.
Public function void

Append ( ContainerType&& Container
)

  
Public function void

Append ( std::initializer_list< ElementType > InList
)

  
Public function void

Assign ( const ElementType* InSource,
SizeType InSize
)

 Assigns the parameter contiguous range to this container. Any pre-existing content is removed.
Public function void

Assign ( const TPagedArray< ElementType, OtherPageSizeInBytes, OtherAllocator >& Other
)

 Assigns a compatible paged array to this container.
Public function void

Assign ( ContainerType&& Container
)

  
Public function void

Assign ( std::initializer_list< ElementType > InList
)

  
Public function Const ConstIteratorType

begin ()

 STL IteratorType model compliance methods.
Public function IteratorType

begin ()

  
Public function Const void Count bytes needed to serialize this paged array.
Public function SizeType

Emplace ( ArgsType&&... Args
)

 Constructs an element in place using the parameter arguments and adds it at the back of the container.
Public function ElementType &

Emplace_GetRef ( ArgsType&&... Args
)

 Constructs an element in place using the parameter arguments and adds it at the back of the container.
Public function void

Empty ( SizeType InCapacity
)

 Empties the container effectively destroying all contained elements and ensures storage for the parameter capacity.
Public function void

Empty ()

 Empties the container effectively destroying all contained elements and releases any acquired storage.
Public function Const ConstIteratorType

end ()

  
Public function IteratorType

end ()

  
Public function Const SIZE_T Helper function to return the amount of memory allocated by this container.
Public function Const bool

IsEmpty ()

  
Public function Const const ElementType &

Last ()

  
Public function ElementType &

Last ()

  
Public function Const SizeType

Max ()

  
Public function Static constexpr SizeType  
Public function Const SizeType

Num ()

  
Public function Const SizeType  
Public function void

Pop ( bool bAllowShrinking
)

 Removes the last element in the container.
Public function void

Push ( const ElementType& Element
)

  
Public function void

Push ( ElementType&& Element
)

  
Public function void

RemoveAtSwap ( SizeType Index,
bool bAllowShrinking
)

 Removes the element at the parameter index position and swaps the last element if existent to the same position to ensure the range is contiguous.
Public function void

Reserve ( SizeType InCount
)

 Reserves storage for the parameter element count.
Public function void

Reset ()

 Destroys all contained elements but doesn't release the container's storage.
Public function void

Reset ( SizeType InCapacity
)

 Destroys all contained elements and ensures storage for the parameter capacity.
Public function void

SetMem ( uint8 ByteValue
)

 Fills the memory used by the container elements with the parameter byte value.
Public function void

SetNum ( SizeType NewNum,
bool bAllowShrinking
)

 Resizes array to the parameter number of elements.
Public function void

SetZero ()

 Sets the memory used by the container elements to zero.
Public function Const void

ToArray ( TArray< ElementType, AnyAllocator >& OutDestination
)

 Copies this container elements into the parameter destination array.
Public function void

ToArray ( TArray< ElementType, AnyAllocator >& OutDestination
)

 Moves this container elements into the parameter destination array.

Operators

  Type Name Description
Public function Const bool

operator!= ( const TPagedArray& Right
)

  
Public function ElementType &

operator[] ( SizeType Index
)

  
Public function Const const ElementType &

operator[] ( SizeType Index
)

  
Public function TPagedArray &

operator= ( const TPagedArray& Other
)

  
Public function TPagedArray &

operator= ( std::initializer_list< ElementType > InList
)

  
Public function TPagedArray &

operator= ( TPagedArray&& Other
)

  
Public function Const bool

operator== ( const TPagedArray& Right
)

 Friend operators.

Typedefs

Name Description
AllocatorType  
ConstIteratorType  
ElementAllocatorType  
ElementType  
IteratorType  
PageTraits  
PageType  
SizeType  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page