Detailed Description

template<class T>
struct evo::CompareHash< T >

Hash object used with containers that hash items.

This inherits an associated comparison type used with hash collisons
Hashing is done with the SpookyHash V2 library (included with Evo):
- SpookyHash reference: http://burtleburtle.net/bob/hash/spooky.html
Non-POD types are compared by calling method the T::hash(), which should use DataHash to hash the actual data
- Evo types like String implement this hash() method
- See IsNormalType, TypeId

Template Parameters

T	Type to hash

Public Types
typedef Compare< T >	CompareBase
	Base compare type. More...

typedef RemoveConst< T >::Type	Item
	Item type (const removed) More...

typedef DataCopy< T >::PassType	PassItem
	Best type for passing Item, either `const Item&` (by reference) or `Item` (by value) for POD types. More...

Public Member Functions
ulong	hash (PassItem key, ulong seed=0) const
	Hash function method. More...

int	operator() (PassItem a, PassItem b) const
	Comparison method. More...

Member Typedef Documentation

◆ CompareBase

typedef Compare<T> CompareBase

Base compare type.

◆ Item

typedef RemoveConst<T>::Type Item

inherited

Item type (const removed)

◆ PassItem

typedef DataCopy<T>::PassType PassItem

inherited

Best type for passing Item, either const Item& (by reference) or Item (by value) for POD types.

Member Function Documentation

◆ hash()

ulong hash	(	PassItem	key,
		ulong	seed = `0`
	)		const

inline

Hash function method.

Parameters

key	Key to hash
seed	Seed to start with, 0 for none, or can be from hashing another value

Returns: Hash function result

◆ operator()()

int operator()	(	PassItem	a,
		PassItem	b
	)		const

inlinevirtualinherited

Comparison method.

Parameters

a	Item a to compare (left side)
b	Item b to compare (right side)

Returns: Comparison result: 0:equal, negative:(a < b), positive:(a > b)

Implements CompareBase< T >.

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

evo/impl/container.h