diff --git a/docs/docs/algorithms.xml b/docs/docs/algorithms.xml index 80bf7f07937b90a59afc5029facb7f261d795c9c..9af472c8e3a3cfd4c93ea2acbf9484d449f91ce8 100644 --- a/docs/docs/algorithms.xml +++ b/docs/docs/algorithms.xml @@ -27,6 +27,8 @@ <item>bigint</item> <item>crc32</item> <item>rand</item> + <item>hash</item> + <item>murmur_hash3</item> <item>running_stats</item> <item>running_scalar_covariance</item> <item>running_covariance</item> @@ -169,6 +171,37 @@ </component> + <!-- ************************************************************************* --> + + <component> + <name>murmur_hash3</name> + <file>dlib/hash.h</file> + <spec_file>dlib/general_hash/murmur_hash3_abstract.h</spec_file> + <description> + This function takes a block of memory and returns a 32bit hash. The + hashing algorithm used is Austin Appleby's excellent + <a href="http://code.google.com/p/smhasher/">MurmurHash3</a>. + </description> + + </component> + + <!-- ************************************************************************* --> + + <component> + <name>hash</name> + <file>dlib/hash.h</file> + <spec_file>dlib/general_hash/hash_abstract.h</spec_file> + <description> + This is a set of convenience functions for invoking <a href="#murmur_hash3">murmur_hash3</a> + on std::strings, std::vectors, std::maps, or <a href="containers.html#matrix">dlib::matrix</a> objects. + <p> + As an aside, the hash() for matrix objects is defined <a href="dlib/matrix/matrix_utilities_abstract.h.html#hash">here</a>. + It has the same interface as all the others. + </p> + </description> + + </component> + <!-- ************************************************************************* --> <component> diff --git a/docs/docs/containers.xml b/docs/docs/containers.xml index 61eddeb75a358fd114026dc55dae54641bb437b3..ce3007fb2f58b66404b5ac735e31e9b79054f4e3 100644 --- a/docs/docs/containers.xml +++ b/docs/docs/containers.xml @@ -475,6 +475,10 @@ <name>set_all_elements</name> <link>dlib/matrix/matrix_utilities_abstract.h.html#set_all_elements</link> </item> + <item> + <name>hash</name> + <link>dlib/matrix/matrix_utilities_abstract.h.html#hash</link> + </item> <item> <name>tmp</name> <link>dlib/matrix/matrix_utilities_abstract.h.html#tmp</link> diff --git a/docs/docs/term_index.xml b/docs/docs/term_index.xml index 45b01ce9e08db0bd99e6d2d25c276de1404cdfe9..e42d4c80aca23517fceb194d833415aaedb59efc 100644 --- a/docs/docs/term_index.xml +++ b/docs/docs/term_index.xml @@ -853,6 +853,8 @@ <term file="algorithms.html" name="bigint"/> <term file="algorithms.html" name="crc32"/> + <term file="algorithms.html" name="murmur_hash3"/> + <term file="algorithms.html" name="hash"/> <term file="algorithms.html" name="md5"/>