Subject: [Boost-commit] svn:boost r74529 - trunk/libs/filesystem/v3/doc
From: dnljms_at_[hidden]
Date: 2011-09-22 19:55:40
Author: danieljames
Date: 2011-09-22 19:55:40 EDT (Thu, 22 Sep 2011)
New Revision: 74529
URL: http://svn.boost.org/trac/boost/changeset/74529
Log:
Document hash_value for paths.
Text files modified:
trunk/libs/filesystem/v3/doc/reference.html | 9 +++++++++
1 files changed, 9 insertions(+), 0 deletions(-)
Modified: trunk/libs/filesystem/v3/doc/reference.html
==============================================================================
--- trunk/libs/filesystem/v3/doc/reference.html (original)
+++ trunk/libs/filesystem/v3/doc/reference.html 2011-09-22 19:55:40 EDT (Thu, 22 Sep 2011)
@@ -298,6 +298,7 @@
void swap(path& lhs, path& rhs);
bool lexicographical_compare(path::iterator first1, path::iterator last1,
path::iterator first2, path::iterator last2);
+ std::size_t hash_value(const path& p);
bool operator==(const path& lhs, const path& rhs);
bool operator!=(const path& lhs, const path& rhs);
@@ -1175,6 +1176,14 @@
due to the <code>path</code> iterator's value type itself being <code>path</code>.
<i>--end note</i>]</p>
</blockquote>
+<pre>std::size_t hash_value (const path& p);</pre>
+<blockquote>
+ <p><i>Returns:</i> A hash value for the path <code>p</code>. If
+ for two paths, <code>p1 == p2</code> then
+ <code>hash_value(p1) == hash_value(p2)</code>.</p>
+ <p>This allows paths to be used with
+ Boost.Hash.</p>
+</blockquote>
<pre>bool operator< (const path& lhs, const path& rhs);</pre>
<blockquote>
<p><i>Returns:</i> <code>return lexicographical_compare(lhs.begin(), lhs.end(),