src/gromacs/utility/iserializer.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2016,2017,2018,2019, 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 a generic serialization interface that supports both directions.
  38  *
  39  * \todo Generalize and transfer serialization functionality used in
  40  *       mrc density file header serialization to here.
  41  *
  42  * \author Teemu Murtola <teemu.murtola@gmail.com>
  43  * \inlibraryapi
  44  * \ingroup module_utility
  45  */
  46 #ifndef GMX_UTILITY_ISERIALIZER_H
  47 #define GMX_UTILITY_ISERIALIZER_H
  48
  49 #include <string>
  50
  51 #include "gromacs/math/vectypes.h"
  52 #include "gromacs/utility/basedefinitions.h"
  53 #include "gromacs/utility/real.h"
  54 #include "gromacs/utility/smalloc.h"
  55
  56 namespace gmx
  57 {
  58
  59 /*! \libinternal
  60  * \brief Interface for types that convert standard data types into a
  61  * form suitable for storage or transfer.
  62  *
  63  * Different implementations could suit MPI, file I/O, or in-memory
  64  * conversion. */
  65 class ISerializer
  66 {
  67 public:
  68     virtual ~ISerializer() {}
  69     /*! \brief Returns whether the serializer is reading or
  70      * writing, because details like memory management vary
  71      * accordingly. */
  72     virtual bool reading() const = 0;
  73     //! \brief Serialize values of different types.
  74     ///@{
  75     virtual void doBool(bool* value)             = 0;
  76     virtual void doUChar(unsigned char* value)   = 0;
  77     virtual void doChar(char* value)             = 0;
  78     virtual void doUShort(unsigned short* value) = 0;
  79     virtual void doInt(int* value)               = 0;
  80     virtual void doInt32(int32_t* value)         = 0;
  81     virtual void doInt64(int64_t* value)         = 0;
  82     virtual void doFloat(float* value)           = 0;
  83     virtual void doDouble(double* value)         = 0;
  84     virtual void doReal(real* value)             = 0;
  85     virtual void doIvec(ivec* value)             = 0;
  86     virtual void doRvec(rvec* value)             = 0;
  87     virtual void doString(std::string* value)    = 0;
  88     ///@}
  89
  90     //! \brief Serialize arrays of values of different types.
  91     ///@{
  92     void doBoolArray(bool* values, int elements)
  93     {
  94         for (int i = 0; i < elements; i++)
  95         {
  96             doBool(&(values[i]));
  97         }
  98     }
  99     // Char, UChar and RVec have vector specializations that can be
 100     // used instead of the default looping.
 101     virtual void doCharArray(char* values, int elements)
 102     {
 103         for (int i = 0; i < elements; i++)
 104         {
 105             doChar(&(values[i]));
 106         }
 107     }
 108     virtual void doUCharArray(unsigned char* values, int elements)
 109     {
 110         for (int i = 0; i < elements; i++)
 111         {
 112             doUChar(&(values[i]));
 113         }
 114     }
 115     void doUShortArray(unsigned short* values, int elements)
 116     {
 117         for (int i = 0; i < elements; i++)
 118         {
 119             doUShort(&(values[i]));
 120         }
 121     }
 122     void doIntArray(int* values, int elements)
 123     {
 124         for (int i = 0; i < elements; i++)
 125         {
 126             doInt(&(values[i]));
 127         }
 128     }
 129     void doInt32Array(int32_t* values, int elements)
 130     {
 131         for (int i = 0; i < elements; i++)
 132         {
 133             doInt32(&(values[i]));
 134         }
 135     }
 136     void doInt64Array(int64_t* values, int elements)
 137     {
 138         for (int i = 0; i < elements; i++)
 139         {
 140             doInt64(&(values[i]));
 141         }
 142     }
 143     void doFloatArray(float* values, int elements)
 144     {
 145         for (int i = 0; i < elements; i++)
 146         {
 147             doFloat(&(values[i]));
 148         }
 149     }
 150     void doDoubleArray(double* values, int elements)
 151     {
 152         for (int i = 0; i < elements; i++)
 153         {
 154             doDouble(&(values[i]));
 155         }
 156     }
 157     void doRealArray(real* values, int elements)
 158     {
 159         for (int i = 0; i < elements; i++)
 160         {
 161             doReal(&(values[i]));
 162         }
 163     }
 164     void doIvecArray(ivec* values, int elements)
 165     {
 166         for (int i = 0; i < elements; i++)
 167         {
 168             doIvec(&(values[i]));
 169         }
 170     }
 171     virtual void doRvecArray(rvec* values, int elements)
 172     {
 173         for (int i = 0; i < elements; i++)
 174         {
 175             doRvec(&(values[i]));
 176         }
 177     }
 178     ///@}
 179 };
 180
 181 } // namespace gmx
 182
 183 #endif