libstdc++-v3/include/ext/pb_ds/detail/hash_fn/sample_probe_fn.hpp

   1 // -*- C++ -*-
   2
   3 // Copyright (C) 2005-2019 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 3, 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 // Under Section 7 of GPL version 3, you are granted additional
  17 // permissions described in the GCC Runtime Library Exception, version
  18 // 3.1, as published by the Free Software Foundation.
  19
  20 // You should have received a copy of the GNU General Public License and
  21 // a copy of the GCC Runtime Library Exception along with this program;
  22 // see the files COPYING3 and COPYING.RUNTIME respectively.  If not, see
  23 // <http://www.gnu.org/licenses/>.
  24
  25 // Copyright (C) 2004 Ami Tavory and Vladimir Dreizin, IBM-HRL.
  26
  27 // Permission to use, copy, modify, sell, and distribute this software
  28 // is hereby granted without fee, provided that the above copyright
  29 // notice appears in all copies, and that both that copyright notice
  30 // and this permission notice appear in supporting documentation. None
  31 // of the above authors, nor IBM Haifa Research Laboratories, make any
  32 // representation about the suitability of this software for any
  33 // purpose. It is provided "as is" without express or implied
  34 // warranty.
  35
  36 /**
  37  * @file sample_probe_fn.hpp
  38  * Contains a sample probe policy.
  39  */
  40
  41 #ifndef PB_DS_SAMPLE_PROBE_FN_HPP
  42 #define PB_DS_SAMPLE_PROBE_FN_HPP
  43
  44 namespace __gnu_pbds
  45 {
  46   /// A sample probe policy.
  47   class sample_probe_fn
  48   {
  49   public:
  50     typedef std::size_t size_type;
  51
  52     /// Default constructor.
  53     sample_probe_fn();
  54
  55     /// Copy constructor.
  56     sample_probe_fn(const sample_probe_fn&);
  57
  58     /// Swaps content.
  59     inline void
  60     swap(sample_probe_fn&);
  61
  62   protected:
  63     /// Returns the i-th offset from the hash value of some key r_key.
  64     inline size_type
  65     operator()(key_const_reference r_key, size_type i) const;
  66   };
  67 }
  68 #endif // #ifndef PB_DS_SAMPLE_PROBE_FN_HPP