This class wraps an unspecified default hashing algorithm, which takes a seed, that is appropriate for general purpose use such as generating hashes for a hash table.

Synopsis

Declared in <bslh_defaultseededhashalgorithm.h>

class DefaultSeededHashAlgorithm;

Type Aliases

Name

Description

result_type

Typedef indicating the value type returned by this algorithm.

Enums

Name

Description

Unnamed enum

Compile‐time constants for this seeded hash algorithm.

Member Functions

Name

Description

DefaultSeededHashAlgorithm [constructor]

Create a bslh::DefaultSeededHashAlgorithm, seeded with the (k_SEED_LENGTH bytes) seed pointed to by the specified seed. Each bit of the supplied seed will contribute to the final hash produced by computeHash(). The behaviour is undefined unless seed points to at least k_SEED_LENGTH bytes of initialized memory.

computeHash

Return the finalized version of the hash that has been accumulated. Note that this changes the internal state of the object, so calling computeHash() multiple times in a row will return different results, and only the first result returned will match the expected result of the algorithm. Also note that a value will be returned, even if data has not been passed into operator().

operator()

Incorporate the specified data, of at least the specified numBytes, into the internal state of the hashing algorithm. Every bit of data incorporated into the internal state of the algorithm will contribute to the final hash produced by computeHash(). The same hash will be produced regardless of whether a sequence of bytes is passed in all at once or through multiple calls to this member function. Input where numBytes is 0 will have no effect on the internal state of the algorithm. The behaviour is undefined unless data points to a valid memory location with at least numBytes bytes of initialized memory or numBytes is zero.

Created with MrDocs