dice::hash::dice_hash_templates< Policy > Class Template Reference

Class which contains all dice_hash functions. More...

#include <DiceHash.hpp>

Static Public Member Functions
template<typename T >
static std::size_t	dice_hash (T const &t) noexcept
	Base case for dice_hash.
template<typename T > requires is_fundamental<std::decay_t<T>>
static std::size_t	dice_hash (T const &fundamental) noexcept
	Implementation for fundamentals.
template<typename CharT >
static std::size_t	dice_hash (std::basic_string< CharT > const &str) noexcept
	Implementation for string types.
template<typename CharT >
static std::size_t	dice_hash (std::basic_string_view< CharT > const &sv) noexcept
	Implementation for string view.
template<typename T >
static std::size_t	dice_hash (T *ptr) noexcept
	Implementation for raw pointers.
template<typename T >
static std::size_t	dice_hash (std::unique_ptr< T > const &ptr) noexcept
	Implementation for unique pointers.
template<typename T >
static std::size_t	dice_hash (std::shared_ptr< T > const &ptr) noexcept
	implementation for shared pointers.
template<typename T , std::size_t N>
static std::size_t	dice_hash (std::array< T, N > const &arr) noexcept
	Implementation for std arrays.
template<typename T >
static std::size_t	dice_hash (std::vector< T > const &vec) noexcept
	Implementation for vectors.
template<typename T , std::size_t Extent>
static std::size_t	dice_hash (std::span< T, Extent > const &span) noexcept
	Implementation for byte spans.
template<typename... TupleArgs>
static std::size_t	dice_hash (std::tuple< TupleArgs... > const &tpl) noexcept
	Implementation for tuples.
template<typename T , typename V >
static std::size_t	dice_hash (std::pair< T, V > const &p) noexcept
	Implementation for pairs.
static std::size_t	dice_hash (std::monostate const &) noexcept
	Overload for std::monostate.
template<typename... VariantArgs>
static std::size_t	dice_hash (std::variant< VariantArgs... > const &var) noexcept
	Implementation for variant.
template<typename T > requires is_ordered_container_v<T>
static std::size_t	dice_hash (T const &container) noexcept
	Implementation for ordered container.
template<typename T > requires is_unordered_container_v<T>
static std::size_t	dice_hash (T const &container) noexcept
	Implementation for unordered container.

Detailed Description

template<Policies::HashPolicy Policy>
class dice::hash::dice_hash_templates< Policy >

Class which contains all dice_hash functions.

Template Parameters

Policy

The Policy the hash is based on.

Member Function Documentation

dice_hash() [1/16]

template<Policies::HashPolicy Policy>

template<typename T , std::size_t N>

static std::size_t dice::hash::dice_hash_templates< Policy >::dice_hash ( std::array< T, N > const &  arr )

inlinestaticnoexcept

Implementation for std arrays.

It will use different implementations if the type is fundamental or not.

Template Parameters

T	The type of the values.
N	The number of values.

Parameters

arr	The array itself.

Returns

Hash value.

dice_hash() [2/16]

template<Policies::HashPolicy Policy>

template<typename CharT >

static std::size_t dice::hash::dice_hash_templates< Policy >::dice_hash ( std::basic_string< CharT > const &  str )

inlinestaticnoexcept

Implementation for string types.

Template Parameters

CharT

A char type. See the definition of std::string for more information.

Parameters

str	The string to hash.

Returns

Hash value.

dice_hash() [3/16]

template<Policies::HashPolicy Policy>

template<typename CharT >

static std::size_t dice::hash::dice_hash_templates< Policy >::dice_hash ( std::basic_string_view< CharT > const &  sv )

inlinestaticnoexcept

Implementation for string view.

Template Parameters

CharT

A char type. See the definition of std::string for more information.

Parameters

sv	The string view to hash.

Returns

Hash value.

dice_hash() [4/16]

template<Policies::HashPolicy Policy>

static std::size_t dice::hash::dice_hash_templates< Policy >::dice_hash ( std::monostate const &  )

inlinestaticnoexcept

Overload for std::monostate.

It is needed so its usage in std::variant is possible. Will simply return the seed.

Returns

The seed of the hash function.

dice_hash() [5/16]

template<Policies::HashPolicy Policy>

template<typename T , typename V >

static std::size_t dice::hash::dice_hash_templates< Policy >::dice_hash ( std::pair< T, V > const &  p )

inlinestaticnoexcept

Implementation for pairs.

Will hash the entries and then combine them.

Template Parameters

T	Type of the first value.
V	Type of the second value.

Parameters

p	The pair itself.

Returns

Hash value.

dice_hash() [6/16]

template<Policies::HashPolicy Policy>

template<typename T >

static std::size_t dice::hash::dice_hash_templates< Policy >::dice_hash ( std::shared_ptr< T > const &  ptr )

inlinestaticnoexcept

implementation for shared pointers.

