2 * @file sample_size_policy.hpp
3 * Contains a sample size resize-policy.
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_SIZE_POLICY_HPP
19 #define SAMPLE_SIZE_POLICY_HPP
24 * description = "A sample size policy."
25 * comment = "This class serves to show the interface a size policy
28 class sample_size_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_size_policy
&r_other
);
59 * <fn description = "Swaps content."
60 * comment = "Must be swappable (if there is such a word).">
64 (sample_size_policy
&r_other
);
68 ***************************************************************************
69 ***************************************************************************
75 *******************************************************************************
76 *******************************************************************************
77 * </public_methods_group>
82 *******************************************************************************
83 *******************************************************************************
84 * <protected_methods_group>
89 **************************************************************************
90 ***************************************************************************
91 ** <group description = "Size methods">
95 * <fn description = "Given suggested_size, a suggested size, returns
96 * an initial size of the container related to the initial size.">
100 (size_type suggested_size
) const;
104 * <fn description = "Given cur_size, the
105 * current size, returns a size that is
109 get_nearest_larger_size
110 (size_type cur_size
) const;
114 * <fn description = "Given cur_size, the current size, returns a size that is
118 get_nearest_smaller_size
119 (size_type cur_size
) const;
123 **************************************************************************
124 ***************************************************************************
130 *******************************************************************************
131 *******************************************************************************
132 * </protected_methods_group>
140 #endif // #ifndef SAMPLE_SIZE_POLICY_HPP