l4/pkg/libstdc++-v3/contrib/libstdc++-v3-4.1.0/docs/html/ext/pb_assoc/sample_size_policy.hpp

   1 /** \r
   2 * @file sample_size_policy.hpp \r
   3 * Contains a sample size resize-policy.\r
   4 * \r
   5 * Copyright Ami Tavory, IBM-HRL, 2004.\r
   6 * \r
   7 * Permission to use, copy, modify, sell, and distribute this software\r
   8 *   is hereby granted without fee, provided that the above copyright notice\r
   9 *   appears in all copies, and that both that copyright notice and this\r
  10 *   permission notice appear in supporting documentation.\r
  11 *\r
  12 * None of the above authors, nor IBM Haifa Research Laboratories, make any\r
  13 *   representation about the suitability of this software for any\r
  14 *   purpose. It is provided "as is" without express or implied warranty.\r
  15 **/\r
  16 \r
  17 \r
  18 #ifndef SAMPLE_SIZE_POLICY_HPP\r
  19 #define SAMPLE_SIZE_POLICY_HPP\r
  20 \r
  21 \r
  22 /**\r
  23 * <class \r
  24 *   description = "A sample size policy."\r
  25 *  comment = "This class serves to show the interface a size policy\r
  26 *       needs to support.">\r
  27 **/\r
  28 class sample_size_policy\r
  29 {\r
  30 /**\r
  31 *******************************************************************************\r
  32 *******************************************************************************\r
  33 * <public_methods_group>\r
  34 **/\r
  35 public:\r
  36         /**\r
  37         ***************************************************************************\r
  38         ***************************************************************************\r
  39         ** <group description = "Constructors, destructor, and related.">\r
  40         **/\r
  41 \r
  42         /*\r
  43         * <fn description = "Default constructor."\r
  44         *       comment = "Must be default constructible.">\r
  45         **/\r
  46                 sample_size_policy\r
  47                 ();\r
  48         /** </fn> **/\r
  49 \r
  50         /*\r
  51         * <fn description = "Copy constructor."\r
  52         *       comment = "Must be copy constructible.">\r
  53         **/\r
  54                 sample_range_hashing\r
  55                 (const sample_size_policy &r_other);\r
  56         /** </fn> **/\r
  57 \r
  58         /*\r
  59         * <fn description = "Swaps content."\r
  60         *       comment = "Must be swappable (if there is such a word).">\r
  61         **/\r
  62         inline void\r
  63                 swap\r
  64                 (sample_size_policy &r_other);\r
  65         /** </fn> **/\r
  66 \r
  67         /*\r
  68         ***************************************************************************\r
  69         ***************************************************************************\r
  70         * </group>\r
  71         **/\r
  72 \r
  73 \r
  74 /**\r
  75 *******************************************************************************\r
  76 *******************************************************************************\r
  77 * </public_methods_group>\r
  78 **/\r
  79 \r
  80 \r
  81 /**\r
  82 *******************************************************************************\r
  83 *******************************************************************************\r
  84 * <protected_methods_group>\r
  85 **/\r
  86 protected:\r
  87 \r
  88         /**\r
  89         **************************************************************************      \r
  90         ***************************************************************************\r
  91         ** <group description = "Size methods">\r
  92         **/\r
  93         \r
  94         /*\r
  95         * <fn description = "Given suggested_size, a suggested size, returns\r
  96         *   an initial size of the container related to the initial size.">\r
  97         **/ \r
  98         inline size_type\r
  99                 get_init_size\r
 100                 (size_type suggested_size) const;\r
 101         /** </fn> **/\r
 102         \r
 103         /*\r
 104         * <fn description = "Given cur_size, the\r
 105         *       current size, returns a size that is \r
 106         *   larger.">\r
 107         **/ \r
 108         inline size_type\r
 109                 get_nearest_larger_size\r
 110                 (size_type cur_size) const;\r
 111         /** </fn> **/\r
 112         \r
 113         /*\r
 114         * <fn description = "Given cur_size, the current size, returns a size that is \r
 115         *   smaller.">\r
 116         **/              \r
 117         inline size_type\r
 118                 get_nearest_smaller_size\r
 119                 (size_type cur_size) const;             \r
 120         /** </fn> **/\r
 121 \r
 122         /**\r
 123         **************************************************************************      \r
 124         ***************************************************************************\r
 125         ** </group>\r
 126         **/\r
 127 \r
 128 \r
 129 /**\r
 130 *******************************************************************************\r
 131 *******************************************************************************\r
 132 * </protected_methods_group>\r
 133 **/\r
 134 };\r
 135 /*\r
 136 ** </class>\r
 137 **/\r
 138 \r
 139 \r
 140 #endif // #ifndef SAMPLE_SIZE_POLICY_HPP\r