src/gromacs/analysisdata/framelocaldata.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2014,2015,2017,2019,2020,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 /*! \internal \file
  36  * \brief
  37  * Defines gmx::AnalysisDataFrameLocalData and supporting types.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \ingroup module_analysisdata
  41  */
  42 #ifndef GMX_ANALYSISDATA_FRAMELOCALDATA_H
  43 #define GMX_ANALYSISDATA_FRAMELOCALDATA_H
  44
  45 #include <algorithm>
  46 #include <numeric>
  47 #include <vector>
  48
  49 #include "gromacs/analysisdata/paralleloptions.h"
  50 #include "gromacs/utility/gmxassert.h"
  51
  52 namespace gmx
  53 {
  54
  55 template<typename>
  56 class ArrayRef;
  57
  58 //! \addtogroup module_analysisdata
  59 //! \{
  60
  61 /*! \internal
  62  * \brief
  63  * Handle to a single data set within frame-local data array.
  64  *
  65  * Methods in this class do not throw.
  66  *
  67  * \see AnalysisDataFrameLocalData
  68  */
  69 template<typename ValueType>
  70 class AnalysisDataFrameLocalDataSetHandle
  71 {
  72 public:
  73     //! Constructs a handle from an array of values.
  74     explicit AnalysisDataFrameLocalDataSetHandle(ArrayRef<ValueType> values) : values_(values) {}
  75
  76     //! Clears all values in the data set.
  77     void clear() { std::fill(values_.begin(), values_.end(), ValueType()); }
  78
  79     //! Accesses a single value in the data set.
  80     ValueType& value(int column)
  81     {
  82         GMX_ASSERT(column >= 0 && column < ssize(values_), "Invalid column index");
  83         return values_[column];
  84     }
  85
  86 private:
  87     ArrayRef<ValueType> values_;
  88 };
  89
  90 /*! \internal
  91  * \brief
  92  * Handle to a single frame data within frame-local data array.
  93  *
  94  * Methods in this class do not throw.
  95  *
  96  * \see AnalysisDataFrameLocalData
  97  */
  98 template<typename ValueType>
  99 class AnalysisDataFrameLocalDataHandle
 100 {
 101 public:
 102     //! Shorthand for the internal array of values.
 103     typedef std::vector<ValueType> ValueArray;
 104     //! Shorthand for a handle to a single data set.
 105     typedef AnalysisDataFrameLocalDataSetHandle<ValueType> DataSetHandle;
 106
 107     //! Constructs a handle from specified frame data.
 108     AnalysisDataFrameLocalDataHandle(const std::vector<int>* dataSetIndices, ValueArray* values) :
 109         dataSetIndices_(dataSetIndices), values_(values)
 110     {
 111     }
 112
 113     //! Returns the number of data sets in the array.
 114     int dataSetCount() const { return dataSetIndices_->size() - 1; }
 115     //! Clears all values in the frame.
 116     void clear() { std::fill(values_->begin(), values_->end(), ValueType()); }
 117
 118     //! Returns a handle for a single data set.
 119     DataSetHandle dataSet(int dataSet)
 120     {
 121         GMX_ASSERT(dataSet >= 0 && dataSet < dataSetCount(), "Invalid data set index");
 122         const int firstIndex = (*dataSetIndices_)[dataSet];
 123         const int lastIndex  = (*dataSetIndices_)[dataSet + 1];
 124         return DataSetHandle(makeArrayRef(*values_).subArray(firstIndex, lastIndex - firstIndex));
 125     }
 126     //! Accesses a single value in the frame.
 127     ValueType& value(int dataSet, int column)
 128     {
 129         GMX_ASSERT(dataSet >= 0 && dataSet < dataSetCount(), "Invalid data set index");
 130         const int firstIndex = (*dataSetIndices_)[dataSet];
 131         GMX_ASSERT(column >= 0 && column < (*dataSetIndices_)[dataSet + 1] - firstIndex,
 132                    "Invalid column index");
 133         return (*values_)[firstIndex + column];
 134     }
 135
 136 private:
 137     const std::vector<int>* dataSetIndices_;
 138     ValueArray*             values_;
 139 };
 140
 141 /*! \internal \brief
 142  * Container for an array of frame-local values that supports parallel data
 143  * processing.
 144  *
 145  * \tparam ValueType Type of values to store.
 146  *
 147  * This class provides a convenient interface to create an array of frame-local
 148  * data for use in analysis data modules that support parallel processing.
 149  * The object is initialized by setting the desired dimensionality with
 150  * setDataSetCount() and setColumnCount(), followed by a call to init(),
 151  * typically in IAnalysisDataModule::parallelDataStarted(),
 152  *
 153  * After initialization, frameData() can be used to access the data for a given
 154  * frame, independently from other frames.  This works if the assumptions about
 155  * parallelism hold: if `N` is the parallelization factor given for init() with
 156  * AnalysisDataParallelOptions::parallelizationFactor(), then frame `i+N` must
 157  * not be accessed before all processing for frame `i` is finished.
 158  * Technically, the data for different frames is kept in a ring buffer of size
 159  * `N`.
 160  *
 161  * The data for a frame is not cleared after it is reused for a new frame (but
 162  * is initially cleared).  This allows using the data for accumulating values
 163  * over all frames in a lock-free manner.
 164  *
 165  * frameDataSet() is provided for convenience when only a single data set
 166  * needs to be accessed (typically in IAnalysisDataModule::pointsAdded()).
 167  *
 168  * Methods in this class do not throw except where indicated.
 169  *
 170  * \see AnalysisDataFrameLocalData
 171  */
 172 template<typename ValueType>
 173 class AnalysisDataFrameLocalData
 174 {
 175 public:
 176     //! Shorthand for the internal array of values for a frame.
 177     typedef std::vector<ValueType> ValueArray;
 178     //! Shorthand for a handle to a single frame.
 179     typedef AnalysisDataFrameLocalDataHandle<ValueType> FrameHandle;
 180     //! Shorthand for a handle to a single data set.
 181     typedef AnalysisDataFrameLocalDataSetHandle<ValueType> DataSetHandle;
 182
 183     //! Constructs an empty container with a single data set.
 184     AnalysisDataFrameLocalData() { dataSetColumns_.resize(2); }
 185
 186     //! Whether init() has been called.
 187     bool isInitialized() const { return !values_.empty(); }
 188     /*! \brief
 189      * Returns number of independent data frames in this object.
 190      *
 191      * This supports looping over all the frame arrays to, e.g., sum them
 192      * up at the end in accumulation scenarios.
 193      */
 194     int frameCount() const { return values_.size(); }
 195
 196     /*! \brief
 197      * Sets the number of data sets stored for each frame.
 198      *
 199      * \throws std::bad_alloc if out of memory.
 200      *
 201      * If not called, there is a single data set in the object.
 202      * Cannot be called after init().
 203      */
 204     void setDataSetCount(int dataSetCount)
 205     {
 206         GMX_RELEASE_ASSERT(!isInitialized(), "Cannot change value count after init()");
 207         GMX_RELEASE_ASSERT(dataSetCount >= 0, "Invalid data set count");
 208         dataSetColumns_.resize(dataSetCount + 1);
 209     }
 210     /*! \brief
 211      * Sets the number of columns stored for a data set.
 212      *
 213      * Must be called for each data set that needs to have values,
 214      * otherwise there will be zero columns for that data set.
 215      * Cannot be called after init().
 216      */
 217     void setColumnCount(int dataSet, int columnCount)
 218     {
 219         GMX_RELEASE_ASSERT(!isInitialized(), "Cannot change value count after init()");
 220         GMX_RELEASE_ASSERT(dataSet >= 0 && dataSet < ssize(dataSetColumns_) - 1,
 221                            "Invalid data set index");
 222         GMX_RELEASE_ASSERT(columnCount >= 0, "Invalid column count");
 223         dataSetColumns_[dataSet + 1] = columnCount;
 224     }
 225
 226     /*! \brief
 227      * Initializes the storage to support specified parallelism.
 228      *
 229      * \throws std::bad_alloc if out of memory.
 230      */
 231     void init(const AnalysisDataParallelOptions& opt)
 232     {
 233         GMX_RELEASE_ASSERT(!isInitialized(), "init() called multiple times");
 234         std::partial_sum(dataSetColumns_.begin(), dataSetColumns_.end(), dataSetColumns_.begin());
 235         values_.resize(opt.parallelizationFactor());
 236         typename std::vector<ValueArray>::iterator i;
 237         for (i = values_.begin(); i != values_.end(); ++i)
 238         {
 239             i->resize(dataSetColumns_.back());
 240         }
 241     }
 242
 243     //! Returns a handle to access data for a frame.
 244     FrameHandle frameData(int frameIndex)
 245     {
 246         GMX_ASSERT(frameIndex >= 0, "Invalid frame index");
 247         GMX_ASSERT(isInitialized(), "Cannot access data before init()");
 248         return FrameHandle(&dataSetColumns_, &values_[frameIndex % values_.size()]);
 249     }
 250     //! Returns a handle to access a single data set within a frame.
 251     DataSetHandle frameDataSet(int frameIndex, int dataSet)
 252     {
 253         return frameData(frameIndex).dataSet(dataSet);
 254     }
 255
 256 private:
 257     /*! \brief
 258      * Index to find data sets within a per-frame array in `values_`.
 259      *
 260      * The first entry is always zero, followed by one entry for each data
 261      * set.  Before init(), the data set entries hold the numbers set with
 262      * setColumnCount().  After init(), the data set entries hold the
 263      * indices of the first column for that data set in the per-frame
 264      * arrays in `values_`.
 265      */
 266     std::vector<int> dataSetColumns_;
 267     /*! \brief
 268      * Data array for each frame.
 269      *
 270      * This is a ring buffer whose size is specified by the desired
 271      * parallelism level.  For each frame, there is a single array of
 272      * values, where the individual data sets are indexed with
 273      * `dataSetColumns_`.
 274      */
 275     std::vector<ValueArray> values_;
 276 };
 277
 278 //! \}
 279
 280 } // namespace gmx
 281
 282 #endif