CGAL 6.2 - Profiling tools, Hash Map, Union-find, Modifiers: CGAL::Handle_hash_function Struct Reference

CGAL 6.2 - Profiling tools, Hash Map, Union-find, Modifiers

Loading...
Searching...
No Matches
List of all members
CGAL::Handle_hash_function Struct Reference
Reference Manual

`#include <CGAL/Handle_hash_function.h>`

## Definition

The class `Handle_hash_function` is a model for the `UniqueHashFunction` concept.

It is applicable for all key types with pointer-like functionality, such as handles, iterators, and circulators. Specifically, for a `key` value the expression `&*key` must return a unique address.

Is model of
  `UniqueHashFunction`

See also
  `CGAL::Unique_hash_map<Key,Data,UniqueHashFunction>`

Implementation

Plain type cast of `&*key` to `std::size_t` and divided by the size of the `std::iterator_traits<Handle>::value_type` to avoid correlations with the internal table size, which is a power of two.

## Creation
| Handle_hash_function ()
| Default constructor.

## Operations
template<class Handle >
std::size_t | operator() (const Handle &key)
| Returns unique hash value for any `Handle` type for which `&*key` gives a unique address.

## Member Function Documentation

## ◆ operator()()

template<class Handle >

std::size_t CGAL::Handle_hash_function::operator() | ( | const Handle & | key | ) |

Returns unique hash value for any `Handle` type for which `&*key` gives a unique address.

The type `std::iterator_traits<Handle>::value_type` has to be defined (which it is already for pointers, handles, iterators, and circulators).