forked from boostorg/container_hash
Move 'functional' headers and update paths
This commit is contained in:
+1
-1
@@ -15,7 +15,7 @@ boostbook standalone : hash :
|
||||
<xsl:param>generate.section.toc.level=2
|
||||
<xsl:param>toc.section.depth=1
|
||||
<xsl:param>toc.max.depth=1
|
||||
<format>pdf:<xsl:param>boost.url.prefix=http://www.boost.org/doc/libs/release/libs/functional/hash/doc/html
|
||||
<format>pdf:<xsl:param>boost.url.prefix=http://www.boost.org/doc/libs/release/libs/container_hash/hash/doc/html
|
||||
;
|
||||
|
||||
###############################################################################
|
||||
|
||||
+7
-7
@@ -19,8 +19,8 @@
|
||||
|
||||
* Use declarations for standard classes, so that the library
|
||||
doesn't need to include all of their headers
|
||||
* Deprecated the `<boost/functional/hash/*.hpp>` headers. Now a single header,
|
||||
<[headerref boost/functional/hash.hpp]> is used.
|
||||
* Deprecated the `<boost/container_hash/hash/*.hpp>` headers. Now a single header,
|
||||
<[headerref boost/container_hash/hash.hpp]> is used.
|
||||
* Add support for the `BOOST_HASH_NO_EXTENSIONS` macro, which
|
||||
disables the extensions to TR1.
|
||||
|
||||
@@ -71,10 +71,10 @@
|
||||
|
||||
* Changed the warnings in the deprecated headers from 1.34.0 to errors. These
|
||||
will be removed in a future version of Boost.
|
||||
* Moved detail headers out of `boost/functional/detail`, since they are part of
|
||||
functional/hash, not functional. `boost/functional/detail/container_fwd.hpp`
|
||||
* Moved detail headers out of `boost/container_hash/detail`, since they are part of
|
||||
container_hash/hash, not container_hash. `boost/container_hash/detail/container_fwd.hpp`
|
||||
has been moved to `boost/detail/container_fwd.hpp` as it's used outside of
|
||||
this library, the others have been moved to `boost/functional/hash/detail`.
|
||||
this library, the others have been moved to `boost/container_hash/hash/detail`.
|
||||
|
||||
[h2 Boost 1.39.0]
|
||||
|
||||
@@ -132,7 +132,7 @@
|
||||
* [@http://svn.boost.org/trac/boost/ticket/6806 Ticket 6806]:
|
||||
Support `std::array` and `std::tuple` when available.
|
||||
* Add deprecation warning to the long deprecated
|
||||
`boost/functional/detail/container_fwd.hpp`.
|
||||
`boost/container_hash/detail/container_fwd.hpp`.
|
||||
|
||||
[h2 Boost 1.51.0]
|
||||
|
||||
@@ -177,7 +177,7 @@
|
||||
[h2 Boost 1.58.0]
|
||||
|
||||
* Fixed strict aliasing violation
|
||||
([@https://github.com/boostorg/functional/pull/3 GitHub #3]).
|
||||
([@https://github.com/boostorg/container_hash/pull/3 GitHub #3]).
|
||||
|
||||
[h2 Boost 1.63.0]
|
||||
|
||||
|
||||
+1
-1
@@ -10,7 +10,7 @@ to turn them of in order to check that your code will work with other
|
||||
implementations of TR1. To do this define the macro `BOOST_HASH_NO_EXTENSIONS`.
|
||||
When this macro is defined, only the specialisations detailed
|
||||
in TR1 will be declared. But, if you later undefine the macro and include
|
||||
<[headerref boost/functional/hash.hpp]> then the non-specialised form will be defined
|
||||
<[headerref boost/container_hash/hash.hpp]> then the non-specialised form will be defined
|
||||
- activating the extensions.
|
||||
|
||||
It is strongly recommended that you never undefine the macro - and only define
|
||||
|
||||
+2
-2
@@ -1,4 +1,4 @@
|
||||
[library Boost.Functional/Hash
|
||||
[library Boost.ContainerHash
|
||||
[quickbook 1.5]
|
||||
[authors [James, Daniel]]
|
||||
[copyright 2005 2006 2007 2008 Daniel James]
|
||||
@@ -6,7 +6,7 @@
|
||||
defined types]
|
||||
[category higher-order]
|
||||
[id hash]
|
||||
[dirname functional/hash]
|
||||
[dirname container_hash]
|
||||
[license
|
||||
Distributed under the Boost Software License, Version 1.0.
|
||||
(See accompanying file LICENSE_1_0.txt or copy at
|
||||
|
||||
+1
-1
@@ -88,6 +88,6 @@ boost namespace:
|
||||
}
|
||||
|
||||
Full code for this example is at
|
||||
[@boost:/libs/functional/hash/examples/portable.cpp /libs/functional/hash/examples/portable.cpp].
|
||||
[@boost:/libs/container_hash/hash/examples/portable.cpp /libs/container_hash/hash/examples/portable.cpp].
|
||||
|
||||
[endsect]
|
||||
|
||||
+4
-4
@@ -13,7 +13,7 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
|
||||
<ulink url="http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2005/n1837.pdf">Library Extension Technical Report Issues List</ulink> (page 63).
|
||||
</para>
|
||||
</section>
|
||||
<header name="boost/functional/hash.hpp">
|
||||
<header name="boost/container_hash/hash.hpp">
|
||||
<para>
|
||||
Defines <code><classname>boost::hash</classname></code>,
|
||||
and helper functions.
|
||||
@@ -57,7 +57,7 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
|
||||
</para>
|
||||
<para>
|
||||
Forward declared in
|
||||
<code><boost/functional/hash_fwd.hpp></code>
|
||||
<code><boost/container_hash/hash_fwd.hpp></code>
|
||||
</para>
|
||||
<para>
|
||||
This hash function is not intended for general use, and isn't
|
||||
@@ -542,7 +542,7 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
|
||||
<para>This is an extension to TR1</para>
|
||||
<para>
|
||||
Forward declared in
|
||||
<code><boost/functional/hash_fwd.hpp></code>
|
||||
<code><boost/container_hash/hash_fwd.hpp></code>
|
||||
</para>
|
||||
<para>
|
||||
This hash function is not intended for general use, and isn't
|
||||
@@ -615,7 +615,7 @@ for(; first != last; ++first)
|
||||
<para>This is an extension to TR1</para>
|
||||
<para>
|
||||
Forward declared in
|
||||
<code><boost/functional/hash_fwd.hpp></code>
|
||||
<code><boost/container_hash/hash_fwd.hpp></code>
|
||||
</para>
|
||||
<para>
|
||||
This hash function is not intended for general use, and isn't
|
||||
|
||||
+7
-7
@@ -27,7 +27,7 @@ associative containers and you wish to use
|
||||
|
||||
To use [classref boost::hash] directly, create an instance and call it as a function:
|
||||
|
||||
#include <``[headerref boost/functional/hash.hpp]``>
|
||||
#include <``[headerref boost/container_hash/hash.hpp]``>
|
||||
|
||||
int main()
|
||||
{
|
||||
@@ -110,9 +110,9 @@ And you can now use [classref boost::hash] with book:
|
||||
assert(books.find(dandelion) == books.end());
|
||||
|
||||
The full example can be found in:
|
||||
[@boost:/libs/functional/hash/examples/books.hpp /libs/functional/hash/examples/books.hpp]
|
||||
[@boost:/libs/container_hash/hash/examples/books.hpp /libs/container_hash/hash/examples/books.hpp]
|
||||
and
|
||||
[@boost:/libs/functional/hash/examples/books.cpp /libs/functional/hash/examples/books.cpp].
|
||||
[@boost:/libs/container_hash/hash/examples/books.cpp /libs/container_hash/hash/examples/books.cpp].
|
||||
|
||||
[tip
|
||||
When writing a hash function, first look at how the equality function works.
|
||||
@@ -170,7 +170,7 @@ of point, it can be repeatedly called for any number of elements. It calls
|
||||
[funcref boost::hash_value hash_value] on the supplied element, and combines it with the seed.
|
||||
|
||||
Full code for this example is at
|
||||
[@boost:/libs/functional/hash/examples/point.cpp /libs/functional/hash/examples/point.cpp].
|
||||
[@boost:/libs/container_hash/hash/examples/point.cpp /libs/container_hash/hash/examples/point.cpp].
|
||||
|
||||
[note
|
||||
When using [funcref boost::hash_combine] the order of the
|
||||
@@ -200,13 +200,13 @@ To calculate the hash of an iterator range you can use [funcref boost::hash_rang
|
||||
|
||||
Note that when writing template classes, you might not want to include the main
|
||||
hash header as it's quite an expensive include that brings in a lot of other
|
||||
headers, so instead you can include the `<boost/functional/hash_fwd.hpp>`
|
||||
headers, so instead you can include the `<boost/container_hash/hash_fwd.hpp>`
|
||||
header which forward declares [classref boost::hash],
|
||||
[funcref boost::hash_range] and [funcref boost::hash_combine]. You'll need to
|
||||
include the main header before instantiating [classref boost::hash]. When using
|
||||
a container that uses [classref boost::hash] it should do that for you, so your
|
||||
type will work fine with the boost hash containers. There's an example of this
|
||||
in [@boost:/libs/functional/hash/examples/template.hpp template.hpp] and
|
||||
[@boost:/libs/functional/hash/examples/template.cpp template.cpp].
|
||||
in [@boost:/libs/container_hash/hash/examples/template.hpp template.hpp] and
|
||||
[@boost:/libs/container_hash/hash/examples/template.cpp template.cpp].
|
||||
|
||||
[endsect]
|
||||
|
||||
Reference in New Issue
Block a user