HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
stringHash.h
Go to the documentation of this file.
1 //
2 // Copyright 2018 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 
25 #ifndef PXR_BASE_TRACE_STRING_HASH_H
26 #define PXR_BASE_TRACE_STRING_HASH_H
27 
28 #include "pxr/pxr.h"
29 
30 #include <cstdint>
31 
33 
34 ///////////////////////////////////////////////////////////////////////////////
35 ///
36 /// \class TraceStringHash
37 ///
38 /// This class provides a function to compute compile time hashes for string
39 /// literals.
40 ///
42  public:
43 
44  /// Computes a compile time hash of \p str.
45  template <int N>
46  static constexpr std::uint32_t Hash(const char (&str)[N]) {
47  return djb2HashStr<N-1>(str);
48  }
49 
50  private:
51  // Recursive function computing the xor variant of the djb2 hash
52  // function.
53  template <int N>
54  static constexpr std::uint32_t djb2HashStr(const char* str) {
55  return (djb2HashStr<N-1>(str) * 33) ^ str[N-1];
56  }
57 };
58 
59 // Template recursion base case.
60 template <>
61 constexpr std::uint32_t TraceStringHash::djb2HashStr<0>(const char* str) {
62  return 5381;
63 }
64 
66 
67 #endif //PXR_BASE_TRACE_STRING_HASH_H
static constexpr std::uint32_t Hash(const char(&str)[N])
Computes a compile time hash of str.
Definition: stringHash.h:46
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1375
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
GA_API const UT_StringHolder N