blob: 2e17c9290f24e15d14782ccf5eec53155ebab753 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
|
/********************* */
/*! \file map_util.h
** \verbatim
** Top contributors (to current version):
** Tim King
** This file is part of the CVC4 project.
** Copyright (c) 2009-2018 by the authors listed in the file AUTHORS
** in the top-level source directory) and their institutional affiliations.
** All rights reserved. See the file COPYING in the top-level source
** directory for licensing information.\endverbatim
**
** \brief Utility functions for dealing with maps in a mostly uniform fashion.
**
** Utility functions for dealing with maps and related classed in a mostly
** uniform fashion. These are stylistically encouraged (but not required) in
** new code. Supports:
** - std::map
** - std::unordered_map
** - CVC4::context::CDHashmap
** - CVC4::context::CDInsertHashmap
** The ContainsKey function is also compatible with std::[unordered_]set.
**
** Currently implemented classes of functions:
** - ContainsKey
** Returns true if a map contains a key. (Also Supports std::set and
** std::unordered_set.)
** - FindOr*
** Finds an data element mapped to by the map. Variants include FindOrNull
** and FindOrDie.
**
** Potential future classes of functions:
** - InsertOrUpdate
** - InsertIfNotPresent
**/
#include "cvc4_private.h"
#ifndef __CVC4__BASE__MAP_UTIL_H
#define __CVC4__BASE__MAP_UTIL_H
#include "base/cvc4_check.h"
namespace CVC4 {
// Returns true if the `map` contains the `key`.
//
// Supports sets as well.
template <class M, class Key>
bool ContainsKey(const M& map, const Key& key)
{
return map.find(key) != map.end();
}
template <typename M>
using MapKeyTypeT = typename M::value_type::first_type;
template <typename M>
using MapMappedTypeT = typename M::value_type::second_type;
// Returns a pointer to the const value mapped by `key` if it exists, or nullptr
// otherwise.
template <class M>
const MapMappedTypeT<M>* FindOrNull(const M& map, const MapKeyTypeT<M>& key)
{
auto it = map.find(key);
if (it == map.end())
{
return nullptr;
}
return &((*it).second);
}
// Returns a pointer to the non-const value mapped by `key` if it exists, or
// nullptr otherwise.
template <class M>
MapMappedTypeT<M>* FindOrNull(M& map, const MapKeyTypeT<M>& key)
{
auto it = map.find(key);
if (it == map.end())
{
return nullptr;
}
return &((*it).second);
}
// Returns a const reference to the value mapped by `key` if it exists. Dies
// if the element is not there.
template <class M>
const MapMappedTypeT<M>& FindOrDie(const M& map, const MapKeyTypeT<M>& key)
{
auto it = map.find(key);
CVC4_CHECK(it != map.end()) << "The map does not contain the key.";
return (*it).second;
}
} // namespace CVC4
#endif /* __CVC4__BASE__MAP_UTIL_H */
|
