coal/broadphase/detail/sparse_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_SPARSEHASHTABLE_H
39 #define COAL_BROADPHASE_SPARSEHASHTABLE_H
40 
41 #include <set>
42 #include <vector>
43 #include <list>
44 #include <unordered_map>
45 
46 namespace coal {
47 
48 namespace detail {
49 
50 template <typename U, typename V>
51 class unordered_map_hash_table : public std::unordered_map<U, V> {
52  typedef std::unordered_map<U, V> Base;
53 
54  public:
56 };
57 
59 template <typename Key, typename Data, typename HashFnc,
60  template <typename, typename> class TableT = unordered_map_hash_table>
62  protected:
63  HashFnc h_;
64  typedef std::list<Data> Bin;
65  typedef TableT<size_t, Bin> Table;
66 
68 
69  public:
70  SparseHashTable(const HashFnc& h);
71 
73  void init(size_t);
74 
76  void insert(Key key, Data value);
77 
79  std::vector<Data> query(Key key) const;
80 
82  void remove(Key key, Data value);
83 
85  void clear();
86 };
87 
88 } // namespace detail
89 } // namespace coal
90 
92 
93 #endif
sparse_hash_table-inl.h
coal::detail::SparseHashTable::init
void init(size_t)
Init the hash table. The bucket size is dynamically decided.
Definition: coal/broadphase/detail/sparse_hash_table-inl.h:58
coal::detail::SparseHashTable::query
std::vector< Data > query(Key key) const
find the elements whose key is the same as the query
Definition: coal/broadphase/detail/sparse_hash_table-inl.h:74
coal::detail::unordered_map_hash_table::unordered_map_hash_table
unordered_map_hash_table()
Definition: coal/broadphase/detail/sparse_hash_table.h:55
coal::detail::SparseHashTable
A hash table implemented using unordered_map.
Definition: coal/broadphase/detail/sparse_hash_table.h:61
coal
Main namespace.
Definition: coal/broadphase/broadphase_bruteforce.h:44
coal::detail::SparseHashTable::table_
Table table_
Definition: coal/broadphase/detail/sparse_hash_table.h:67
coal::detail::SparseHashTable::remove
void remove(Key key, Data value)
remove one key-value pair from the hash table
Definition: coal/broadphase/detail/sparse_hash_table-inl.h:93
coal::detail::unordered_map_hash_table
Definition: coal/broadphase/detail/sparse_hash_table.h:51
coal::detail::SparseHashTable::h_
HashFnc h_
Definition: coal/broadphase/detail/sparse_hash_table.h:63
coal::detail::unordered_map_hash_table::Base
std::unordered_map< U, V > Base
Definition: coal/broadphase/detail/sparse_hash_table.h:52
coal::detail::SparseHashTable::Table
TableT< size_t, Bin > Table
Definition: coal/broadphase/detail/sparse_hash_table.h:65
coal::detail::SparseHashTable::clear
void clear()
clear the hash table
Definition: coal/broadphase/detail/sparse_hash_table-inl.h:104
Base
coal::detail::SparseHashTable::Bin
std::list< Data > Bin
Definition: coal/broadphase/detail/sparse_hash_table.h:64
coal::detail::SparseHashTable::SparseHashTable
SparseHashTable(const HashFnc &h)
Definition: coal/broadphase/detail/sparse_hash_table-inl.h:50
coal::detail::SparseHashTable::insert
void insert(Key key, Data value)
insert one key-value pair into the hash table
Definition: coal/broadphase/detail/sparse_hash_table-inl.h:65


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