Commit 40fd24b8 authored by Davis King's avatar Davis King

updated docs

parent 884fca7a
......@@ -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>
......
......@@ -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>
......
......@@ -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"/>
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment