2 * @file sample_resize_policy.hpp
3 * Contains a sample resize policy for hash tables.
5 * Copyright Ami Tavory, IBM-HRL, 2004.
7 * Permission to use, copy, modify, sell, and distribute this software
8 * is hereby granted without fee, provided that the above copyright notice
9 * appears in all copies, and that both that copyright notice and this
10 * permission notice appear in supporting documentation,
12 * None of the above authors, nor IBM Haifa Research Laboratories, make any
13 * representation about the suitability of this software for any
14 * purpose. It is provided "as is" without express or implied warranty.
18 #ifndef SAMPLE_RESIZE_POLICY_HPP
19 #define SAMPLE_RESIZE_POLICY_HPP
24 * description = "A sample resize policy."
25 * comment = "This class serves to show the interface a resize policy
28 class sample_resize_policy
31 *******************************************************************************
32 *******************************************************************************
33 * <public_methods_group>
37 ***************************************************************************
38 ***************************************************************************
39 ** <group description = "Constructors, destructor, and related.">
43 * <fn description = "Default constructor."
44 * comment = "Must be default constructible.">
51 * <fn description = "Copy constructor."
52 * comment = "Must be copy constructible.">
55 (const sample_resize_policy &r_other);
59 * <fn description = "Swaps content."
60 * comment = "Must be swappable (if there is such a word).">
64 (sample_resize_policy &r_other);
68 ***************************************************************************
69 ***************************************************************************
75 *******************************************************************************
76 *******************************************************************************
77 * </public_methods_group>
82 *******************************************************************************
83 *******************************************************************************
84 * <protected_methods_group>
88 ***************************************************************************
89 ***************************************************************************
90 ** <group description = "Insert search notifications."
91 ** comment = "Notifications called during an insert operation.">
95 * <fn description = "Notifies a search started.">
98 notify_insert_search_start
103 * <fn description = "Notifies a search encountered a collision.">
106 notify_insert_search_collision
111 * <fn description = "Notifies a search ended.">
114 notify_insert_search_end
119 ***************************************************************************
120 ***************************************************************************
126 ***************************************************************************
127 ***************************************************************************
128 ** <group description = "Find search notifications."
129 ** comment = "Notifications called during a find operation.">
133 * <fn description = "Notifies a search started.">
136 notify_find_search_start
141 * <fn description = "Notifies a search encountered a collision.">
144 notify_find_search_collision
149 * <fn description = "Notifies a search ended.">
152 notify_find_search_end
157 ***************************************************************************
158 ***************************************************************************
164 ***************************************************************************
165 ***************************************************************************
166 ** <group description = "Erase search notifications."
167 ** comment = "Notifications called during an insert operation.">
171 * <fn description = "Notifies a search started.">
174 notify_erase_search_start
179 * <fn description = "Notifies a search encountered a collision.">
182 notify_erase_search_collision
187 * <fn description = "Notifies a search ended.">
190 notify_erase_search_end
195 ***************************************************************************
196 ***************************************************************************
202 ***************************************************************************
203 ***************************************************************************
204 ** <group description = "Content change notifications."
205 ** comment = "Notifications called when the content of the table
206 ** changes in a way that can affect the resize policy.">
210 * <fn description = "Notifies an element was inserted.">
218 * <fn description = "Notifies an element was erased.">
226 * <fn description = "Notifies the table was cleared.">
234 ***************************************************************************
235 ***************************************************************************
241 ***************************************************************************
242 ***************************************************************************
243 ** <group description = "Size change notifications."
244 ** comment = "Notifications called when the table changes size.">
248 * <fn description = "Notifies the table was resized to new_size.">
252 (size_type new_size);
256 ***************************************************************************
257 ***************************************************************************
263 ***************************************************************************
264 ***************************************************************************
265 ** <group description = "Queries."
266 ** comment = "Called to query whether/how to resize.">
270 * <fn description = "Queries initial size.">
278 * <fn description = "Queries whether a resize is needed.">
286 * <fn description = "Queries what the new size should be.">
290 (size_type size, size_type num_used_e) const;
294 ***************************************************************************
295 ***************************************************************************
300 *******************************************************************************
301 *******************************************************************************
302 * </protected_methods_group>
310 #endif // #ifndef SAMPLE_RESIZE_POLICY_HPP