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
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
|
<HTML>
<!--
-- Copyright (c) 1996-1999
-- Silicon Graphics Computer Systems, Inc.
--
-- Permission to use, copy, modify, distribute and sell this software
-- and its documentation for any purpose is hereby granted without fee,
-- provided that the above copyright notice appears in all copies and
-- that both that copyright notice and this permission notice appear
-- in supporting documentation. Silicon Graphics makes no
-- representations about the suitability of this software for any
-- purpose. It is provided "as is" without express or implied warranty.
--
-- Copyright (c) 1994
-- Hewlett-Packard Company
--
-- Permission to use, copy, modify, distribute and sell this software
-- and its documentation for any purpose is hereby granted without fee,
-- provided that the above copyright notice appears in all copies and
-- that both that copyright notice and this permission notice appear
-- in supporting documentation. Hewlett-Packard Company makes no
-- representations about the suitability of this software for any
-- purpose. It is provided "as is" without express or implied warranty.
--
-->
<Head>
<Title>hash<T></Title>
<!-- Generated by htmldoc -->
</HEAD>
<BODY BGCOLOR="#ffffff" LINK="#0000ee" TEXT="#000000" VLINK="#551a8b"
ALINK="#ff0000">
<IMG SRC="CorpID.gif"
ALT="SGI" HEIGHT="43" WIDTH="151">
<!--end header-->
<BR Clear>
<H1>hash<T></H1>
<Table CellPadding=0 CellSpacing=0 width=100%>
<TR>
<TD Align=left><Img src = "containers.gif" Alt="" WIDTH = "194" HEIGHT = "38" ></TD>
<TD Align=right><Img src = "type.gif" Alt="" WIDTH = "194" HEIGHT = "39" ></TD>
</TR>
<TR>
<TD Align=left><Img src = "functors.gif" Alt="" WIDTH = "194" HEIGHT = "38" ></TD>
<TD Align=right></TD>
</TR>
<TR>
<TD Align=left VAlign=top><b>Categories</b>: containers, functors</TD>
<TD Align=right VAlign=top><b>Component type</b>: type</TD>
</TR>
</Table>
<h3>Description</h3>
The function object <tt>hash<T></tt> is a <A href="HashFunction.html">Hash Function</A>; it is used as
the default hash function by all of the <A href="HashedAssociativeContainer.html">Hashed Associative
Containers</A> that are included in the STL.
<P>
The <tt>hash<T></tt> template is only defined for template arguments of type
<tt>char*</tt>, <tt>const char*</tt>, <tt><A href="Rope.html">crope</A></tt>, <tt><A href="Rope.html">wrope</A></tt>, and the built-in
integral types. <A href="#1">[1]</A> If you need a Hash Function with a different
argument type, you must either provide your own template
specialization or else use a different Hash Function.
<h3>Example</h3>
<pre>
int main()
{
hash<const char*> H;
cout << "foo -> " << H("foo") << endl;
cout << "bar -> " << H("bar") << endl;
}
</pre>
<h3>Definition</h3>
Defined in the headers <A href="hash_map">hash_map</A> and <A href="hash_set">hash_set</A>, and in the
backward-compatibility headers <A href="hash_map.h">hash_map.h</A> and <A href="hash_set.h">hash_set.h</A>.
This class is an SGI extension; it is not part of the C++ standard.
<h3>Template parameters</h3>
<Table border>
<TR>
<TH>
Parameter
</TH>
<TH>
Description
</TH>
<TH>
Default
</TH>
</TR>
<TR>
<TD VAlign=top>
<tt>T</tt>
</TD>
<TD VAlign=top>
The argument type. That is, the type of object that is being
hashed.
</TD>
<TD VAlign=top>
</TD>
</tr>
</table>
<h3>Model of</h3>
<A href="HashFunction.html">Hash Function</A>
<h3>Type requirements</h3>
<tt>T</tt> must be a type for which a specialization of <tt>hash</tt> has been
defined. The STL defines the following specializations:
<UL>
<LI>
<tt>char*</tt>
<LI>
<tt>const char*</tt>
<LI>
<tt><A href="Rope.html">crope</A></tt>
<LI>
<tt><A href="Rope.html">wrope</A></tt>
<LI>
<tt>char</tt>
<LI>
<tt>signed char</tt>
<LI>
<tt>unsigned char</tt>
<LI>
<tt>short</tt>
<LI>
<tt>unsigned short</tt>
<LI>
<tt>int</tt>
<LI>
<tt>unsigned int</tt>
<LI>
<tt>long</tt>
<LI>
<tt>unsigned long</tt>
</UL>
<h3>Public base classes</h3>
None.
<h3>Members</h3>
<Table border>
<TR>
<TH>
Member
</TH>
<TH>
Where defined
</TH>
<TH>
Description
</TH>
</TR>
<TR>
<TD VAlign=top>
<tt>size_t <b>operator</b>()(const T& x)</tt>
</TD>
<TD VAlign=top>
<A href="HashFunction.html">Hash Function</A>
</TD>
<TD VAlign=top>
Returns <tt>x</tt>'s hash value.
</TD>
</tr>
</table>
<h3>New members</h3>
All of <tt>hash</tt>'s members are defined in the
<A href="HashFunction.html">Hash Function</A>
requirements. <tt>Hash</tt> does not introduce any new members.
<h3>Notes</h3>
<P><A name="1">[1]</A>
Technically, what this means is that the actual template
<tt>hash<T></tt> is an empty class; the member function <tt>operator()</tt>
is defined only in the various specializations.
<h3>See also</h3>
<A href="HashedAssociativeContainer.html">Hashed Associative Container</A>, <A href="HashFunction.html">Hash Function</A>
<!--start footer-->
<HR SIZE="6">
<A href="http://www.sgi.com/"><IMG SRC="surf.gif" HEIGHT="54" WIDTH="54"
ALT="[Silicon Surf]"></A>
<A HREF="index.html"><IMG SRC="stl_home.gif"
HEIGHT="54" WIDTH="54" ALT="[STL Home]"></A>
<BR>
<FONT SIZE="-2">
<A href="http://www.sgi.com/Misc/sgi_info.html" TARGET="_top">Copyright ©
1999 Silicon Graphics, Inc.</A> All Rights Reserved.</FONT>
<FONT SIZE="-3"><a href="http://www.sgi.com/Misc/external.list.html" TARGET="_top">TrademarkInformation</A>
</FONT>
<P>
</BODY>
</HTML>
|
