te::AnyHash Struct Reference

Detailed Description

Generic hash function object.

This is the default hash type for te::AnySet. Users should not specialize the operator() member function of this class.

See also

Hash - A template class whose specializations determine the behavior of AnyHash.

hash_value() - Provides and ADL-based approach to customizing the behavior of AnyHash.

#include <AnyHash.h>

Public Member Functions
template<class T >
std::size_t	operator() (const T &value) const
	Implements a generic hash function. More...

Related Functions
(Note that these are not member functions.)
template<class T , class = std::enable_if_t<detail::has_hash_specialization_v<T>>>
std::size_t	hash_value (const T &value)
	Generic hash function. More...

Member Function Documentation

operator()()

template<class T >

std::size_t te::AnyHash::operator() ( const T &  value ) const

inline

Implements a generic hash function.

Users should not specialize this member function. To modify the behavior of AnyHash for different types, users can do one of two things:

1. Specialize te::Hash<T> for the desired type T, providing a default constructor and member function std::size_t te::Hash<T>::operator()(const T&).
2. Provide an overload of std::size_t hash_value(const T&) in the same namespace as type T, which will be found by ADL in AnyHash::operator()`.

Parameters

value

- object to compute the hash of.

Returns

the computed hash of value.

See also

Hash - A template class whose specializations determine the behavior of AnyHash.

hash_value() - Provides and ADL-based approach to customizing the behavior of AnyHash.

Friends And Related Function Documentation

hash_value()

template<class T , class = std::enable_if_t<detail::has_hash_specialization_v<T>>>

std::size_t hash_value ( const T &  value )

related

Generic hash function.

Users can customize the behavior of AnyHash by providing an overload of hash_value() in the same namespace that their own classes are declared in. AnyHash makes an unqualified call to hash_value() like so:

using te::hash_value;
return hash_value(value);

This allows ADL to find overloads of hash_value() in the namespace that value's type is defined in. This is the same method that boost::container_hash uses, so existing overloads of hash_value() intended for boost::container_hash will also work here.

te::hash_value() otherwise uses te::Hash to compute value's hash code. If te::Hash has no specialization for value's type, then te::hash_value() is removed from overload resolution via SFINAE.

Parameters

value

- object to compute the hash code for.

Returns

std::invoke(te::Hash<T>{}, value)

See also

Hash - A template class whose specializations determine the behavior of AnyHash.

AnyHash - The default hash function type for AnySet.

---

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

• /home/tim/Projects/AnySet/include/anyset/AnyHash.h