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

   1 /** \r
   2 * @file sample_probe_fn.hpp\r
   3 * Contains a sample probe 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_PROBE_FN_HPP\r
  19 #define SAMPLE_PROBE_FN_HPP\r
  20 \r
  21 \r
  22 /**\r
  23 * <class \r
  24 *   description = "A sample probe policy."\r
  25 *  comment = "This class serves to show the interface a probe functor\r
  26 *       needs to support.">\r
  27 **/\r
  28 class sample_probe_fn\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_probe_fn\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_probe_fn\r
  55                 (const sample_probe_fn &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_probe_fn &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         ** <group description = "Offset methods.">\r
  91         **/\r
  92 \r
  93         /*\r
  94         * <fn description = "Returns the i-th offset from the hash value\r
  95         *               of some key r_key."\r
  96         *       comment = "@@sample_range_hashing_size_type_comment">\r
  97         **/\r
  98         inline size_type\r
  99                 operator()\r
 100                 (const_key_reference r_key,\r
 101                         size_type i) const;\r
 102         /** </fn> **/\r
 103 \r
 104         /**\r
 105         ***************************************************************************\r
 106         ***************************************************************************\r
 107         ** </group">\r
 108         **/\r
 109 \r
 110 /**\r
 111 *******************************************************************************\r
 112 *******************************************************************************\r
 113 * </protected_methods_group>\r
 114 **/\r
 115 };\r
 116 /**\r
 117 * </class>\r
 118 **/\r
 119 \r
 120 \r
 121 #endif // #ifndef SAMPLE_PROBE_FN_HPP\r