FCL  0.6.0
Flexible Collision Library
simple_hash_table.h
1 /*
2  * Software License Agreement (BSD License)
3  *
4  * Copyright (c) 2011-2014, Willow Garage, Inc.
5  * Copyright (c) 2014-2016, Open Source Robotics Foundation
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * * Redistributions of source code must retain the above copyright
13  * notice, this list of conditions and the following disclaimer.
14  * * Redistributions in binary form must reproduce the above
15  * copyright notice, this list of conditions and the following
16  * disclaimer in the documentation and/or other materials provided
17  * with the distribution.
18  * * Neither the name of Open Source Robotics Foundation nor the names of its
19  * contributors may be used to endorse or promote products derived
20  * from this software without specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
25  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
26  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
27  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
28  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
29  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
30  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
32  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
33  * POSSIBILITY OF SUCH DAMAGE.
34  */
35 
38 #ifndef FCL_BROADPHASE_SIMPLEHASHTABLE_H
39 #define FCL_BROADPHASE_SIMPLEHASHTABLE_H
40 
41 #include <stdexcept>
42 #include <set>
43 #include <vector>
44 #include <list>
45 
46 namespace fcl
47 {
48 
49 namespace detail
50 {
51 
54 template<typename Key, typename Data, typename HashFnc>
56 {
57 protected:
58  typedef std::list<Data> Bin;
59 
60  std::vector<Bin> table_;
61 
62  HashFnc h_;
63 
64  size_t table_size_;
65 
66 public:
67  SimpleHashTable(const HashFnc& h);
68 
70  void init(size_t size);
71 
73  void insert(Key key, Data value);
74 
77  std::vector<Data> query(Key key) const;
78 
80  void remove(Key key, Data value);
81 
83  void clear();
84 };
85 
86 } // namespace detail
87 } // namespace fcl
88 
89 #include "fcl/broadphase/detail/simple_hash_table-inl.h"
90 
91 #endif
Main namespace.
Definition: broadphase_bruteforce-inl.h:45
void init(size_t size)
Init the number of bins in the hash table.
Definition: simple_hash_table-inl.h:61
void clear()
clear the hash table
Definition: simple_hash_table-inl.h:114
std::vector< Data > query(Key key) const
Find the elements in the hash table whose key is the same as query key.
Definition: simple_hash_table-inl.h:84
A simple hash table implemented as multiple buckets. HashFnc is any extended hash function: HashFnc(k...
Definition: simple_hash_table.h:55