All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
hash.h
1 //
2 // Copyright 2016 Pixar
3 //
4 // Licensed under the Apache License, Version 2.0 (the "Apache License")
5 // with the following modification; you may not use this file except in
6 // compliance with the Apache License and the following modification to it:
7 // Section 6. Trademarks. is deleted and replaced with:
8 //
9 // 6. Trademarks. This License does not grant permission to use the trade
10 // names, trademarks, service marks, or product names of the Licensor
11 // and its affiliates, except as required to comply with Section 4(c) of
12 // the License and to reproduce the content of the NOTICE file.
13 //
14 // You may obtain a copy of the Apache License at
15 //
16 // http://www.apache.org/licenses/LICENSE-2.0
17 //
18 // Unless required by applicable law or agreed to in writing, software
19 // distributed under the Apache License with the above modification is
20 // distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
21 // KIND, either express or implied. See the Apache License for the specific
22 // language governing permissions and limitations under the Apache License.
23 //
24 #ifndef VT_HASH_H
25 #define VT_HASH_H
26 
27 #include "pxr/pxr.h"
28 #include "pxr/base/vt/api.h"
29 #include "pxr/base/tf/hash.h"
30 #include <boost/functional/hash.hpp>
31 #include <typeinfo>
32 #include <utility>
33 
34 PXR_NAMESPACE_OPEN_SCOPE
35 
36 namespace Vt_HashDetail {
37 
38 // Issue a coding error when we attempt to hash a t.
39 VT_API void _IssueUnimplementedHashError(std::type_info const &t);
40 
41 // We make unqualified calls, intending to pick up boost::hash_value if an
42 // overload isn't found by ADL.
43 using boost::hash_value;
44 
45 // A constexpr function that determines hashability.
46 template <class T, class = decltype(hash_value(std::declval<T>()))>
47 constexpr bool _IsHashable(int) { return true; }
48 template <class T, class = decltype(TfHash()(std::declval<T>()))>
49 constexpr bool _IsHashable(long) { return true; }
50 template <class T>
51 constexpr bool _IsHashable(...) { return false; }
52 
53 // Hash implementations -- We're using an overload resolution ordering trick
54 // here (int vs long vs ...) so that we pick hash_value first, if possible,
55 // otherwise we do TfHash() if possible, otherwise we issue a runtime error.
56 template <class T, class = decltype(hash_value(std::declval<T>()))>
57 inline size_t
58 _HashValueImpl(T const &val, int)
59 {
60  return hash_value(val);
61 }
62 
63 template <class T, class = decltype(TfHash()(std::declval<T>()))>
64 inline size_t
65 _HashValueImpl(T const &val, long)
66 {
67  return TfHash()(val);
68 }
69 
70 template <class T>
71 inline size_t
72 _HashValueImpl(T const &val, ...)
73 {
74  Vt_HashDetail::_IssueUnimplementedHashError(typeid(T));
75  return 0;
76 }
77 
78 } // Vt_HashDetail
79 
80 
84 template <class T>
85 constexpr bool
86 VtIsHashable() {
87  return Vt_HashDetail::_IsHashable<T>(0);
88 }
89 
93 template <class T>
94 size_t VtHashValue(T const &val)
95 {
96  return Vt_HashDetail::_HashValueImpl(val, 0);
97 }
98 
99 PXR_NAMESPACE_CLOSE_SCOPE
100 
101 #endif // VT_HASH_H
Provides hash function on STL string types and other types.
Definition: hash.h:86