coal/broadphase/detail/simple_hash_table.h
Go to the documentation of this file.
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 COAL_BROADPHASE_SIMPLEHASHTABLE_H
39 #define COAL_BROADPHASE_SIMPLEHASHTABLE_H
40 
41 #include <set>
42 #include <vector>
43 #include <list>
44 
45 namespace coal {
46 
47 namespace detail {
48 
51 template <typename Key, typename Data, typename HashFnc>
53  protected:
54  typedef std::list<Data> Bin;
55 
56  std::vector<Bin> table_;
57 
58  HashFnc h_;
59 
60  size_t table_size_;
61 
62  public:
63  SimpleHashTable(const HashFnc& h);
64 
66  void init(size_t size);
67 
69  void insert(Key key, Data value);
70 
73  std::vector<Data> query(Key key) const;
74 
76  void remove(Key key, Data value);
77 
79  void clear();
80 };
81 
82 } // namespace detail
83 } // namespace coal
84 
86 
87 #endif
coal::detail::SimpleHashTable::SimpleHashTable
SimpleHashTable(const HashFnc &h)
Definition: coal/broadphase/detail/simple_hash_table-inl.h:50
coal::detail::SimpleHashTable::table_size_
size_t table_size_
Definition: coal/broadphase/detail/simple_hash_table.h:60
coal
Main namespace.
Definition: coal/broadphase/broadphase_bruteforce.h:44
coal::detail::SimpleHashTable::query
std::vector< Data > query(Key key) const
Find the elements in the hash table whose key is the same as query key.
Definition: coal/broadphase/detail/simple_hash_table-inl.h:77
coal::detail::SimpleHashTable::init
void init(size_t size)
Init the number of bins in the hash table.
Definition: coal/broadphase/detail/simple_hash_table-inl.h:56
coal::detail::SimpleHashTable::insert
void insert(Key key, Data value)
Definition: coal/broadphase/detail/simple_hash_table-inl.h:68
coal::detail::SimpleHashTable::table_
std::vector< Bin > table_
Definition: coal/broadphase/detail/simple_hash_table.h:56
coal::detail::SimpleHashTable::remove
void remove(Key key, Data value)
remove the key-value pair from the table
Definition: coal/broadphase/detail/simple_hash_table-inl.h:92
coal::detail::SimpleHashTable
A simple hash table implemented as multiple buckets. HashFnc is any extended hash function: HashFnc(k...
Definition: coal/broadphase/detail/simple_hash_table.h:52
coal::detail::SimpleHashTable::h_
HashFnc h_
Definition: coal/broadphase/detail/simple_hash_table.h:58
simple_hash_table-inl.h
coal::detail::SimpleHashTable::clear
void clear()
clear the hash table
Definition: coal/broadphase/detail/simple_hash_table-inl.h:103
coal::detail::SimpleHashTable::Bin
std::list< Data > Bin
Definition: coal/broadphase/detail/simple_hash_table.h:54


hpp-fcl
Author(s):
autogenerated on Sat Nov 23 2024 03:44:59