编译时字符串哈希化

115

我在几个不同的地方读到,使用C++11的新字符串字面值可能可以在编译时计算字符串的哈希值。然而,似乎没有人愿意明确表示这是可能的或如何实现。

  • 这是否可行?
  • 运算符会是什么样子?

我对像这样的用例特别感兴趣。

void foo( const std::string& value )
{
   switch( std::hash(value) )
   {
      case "one"_hash: one(); break;
      case "two"_hash: two(); break;
      /*many more cases*/
      default: other(); break;
   }
}

注意:编译时哈希函数不一定要像我写的那样。我尽力猜测最终解决方案会是什么样子,但 meta_hash<"string"_meta>::value 也可以是一个可行的解决方案。


我似乎也找不到任何东西,但我可以理解将哈希函数强制转换为constexpr的必要性。 - luke
4
是否有编译器已经支持用户自定义字面量?GCC不支持(http://gcc.gnu.org/projects/cxx0x.html),我也没有看到VC10提到它们。如果没有编译器支持,只能猜测,但模板化的用户自定义字面量*看起来*应该是可能的。 提示:
  • 对原文中的技术术语进行翻译,如 "user-defined literals" 翻译为 "用户自定义字面量"。
  • 不要添加解释或额外的信息,如可选项或建议。
- Georg Fritzsche
1
这很可爱但没用吗?如果开关的值是运行时字符串,您还需要检查冲突。也许打包更好(我的答案有一个打包函数来将9个字符装入64位)。 - u0b34a0f6ae
为什么要检查碰撞? - cubuspl42
如果两个case值相等,编译器应该报错。 - Mark Storer
编译器会为您找到冲突。如果您放置了两个相同的case表达式,编译器会抛出错误。该过程变为:1)在编译时哈希上切换2)与字符串进行比较。 - Joshua Hyatt
12个回答

103
这有点晚了,但我成功地使用constexpr实现了一个编译时CRC32函数。问题在于,目前它只能在GCC中使用,不能在MSVC和Intel编译器中使用。
以下是代码片段:
// CRC32 Table (zlib polynomial)
static constexpr uint32_t crc_table[256] = {
    0x00000000L, 0x77073096L, 0xee0e612cL, 0x990951baL, 0x076dc419L,
    0x706af48fL, 0xe963a535L, 0x9e6495a3L, 0x0edb8832L, 0x79dcb8a4L,
    0xe0d5e91eL, 0x97d2d988L, 0x09b64c2bL, 0x7eb17cbdL, 0xe7b82d07L,
...
};
template<size_t idx>
constexpr uint32_t crc32(const char * str)
{
    return (crc32<idx-1>(str) >> 8) ^ crc_table[(crc32<idx-1>(str) ^ str[idx]) & 0x000000FF];
}

// This is the stop-recursion function
template<>
constexpr uint32_t crc32<size_t(-1)>(const char * str)
{
    return 0xFFFFFFFF;
}

// This doesn't take into account the nul char
#define COMPILE_TIME_CRC32_STR(x) (crc32<sizeof(x) - 2>(x) ^ 0xFFFFFFFF)

enum TestEnum
{
    CrcVal01 = COMPILE_TIME_CRC32_STR("stack-overflow"),
};

CrcVal01 等于 0x335CC04A。

希望这能帮到您!


5
没问题。我已经对Python CRC32运行时算法(来自zlib)进行了测试,结果相同。实际上,你想要达到的目的正是我使用这种技术的原因! - Clement JACOB
2
感谢您发布这篇文章,非常有用! - Tamás Szelei
2
你缺少了一个编译标志。此外,我不得不将停止递归模板函数中的值-1强制转换为size_t类型。更新版本在这里可用(适用于Clang 3.3):http://goo.gl/vPMkfB - Clement JACOB
1
constexpr 在 VS2013 中不可用,除了在 2013 年 11 月的 CTP 版本中 http://blogs.msdn.com/b/vcblog/archive/2013/11/18/announcing-the-visual-c-compiler-november-2013-ctp.aspx - user472308
3
你正在进行两次递归调用。这个解决方案与字符串长度呈指数级复杂度,编译器无法聪明地省略第二次调用。请查看其他答案,以找到可能修复此问题的方法。 - CygnusX1
显示剩余7条评论

31

按照我对§7.1.5/3和§5.19的理解,以下内容可能是合法的:

unsigned constexpr const_hash(char const *input) {
    return *input ?
        static_cast<unsigned int>(*input) + 33 * const_hash(input + 1) :
        5381;
}

这似乎遵循 §7.1.5/3 中的基本规则:
  1. 形式为:"return expression;"
  2. 它的唯一参数是指针,它是标量类型,因此是字面类型。
  3. 其返回值为无符号整数,也是标量(因此是字面值)。
  4. 没有到返回类型的隐式转换。
有些问题是 *input 是否涉及非法的左值到右值转换,我不确定我是否足够理解 §5.19/2/6/21 和 §4.1 中的规则以确定这一点。
从实际角度来看,此代码被 (例如) g++ 接受,至少回溯到 g++ 4.7.1。
使用方式类似于:
switch(std::hash(value)) {
    case const_hash("one"): one(); break;
    case const_hash("two"): two(); break;
    // ...
    default: other(); break;
}

为了符合§5.19/2/6/2的要求,您可能需要做类似于以下的操作:
// one of the `constexpr`s is probably redundant, but I haven't figure out which.
char constexpr * constexpr v_one = "one"; 

// ....

case const_hash(v_one): one(); break;
  1. 我使用额外的“斜杠”数字来指代未编号的项目符号,所以这是第六条§5.19/2下的第二个项目符号。我认为我可能需要与Pete Becker交谈,看是否可以添加一些数字/字母/罗马数字来标识这样的部分层次结构...

3
有两个问题。1:constexpr中不允许递归调用,2:你没有停止条件(即*input == nullptr),根据我理解,constexpr中不能有停止条件。 - Motti
10
在哪里说不能在constexpr中使用递归?我所看到的只是说你调用的任何函数必须本身标记为constexpr(§5.19/2/2)。我在终止条件上犯了一个错误,现在已经修复了(我在应该是&&的地方不小心使用了||)。 - Jerry Coffin
3
递归 constexpr。我读到了一份2008年的会议记录。当时讨论了允许或禁止递归 constexpr 函数的问题。要点是当前的措辞并没有禁止,稍微暗示可以这么做。委员会认为这样一个强大的特性应该被明确规定。那是在2008年,我不知道之后发生了什么。 - deft_code
3
对,我可能应该指出我是从N3000开始的,这(我相信)是目前最新的草案。我很确定它曾经被禁止过,但至少现在似乎是允许的。 - Jerry Coffin
2
哦,&& 运算符返回一个布尔值,所以这个函数可能不是你想要的。特别地,它对于任何空字符串都会返回 0,并且对于某些以字符开头且转换为 (unsigned)-1 的字符串也会返回 0;而对于其他所有字符串则返回 1。可以使用条件运算符进行重写吗? - ndkrempel
显示剩余8条评论

17

这段代码基于Clement JACOB的代码,但也可以在clang上使用。它的编译速度应该更快(只有一个递归调用,而原始代码中有两个)。

#include <iostream>
#include <string>
#include <vector>

static constexpr unsigned int crc_table[256] = {
    0x00000000, 0x77073096, 0xee0e612c, 0x990951ba, 0x076dc419, 0x706af48f,
    0xe963a535, 0x9e6495a3,    0x0edb8832, 0x79dcb8a4, 0xe0d5e91e, 0x97d2d988,
    0x09b64c2b, 0x7eb17cbd, 0xe7b82d07, 0x90bf1d91, 0x1db71064, 0x6ab020f2,
    0xf3b97148, 0x84be41de, 0x1adad47d, 0x6ddde4eb, 0xf4d4b551, 0x83d385c7,
    0x136c9856, 0x646ba8c0, 0xfd62f97a, 0x8a65c9ec, 0x14015c4f, 0x63066cd9,
    0xfa0f3d63, 0x8d080df5, 0x3b6e20c8, 0x4c69105e, 0xd56041e4, 0xa2677172,
    0x3c03e4d1, 0x4b04d447, 0xd20d85fd, 0xa50ab56b, 0x35b5a8fa, 0x42b2986c,
    0xdbbbc9d6, 0xacbcf940, 0x32d86ce3, 0x45df5c75, 0xdcd60dcf, 0xabd13d59,
    0x26d930ac, 0x51de003a, 0xc8d75180, 0xbfd06116, 0x21b4f4b5, 0x56b3c423,
    0xcfba9599, 0xb8bda50f, 0x2802b89e, 0x5f058808, 0xc60cd9b2, 0xb10be924,
    0x2f6f7c87, 0x58684c11, 0xc1611dab, 0xb6662d3d, 0x76dc4190, 0x01db7106,
    0x98d220bc, 0xefd5102a, 0x71b18589, 0x06b6b51f, 0x9fbfe4a5, 0xe8b8d433,
    0x7807c9a2, 0x0f00f934, 0x9609a88e, 0xe10e9818, 0x7f6a0dbb, 0x086d3d2d,
    0x91646c97, 0xe6635c01, 0x6b6b51f4, 0x1c6c6162, 0x856530d8, 0xf262004e,
    0x6c0695ed, 0x1b01a57b, 0x8208f4c1, 0xf50fc457, 0x65b0d9c6, 0x12b7e950,
    0x8bbeb8ea, 0xfcb9887c, 0x62dd1ddf, 0x15da2d49, 0x8cd37cf3, 0xfbd44c65,
    0x4db26158, 0x3ab551ce, 0xa3bc0074, 0xd4bb30e2, 0x4adfa541, 0x3dd895d7,
    0xa4d1c46d, 0xd3d6f4fb, 0x4369e96a, 0x346ed9fc, 0xad678846, 0xda60b8d0,
    0x44042d73, 0x33031de5, 0xaa0a4c5f, 0xdd0d7cc9, 0x5005713c, 0x270241aa,
    0xbe0b1010, 0xc90c2086, 0x5768b525, 0x206f85b3, 0xb966d409, 0xce61e49f,
    0x5edef90e, 0x29d9c998, 0xb0d09822, 0xc7d7a8b4, 0x59b33d17, 0x2eb40d81,
    0xb7bd5c3b, 0xc0ba6cad, 0xedb88320, 0x9abfb3b6, 0x03b6e20c, 0x74b1d29a,
    0xead54739, 0x9dd277af, 0x04db2615, 0x73dc1683, 0xe3630b12, 0x94643b84,
    0x0d6d6a3e, 0x7a6a5aa8, 0xe40ecf0b, 0x9309ff9d, 0x0a00ae27, 0x7d079eb1,
    0xf00f9344, 0x8708a3d2, 0x1e01f268, 0x6906c2fe, 0xf762575d, 0x806567cb,
    0x196c3671, 0x6e6b06e7, 0xfed41b76, 0x89d32be0, 0x10da7a5a, 0x67dd4acc,
    0xf9b9df6f, 0x8ebeeff9, 0x17b7be43, 0x60b08ed5, 0xd6d6a3e8, 0xa1d1937e,
    0x38d8c2c4, 0x4fdff252, 0xd1bb67f1, 0xa6bc5767, 0x3fb506dd, 0x48b2364b,
    0xd80d2bda, 0xaf0a1b4c, 0x36034af6, 0x41047a60, 0xdf60efc3, 0xa867df55,
    0x316e8eef, 0x4669be79, 0xcb61b38c, 0xbc66831a, 0x256fd2a0, 0x5268e236,
    0xcc0c7795, 0xbb0b4703, 0x220216b9, 0x5505262f, 0xc5ba3bbe, 0xb2bd0b28,
    0x2bb45a92, 0x5cb36a04, 0xc2d7ffa7, 0xb5d0cf31, 0x2cd99e8b, 0x5bdeae1d,
    0x9b64c2b0, 0xec63f226, 0x756aa39c, 0x026d930a, 0x9c0906a9, 0xeb0e363f,
    0x72076785, 0x05005713, 0x95bf4a82, 0xe2b87a14, 0x7bb12bae, 0x0cb61b38,
    0x92d28e9b, 0xe5d5be0d, 0x7cdcefb7, 0x0bdbdf21, 0x86d3d2d4, 0xf1d4e242,
    0x68ddb3f8, 0x1fda836e, 0x81be16cd, 0xf6b9265b, 0x6fb077e1, 0x18b74777,
    0x88085ae6, 0xff0f6a70, 0x66063bca, 0x11010b5c, 0x8f659eff, 0xf862ae69,
    0x616bffd3, 0x166ccf45, 0xa00ae278, 0xd70dd2ee, 0x4e048354, 0x3903b3c2,
    0xa7672661, 0xd06016f7, 0x4969474d, 0x3e6e77db, 0xaed16a4a, 0xd9d65adc,
    0x40df0b66, 0x37d83bf0, 0xa9bcae53, 0xdebb9ec5, 0x47b2cf7f, 0x30b5ffe9,
    0xbdbdf21c, 0xcabac28a, 0x53b39330, 0x24b4a3a6, 0xbad03605, 0xcdd70693,
    0x54de5729, 0x23d967bf, 0xb3667a2e, 0xc4614ab8, 0x5d681b02, 0x2a6f2b94,
    0xb40bbe37, 0xc30c8ea1, 0x5a05df1b, 0x2d02ef8d
};


template<int size, int idx = 0, class dummy = void>
struct MM{
  static constexpr unsigned int crc32(const char * str, unsigned int prev_crc = 0xFFFFFFFF)
  {
      return MM<size, idx+1>::crc32(str, (prev_crc >> 8) ^ crc_table[(prev_crc ^ str[idx]) & 0xFF] );
  }
};

// This is the stop-recursion function
template<int size, class dummy>
struct MM<size, size, dummy>{
  static constexpr unsigned int crc32(const char * str, unsigned int prev_crc = 0xFFFFFFFF)
  {
      return prev_crc^ 0xFFFFFFFF;
  }
};

// This don't take into account the nul char
#define COMPILE_TIME_CRC32_STR(x) (MM<sizeof(x)-1>::crc32(x))


template<unsigned int crc>
void PrintCrc()
{
    std::cout << crc << std::endl;
}


int main()
{

    PrintCrc<COMPILE_TIME_CRC32_STR("HAH")>();
}

See proof of concept here


1
谢谢,Jacob的答案在GCC上对我想要的东西很好用,但是在msvc上处理更大的字符串时会出现错误。你的答案可以在msvc上处理我需要哈希的更大的字符串。 - Daniel Moodie

14

这是尽可能准确地解决提问者的问题的尝试。

namespace my_hash {
  template<class>struct hasher;
  template<>
  struct hasher<std::string> {
    std::size_t constexpr operator()(char const *input)const {
      return *input ?
        static_cast<unsigned int>(*input) + 33 * (*this)(input + 1) :
        5381;
    }
    std::size_t operator()( const std::string& str ) const {
      return (*this)(str.c_str());
    }
  };
  template<typename T>
  std::size_t constexpr hash(T&& t) {
    return hasher< typename std::decay<T>::type >()(std::forward<T>(t));
  }
  inline namespace literals {
    std::size_t constexpr operator "" _hash(const char* s,size_t) {
      return hasher<std::string>()(s);
    }
  }
}
using namespace my_hash::literals;
void one() {} void two() {} void other() {}

void foo( const std::string& value )
{
  switch( my_hash::hash(value) )
  {
    case "one"_hash: one(); break;
    case "two"_hash: two(); break;
    /*many more cases*/
    default: other(); break;
  }
}

实时示例

请注意主要区别——由于我们无法控制std::hash的算法,因此不能使用它,我们必须重新实现它作为constexpr才能在编译时评估它。此外,在std中没有“透明”的哈希,因此您不能(除非创建std::string)将原始字符缓冲区哈希为std::string

我将支持透明const char*std::string自定义哈希器(hasher)放入了my_hash命名空间,因此如果需要一致性,则可以将其存储在std::unordered_map中。

