src/gromacs/analysisdata/arraydata.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2010,2011,2012,2013,2014,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 /*! \file
  36  * \brief
  37  * Declares gmx::AbstractAnalysisArrayData and gmx::AnalysisArrayData.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \inpublicapi
  41  * \ingroup module_analysisdata
  42  */
  43 #ifndef GMX_ANALYSISDATA_ARRAYDATA_H
  44 #define GMX_ANALYSISDATA_ARRAYDATA_H
  45
  46 #include <vector>
  47
  48 #include "gromacs/analysisdata/abstractdata.h"
  49 #include "gromacs/analysisdata/dataframe.h"
  50 #include "gromacs/utility/gmxassert.h"
  51
  52 namespace gmx
  53 {
  54
  55 /*! \brief
  56  * Abstract base class for data objects that present in-memory data.
  57  *
  58  * This class implements a subclass of AbstractAnalysisData that presents an
  59  * in-memory array through the AbstractAnalysisData interface.  Subclasses
  60  * should initialize the in-memory array through the provided protected member
  61  * functions.  This class provides public accessor methods for read access to
  62  * the data.
  63  *
  64  * Public accessor methods in this class do not throw, but assert if data is
  65  * accessed before it is available.
  66  *
  67  * \todo
  68  * Add support for multiple data sets.
  69  *
  70  * \inlibraryapi
  71  * \ingroup module_analysisdata
  72  */
  73 class AbstractAnalysisArrayData : public AbstractAnalysisData
  74 {
  75 public:
  76     ~AbstractAnalysisArrayData() override;
  77
  78     int frameCount() const override { return bReady_ ? rowCount_ : 0; }
  79
  80     /*! \brief
  81      * Returns the number of rows in the data array.
  82      *
  83      * This function is identical to frameCount(), except that frameCount()
  84      * returns 0 before valuesReady() has been called.
  85      */
  86     int rowCount() const { return rowCount_; }
  87     //! Returns true if values have been allocated.
  88     bool isAllocated() const { return !value_.empty(); }
  89     //! Returns the x value of the first frame.
  90     real xstart() const { return xvalue_[0]; }
  91     //! Returns the step between frame x values.
  92     real xstep() const
  93     {
  94         GMX_ASSERT(bUniformX_, "Accessing x step for non-uniform data");
  95         return xstep_;
  96     }
  97     //! Returns the x value of a row.
  98     real xvalue(int row) const
  99     {
 100         GMX_ASSERT(row >= 0 && row < rowCount(), "Row index out of range");
 101         return xvalue_[row];
 102     }
 103     //! Returns a given array element.
 104     const AnalysisDataValue& value(int row, int col) const
 105     {
 106         GMX_ASSERT(row >= 0 && row < rowCount(), "Row index out of range");
 107         GMX_ASSERT(col >= 0 && col < columnCount(), "Column index out of range");
 108         GMX_ASSERT(isAllocated(), "Data array not allocated");
 109         return value_[row * columnCount() + col];
 110     }
 111
 112 protected:
 113     /*! \brief
 114      * Initializes an empty array data object.
 115      *
 116      * \throws std::bad_alloc if out of memory.
 117      */
 118     AbstractAnalysisArrayData();
 119
 120     /*! \brief
 121      * Sets the number of columns in the data array.
 122      *
 123      * \param[in] ncols  Number of columns in the data.
 124      *
 125      * Cannot be called after allocateValues().
 126      *
 127      * See AbstractAnalysisData::setColumnCount() for exception behavior.
 128      */
 129     void setColumnCount(int ncols);
 130     /*! \brief
 131      * Sets the number of rows in the data array.
 132      *
 133      * \param[in] rowCount  Number of rows in the data.
 134      *
 135      * Cannot be called after allocateValues().
 136      *
 137      * Does not throw.
 138      */
 139     void setRowCount(int rowCount);
 140     /*! \brief
 141      * Allocates memory for the values.
 142      *
 143      * \throws std::bad_alloc if memory allocation fails.
 144      *
 145      * setColumnCount() and setRowCount() must have been called.
 146      *
 147      * Strong exception safety guarantee.
 148      */
 149     void allocateValues();
 150     /*! \brief
 151      * Sets the values reported as x values for frames.
 152      *
 153      * \param[in] start  x value for the first frame.
 154      * \param[in] step   Step between x values of successive frames.
 155      *
 156      * Must not be called after valuesReady().
 157      * Any values set with setXAxisValue() are overwritten.
 158      *
 159      * Does not throw.
 160      */
 161     void setXAxis(real start, real step);
 162     /*! \brief
 163      * Sets a single value reported as x value for frames.
 164      *
 165      * \param[in] row    Row/frame for which to set the value.
 166      * \param[in] value  x value for the frame specified by \p row.
 167      *
 168      * Must not be called after valuesReady().
 169      *
 170      * Does not throw.
 171      */
 172     void setXAxisValue(int row, real value);
 173     //! Returns a reference to a given array element.
 174     AnalysisDataValue& value(int row, int col)
 175     {
 176         GMX_ASSERT(row >= 0 && row < rowCount(), "Row index out of range");
 177         GMX_ASSERT(col >= 0 && col < columnCount(), "Column index out of range");
 178         GMX_ASSERT(isAllocated(), "Data array not allocated");
 179         return value_[row * columnCount() + col];
 180     }
 181     /*! \brief
 182      * Notifies modules of the data.
 183      *
 184      * \throws    unspecified Any exception thrown by attached data modules
 185      *      in data notification methods.
 186      *
 187      * This function should be called once the values in the array
 188      * have been initialized.  The values should not be changed after this
 189      * function has been called.
 190      */
 191     void valuesReady();
 192
 193     /*! \brief
 194      * Copies the contents into a new object.
 195      *
 196      * \param[in]     src  Object to copy data from.
 197      * \param[in,out] dest Empty array data object to copy data to.
 198      * \throws std::bad_alloc if memory allocation for \p dest fails.
 199      *
 200      * \p dest should not have previous contents.
 201      */
 202     static void copyContents(const AbstractAnalysisArrayData* src, AbstractAnalysisArrayData* dest);
 203
 204 private:
 205     AnalysisDataFrameRef tryGetDataFrameInternal(int index) const override;
 206     bool                 requestStorageInternal(int nframes) override;
 207
 208     int                            rowCount_;
 209     AnalysisDataPointSetInfo       pointSetInfo_;
 210     std::vector<AnalysisDataValue> value_;
 211     std::vector<real>              xvalue_;
 212     real                           xstep_;
 213     bool                           bUniformX_;
 214     bool                           bReady_;
 215
 216     // Copy and assign disallowed by base.
 217 };
 218
 219 /*! \brief
 220  * Simple in-memory data array.
 221  *
 222  * This class is a simple alternative to AnalysisData for in-memory data arrays
 223  * that are constructed in-place.
 224  *
 225  * Public accessor methods in this class do not throw, but assert if data is
 226  * accessed before it is available.
 227  *
 228  * \if libapi
 229  * This class exposes the protected functions of AbstractAnalysisArrayData for
 230  * users.
 231  * \endif
 232  *
 233  * \inpublicapi
 234  * \ingroup module_analysisdata
 235  */
 236 class AnalysisArrayData : public AbstractAnalysisArrayData
 237 {
 238 public:
 239     /*! \brief
 240      * Initializes an empty array data object.
 241      *
 242      * \throws std::bad_alloc if out of memory.
 243      */
 244     AnalysisArrayData() {}
 245
 246     // TODO: These statements cause Doxygen to generate confusing
 247     // documentation.
 248     using AbstractAnalysisArrayData::allocateValues;
 249     using AbstractAnalysisArrayData::setColumnCount;
 250     using AbstractAnalysisArrayData::setRowCount;
 251     using AbstractAnalysisArrayData::setXAxis;
 252     using AbstractAnalysisArrayData::setXAxisValue;
 253     using AbstractAnalysisArrayData::value;
 254     using AbstractAnalysisArrayData::valuesReady;
 255
 256     // Copy and assign disallowed by base.
 257 };
 258
 259 } // namespace gmx
 260
 261 #endif