w_hash_t< T, LOCK, K > Class Template Reference

Inherits w_base_t.

Inheritance diagram for w_hash_t< T, LOCK, K >:

[legend]Collaboration diagram for w_hash_t< T, LOCK, K >:

[legend]List of all members.

---

Detailed Description

template<class T, class LOCK, class K>
class w_hash_t< T, LOCK, K >

Templated hash table. Not particularly sophisticated.

The hash function used here is :

• w_hash(key) & _mask

Thus, to make this work, your key type needs to be a class containing a public method w_base_t::uint4_t hash() const; (This is somewhat inconvenient if you want the key to be an atomic type, but it's a lot easier to find locate the hash functions this way and we don't have to worry about any implicit construction of types by the compiler this way.)

Note that since the hash function uses the _mask to collect the lower bits of the result of w_hash, the key.hash() function should be sensitive to the way hash-table uses it, and the hash tables should be aware of the likely bit distribution of the result of key.hash().

Definition at line 94 of file w_hash.h.

Public Member Functions
NORET	w_hash_t (uint4_t sz, uint4_t key_offset, uint4_t link_offset, const LOCK *lock)
	Construct hash table.
w_hash_t &	push (T *t)
	Insert an element in the table at the front of its bucket.
w_hash_t &	append (T *t)
	Insert an element in the table at the tail of its bucket.
T *	lookup (const K &k) const
	Find an element in the table.
bool	member (T const *t) const
	True if element is in the table.
T *	remove (const K &k)
	Remove the (single) element with the given key.
void	remove (T *t)
	Remove the given element that is in the table.
uint4_t	num_members () const
	Total number of elements in the table.
Friends
ostream &const w_hash_t< T, LOCK, K > &	obj
ostream &	operator<< BIND_FRIEND_OPERATOR_PART_2B (T, LOCK, K)(ostream &o
	Standard ostream operator, despite the macro here (in w_workaround.h).

---

Constructor & Destructor Documentation

template<class T, class LOCK, class K>

NORET w_hash_t< T, LOCK, K >::w_hash_t	(	uint4_t	sz,
		uint4_t	key_offset,
		uint4_t	link_offset,
		const LOCK *	lock
	)

Construct hash table.

Parameters:

[in]	sz	Number of bits in result values.
[in]	key_offset	Offset in object of type T where key K is found
[in]	link_offset	Offset in object of type T where w_link_t is found This w_link_t is used to hold the object in a hash table bucket
[in]	lock	Pointer to a lock used to protect the table.

The size determines a mask used to restrict the resulting hash values to a desired size.

The lock passed in is not used. There is no enforcement of locking these structures. The template contains the lock type so that it is relatively easy to tell what structures are unprotected by perusing the code.

See W_HASH_ARG(class,key,link)

---

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

• src/fc/w_hash.h

---