1. Epic GamesDeveloper
  3. TLruCache

TLruCache

Implements a Least Recently Used (LRU) cache.

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

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

  Type Name Description
Public function   Default constructor (empty cache that cannot hold any values).
Public function  

TLruCache ( int32 InMaxNumElements
)

 Create and initialize a new instance.

Destructors

  Type Name Description
Public function   Destructor.

Functions

  Type Name Description
Public function void

Add ( const KeyType& Key,
const ValueType& Value
)

 Add an entry to the cache.
Public function ValueType &

AddUninitialized_GetRef ( const KeyType& Key
)

 Add an entry to the cache.
Public function Const TConstIterator

begin ()

  
Public function TIterator

begin ()

  
Public function Const bool

Contains ( const KeyType& Key
)

 Check whether an entry with the specified key is in the cache.
Public function Const bool

ContainsByPredicate ( Predicate Pred
)

 Check whether an entry for which a predicate returns true is in the cache.
Public function void

Empty ( int32 InMaxNumElements
)

 Empty the cache.
Public function Const TConstIterator

end ()

  
Public function TIterator

end ()

  
Public function Const TArray< ValueType >

FilterByPredicate ( Predicate Pred
)

 Filter the entries in the cache using a predicate.
Public function ValueType *

Find ( const KeyType& Key
)

 Find the value of the entry with the specified key.
Public function Const const ValueType *

Find ( const KeyType& Key
)

 Find the value of the entry with the specified key.
Public function const ValueType *

FindAndTouch ( const KeyType& Key
)

 Find the value of the entry with the specified key and mark it as the most recently used.
Public function const ValueType &

FindAndTouchChecked ( const KeyType& Key
)

 Find the value of the entry with the specified key and mark it as the most recently used.
Public function ValueType

FindAndTouchRef ( const KeyType& Key
)

 Find the value of the entry with the specified key and mark it as the most recently used.
Public function Const const ValueType *

FindByPredicate ( Predicate Pred
)

 Find the value of an entry using a predicate.
Public function Const const ValueType &

FindChecked ( const KeyType& Key
)

 Find the value of the entry with the specified key.
Public function Const ValueType

FindRef ( const KeyType& Key
)

 Find the value of the entry with the specified key.
Public function Const void

GetKeys ( TArray< KeyType >& OutKeys
)

 Find the keys of all cached entries.
Public function Const bool

IsEmpty ()

 Returns true if the cache is empty and contains no elements.
Protected function void

MarkAsRecent ( FCacheEntry& Entry
)

 Mark the given entry as recently used.
Public function Const int32

Max ()

 Get the maximum number of entries in the cache.
Public function Const int32

Num ()

 Get the number of entries in the cache.
Public function void

Remove ( const KeyType& Key
)

 Remove all entries with the specified key from the cache.
Protected function void

Remove ( FCacheEntry* Entry
)

 Remove the specified entry from the cache.
Public function int32

RemoveByPredicate ( Predicate Pred
)

 Remove all entries using a predicate.
Public function ValueType Remove and return the least recent element from the cache.

Classes

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

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page