aboutsummaryrefslogtreecommitdiff
path: root/libstdc++-v3/doc/html/ext/pb_ds/hash_prime_size_policy.html
blob: cf67dabe078e782fac550c5d8b575dc39887510e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <meta name="generator" content=
  "HTML Tidy for Linux/x86 (vers 12 April 2005), see www.w3.org" />

  <title>hash_prime_size_policy Interface</title>
  <meta http-equiv="Content-Type" content=
  "text/html; charset=us-ascii" />
  </head>

<body>
  <div id="page">
    <h1><tt>hash_prime_size_policy</tt> Interface</h1>

    <p>A size policy whose sequence of sizes form a
    nearly-exponential sequence of primes.</p>

    <p>Defined in: <a href=
    "../../../../include/ext/pb_ds/hash_policy.hpp"><tt>hash_policy.hpp</tt></a></p>

    <h2><a name="link1" id="link1">Public Types and
    Constants</a></h2>

    <h3><a name="link2" id="link2">General Definitions</a></h3>

    <table class="c1" width="100%" border="1" summary="Types">
      <tr>
        <td width="30%" align="left"><b>Type</b></td>

        <td width="55%" align="left"><b>Definition</b></td>

        <td width="15%" align="left"><b>Description</b></td>
      </tr>

      <tr>
        <td>
          <pre>
<a name="size_type55424436" id="size_type55424436">size_type</a>
</pre>
        </td>

        <td>
          <pre>
size_t
</pre>
        </td>

        <td>
          <p>Size type.</p>
        </td>
      </tr>
    </table>

    <h2><a name="link3" id="link3">Public Methods</a></h2>

    <h3><a name="link4" id="link4">Constructors, Destructor, and
    Related</a></h3>

    <table class="c1" width="100%" border="1" summary="Methods">
      <tr>
        <td width="45%" align="left"><b>Method</b></td>

        <td width="55%" align="left"><b>Description</b></td>
      </tr>

      <tr>
        <td>
          <pre>
  hash_prime_size_policy
  (<a href=
"#size_type55424436"><tt>size_type</tt></a> start_size = 8)
</pre>
        </td>

        <td>
          <p>Default constructor, or constructor taking a
          <span class="c1"><tt>start_size</tt></span> The policy
          will use the sequence of sizes approximately <span class=
          "c1"><tt>start_size</tt></span>, <span class=
          "c1"><tt>start_size</tt></span> * 2, <span class=
          "c1"><tt>start_size</tt></span> * 2^2, ...</p>
        </td>
      </tr>

      <tr>
        <td>
          <pre>
<b>inline</b> <b>void</b>
  swap
  (<span class=
"c2"><tt>hash_prime_size_policy</tt></span> &amp;other)
</pre>
        </td>

        <td>
          <p>Swaps content.</p>
        </td>
      </tr>
    </table>

    <h2><a name="link5" id="link5">Protected Methods</a></h2>

    <h3><a name="link6" id="link6">Size methods</a></h3>

    <table class="c1" width="100%" border="1" summary="Methods">
      <tr>
        <td width="45%" align="left"><b>Method</b></td>

        <td width="55%" align="left"><b>Description</b></td>
      </tr>

      <tr>
        <td>
          <pre>
<a href="#size_type55424436"><tt>size_type</tt></a>
  get_nearest_larger_size
  (<a href=
"#size_type55424436"><tt>size_type</tt></a> size) <b>const</b>
</pre>
        </td>

        <td>
          <p>Given a size <span class="c1"><tt>size</tt></span>,
          returns a size that is larger.</p>
        </td>
      </tr>

      <tr>
        <td>
          <pre>
<a href="#size_type55424436"><tt>size_type</tt></a>
  get_nearest_smaller_size
  (<a href=
"#size_type55424436"><tt>size_type</tt></a> size) <b>const</b>
</pre>
        </td>

        <td>
          <p>Given a size <span class="c1"><tt>size</tt></span>,
          returns a size that is smaller.</p>
        </td>
      </tr>
    </table>
  </div>
</body>
</html>