src/gromacs/utility/bitmask.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2014,2018,2019,2021, by the GROMACS development team, led by
   5  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   6  * and including many others, as listed in the AUTHORS file in the
   7  * top-level source directory and at http://www.gromacs.org.
   8  *
   9  * GROMACS is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU Lesser General Public License
  11  * as published by the Free Software Foundation; either version 2.1
  12  * of the License, or (at your option) any later version.
  13  *
  14  * GROMACS is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public
  20  * License along with GROMACS; if not, see
  21  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  22  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  23  *
  24  * If you want to redistribute modifications to GROMACS, please
  25  * consider that scientific software is very special. Version
  26  * control is crucial - bugs must be traceable. We will be happy to
  27  * consider code for inclusion in the official distribution, but
  28  * derived work must not be called official GROMACS. Details are found
  29  * in the README & COPYING files - if they are missing, get the
  30  * official version at http://www.gromacs.org.
  31  *
  32  * To help us fund GROMACS development, we humbly ask that you cite
  33  * the research papers on the package. Check out http://www.gromacs.org.
  34  */
  35 /*! \libinternal \file
  36  * \brief
  37  * Declares gmx_bitmask_t and associated functions
  38  *
  39  * \author Roland Schulz <roland@utk.edu>
  40  * \inlibraryapi
  41  * \ingroup module_utility
  42  */
  43
  44 #ifndef GMX_MDLIB_BITMASK_H
  45 #define GMX_MDLIB_BITMASK_H
  46
  47 #include "config.h" /* for GMX_MAX_OPENMP_THREADS */
  48
  49 #include <string.h>
  50
  51 #include <algorithm>
  52 #include <array>
  53
  54 #include "gromacs/utility/basedefinitions.h"
  55 #include "gromacs/utility/stringutil.h"
  56
  57 /*! \brief Size of bitmask. Has to be 32 or multiple of 64. */
  58 #ifndef BITMASK_SIZE
  59 #    define BITMASK_SIZE GMX_OPENMP_MAX_THREADS
  60 #endif
  61
  62 #if BITMASK_SIZE != 32 && BITMASK_SIZE % 64 != 0
  63 #    error BITMASK_SIZE has to be 32 or a multiple of 64.
  64 #endif
  65
  66 #if BITMASK_SIZE <= 64 || defined DOXYGEN
  67 #    if BITMASK_SIZE == 32
  68 typedef uint32_t gmx_bitmask_t;
  69 #    else
  70 typedef uint64_t gmx_bitmask_t; /**< bitmask type */
  71 #    endif
  72
  73 /*! \brief Initialize all bits to 0 */
  74 inline static void bitmask_clear(gmx_bitmask_t* m)
  75 {
  76     *m = 0;
  77 }
  78
  79 /*! \brief Set bit at position b to 1. */
  80 inline static void bitmask_set_bit(gmx_bitmask_t* m, int b)
  81 {
  82     *m |= gmx_bitmask_t(1) << b;
  83 }
  84
  85 /*! \brief Initialize all bits: bit b to 1, others to 0 */
  86 inline static void bitmask_init_bit(gmx_bitmask_t* m, int b)
  87 {
  88     *m = gmx_bitmask_t(1) << b;
  89 }
  90
  91 /*! \brief Initialize all bits: all bits below b to 1, others to 0 */
  92 inline static void bitmask_init_low_bits(gmx_bitmask_t* m, int b)
  93 {
  94     *m = (gmx_bitmask_t(1) << b) - 1;
  95 }
  96
  97 /*! \brief Test if bit b is set */
  98 inline static bool bitmask_is_set(gmx_bitmask_t m, int b)
  99 {
 100     return (m & (gmx_bitmask_t(1) << b)) != 0;
 101 }
 102
 103 /*! \brief Test if both bitmasks have no common bits enabled */
 104 inline static bool bitmask_is_disjoint(gmx_bitmask_t a, gmx_bitmask_t b)
 105 {
 106     return (a & b) == 0U;
 107 }
 108
 109 /*! \brief Test if both bitmasks are equal */
 110 inline static bool bitmask_is_equal(gmx_bitmask_t a, gmx_bitmask_t b)
 111 {
 112     return a == b;
 113 }
 114
 115 /*! \brief Test if bitmask has no enabled bits */
 116 inline static bool bitmask_is_zero(gmx_bitmask_t m)
 117 {
 118     return m == 0U;
 119 }
 120
 121 /*! \brief Set all bits enabled in either mask and write into a */
 122 inline static void bitmask_union(gmx_bitmask_t* a, gmx_bitmask_t b)
 123 {
 124     *a |= b;
 125 }
 126 #else
 127 #    define BITMASK_ALEN (BITMASK_SIZE / 64)
 128 using gmx_bitmask_t = std::array<uint64_t, BITMASK_ALEN>;
 129
 130 inline static void bitmask_clear(gmx_bitmask_t* m)
 131 {
 132     m->fill(0);
 133 }
 134
 135 inline static void bitmask_set_bit(gmx_bitmask_t* m, int b)
 136 {
 137     (*m)[b / 64] |= (static_cast<uint64_t>(1) << (b % 64));
 138 }
 139
 140 inline static void bitmask_init_bit(gmx_bitmask_t* m, int b)
 141 {
 142     bitmask_clear(m);
 143     (*m)[b / 64] = (static_cast<uint64_t>(1) << (b % 64));
 144 }
 145
 146 inline static void bitmask_init_low_bits(gmx_bitmask_t* m, int b)
 147 {
 148     memset(m->data(), 255, b / 64 * 8);
 149     (*m)[b / 64] = (static_cast<uint64_t>(1) << (b % 64)) - 1;
 150     memset(m->data() + (b / 64 + 1), 0, (BITMASK_ALEN - b / 64 - 1) * 8);
 151 }
 152
 153 inline static bool bitmask_is_set(gmx_bitmask_t m, int b)
 154 {
 155     return (m[b / 64] & (static_cast<uint64_t>(1) << (b % 64))) != 0;
 156 }
 157
 158 inline static bool bitmask_is_disjoint(gmx_bitmask_t a, gmx_bitmask_t b)
 159 {
 160     bool r = true;
 161     for (int i = 0; i < BITMASK_ALEN; i++)
 162     {
 163         r = r && ((a[i] & b[i]) == 0U);
 164     }
 165     return r;
 166 }
 167
 168 inline static bool bitmask_is_equal(gmx_bitmask_t a, gmx_bitmask_t b)
 169 {
 170     bool r = true;
 171     for (int i = 0; i < BITMASK_ALEN; i++)
 172     {
 173         r = r && (a[i] == b[i]);
 174     }
 175     return r;
 176 }
 177
 178 inline static bool bitmask_is_zero(gmx_bitmask_t m)
 179 {
 180     bool r = true;
 181     for (int i = 0; i < BITMASK_ALEN; i++)
 182     {
 183         r = r && (m[i] == 0U);
 184     }
 185     return r;
 186 }
 187
 188 inline static void bitmask_union(gmx_bitmask_t* a, gmx_bitmask_t b)
 189 {
 190     for (int i = 0; i < BITMASK_ALEN; i++)
 191     {
 192         (*a)[i] |= b[i];
 193     }
 194 }
 195 #endif
 196 // In bitmask.h because only current use is for bitmask.
 197
 198 //! Convert uint32_t to hex string
 199 inline static std::string to_hex_string(uint32_t m)
 200 {
 201     return gmx::formatString("%08" PRIx32, m);
 202 }
 203 //! Convert uint64_t to hex string
 204 inline static std::string to_hex_string(uint64_t m)
 205 {
 206     return gmx::formatString("%016" PRIx64, m);
 207 }
 208 //! Convert container of intergers to hex string
 209 template<typename C>
 210 inline static std::string to_hex_string(C m)
 211 {
 212     std::string ret;
 213     for (auto it = m.rbegin(); it < m.rend(); ++it)
 214     {
 215         ret += to_hex_string(*it);
 216     }
 217     return ret;
 218 }
 219
 220 #endif