LSSTApplications  19.0.0-14-gb0260a2+72efe9b372,20.0.0+7927753e06,20.0.0+8829bf0056,20.0.0+995114c5d2,20.0.0+b6f4b2abd1,20.0.0+bddc4f4cbe,20.0.0-1-g253301a+8829bf0056,20.0.0-1-g2b7511a+0d71a2d77f,20.0.0-1-g5b95a8c+7461dd0434,20.0.0-12-g321c96ea+23efe4bbff,20.0.0-16-gfab17e72e+fdf35455f6,20.0.0-2-g0070d88+ba3ffc8f0b,20.0.0-2-g4dae9ad+ee58a624b3,20.0.0-2-g61b8584+5d3db074ba,20.0.0-2-gb780d76+d529cf1a41,20.0.0-2-ged6426c+226a441f5f,20.0.0-2-gf072044+8829bf0056,20.0.0-2-gf1f7952+ee58a624b3,20.0.0-20-geae50cf+e37fec0aee,20.0.0-25-g3dcad98+544a109665,20.0.0-25-g5eafb0f+ee58a624b3,20.0.0-27-g64178ef+f1f297b00a,20.0.0-3-g4cc78c6+e0676b0dc8,20.0.0-3-g8f21e14+4fd2c12c9a,20.0.0-3-gbd60e8c+187b78b4b8,20.0.0-3-gbecbe05+48431fa087,20.0.0-38-ge4adf513+a12e1f8e37,20.0.0-4-g97dc21a+544a109665,20.0.0-4-gb4befbc+087873070b,20.0.0-4-gf910f65+5d3db074ba,20.0.0-5-gdfe0fee+199202a608,20.0.0-5-gfbfe500+d529cf1a41,20.0.0-6-g64f541c+d529cf1a41,20.0.0-6-g9a5b7a1+a1cd37312e,20.0.0-68-ga3f3dda+5fca18c6a4,20.0.0-9-g4aef684+e18322736b,w.2020.45
LSSTDataManagementBasePackage
StorableMap.h
Go to the documentation of this file.
1 // -*- LSST-C++ -*-
2 /*
3  * This file is part of afw.
4  *
5  * Developed for the LSST Data Management System.
6  * This product includes software developed by the LSST Project
7  * (https://www.lsst.org).
8  * See the COPYRIGHT file at the top-level directory of this distribution
9  * for details of code ownership.
10  *
11  * This program is free software: you can redistribute it and/or modify
12  * it under the terms of the GNU General Public License as published by
13  * the Free Software Foundation, either version 3 of the License, or
14  * (at your option) any later version.
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19  * GNU General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License
22  * along with this program. If not, see <https://www.gnu.org/licenses/>.
23  */
24 
25 #ifndef LSST_AFW_IMAGE_DETAIL_STORABLEMAP_H
26 #define LSST_AFW_IMAGE_DETAIL_STORABLEMAP_H
27 
28 #include <exception>
29 #include <memory>
30 #include <sstream>
31 #include <string>
32 #include <type_traits>
33 #include <unordered_map>
34 #include <utility>
35 
36 #include "lsst/pex/exceptions.h"
39 
40 namespace lsst {
41 namespace afw {
42 namespace image {
43 namespace detail {
44 
59 class StorableMap final {
60 public:
67  using const_reference = value_type const&;
68  using pointer = value_type*;
69  using const_pointer = value_type const*;
70 
71 private:
73 
74 public:
75  // These definitions may be replaced with adapters if we need
76  // StorableMap's iterators to behave differently from _Impl's.
77  using const_iterator = _Impl::const_iterator;
78  using iterator = _Impl::iterator;
81 
82  template <typename V>
85 
91  ~StorableMap() noexcept;
92 
105  StorableMap(std::initializer_list<value_type> init);
106 
121  template <typename T>
122  std::shared_ptr<T> at(Key<std::shared_ptr<T>> const& key) const {
124  "Can only retrieve pointers to subclasses of Storable.");
125  static_assert(std::is_const<T>::value,
126  "Due to implementation constraints, pointers to non-const are not supported.");
127  try {
128  // unordered_map::at(Key<Storable>) does not do any type-checking.
129  mapped_type const& pointer = _contents.at(key);
130 
131  // Null pointer stored; skip dynamic_cast because won't change result.
132  if (pointer == nullptr) {
133  return nullptr;
134  }
135 
136  std::shared_ptr<T> typedPointer = std::dynamic_pointer_cast<T>(pointer);
137  // shared_ptr can be empty without being null. dynamic_pointer_cast
138  // only promises result of failed cast is empty, so test for that.
139  if (typedPointer.use_count() > 0) {
140  return typedPointer;
141  } else {
142  std::stringstream message;
143  message << "Key " << key << " not found, but a key labeled " << key.getId() << " is present.";
145  }
146  } catch (std::out_of_range const&) {
148  "No key labeled " + key.getId() + " found."));
149  }
150  }
151 
153  size_type size() const noexcept;
154 
156  bool empty() const noexcept;
157 
167  size_type max_size() const noexcept;
168 
184  bool contains(std::string const& key) const;
185 
200  template <typename T>
201  bool contains(Key<std::shared_ptr<T>> const& key) const {
203  "Can only retrieve pointers to subclasses of Storable.");
204  static_assert(std::is_const<T>::value,
205  "Due to implementation constraints, pointers to non-const are not supported.");
206  if (_contents.count(key) > 0) {
207  // unordered_map::at(Key<Storable>) does not do any type-checking.
208  mapped_type const& pointer = _contents.at(key);
209 
210  // Null pointer stored; dynamic_cast will always return null.
211  if (pointer == nullptr) {
212  return true;
213  }
214 
215  std::shared_ptr<T> typedPointer = std::dynamic_pointer_cast<T>(pointer);
216  // shared_ptr can be empty without being null. dynamic_pointer_cast
217  // only promises result of failed cast is empty, so test for that.
218  return typedPointer.use_count() > 0;
219  } else {
220  return false;
221  }
222  }
223 
232  bool operator==(StorableMap const& other) const noexcept;
233 
234  bool operator!=(StorableMap const& other) const noexcept { return !(*this == other); }
235 
243  void clear() noexcept;
244 
262  template <typename T>
263  bool insert(Key<std::shared_ptr<T>> const& key, std::shared_ptr<T> const& value) {
265  "Can only store shared pointers to subclasses of Storable.");
266  static_assert(std::is_const<T>::value,
267  "Due to implementation constraints, pointers to non-const are not supported.");
268  // unordered_map uses Key<shared_ptr<Storable>> internally, so
269  // any key with the same ID will block emplacement.
270  return _contents.emplace(key, value).second;
271  }
272 
292  template <typename T>
293  std::pair<Key<T>, bool> insert(std::string const& key, T const& value) {
294  auto strongKey = typehandling::makeKey<T>(key);
295  // Construct return value in advance, so that exception from
296  // copying/moving Key is atomic.
297  auto result = std::make_pair(strongKey, false);
298  result.second = insert(strongKey, value);
299  return result;
300  }
301 
310  template <typename T>
311  bool erase(Key<T> const& key) noexcept {
312  // unordered_map::erase(Key<Storable>) does no type checking.
313  if (this->contains(key)) {
314  return _contents.erase(key) > 0;
315  } else {
316  return false;
317  }
318  }
319 
328  iterator begin() noexcept;
329  const_iterator begin() const noexcept;
330  const_iterator cbegin() const noexcept { return begin(); }
331 
342  iterator end() noexcept;
343  const_iterator end() const noexcept;
344  const_iterator cend() const noexcept { return end(); }
345 
348 private:
349  _Impl _contents;
350 };
351 
352 } // namespace detail
353 } // namespace image
354 } // namespace afw
355 } // namespace lsst
356 
357 #endif
lsst::afw::image
Backwards-compatibility support for depersisting the old Calib (FluxMag0/FluxMag0Err) objects.
Definition: imageAlgorithm.dox:1
lsst::afw::image::detail::StorableMap::begin
iterator begin() noexcept
Return an iterator to the first element of the map.
Definition: StorableMap.cc:63
std::string
STL class.
std::shared_ptr
STL class.
lsst::afw::image::detail::StorableMap::size
size_type size() const noexcept
Return the number of key-value pairs in the map.
Definition: StorableMap.cc:44
std::pair
lsst::afw::image::detail::StorableMap::operator=
StorableMap & operator=(StorableMap const &other)
lsst::afw::image::detail::StorableMap::empty
bool empty() const noexcept
Return true if this map contains no key-value pairs.
Definition: StorableMap.cc:46
lsst::afw::image::detail::StorableMap::insert
bool insert(Key< std::shared_ptr< T >> const &key, std::shared_ptr< T > const &value)
Insert an element into the map, if the map doesn't already contain a mapping with the same or a confl...
Definition: StorableMap.h:263
lsst::afw::image::detail::StorableMap::operator==
bool operator==(StorableMap const &other) const noexcept
Test for map equality.
Definition: StorableMap.cc:52
lsst::afw
Definition: imageAlgorithm.dox:1
std::unordered_map::emplace
T emplace(T... args)
std::stringstream
STL class.
lsst::afw::image::detail::StorableMap::clear
void clear() noexcept
Remove all of the mappings from this map.
Definition: StorableMap.cc:54
lsst::afw::image::detail::StorableMap::size_type
std::size_t size_type
Definition: StorableMap.h:64
lsst::afw::image::detail::StorableMap::const_pointer
value_type const * const_pointer
Definition: StorableMap.h:69
lsst::afw::image::detail::StorableMap::erase
bool erase(Key< T > const &key) noexcept
Remove the mapping for a key from this map, if it exists.
Definition: StorableMap.h:311
lsst::afw::image::detail::StorableMap::cbegin
const_iterator cbegin() const noexcept
Return an iterator to the first element of the map.
Definition: StorableMap.h:330
lsst::afw::typehandling::Storable
Interface supporting iteration over heterogenous containers.
Definition: Storable.h:58
lsst::afw::image::detail::StorableMap::operator=
StorableMap & operator=(StorableMap &&other)
lsst::afw::image::detail::StorableMap::at
std::shared_ptr< T > at(Key< std::shared_ptr< T >> const &key) const
Return a the mapped value of the element with key equal to key.
Definition: StorableMap.h:122
lsst::afw::image::detail::StorableMap::cend
const_iterator cend() const noexcept
Return an iterator to the element past the end of the map.
Definition: StorableMap.h:344
std::unordered_map::at
T at(T... args)
std::throw_with_nested
T throw_with_nested(T... args)
other
ItemVariant const * other
Definition: Schema.cc:56
std::unordered_map::erase
T erase(T... args)
Storable.h
result
py::object result
Definition: _schema.cc:429
lsst
A base class for image defects.
Definition: imageAlgorithm.dox:1
lsst::afw::image::detail::StorableMap::operator!=
bool operator!=(StorableMap const &other) const noexcept
Test for map equality.
Definition: StorableMap.h:234
LSST_EXCEPT
#define LSST_EXCEPT(type,...)
Create an exception with a given type.
Definition: Exception.h:48
lsst::afw::image::detail::StorableMap::StorableMap
StorableMap()
lsst::afw::typehandling::Key
Key for type-safe lookup in a GenericMap.
Definition: Key.h:52
lsst::afw::image::detail::StorableMap::~StorableMap
~StorableMap() noexcept
std::is_const
lsst::afw::image::detail::StorableMap::const_reference
value_type const & const_reference
Definition: StorableMap.h:67
std
STL namespace.
key
Key< U > key
Definition: Schema.cc:281
lsst::afw::image::detail::StorableMap::StorableMap
StorableMap(StorableMap &&other)
lsst.pex::exceptions::OutOfRangeError
Reports attempts to access elements outside a valid range of indices.
Definition: Runtime.h:89
std::unordered_map::count
T count(T... args)
std::ptrdiff_t
std::out_of_range
STL class.
std::stringstream::str
T str(T... args)
std::size_t
lsst::afw::image::detail::StorableMap::max_size
size_type max_size() const noexcept
Return the maximum number of elements the container is able to hold due to system or library implemen...
Definition: StorableMap.cc:48
std::make_pair
T make_pair(T... args)
std::reverse_iterator
Key.h
lsst::utils.tests.init
def init()
Definition: tests.py:59
lsst::afw::image::detail::StorableMap::insert
std::pair< Key< T >, bool > insert(std::string const &key, T const &value)
Insert an element into the map, if the map doesn't already contain a mapping with a conflicting key.
Definition: StorableMap.h:293
std::unordered_map< key_type, mapped_type >
lsst::afw::image::detail::StorableMap::end
iterator end() noexcept
Return an iterator to the element past the end of the map.
Definition: StorableMap.cc:64
lsst::afw::image::detail::StorableMap::iterator
_Impl::iterator iterator
Definition: StorableMap.h:78
lsst::afw::image::detail::StorableMap::contains
bool contains(std::string const &key) const
Return true if this map contains a mapping whose key has the specified label.
Definition: StorableMap.cc:50
lsst::afw::image::detail::StorableMap::StorableMap
StorableMap(StorableMap const &other)
std::is_base_of
lsst::afw::image::detail::StorableMap::const_iterator
_Impl::const_iterator const_iterator
Definition: StorableMap.h:77
exceptions.h
lsst::afw::image::detail::StorableMap
A map of Storable supporting strongly-typed access.
Definition: StorableMap.h:59