OpenMD 3.0
Molecular Dynamics in the Open
Loading...
Searching...
No Matches
MemoryUtils.hpp
Go to the documentation of this file.
1/*
2 * Copyright (c) 2004-present, The University of Notre Dame. All rights
3 * reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are met:
7 *
8 * 1. Redistributions of source code must retain the above copyright notice,
9 * this list of conditions and the following disclaimer.
10 *
11 * 2. Redistributions in binary form must reproduce the above copyright notice,
12 * this list of conditions and the following disclaimer in the documentation
13 * and/or other materials provided with the distribution.
14 *
15 * 3. Neither the name of the copyright holder nor the names of its
16 * contributors may be used to endorse or promote products derived from
17 * this software without specific prior written permission.
18 *
19 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
20 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
23 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29 * POSSIBILITY OF SUCH DAMAGE.
30 *
31 * SUPPORT OPEN SCIENCE! If you use OpenMD or its source code in your
32 * research, please cite the appropriate papers when you publish your
33 * work. Good starting points are:
34 *
35 * [1] Meineke, et al., J. Comp. Chem. 26, 252-271 (2005).
36 * [2] Fennell & Gezelter, J. Chem. Phys. 124, 234104 (2006).
37 * [3] Sun, Lin & Gezelter, J. Chem. Phys. 128, 234107 (2008).
38 * [4] Vardeman, Stocker & Gezelter, J. Chem. Theory Comput. 7, 834 (2011).
39 * [5] Kuang & Gezelter, Mol. Phys., 110, 691-701 (2012).
40 * [6] Lamichhane, Gezelter & Newman, J. Chem. Phys. 141, 134109 (2014).
41 * [7] Lamichhane, Newman & Gezelter, J. Chem. Phys. 141, 134110 (2014).
42 * [8] Bhattarai, Newman & Gezelter, Phys. Rev. B 99, 094106 (2019).
43 */
44
45/**
46 * @file MemoryUtils.hpp
47 * @authors tlin crdrisko
48 * @date 10/25/2004
49 * @version 1.0
50 */
51
52#ifndef OPENMD_UTILS_MEMORYUTILS_HPP
53#define OPENMD_UTILS_MEMORYUTILS_HPP
54
55#include <memory>
56#include <type_traits>
57#include <utility>
58
59namespace OpenMD::Utils {
60 namespace details {
61
62 template<typename, typename = std::void_t<>>
63 struct is_container : std::false_type {};
64
65 template<typename T>
66 struct is_container<T, std::void_t<typename T::value_type,
67 typename T::reference,
68 typename T::const_reference,
69 typename T::iterator,
70 typename T::const_iterator,
71 typename T::difference_type,
72 typename T::size_type,
73 decltype(std::declval<T>().begin()),
74 decltype(std::declval<T>().end()),
75 decltype(std::declval<T>().cbegin()),
76 decltype(std::declval<T>().cend()),
77 decltype(std::declval<T>().max_size()),
78 decltype(std::declval<T>().empty())>> : std::true_type {};
79
80 // Convenience variable template for ease-of-use
81 template<typename T>
82 constexpr bool is_container_v = is_container<T>::value;
83
84 template<typename T>
85 void lifted_deleter(T val) {
86 delete val;
87 }
88
89 template<typename T1, typename T2>
90 void lifted_deleter(std::pair<T1, T2>& val) {
91 lifted_deleter(val.second);
92 }
93 } // namespace details
94
95 // Recursively deallocate the previously allocated memory from each container
96 template<typename Container>
97 void deletePointers(Container& container) {
98 if constexpr(details::is_container_v<typename Container::value_type>) {
99 for (auto& elem : container)
100 deletePointers(elem);
101 } else {
102 for (auto& elem : container)
103 details::lifted_deleter(elem);
104 }
105 }
106} // namespace OpenMD::Utils
107
108#endif // OPENMD_UTILS_MEMORYUTILS_HPP