src/gromacs/utility/bitmask.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2014, 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 "gromacs/utility/basedefinitions.h"
  52
  53 /*! \brief Size of bitmask. Has to be 32 or multiple of 64. */
  54 #ifndef BITMASK_SIZE
  55 #define BITMASK_SIZE GMX_OPENMP_MAX_THREADS
  56 #endif
  57
  58 #if BITMASK_SIZE != 32 && BITMASK_SIZE%64 != 0
  59 #error BITMASK_SIZE has to be 32 or a multiple of 64.
  60 #endif
  61
  62 #if BITMASK_SIZE <= 64 || defined DOXYGEN
  63 #if BITMASK_SIZE == 32
  64 typedef gmx_uint32_t gmx_bitmask_t;
  65 #else
  66 typedef gmx_uint64_t gmx_bitmask_t; /**< bitmask type */
  67 #endif
  68
  69 /*! \brief Initialize all bits to 0 */
  70 gmx_inline static void bitmask_clear(gmx_bitmask_t* m)
  71 {
  72     *m = 0;
  73 }
  74
  75 /*! \brief Set bit at position b to 1. */
  76 gmx_inline static void bitmask_set_bit(gmx_bitmask_t* m, int b)
  77 {
  78     *m |= ((gmx_bitmask_t)1 << b);
  79 }
  80
  81 /*! \brief Initialize all bits: bit b to 1, others to 0 */
  82 gmx_inline static void bitmask_init_bit(gmx_bitmask_t* m, int b)
  83 {
  84     *m = ((gmx_bitmask_t)1 << b);
  85 }
  86
  87 /*! \brief Initialize all bits: all bits below b to 1, others to 0 */
  88 gmx_inline static void bitmask_init_low_bits(gmx_bitmask_t* m, int b)
  89 {
  90     *m = ((gmx_bitmask_t)1 << b) - 1;
  91 }
  92
  93 /*! \brief Test if bit b is set */
  94 gmx_inline static gmx_bool bitmask_is_set(gmx_bitmask_t m, int b)
  95 {
  96     return (m & ((gmx_bitmask_t)1 << b)) != 0;
  97 }
  98
  99 /*! \brief Test if both bitmasks have no common bits enabled */
 100 gmx_inline static gmx_bool bitmask_is_disjoint(gmx_bitmask_t a, gmx_bitmask_t b)
 101 {
 102     return !(a & b);
 103 }
 104
 105 /*! \brief Test if both bitmasks are equal */
 106 gmx_inline static gmx_bool bitmask_is_equal(gmx_bitmask_t a, gmx_bitmask_t b)
 107 {
 108     return a == b;
 109 }
 110
 111 /*! \brief Test if bitmask has no enabled bits */
 112 gmx_inline static gmx_bool bitmask_is_zero(gmx_bitmask_t m)
 113 {
 114     return !m;
 115 }
 116
 117 /*! \brief Set all bits enabled in either mask and write into a */
 118 gmx_inline static void bitmask_union(gmx_bitmask_t* a, gmx_bitmask_t b)
 119 {
 120     *a |= b;
 121 }
 122 #else
 123 #define BITMASK_ALEN (BITMASK_SIZE/64)
 124 typedef gmx_uint64_t gmx_bitmask_t[BITMASK_ALEN];
 125
 126 gmx_inline static void bitmask_clear(gmx_bitmask_t* m)
 127 {
 128     memset(*m, 0, BITMASK_SIZE/8);
 129 }
 130
 131 gmx_inline static void bitmask_set_bit(gmx_bitmask_t* m, int b)
 132 {
 133     (*m)[b/64] |= ((gmx_uint64_t)1 << (b%64));
 134 }
 135
 136 gmx_inline static void bitmask_init_bit(gmx_bitmask_t* m, int b)
 137 {
 138     bitmask_clear(m);
 139     (*m)[b/64] = ((gmx_uint64_t)1 << (b%64));
 140 }
 141
 142 gmx_inline static void bitmask_init_low_bits(gmx_bitmask_t* m, int b)
 143 {
 144     memset(*m, 255, b/64*8);
 145     (*m)[b/64] = ((gmx_uint64_t)1 << (b%64)) - 1;
 146     memset(&(*m)[b/64+1], 0, (BITMASK_ALEN-b/64-1)*8);
 147 }
 148
 149 gmx_inline static gmx_bool bitmask_is_set(gmx_bitmask_t m, int b)
 150 {
 151     return (m[b/64] & ((gmx_uint64_t)1 << (b%64))) != 0;
 152 }
 153
 154 gmx_inline static gmx_bool bitmask_is_disjoint(gmx_bitmask_t a, gmx_bitmask_t b)
 155 {
 156     int      i;
 157     gmx_bool r = 1;
 158     for (i = 0; i < BITMASK_ALEN; i++)
 159     {
 160         r = r && !(a[i] & b[i]);
 161     }
 162     return r;
 163 }
 164
 165 gmx_inline static gmx_bool bitmask_is_equal(gmx_bitmask_t a, gmx_bitmask_t b)
 166 {
 167     int      i;
 168     gmx_bool r = 1;
 169     for (i = 0; i < BITMASK_ALEN; i++)
 170     {
 171         r = r && (a[i] == b[i]);
 172     }
 173     return r;
 174 }
 175
 176 gmx_inline static gmx_bool bitmask_is_zero(gmx_bitmask_t m)
 177 {
 178     int      i;
 179     gmx_bool r = 1;
 180     for (i = 0; i < BITMASK_ALEN; i++)
 181     {
 182         r = r && !m[i];
 183     }
 184     return r;
 185 }
 186
 187 gmx_inline static void bitmask_union(gmx_bitmask_t* a, gmx_bitmask_t b)
 188 {
 189     int i;
 190     for (i = 0; i < BITMASK_ALEN; i++)
 191     {
 192         (*a)[i] |= b[i];
 193     }
 194 }
 195 #endif
 196
 197 #endif