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 (unsigned int i = 0; i < len; ++i)
95         s.push_back(rand() % 128);
96       set.insert(s);
97     }
99   double chi2 = chi2_hash(set, k);
100   VERIFY( chi2 < k*1.1 );
101 }
103 // Tests chi^2 for a distribution of strings that differ from each
104 // other by only a few bits. We start with an arbitrary base string, and
105 // flip three random bits for each member of the set.
106 void
107 test_bit_flip_set()
108 {
109   bool test __attribute__((unused)) = true;
110   const unsigned long N = SAMPLES;
111   const unsigned long k = N/100;
112   const unsigned int len = 67;
113   const unsigned int bitlen = len * 8;
114   const unsigned int bits_to_flip = 3;
115   const char base[len+1] = "abcdefghijklmnopqrstuvwxyz"
116                            "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
117                            "0123456789!@#\$%";
119   std::unordered_set<std::string> set;
120   while (set.size() < N)
121     {
122       std::string s(base, base+len);
123       for (unsigned int i = 0; i < bits_to_flip; ++i)
124         {
125           int bit = rand() % bitlen;
126           s[bit/8] ^= (1 << (bit%8));
127         }
128       set.insert(s);
129     }
131   double chi2 = chi2_hash(set, k);
132   VERIFY( chi2 < k*1.1 );
133 }
135 // Tests chi^2 of a set of strings that all have a similar pattern,
136 // intended to mimic some sort of ID string.
137 void
138 test_numeric_pattern_set()
139 {
140   bool test __attribute__((unused)) = true;
141   const unsigned long N = SAMPLES;
142   const unsigned long k = N/100;
143   std::vector<std::string> set;
144   for (unsigned long i = 0; i < N; ++i)
145     {
146       long i1 = i % 100000;
147       long i2 = i / 100000;
148       char buf;
149       std::sprintf(buf, "XX-%05lu-%05lu", i1, i2);
150       set.push_back(buf);
151     }
153   double chi2 = chi2_hash(set, k);
154   VERIFY( chi2 < k*1.1 );
155 }
157 // Tests chi^2 for a set of strings that all consist of '1' and '0'.
158 void
159 test_bit_string_set()
160 {
161   bool test __attribute__((unused)) = true;
162   const unsigned long N = SAMPLES;
163   const unsigned long k = N/100;
164   std::vector<std::string> set;
165   std::string s;
166   for (unsigned long i = 0; i < N; ++i)
167     {
168       s.clear();
169       for (unsigned int j = 0; j < sizeof(unsigned long) * 8; ++j)
170         {
171           const bool bit = (1UL << j) & i;
172           s.push_back(bit ? '1' : '0');
173         }
174       set.push_back(s);
175     }
177   double chi2 = chi2_hash(set, k);
178   VERIFY( chi2 < k*1.1 );
179 }
181 // Tests chi^2 for a set of words taken from a document written in English.
182 void
183 test_document_words()
184 {
185   bool test __attribute__((unused)) = true;
186   const std::string f_name = "thirty_years_among_the_dead_preproc.txt";
187   std::ifstream in(f_name);
188   VERIFY( in.is_open() );
189   std::vector<std::string> words;
190   words.assign(std::istream_iterator<std::string>(in),
191                std::istream_iterator<std::string>());
192   VERIFY( words.size() > 100000 );
193   std::sort(words.begin(), words.end());
194   auto it = std::unique(words.begin(), words.end());
195   words.erase(it, words.end());
196   VERIFY( words.size() > 5000 );
198   const unsigned long k = words.size() / 20;
199   double chi2 = chi2_hash(words, k);
200   VERIFY( chi2 < k*1.1 );
201 }
203 int
204 main()
205 {
206   test_uniform_random();
207   test_bit_flip_set();
208   test_numeric_pattern_set();
209   test_bit_string_set();
210   test_document_words();
211   return 0;
212 }