GCC Code Coverage Report
Directory: ./ Exec Total Coverage
File: include/hpp/fcl/broadphase/detail/sparse_hash_table.h Lines: 1 1 100.0 %
Date: 2024-02-09 12:57:42 Branches: 0 0 - %

Line Branch Exec Source
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
36
/** @author Jia Pan */
37
38
#ifndef HPP_FCL_BROADPHASE_SPARSEHASHTABLE_H
39
#define HPP_FCL_BROADPHASE_SPARSEHASHTABLE_H
40
41
#include <set>
42
#include <vector>
43
#include <list>
44
#include <unordered_map>
45
46
namespace hpp {
47
namespace fcl {
48
49
namespace detail {
50
51
template <typename U, typename V>
52
class unordered_map_hash_table : public std::unordered_map<U, V> {
53
  typedef std::unordered_map<U, V> Base;
54
55
 public:
56
51
  unordered_map_hash_table() : Base(){};
57
};
58
59
/// @brief A hash table implemented using unordered_map
60
template <typename Key, typename Data, typename HashFnc,
61
          template <typename, typename> class TableT = unordered_map_hash_table>
62
class SparseHashTable {
63
 protected:
64
  HashFnc h_;
65
  typedef std::list<Data> Bin;
66
  typedef TableT<size_t, Bin> Table;
67
68
  Table table_;
69
70
 public:
71
  SparseHashTable(const HashFnc& h);
72
73
  /// @brief Init the hash table. The bucket size is dynamically decided.
74
  void init(size_t);
75
76
  /// @brief insert one key-value pair into the hash table
77
  void insert(Key key, Data value);
78
79
  /// @brief find the elements whose key is the same as the query
80
  std::vector<Data> query(Key key) const;
81
82
  /// @brief remove one key-value pair from the hash table
83
  void remove(Key key, Data value);
84
85
  /// @brief clear the hash table
86
  void clear();
87
};
88
89
}  // namespace detail
90
}  // namespace fcl
91
}  // namespace hpp
92
93
#include "hpp/fcl/broadphase/detail/sparse_hash_table-inl.h"
94
95
#endif