Branch data     Line data    Source code

       1                 :             : // Copyright (c) 2019-2022 The Bitcoin Core developers
       2                 :             : // Distributed under the MIT software license, see the accompanying
       3                 :             : // file COPYING or http://www.opensource.org/licenses/mit-license.php.
       4                 :             : 
       5                 :             : #ifndef BITCOIN_UTIL_VECTOR_H
       6                 :             : #define BITCOIN_UTIL_VECTOR_H
       7                 :             : 
       8                 :             : #include <functional>
       9                 :             : #include <initializer_list>
      10                 :             : #include <optional>
      11                 :             : #include <type_traits>
      12                 :             : #include <utility>
      13                 :             : #include <vector>
      14                 :             : 
      15                 :             : /** Construct a vector with the specified elements.
      16                 :             :  *
      17                 :             :  * This is preferable over the list initializing constructor of std::vector:
      18                 :             :  * - It automatically infers the element type from its arguments.
      19                 :             :  * - If any arguments are rvalue references, they will be moved into the vector
      20                 :             :  *   (list initialization always copies).
      21                 :             :  */
      22                 :             : template<typename... Args>
      23                 :    12654896 : inline std::vector<typename std::common_type<Args...>::type> Vector(Args&&... args)
      24                 :             : {
      25                 :    12654896 :     std::vector<typename std::common_type<Args...>::type> ret;
      26         [ +  - ]:    12654896 :     ret.reserve(sizeof...(args));
      27                 :             :     // The line below uses the trick from https://www.experts-exchange.com/articles/32502/None-recursive-variadic-templates-with-std-initializer-list.html
      28   [ +  -  +  -  :    12654896 :     (void)std::initializer_list<int>{(ret.emplace_back(std::forward<Args>(args)), 0)...};
           +  - ][ #  # ]
           [ +  -  +  - ]
      29                 :    12654896 :     return ret;
      30                 :           0 : }
      31                 :             : 
      32                 :             : /** Concatenate two vectors, moving elements. */
      33                 :             : template<typename V>
      34                 :     3514688 : inline V Cat(V v1, V&& v2)
      35                 :             : {
      36                 :     3514688 :     v1.reserve(v1.size() + v2.size());
      37         [ +  + ]:     6688727 :     for (auto& arg : v2) {
      38                 :     3174039 :         v1.push_back(std::move(arg));
      39                 :             :     }
      40                 :     3514688 :     return v1;
      41                 :             : }
      42                 :             : 
      43                 :             : /** Concatenate two vectors. */
      44                 :             : template<typename V>
      45                 :        1317 : inline V Cat(V v1, const V& v2)
      46                 :             : {
      47                 :        1317 :     v1.reserve(v1.size() + v2.size());
      48         [ +  + ]:        2640 :     for (const auto& arg : v2) {
      49                 :        1323 :         v1.push_back(arg);
      50                 :             :     }
      51                 :        1317 :     return v1;
      52                 :             : }
      53                 :             : 
      54                 :             : /** Clear a vector (or std::deque) and release its allocated memory. */
      55                 :             : template<typename V>
      56                 :      340969 : inline void ClearShrink(V& v) noexcept
      57                 :             : {
      58                 :             :     // There are various ways to clear a vector and release its memory:
      59                 :             :     //
      60                 :             :     // 1. V{}.swap(v)
      61                 :             :     // 2. v = V{}
      62                 :             :     // 3. v = {}; v.shrink_to_fit();
      63                 :             :     // 4. v.clear(); v.shrink_to_fit();
      64                 :             :     //
      65                 :             :     // (2) does not appear to release memory in glibc debug mode, even if v.shrink_to_fit()
      66                 :             :     // follows. (3) and (4) rely on std::vector::shrink_to_fit, which is only a non-binding
      67                 :             :     // request. Therefore, we use method (1).
      68                 :             : 
      69                 :      340969 :     V{}.swap(v);
      70                 :      340969 : }
      71                 :             : 
      72                 :             : template<typename V, typename L>
      73                 :        2709 : inline std::optional<V> FindFirst(const std::vector<V>& vec, const L fnc)
      74                 :             : {
      75   [ +  +  +  + ]:        5528 :     for (const auto& el : vec) {
      76         [ +  + ]:        5476 :         if (fnc(el)) {
      77                 :        2657 :             return el;
      78                 :             :         }
      79                 :             :     }
      80                 :          52 :     return std::nullopt;
      81                 :             : }
      82                 :             : 
      83                 :             : #endif // BITCOIN_UTIL_VECTOR_H