src/gromacs/legacyheaders/types/simple.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
   5  * Copyright (c) 2001-2004, The GROMACS development team.
   6  * Copyright (c) 2013,2014, by the GROMACS development team, led by
   7  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   8  * and including many others, as listed in the AUTHORS file in the
   9  * top-level source directory and at http://www.gromacs.org.
  10  *
  11  * GROMACS is free software; you can redistribute it and/or
  12  * modify it under the terms of the GNU Lesser General Public License
  13  * as published by the Free Software Foundation; either version 2.1
  14  * of the License, or (at your option) any later version.
  15  *
  16  * GROMACS is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19  * Lesser General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU Lesser General Public
  22  * License along with GROMACS; if not, see
  23  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  24  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  25  *
  26  * If you want to redistribute modifications to GROMACS, please
  27  * consider that scientific software is very special. Version
  28  * control is crucial - bugs must be traceable. We will be happy to
  29  * consider code for inclusion in the official distribution, but
  30  * derived work must not be called official GROMACS. Details are found
  31  * in the README & COPYING files - if they are missing, get the
  32  * official version at http://www.gromacs.org.
  33  *
  34  * To help us fund GROMACS development, we humbly ask that you cite
  35  * the research papers on the package. Check out http://www.gromacs.org.
  36  */
  37
  38 #ifndef _simple_h
  39 #define _simple_h
  40
  41 /* Information about integer data type sizes */
  42 #include <limits.h>
  43 #define __STDC_LIMIT_MACROS
  44 #include <stdint.h>
  45 #ifndef _MSC_VER
  46 #define __STDC_FORMAT_MACROS
  47 #include <inttypes.h>
  48 #endif
  49
  50 #ifdef __cplusplus
  51 extern "C" {
  52 #endif
  53 #if 0
  54 }
  55 #endif
  56
  57
  58 #define XX      0           /* Defines for indexing in  */
  59 #define YY      1           /* vectors                  */
  60 #define ZZ      2
  61 #define DIM     3           /* Dimension of vectors             */
  62 #define XXXX    0           /* defines to index matrices */
  63 #define XXYY    1
  64 #define XXZZ    2
  65 #define YYXX    3
  66 #define YYYY    4
  67 #define YYZZ    5
  68 #define ZZXX    6
  69 #define ZZYY    7
  70 #define ZZZZ    8
  71
  72 /* There is no standard size for 'bool' in C++, so when
  73  * we previously defined it to int for C code the data types
  74  * (and structs) would have different size depending on your compiler,
  75  * both at gromacs build time and when you use the library.
  76  * The only way around this is to NOT assume anything about the C++ type,
  77  * so we cannot use the name 'bool' in our C code anymore.
  78  */
  79
  80 typedef int gmx_bool;
  81
  82 #ifndef FALSE
  83 #  define FALSE   0
  84 #endif
  85 #ifndef TRUE
  86 #  define TRUE    1
  87 #endif
  88 #define BOOL_NR 2
  89
  90
  91 typedef int         atom_id;      /* To indicate an atoms id         */
  92 #define NO_ATID     (atom_id)(~0) /* Use this to indicate invalid atid */
  93
  94 /*! \brief Double precision accuracy */
  95 #define GMX_DOUBLE_EPS   1.11022302E-16
  96
  97 /*! \brief Maximum double precision value - reduced 1 unit in last digit for MSVC */
  98 #define GMX_DOUBLE_MAX   1.79769312E+308
  99
 100 /*! \brief Minimum double precision value */
 101 #define GMX_DOUBLE_MIN   2.22507386E-308
 102
 103 /*! \brief Single precision accuracy */
 104 #define GMX_FLOAT_EPS    5.96046448E-08
 105
 106 /*! \brief Maximum single precision value - reduced 1 unit in last digit for MSVC */
 107 #define GMX_FLOAT_MAX    3.40282346E+38
 108
 109 /*! \brief Minimum single precision value */
 110 #define GMX_FLOAT_MIN    1.17549435E-38
 111
 112
 113 /* Check whether we already have a real type! */
 114 #ifdef GMX_DOUBLE
 115
 116 #ifndef HAVE_REAL
 117 typedef double      real;
 118 #define HAVE_REAL
 119 #endif
 120
 121 #define GMX_MPI_REAL    MPI_DOUBLE
 122 #define GMX_REAL_EPS    GMX_DOUBLE_EPS
 123 #define GMX_REAL_MIN    GMX_DOUBLE_MIN
 124 #define GMX_REAL_MAX    GMX_DOUBLE_MAX
 125 #define gmx_real_fullprecision_pfmt "%21.14e"
 126 #else
 127
 128 #ifndef HAVE_REAL
 129 typedef float           real;
 130 #define HAVE_REAL
 131 #endif
 132
 133 #define GMX_MPI_REAL    MPI_FLOAT
 134 #define GMX_REAL_EPS    GMX_FLOAT_EPS
 135 #define GMX_REAL_MIN    GMX_FLOAT_MIN
 136 #define GMX_REAL_MAX    GMX_FLOAT_MAX
 137 #define gmx_real_fullprecision_pfmt "%14.7e"
 138 #endif
 139
 140 typedef real            rvec[DIM];
 141
 142 typedef double          dvec[DIM];
 143
 144 typedef real            matrix[DIM][DIM];
 145
 146 typedef real            tensor[DIM][DIM];
 147
 148 typedef int             ivec[DIM];
 149
 150 typedef int             imatrix[DIM][DIM];
 151
 152 #ifdef _MSC_VER
 153 typedef __int32 gmx_int32_t;
 154 #define GMX_PRId32 "I32d"
 155 #define GMX_SCNd32 "I32d"
 156
 157 typedef __int64 gmx_int64_t;
 158 #define GMX_PRId64 "I64d"
 159 #define GMX_SCNd64 "I64d"
 160
 161 typedef unsigned __int32 gmx_uint32_t;
 162 #define GMX_PRIu32 "I32u"
 163 #define GMX_SCNu32 "I32u"
 164
 165 typedef unsigned __int64 gmx_uint64_t;
 166 #define GMX_PRIu64 "I64u"
 167 #define GMX_SCNu64 "I64u"
 168 #else
 169 typedef int32_t gmx_int32_t;
 170 #define GMX_PRId32 PRId32
 171 #define GMX_SCNd32 SCNd32
 172
 173 typedef int64_t gmx_int64_t;
 174 #define GMX_PRId64 PRId64
 175 #define GMX_SCNd64 SCNd64
 176
 177 typedef uint32_t gmx_uint32_t;
 178 #define GMX_PRIu32 PRIu32
 179 #define GMX_SCNu32 SCNu32
 180
 181 typedef uint64_t gmx_uint64_t;
 182 #define GMX_PRIu64 PRIu64
 183 #define GMX_SCNu64 SCNu64
 184 #endif
 185
 186 #define GMX_INT32_MAX INT32_MAX
 187 #define GMX_INT32_MIN INT32_MIN
 188
 189 #define GMX_INT64_MAX INT64_MAX
 190 #define GMX_INT64_MIN INT64_MIN
 191
 192 #define GMX_UINT32_MAX UINT32_MAX
 193 #define GMX_UINT32_MIN UINT32_MIN
 194
 195 #define GMX_UINT64_MAX UINT64_MAX
 196 #define GMX_UINT64_MIN UINT64_MIN
 197
 198 #if !defined __cplusplus && _MSC_VER
 199 #define gmx_inline __inline
 200 #else
 201 /* C++ or C99 */
 202 #define gmx_inline inline
 203 #endif
 204
 205 /* ICC, GCC, MSVC, Pathscale, PGI, XLC support __restrict.
 206  * Any other compiler can be added here. We cannot
 207  * use restrict because it is in C99 but not in C++ */
 208 #define gmx_restrict __restrict
 209
 210 /*
 211  * These attributes suppress compiler warnings about unused function arguments
 212  * by marking them as possibly unused. Some arguments are unused but
 213  * have to be retained to preserve a function signature
 214  * that must match that of another function.
 215  * Some arguments are only used in *some* code paths (e.g. MPI)
 216  */
 217
 218 #ifndef gmx_unused
 219 #ifdef __GNUC__
 220 /* GCC, clang, and some ICC pretending to be GCC */
 221 #  define gmx_unused __attribute__ ((unused))
 222 #elif (defined(__INTEL_COMPILER) || defined(__ECC)) && !defined(_MSC_VER)
 223 /* ICC on *nix */
 224 #  define gmx_unused __attribute__ ((unused))
 225 #elif defined _MSC_VER
 226 /* MSVC */
 227 #  define gmx_unused /*@unused@*/
 228 #elif defined(__xlC__)
 229 /* IBM */
 230 #  define gmx_unused __attribute__ ((unused))
 231 #else
 232 #  define gmx_unused
 233 #endif
 234 #endif
 235
 236 /* Standard sizes for char* string buffers */
 237 #define STRLEN 4096
 238 #define BIG_STRLEN 1048576
 239
 240
 241 #ifdef __cplusplus
 242 }
 243 #endif
 244
 245 #endif