Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Core > Containers > TLruCache

Light Theme

Dark Theme

TLruCache

Implements a Least Recently Used (LRU) cache.

Windows

MacOS

Linux

References

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

Syntax

template<typename KeyType, typename ValueType, typename KeyComp>
class TLruCache

Remarks

Implements a Least Recently Used (LRU) cache.

Constructors

	Name	Description
	TLruCache()	Default constructor (empty cache that cannot hold any values).
	TLruCache ( int32 InMaxNumElements )	Create and initialize a new instance.

Destructors

	Name	Description
	~TLruCache()	Destructor.

Functions

	Name	Description
void	Add ( const KeyType& Key, const ValueType& Value )	Add an entry to the cache.
TConstIterat...	begin()
TIterator	begin()
bool	Contains ( const KeyType& Key )	Check whether an entry with the specified key is in the cache.
bool	ContainsByPredicate ( Predicate Pred )	Check whether an entry for which a predicate returns true is in the cache.
void	Empty ( int32 InMaxNumElements )	Empty the cache.
TConstIterat...	end()
TIterator	end()
TArray< Valu...	FilterByPredicate ( Predicate Pred )	Filter the entries in the cache using a predicate.
const ValueT...	Find ( const KeyType& Key )	Find the value of the entry with the specified key.
const ValueT...	FindAndTouch ( const KeyType& Key )	Find the value of the entry with the specified key and mark it as the most recently used.
const ValueT...	FindAndTouchChecked ( const KeyType& Key )	Find the value of the entry with the specified key and mark it as the most recently used.
ValueType	FindAndTouchRef ( const KeyType& Key )	Find the value of the entry with the specified key and mark it as the most recently used.
const ValueT...	FindByPredicate ( Predicate Pred )	Find the value of an entry using a predicate.
const ValueT...	FindChecked ( const KeyType& Key )	Find the value of the entry with the specified key.
ValueType	FindRef ( const KeyType& Key )	Find the value of the entry with the specified key.
void	GetKeys ( TArray< KeyType >& OutKeys )	Find the keys of all cached entries.
void	MarkAsRecent ( FCacheEntry& Entry )	Mark the given entry as recently used.
int32	Max()	Get the maximum number of entries in the cache.
int32	Num()	Get the number of entries in the cache.
void	Remove ( const KeyType& Key )	Remove all entries with the specified key from the cache.
void	Remove ( FCacheEntry* Entry )	Remove the specified entry from the cache.
int32	RemoveByPredicate ( Predicate Pred )	Remove all entries using a predicate.
ValueType	RemoveLeastRecent()	Remove and return the least recent element from the cache.

Classes

	Name	Description
	TBaseIterator	Base class for cache iterators. Iteration begins at the most recent entry.
	TConstIterator	Cache iterator (const).
	TIterator	Cache iterator.

Name

Description

TBaseIterator

Base class for cache iterators.

Iteration begins at the most recent entry.

TConstIterator

Cache iterator (const).

TIterator

Cache iterator.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss