1 // { dg-options "-std=gnu++0x" }
3 // Copyright (C) 2010 Free Software Foundation, Inc.
4 //
5 // This file is part of the GNU ISO C++ Library.  This library is free
6 // software; you can redistribute it and/or modify it under the
7 // terms of the GNU General Public License as published by the
8 // Free Software Foundation; either version 3, or (at your option)
9 // any later version.
10 //
11 // This library is distributed in the hope that it will be useful,
12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14 // GNU General Public License for more details.
15 //
16 // You should have received a copy of the GNU General Public License
17 // along with this library; see the file COPYING3.  If not see
20 // This file uses the chi^2 test to measure the quality of a hash
21 // function, by computing the uniformity with which it distributes a set
22 // of N strings into k buckets (where k is significantly greater than N).
23 //
24 // Each bucket has B[i] strings in it. The expected value of each bucket
25 // for a uniform distribution is z = N/k, so
26 //   chi^2 = Sum_i (B[i] - z)^2 / z.
27 //
28 // We check whether chi^2 is small enough to be consistent with the
29 // hypothesis of a uniform distribution. If F(chi^2, k-1) is close to
30 // 0 (where F is the cumulative probability distribution), we can
31 // reject that hypothesis. So we don't want F to be too small, which
32 // for large k, means we want chi^2 to be not too much larger than k.
33 //
34 // We use the chi^2 test for several sets of strings. Any non-horrible
35 // hash function should do well with purely random strings. A really
36 // good hash function will also do well with more structured sets,
37 // including ones where the strings differ by only a few bits.
39 #include <algorithm>
40 #include <cstdlib>
41 #include <cstdio>
42 #include <fstream>
43 #include <functional>
44 #include <iostream>
45 #include <iterator>
46 #include <string>
47 #include <unordered_set>
48 #include <vector>
49 #include <testsuite_hooks.h>
51 // Use smaller statistics when running on simulators, so it takes less time.
52 // { dg-options "-DSAMPLES=10000" { target simulator } }
53 #ifndef SAMPLES
54 #define SAMPLES 300000
55 #endif
57 template <typename Container>
58   double
59   chi2_hash(const Container& c, long buckets)
60   {
61     std::vector<int> counts(buckets);
62     std::hash<std::string> hasher;
63     double elements = 0;
64     for (auto i = c.begin(); i != c.end(); ++i)
65       {
66         ++counts[hasher(*i) % buckets];
67         ++elements;
68       }
70     const double z = elements / buckets;
71     double sum = 0;
72     for (long i = 0; i < buckets; ++i)
73       {
74         double delta = counts[i] - z;
75         sum += delta*delta;
76       }
77     return sum/z;
78   }
80 // Tests chi^2 for a distribution of uniformly generated random strings.
81 void
82 test_uniform_random()
83 {
84   bool test __attribute__((unused)) = true;
85   std::srand(137);
86   std::unordered_set<std::string> set;
87   std::string s;
88   const unsigned long N = SAMPLES;
89   const unsigned long k = N/100;
90   const unsigned int len = 25;
91   while (set.size() < N)
92     {
93       s.clear();
94       for (int i = 0; i < len; ++i)
95         {
96           s.push_back(rand() % 128);
97         }
98       set.insert(s);
99     }
101   double chi2 = chi2_hash(set, k);
102   VERIFY( chi2 < k*1.1 );
103 }
105 // Tests chi^2 for a distribution of strings that differ from each
106 // other by only a few bits. We start with an arbitrary base string, and
107 // flip three random bits for each member of the set.
108 void
109 test_bit_flip_set()
110 {
111   bool test __attribute__((unused)) = true;
112   const unsigned long N = SAMPLES;
113   const unsigned long k = N/100;
114   const unsigned int len = 67;
115   const unsigned int bitlen = len * 8;
116   const unsigned int bits_to_flip = 3;
117   const char base[len+1] = "abcdefghijklmnopqrstuvwxyz"
118                            "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
119                            "0123456789!@#\$%";
121   std::unordered_set<std::string> set;
122   while (set.size() < N)
123     {
124       std::string s(base, base+len);
125       for (int i = 0; i < bits_to_flip; ++i)
126         {
127           int bit = rand() % bitlen;
128           s[bit/8] ^= (1 << (bit%8));
129         }
130       set.insert(s);
131     }
133   double chi2 = chi2_hash(set, k);
134   VERIFY( chi2 < k*1.1 );
135 }
137 // Tests chi^2 of a set of strings that all have a similar pattern,
138 // intended to mimic some sort of ID string.
139 void
140 test_numeric_pattern_set()
141 {
142   bool test __attribute__((unused)) = true;
143   const unsigned long N = SAMPLES;
144   const unsigned long k = N/100;
145   std::vector<std::string> set;
146   for (unsigned long i = 0; i < N; ++i)
147     {
148       long i1 = i % 100000;
149       long i2 = i / 100000;
150       char buf;
151       std::sprintf(buf, "XX-%05lu-%05lu", i1, i2);
152       set.push_back(buf);
153     }
155   double chi2 = chi2_hash(set, k);
156   VERIFY( chi2 < k*1.1 );
157 }
159 // Tests chi^2 for a set of strings that all consist of '1' and '0'.
160 void
161 test_bit_string_set()
162 {
163   bool test __attribute__((unused)) = true;
164   const unsigned long N = SAMPLES;
165   const unsigned long k = N/100;
166   std::vector<std::string> set;
167   std::string s;
168   for (unsigned long i = 0; i < N; ++i)
169     {
170       s.clear();
171       for (int j = 0; j < sizeof(unsigned long) * 8; ++j)
172         {
173           const bool bit = (1UL << j) & i;
174           s.push_back(bit ? '1' : '0');
175         }
176       set.push_back(s);
177     }
179   double chi2 = chi2_hash(set, k);
180   VERIFY( chi2 < k*1.1 );
181 }
183 // Tests chi^2 for a set of words taken from a document written in English.
184 void
185 test_document_words()
186 {
187   bool test __attribute__((unused)) = true;
188   const std::string f_name = "thirty_years_among_the_dead_preproc.txt";
189   std::ifstream in(f_name);
190   VERIFY( in.is_open() );
191   std::vector<std::string> words;
192   words.assign(std::istream_iterator<std::string>(in),
193                std::istream_iterator<std::string>());
194   VERIFY( words.size() > 100000 );
195   std::sort(words.begin(), words.end());
196   auto it = std::unique(words.begin(), words.end());
197   words.erase(it, words.end());
198   VERIFY( words.size() > 5000 );
200   const unsigned long k = words.size() / 20;
201   double chi2 = chi2_hash(words, k);
202   VERIFY( chi2 < k*1.1 );
203 }
205 int
206 main()
207 {
208   test_uniform_random();
209   test_bit_flip_set();
210   test_numeric_pattern_set();
211   test_bit_string_set();
212   test_document_words();
213   return 0;
214 }