regina::HashString Struct Reference

A hash function used to calculate hash values for C++ strings. More...

#include <utilities/hashutils.h>

List of all members.

Public Member Functions
size_t	operator() (const std::string &str) const
	Returns a hash value for the given string.

---

Detailed Description

A hash function used to calculate hash values for C++ strings.

This class is for use with the Standard Template Library.

Python:

Not present.

Deprecated:

Everything related to the hash_set and hash_map classes is deprecated, since these classes are not part of the C++ standard. This material is scheduled to be removed from Regina in version 5.0.

---

Member Function Documentation

size_t regina::HashString::operator() ( const std::string &  str ) const

inline

Returns a hash value for the given string.

Parameters:

str	the string whose hash value should be calculated.

Returns:

the corresponding hash value.

---

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

• utilities/hashutils.h