CAUTION: hashes the POINTER, not the OBJECT POINTED TO!

Template Parameters

T	A shared pointer type.

Parameters

ptr	The pointer to hash.

Returns

Hash value.

dice_hash() [7/16]

template<Policies::HashPolicy Policy>

template<typename T , std::size_t Extent>

static std::size_t dice::hash::dice_hash_templates< Policy >::dice_hash ( std::span< T, Extent > const &  span )

inlinestaticnoexcept

Implementation for byte spans.

Parameters

bytes

byte span to hash

Returns

Hash value.

dice_hash() [8/16]

template<Policies::HashPolicy Policy>

template<typename... TupleArgs>

static std::size_t dice::hash::dice_hash_templates< Policy >::dice_hash ( std::tuple< TupleArgs... > const &  tpl )

inlinestaticnoexcept

Implementation for tuples.

Will hash every entry and then combine the hashes.

Template Parameters

TupleArgs

The types of the tuple values.

Parameters

tpl	The tuple itself.

Returns

Hash value.

dice_hash() [9/16]

template<Policies::HashPolicy Policy>

template<typename T >

static std::size_t dice::hash::dice_hash_templates< Policy >::dice_hash ( std::unique_ptr< T > const &  ptr )

inlinestaticnoexcept

Implementation for unique pointers.

CAUTION: hashes the POINTER, not the OBJECT POINTED TO!

Template Parameters

T	A unique pointer type.

Parameters

ptr	The pointer to hash.

Returns

Hash value.

dice_hash() [10/16]

template<Policies::HashPolicy Policy>

template<typename... VariantArgs>

static std::size_t dice::hash::dice_hash_templates< Policy >::dice_hash ( std::variant< VariantArgs... > const &  var )

inlinestaticnoexcept

Implementation for variant.

Will hash the value which was set. The hash of a variant of a type is equal to the hash of the type. For example: a variant of int of 42 is equal to the hash of the int of 42. If the variant is valueless_by_exception, the seed will be returned.

Template Parameters

VariantArgs

Types of the possible values.

Parameters

var	The variant itself.

Returns

Hash value.

dice_hash() [11/16]

template<Policies::HashPolicy Policy>

template<typename T >

static std::size_t dice::hash::dice_hash_templates< Policy >::dice_hash ( std::vector< T > const &  vec )

inlinestaticnoexcept

Implementation for vectors.

It will use different implementations for fundamental and non-fundamental types.

Template Parameters

T	The type of the values.

Parameters

vec	The vector itself.

Returns

Hash value.

dice_hash() [12/16]

template<Policies::HashPolicy Policy>

template<typename T >

static std::size_t dice::hash::dice_hash_templates< Policy >::dice_hash ( T *  ptr )

inlinestaticnoexcept

Implementation for raw pointers.

CAUTION: hashes the POINTER, not the OBJECT POINTED TO!

Template Parameters

T	A pointer type.

Parameters

ptr	The pointer to hash.

Returns

Hash value.

dice_hash() [13/16]

template<Policies::HashPolicy Policy>

template<typename T >
requires is_ordered_container_v<T>

static std::size_t dice::hash::dice_hash_templates< Policy >::dice_hash ( T const &  container )

inlinestaticnoexcept

Implementation for ordered container.

It uses a custom type trait to check if the type is in fact an ordered container. CAUTION: If you want to add another type to the trait, you might need to do it before this is included!

Template Parameters

T	The container type.

Parameters

container

The container itself.

Returns

Hash value.

dice_hash() [14/16]

template<Policies::HashPolicy Policy>

template<typename T >
requires is_unordered_container_v<T>

static std::size_t dice::hash::dice_hash_templates< Policy >::dice_hash ( T const &  container )

inlinestaticnoexcept

Implementation for unordered container.

It uses a custom type trait to check if the type is in fact an unordered container. CAUTION: If you want to add another type to the trait, you might need to do it before this is included!

Template Parameters

T	The container type.

Parameters

container

The container itself.

Returns

Hash value.

dice_hash() [15/16]

template<Policies::HashPolicy Policy>

template<typename T >
requires is_fundamental<std::decay_t<T>>

static std::size_t dice::hash::dice_hash_templates< Policy >::dice_hash ( T const &  fundamental )

inlinestaticnoexcept

Implementation for fundamentals.

Template Parameters

T	Fundamental type.

Parameters

fundamental

Value to hash.

Returns

Hash value.

dice_hash() [16/16]

template<Policies::HashPolicy Policy>

template<typename T >

static std::size_t dice::hash::dice_hash_templates< Policy >::dice_hash ( T const &  t )

inlinestaticnoexcept

Base case for dice_hash.

This case is only chosen if no other match is found in this struct. Than it tries to find a specialization of dice::hash::dice_hash_overload and if none is found, this function will not compile.

Template Parameters

T	The type to hash.

Returns

Hash value.

---

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

• include/dice/hash/DiceHash.hpp