From 40fd24b8d317484f636b2c4a1820b2d799aa8872 Mon Sep 17 00:00:00 2001
From: Davis King <davis@dlib.net>
Date: Sat, 28 May 2011 19:03:08 -0400
Subject: [PATCH] updated docs
---
docs/docs/algorithms.xml | 33 +++++++++++++++++++++++++++++++++
docs/docs/containers.xml | 4 ++++
docs/docs/term_index.xml | 2 ++
3 files changed, 39 insertions(+)
diff --git a/docs/docs/algorithms.xml b/docs/docs/algorithms.xml
index 80bf7f07..9af472c8 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 61eddeb7..ce3007fb 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 45b01ce9..e42d4c80 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"/>
--
2.18.0