1// -*- C++ -*-
2
3// Copyright (C) 2005, 2006 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 terms
7// of the GNU General Public License as published by the Free Software
8// Foundation; either version 2, or (at your option) any later
9// version.
10
11// This library is distributed in the hope that it will be useful, but
12// WITHOUT ANY WARRANTY; without even the implied warranty of
13// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14// 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 COPYING.  If not, write to
18// the Free Software Foundation, 59 Temple Place - Suite 330, Boston,
19// MA 02111-1307, USA.
20
21// As a special exception, you may use this file as part of a free
22// software library without restriction.  Specifically, if other files
23// instantiate templates or use macros or inline functions from this
24// file, or you compile this file and link it with other files to
25// produce an executable, this file does not by itself cause the
26// resulting executable to be covered by the GNU General Public
27// License.  This exception does not however invalidate any other
28// reasons why the executable file might be covered by the GNU General
29// Public License.
30
31// Copyright (C) 2004 Ami Tavory and Vladimir Dreizin, IBM-HRL.
32
33// Permission to use, copy, modify, sell, and distribute this software
34// is hereby granted without fee, provided that the above copyright
35// notice appears in all copies, and that both that copyright notice
36// and this permission notice appear in supporting documentation. None
37// of the above authors, nor IBM Haifa Research Laboratories, make any
38// representation about the suitability of this software for any
39// purpose. It is provided "as is" without express or implied
40// warranty.
41
42/**
43 * @file sample_resize_trigger.hpp
44 * Contains a sample resize trigger policy class.
45 */
46
47#ifndef PB_DS_SAMPLE_RESIZE_TRIGGER_HPP
48#define PB_DS_SAMPLE_RESIZE_TRIGGER_HPP
49
50// A sample resize trigger policy.
51class sample_resize_trigger
52{
53public:
54
55  // Size type.
56  typedef size_t size_type;
57
58  // Default constructor.
59  sample_resize_trigger();
60
61  // Copy constructor.
62  sample_range_hashing(const sample_resize_trigger& other);
63
64  // Swaps content.
65  inline void
66  swap(sample_resize_trigger& other);
67
68protected:
69
70  // Notifies a search started.
71  inline void
72  notify_insert_search_start();
73
74  // Notifies a search encountered a collision.
75  inline void
76  notify_insert_search_collision();
77
78  // Notifies a search ended.
79  inline void
80  notify_insert_search_end();
81
82  // Notifies a search started.
83  inline void
84  notify_find_search_start();
85
86  // Notifies a search encountered a collision.
87  inline void
88  notify_find_search_collision();
89
90  // Notifies a search ended.
91  inline void
92  notify_find_search_end();
93
94  // Notifies a search started.
95  inline void
96  notify_erase_search_start();
97
98  // Notifies a search encountered a collision.
99  inline void
100  notify_erase_search_collision();
101
102  // Notifies a search ended.
103  inline void
104  notify_erase_search_end();
105
106  // Notifies an element was inserted. the total number of entries in
107  // the table is num_entries.
108  inline void
109  notify_inserted(size_type num_entries);
110
111  // Notifies an element was erased.
112  inline void
113  notify_erased(size_type num_entries);
114
115  // Notifies the table was cleared.
116  void
117  notify_cleared();
118
119  // Notifies the table was resized as a result of this object's
120  // signifying that a resize is needed.
121  void
122  notify_resized(size_type new_size);
123
124  // Notifies the table was resized externally.
125  void
126  notify_externally_resized(size_type new_size);
127
128  // Queries whether a resize is needed.
129  inline bool
130  is_resize_needed() const;
131
132  // Queries whether a grow is needed.
133  inline bool
134  is_grow_needed(size_type size, size_type num_entries) const;
135
136private:
137
138  // Resizes to new_size.
139  virtual void
140  do_resize(size_type new_size);
141};
142
143} // namespace pb_ds
144
145#endif
146