基于@JerryCoffin的出色答案和下面的评论线程,但尝试使用当前的C++11最佳实践来编写它(而不是预测它们!)。

请注意,对于switch语句case使用“原始哈希”是危险的。您需要之后进行==比较以确认它是否有效。


2
实时示例链接似乎错误/过时了? - fuenfundachtzig
1
@fuenfundachtzig 你相信我刚刚修好了它吗? - Yakk - Adam Nevraumont

12

基于Clement JACOB的解决方法,这是另一种解决方案,利用C++11的constexpr(而不是扩展的C++14),但只有一个递归。

namespace detail {
// CRC32 Table (zlib polynomial)
static constexpr uint32_t crc_table[256] = { 0x00000000L, 0x77073096L, ... }

template<size_t idx>
constexpr uint32_t combine_crc32(const char * str, uint32_t part) {
  return (part >> 8) ^ crc_table[(part ^ str[idx]) & 0x000000FF];
}

template<size_t idx>
constexpr uint32_t crc32(const char * str) {
  return combine_crc32<idx>(str, crc32<idx - 1>(str));
}

// This is the stop-recursion function
template<>
constexpr uint32_t crc32<size_t(-1)>(const char * str) {
  return 0xFFFFFFFF;
}

} //namespace detail

template <size_t len>
constexpr uint32_t ctcrc32(const char (&str)[len]) {
  return detail::crc32<len - 2>(str) ^ 0xFFFFFFFF;
}

一些解释

  • 我们使用单个递归,使得函数即使在较长的字符串情况下也能良好运行。
  • 额外的combine_crc32函数允许我们将递归结果存储在变量part下并使用两次。该函数是C++11限制不允许局部变量声明的解决方法。
  • ctcrc32函数期望一个字符串字面值,其被传递为const char (&)[len]。这样,我们可以将字符串长度作为模板参数,并且不必依赖宏。

2
这最终成为了我最喜欢的实现方式,谢谢。 - Daniel Moodie

12

如果您有C++17编译器和string_view,则变得非常简单,只需编写普通版本:

constexpr uint32_t crc32(std::string_view str)
{
    uint32_t crc = 0xffffffff;
    for (auto c : str)
        crc = (crc >> 8) ^ crc_table[(crc ^ c) & 0xff];
    return crc ^ 0xffffffff;
}

请注意,如果您只是编写crc32("mystring")(通常VS倾向于这样做),编译器可能会决定在编译时不处理它。解决此问题的技巧是创建一个取决于您的crc32的编译时评估的constexpr变量。通常情况下,constexpr uint32_t val = crc32("mystring"); - Guillaume Gris

8
请注意,如下所述,此处显示的表单尚未被接受为标准。
通过在N2765中提出的用户定义字面量,猜测可以实现编译时字符串处理。正如我已经提到的,我不知道任何当前实现它的编译器,没有编译器的支持只能进行猜测。
draft的§2.13.7.3和4中,我们有以下内容:
否则(S包含文字操作符模板),L被视为形式为operator "" X<'c1','c2',...,'ck'>()的调用, 其中n是源字符序列c1c2...ck。[注:序列c1c2...ck只能包含基本源字符集中的字符。-结束语]
结合constexpr,我们应该有编译时字符串处理。

更新:我忽视了自己读错了段落,这种形式允许用户定义的整数字面量和浮点数字面量,但显然不适用于字符串字面量(§2.13.7.5)。

话虽如此,在我有限的了解C++0x的情况下,它可能看起来像这样(我很可能弄错了一些东西):

template<char c, char... str>
struct hash {
    static const unsigned result = c + hash<str...>::result;
};

template<char c>
struct hash {
    static const unsigned result = c;
};

template<char... str> 
constexpr unsigned
operator "" _hash() {
    return hash<str>::result;
}

// update: probably wrong, because the above 
// form is not allowed for string-literals:    
const unsigned h = "abcd"_hash;

如果杰瑞的方法有效,则以下内容应该也有效:
constexpr unsigned operator "" _hash(const char* s, size_t) {
    return const_hash(s);
}

