OrgLion-ML
/
dlib
mirror of https://github.com/davisking/dlib.git
1
0
Fork 0
Code Issues Releases Wiki Activity

Added comments regarding endianness and hashing.

This commit is contained in:
Davis King 2011-05-28 18:06:32 -04:00
parent a68c27be8f
commit 3785d3202d
2 changed files with 37 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
dlib/general_hash/hash_abstract.h
View File

@ -37,6 +37,11 @@ namespace dlib
- Each value of seed results in a different hash function being used.
(e.g. hash(item,0) should generally not be equal to hash(item,1))
- uses the murmur_hash3() routine to compute the actual hash.
- Note that the returned hash value will be different on big-endian and
little-endian systems since hash() doesn't attempt to perform any byte
swapping of the data contained in item. If you want to always obtain
the same hash then you need to byte swap the elements of item before
passing it to hash().
!*/
// ----------------------------------------------------------------------------------------
@ -47,11 +52,19 @@ namespace dlib
uint32 seed = 0
);
/*!
requires
- T is a standard layout type (e.g. a POD type like int, float,
or a simple struct).
ensures
- returns a 32bit hash of the data stored in item.
- Each value of seed results in a different hash function being used.
(e.g. hash(item,0) should generally not be equal to hash(item,1))
- uses the murmur_hash3() routine to compute the actual hash.
- Note that the returned hash value will be different on big-endian and
little-endian systems since hash() doesn't attempt to perform any byte
swapping of the data contained in item. If you want to always obtain
the same hash then you need to byte swap the elements of item before
passing it to hash().
!*/
// ----------------------------------------------------------------------------------------
@ -62,11 +75,19 @@ namespace dlib
uint32 seed = 0
);
/*!
requires
- T and U are standard layout types (e.g. POD types like int, float,
or simple structs).
ensures
- returns a 32bit hash of the data stored in item.
- Each value of seed results in a different hash function being used.
(e.g. hash(item,0) should generally not be equal to hash(item,1))
- uses the murmur_hash3() routine to compute the actual hash.
- Note that the returned hash value will be different on big-endian and
little-endian systems since hash() doesn't attempt to perform any byte
swapping of the data contained in item. If you want to always obtain
the same hash then you need to byte swap the elements of item before
passing it to hash().
!*/
// ----------------------------------------------------------------------------------------
@ -77,11 +98,19 @@ namespace dlib
uint32 seed = 0
);
/*!
requires
- T and U are standard layout types (e.g. POD types like int, float,
or simple structs).
ensures
- returns a 32bit hash of the data stored in item.
- Each value of seed results in a different hash function being used.
(e.g. hash(item,0) should generally not be equal to hash(item,1))
- uses the murmur_hash3() routine to compute the actual hash.
- Note that the returned hash value will be different on big-endian and
little-endian systems since hash() doesn't attempt to perform any byte
swapping of the data contained in item. If you want to always obtain
the same hash then you need to byte swap the elements of item before
passing it to hash().
!*/
// ----------------------------------------------------------------------------------------

8
dlib/matrix/matrix_utilities_abstract.h
View File

@ -705,11 +705,19 @@ namespace dlib
uint32 seed = 0
);
/*!
requires
- T is a standard layout type (e.g. a POD type like int, float,
or a simple struct).
ensures
- returns a 32bit hash of the data stored in item.
- Each value of seed results in a different hash function being used.
(e.g. hash(item,0) should generally not be equal to hash(item,1))
- uses the murmur_hash3() routine to compute the actual hash.
- Note that the returned hash value will be different on big-endian and
little-endian systems since hash() doesn't attempt to perform any byte
swapping of the data contained in item. If you want to always obtain
the same hash then you need to byte swap the elements of item before
passing it to hash().
!*/
// ----------------------------------------------------------------------------------------