diff --git a/README.md b/README.md index 8e485f44..276c42a5 100644 --- a/README.md +++ b/README.md @@ -1925,6 +1925,35 @@ If it cannot, the compilation failed. Assuming 'ptr' is a pointer to a fieldType object which is stored within a structure of type 'type' at the position 'field', it returns a pointer to the structure. +#### HASH Functions + +##### M\_HASH\_SEED --> size\_t + +User shall overwrite this macro by a random seed (of type size_t) before including +the header m-core.h o that all hash functions will use this variable +as a seed for the hash functions. If no user macro is defined, +the default is to expand it to 0, +making all hash computations predictible. + +##### M\_HASH\_DECL(hash) + +Declare and initialize a new hash computation, named 'hash' which +is an integer. + +##### M\_HASH\_UP(hash, value) + +Update the 'hash' variable with the given 'value' +by incorporating the 'value' within the 'hash'. 'value' can be up to a 'size_t' +variable. + +##### uint32_t m\_core\_hash (const void *str, size\_t length) + +Compute the hash of the binary representation of the data pointer by 'str' +of length 'length'. 'str' shall have the same alignement restriction +than an 'uint32_t'. + +#### METHOD Functions + TODO: Document the API. ### M-MUTEX