不错(也必要)的变长模板和constexpr用户定义字面量的组合。我不确定您是否可以将字符串字面量用作模板参数,它们是否具有静态链接?(至少在C++98中是这样,并且因此禁止作为模板参数使用)。 - Motti
我把段落搞混了,认为这种情况是个例外 - 可悲的是它似乎并不是这样。 - Georg Fritzsche
1
@Motti:gf 在哪里使用字符串字面值作为模板参数?你是不是混淆了将可变参数模板传递为字符串字面值? - deft_code
从最初的提案来看,字符串字面量的模板版本似乎没有被接受(由于连接问题?http://stackoverflow.com/questions/1108008/any-ideas-for-c1y/1109243#1109243 - 评论)- 真遗憾。 - Georg Fritzsche
1
operator ""_hash 的最新版本在我的 Xcode 5.0.2 上运行良好。 - cubuspl42

6

这里有另一个基于CygnusX1的答案的C++11实现,它可以处理constexprchar数组和运行时string

namespace detail {

    // CRC32 Table (zlib polynomial)
    static constexpr uint32_t crc_table[256] = { 0x00000000L, 0x77073096L, ... };

    constexpr uint32_t combine_crc32(size_t idx, const char * str, uint32_t part) {
        return (part >> 8) ^ crc_table[(part ^ str[idx]) & 0x000000FF];
    }

    constexpr uint32_t crc32(size_t idx, const char * str) {
        return idx == size_t(-1) ? 
            0xFFFFFFFF : combine_crc32(idx, str, crc32(idx - 1, str));
    }
}

uint32_t ctcrc32(std::string const& str) {
    size_t len = str.size() + 1;
    return detail::crc32(len - 2, str.c_str()) ^ 0xFFFFFFFF;
}

template <size_t N>
constexpr uint32_t ctcrc32(const char (&str)[N]) {
    return detail::crc32(N - 2, str) ^ 0xFFFFFFFF;
}

在第一个重载中需要使用str.size() + 1,因为第二个重载中的N是数组的大小,包括空终止字符(而std::string::size不考虑它)。
我没有添加const char *的重载,因为它会与第二个重载混淆——您可以轻松添加const char *,size_tstd::string_view的重载。

6
以下代码适用于GCC 4.6.1,并且在switch语句中可以使用hash或pack。
/* Fast simple string hash (Bernstein?) */                                       
constexpr unsigned int hash(const char *s, int off = 0) {                        
    return !s[off] ? 5381 : (hash(s, off+1)*33) ^ s[off];                           
}                                                                                

/* Pack the string into an unsigned int                                          
 * Using 7 bits (ascii) it packs 9 chars into a uint64_t                         
 */                                                                              
template <class T = uint64_t, unsigned int Bits = 7>                             
constexpr T pack(const char *s, unsigned int off = 0) {                          
    return (Bits*off >= CHAR_BIT*sizeof(T) || !s[off]) ? 0 :                     
        (((T)s[off] << (Bits*off)) | pack(s,off+1));                             
}  

GCC似乎不允许我们在递归调用中传递指向 s 的指针变量 s+1,这就是为什么我使用 off 变量的原因。

5

这是一个不错的问题。

根据Jerry Coffin的答案,我创建了另一个与Visual Studio 2017的std::hash兼容的答案。

#include <functional>
#include <cassert>
using namespace std;


constexpr size_t cx_hash(const char* input) {
    size_t hash = sizeof(size_t) == 8 ? 0xcbf29ce484222325 : 0x811c9dc5;
    const size_t prime = sizeof(size_t) == 8 ? 0x00000100000001b3 : 0x01000193;

    while (*input) {
        hash ^= static_cast<size_t>(*input);
        hash *= prime;
        ++input;
    }

    return hash;
}


int main() {
    /* Enter your code here. Read input from STDIN. Print output to STDOUT */

    auto a = cx_hash("test");
    hash<string> func;
    auto b = func("test");
    assert(a == b);

    return 0;
}

https://github.com/manuelgustavo/cx_hash


网页内容由stack overflow 提供, 点击上面的
可以查看英文原文,
原文链接