2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 2014,2018, 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.
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.
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.
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.
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.
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.
35 /*! \libinternal \file
37 * Declares gmx_bitmask_t and associated functions
39 * \author Roland Schulz <roland@utk.edu>
41 * \ingroup module_utility
44 #ifndef GMX_MDLIB_BITMASK_H
45 #define GMX_MDLIB_BITMASK_H
47 #include "config.h" /* for GMX_MAX_OPENMP_THREADS */
51 #include "gromacs/utility/basedefinitions.h"
53 /*! \brief Size of bitmask. Has to be 32 or multiple of 64. */
55 #define BITMASK_SIZE GMX_OPENMP_MAX_THREADS
58 #if BITMASK_SIZE != 32 && BITMASK_SIZE%64 != 0
59 #error BITMASK_SIZE has to be 32 or a multiple of 64.
62 #if BITMASK_SIZE <= 64 || defined DOXYGEN
63 #if BITMASK_SIZE == 32
64 typedef uint32_t gmx_bitmask_t;
66 typedef uint64_t gmx_bitmask_t; /**< bitmask type */
69 /*! \brief Initialize all bits to 0 */
70 inline static void bitmask_clear(gmx_bitmask_t* m)
75 /*! \brief Set bit at position b to 1. */
76 inline static void bitmask_set_bit(gmx_bitmask_t* m, int b)
78 *m |= ((gmx_bitmask_t)1 << b);
81 /*! \brief Initialize all bits: bit b to 1, others to 0 */
82 inline static void bitmask_init_bit(gmx_bitmask_t* m, int b)
84 *m = ((gmx_bitmask_t)1 << b);
87 /*! \brief Initialize all bits: all bits below b to 1, others to 0 */
88 inline static void bitmask_init_low_bits(gmx_bitmask_t* m, int b)
90 *m = ((gmx_bitmask_t)1 << b) - 1;
93 /*! \brief Test if bit b is set */
94 inline static bool bitmask_is_set(gmx_bitmask_t m, int b)
96 return (m & ((gmx_bitmask_t)1 << b)) != 0;
99 /*! \brief Test if both bitmasks have no common bits enabled */
100 inline static bool bitmask_is_disjoint(gmx_bitmask_t a, gmx_bitmask_t b)
105 /*! \brief Test if both bitmasks are equal */
106 inline static bool bitmask_is_equal(gmx_bitmask_t a, gmx_bitmask_t b)
111 /*! \brief Test if bitmask has no enabled bits */
112 inline static bool bitmask_is_zero(gmx_bitmask_t m)
117 /*! \brief Set all bits enabled in either mask and write into a */
118 inline static void bitmask_union(gmx_bitmask_t* a, gmx_bitmask_t b)
123 #define BITMASK_ALEN (BITMASK_SIZE/64)
124 typedef uint64_t gmx_bitmask_t[BITMASK_ALEN];
126 inline static void bitmask_clear(gmx_bitmask_t* m)
128 memset(*m, 0, BITMASK_SIZE/8);
131 inline static void bitmask_set_bit(gmx_bitmask_t* m, int b)
133 (*m)[b/64] |= ((uint64_t)1 << (b%64));
136 inline static void bitmask_init_bit(gmx_bitmask_t* m, int b)
139 (*m)[b/64] = ((uint64_t)1 << (b%64));
142 inline static void bitmask_init_low_bits(gmx_bitmask_t* m, int b)
144 memset(*m, 255, b/64*8);
145 (*m)[b/64] = ((uint64_t)1 << (b%64)) - 1;
146 memset(&(*m)[b/64+1], 0, (BITMASK_ALEN-b/64-1)*8);
149 inline static bool bitmask_is_set(gmx_bitmask_t m, int b)
151 return (m[b/64] & ((uint64_t)1 << (b%64))) != 0;
154 inline static bool bitmask_is_disjoint(gmx_bitmask_t a, gmx_bitmask_t b)
158 for (i = 0; i < BITMASK_ALEN; i++)
160 r = r && !(a[i] & b[i]);
165 inline static bool bitmask_is_equal(gmx_bitmask_t a, gmx_bitmask_t b)
169 for (i = 0; i < BITMASK_ALEN; i++)
171 r = r && (a[i] == b[i]);
176 inline static bool bitmask_is_zero(gmx_bitmask_t m)
180 for (i = 0; i < BITMASK_ALEN; i++)
187 inline static void bitmask_union(gmx_bitmask_t* a, gmx_bitmask_t b)
190 for (i = 0; i < BITMASK_ALEN; i++)