ALib C++ Library
Library Version: 2510 R0
Documentation generated by doxygen
Loading...
Searching...
No Matches
alib::containers::TIdentDescriptor< T > Struct Template Reference

Description:

template<typename T>
struct alib::containers::TIdentDescriptor< T >

Implements template type TValueDescriptor, which is, for example, offered by types HashTable and LRUCacheTable.

Specifically, this implementation is used with "sets", hence cases where the full portion of a type that is to be stored in a container should serve as the key to itself.

Type definitions HashSet and LRUCacheSet establish a shortcut to their corresponding base type, which incorporates this helper.

Template Parameters
TThe type stored in the container, serving likewise as the key-type.

Definition at line 66 of file valuedescriptor.inl.

Public Type Index:

using KeyType = T
 
using MappedType = T
 
using StoredType = T
 

Public Method Index:

KeyTypeKey (T &src) const
 
MappedTypeMapped (T &src) const
 

Type Definition Details:

◆ KeyType

template<typename T>
using alib::containers::TIdentDescriptor< T >::KeyType = T

Exposes template parameter T and thus equals StoredType and MappedType.
Container types typically publish an alias to this type. For example, see KeyType, or see KeyType.

Definition at line 79 of file valuedescriptor.inl.

◆ MappedType

template<typename T>
using alib::containers::TIdentDescriptor< T >::MappedType = T

Exposes template parameter T and thus equals StoredType and KeyType.
Container types typically publish an alias to this type. For example, see MappedType, or see MappedType.

Definition at line 86 of file valuedescriptor.inl.

◆ StoredType

template<typename T>
using alib::containers::TIdentDescriptor< T >::StoredType = T

The type stored in the container.
Container types typically publish an alias to this type. For example, see StoredType, or see StoredType.

Definition at line 72 of file valuedescriptor.inl.

Method Details:

◆ Key()

template<typename T>
KeyType & alib::containers::TIdentDescriptor< T >::Key ( T & src) const
inline

Returns the given src as is.

Parameters
srcThe value to extract from.
Returns
The given reference.

Definition at line 91 of file valuedescriptor.inl.

◆ Mapped()

template<typename T>
MappedType & alib::containers::TIdentDescriptor< T >::Mapped ( T & src) const
inline

Returns the given src as is.

Parameters
srcThe value to extract from.
Returns
The given reference.

Definition at line 96 of file valuedescriptor.inl.


The documentation for this struct was generated from the following file: