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, by the GROMACS development team, led by
   5  * David van der Spoel, Berk Hess, Erik Lindahl, and including many
   6  * others, as listed in the AUTHORS file in the top-level source
   7  * 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 "../utility/gmxassert.h"
  49
  50 #include "abstractdata.h"
  51 #include "dataframe.h"
  52
  53 namespace gmx
  54 {
  55
  56 /*! \brief
  57  * Abstract base class for data objects that present in-memory data.
  58  *
  59  * This class implements a subclass of AbstractAnalysisData that presents an
  60  * in-memory array through the AbstractAnalysisData interface.  Subclasses
  61  * should initialize the in-memory array through the provided protected member
  62  * functions.  This class provides public accessor methods for read access to
  63  * the data.
  64  *
  65  * Public accessor methods in this class do not throw, but assert if data is
  66  * accessed before it is available.
  67  *
  68  * \todo
  69  * Add support for multiple data sets.
  70  *
  71  * \inlibraryapi
  72  * \ingroup module_analysisdata
  73  */
  74 class AbstractAnalysisArrayData : public AbstractAnalysisData
  75 {
  76     public:
  77         virtual ~AbstractAnalysisArrayData();
  78
  79         virtual int frameCount() const
  80         {
  81             return bReady_ ? rowCount_ : 0;
  82         }
  83
  84         /*! \brief
  85          * Returns the number of rows in the data array.
  86          *
  87          * This function is identical to frameCount(), except that frameCount()
  88          * returns 0 before valuesReady() has been called.
  89          */
  90         int rowCount() const { return rowCount_; }
  91         //! Returns true if values have been allocated.
  92         bool isAllocated() const { return !value_.empty(); }
  93         //! Returns the x value of the first frame.
  94         real xstart() const { return xstart_; }
  95         //! Returns the step between frame x values.
  96         real xstep() const { return xstep_; }
  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 xstart() + row * xstep();
 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          *
 158          * Does not throw.
 159          */
 160         void setXAxis(real start, real step);
 161         //! Returns a reference to a given array element.
 162         AnalysisDataValue &value(int row, int col)
 163         {
 164             GMX_ASSERT(row >= 0 && row < rowCount(), "Row index out of range");
 165             GMX_ASSERT(col >= 0 && col < columnCount(), "Column index out of range");
 166             GMX_ASSERT(isAllocated(), "Data array not allocated");
 167             return value_[row * columnCount() + col];
 168         }
 169         /*! \brief
 170          * Notifies modules of the data.
 171          *
 172          * \throws    unspecified Any exception thrown by attached data modules
 173          *      in data notification methods.
 174          *
 175          * This function should be called once the values in the array
 176          * have been initialized.  The values should not be changed after this
 177          * function has been called.
 178          */
 179         void valuesReady();
 180
 181         /*! \brief
 182          * Copies the contents into a new object.
 183          *
 184          * \param[in]     src  Object to copy data from.
 185          * \param[in,out] dest Empty array data object to copy data to.
 186          * \throws std::bad_alloc if memory allocation for \p dest fails.
 187          *
 188          * \p dest should not have previous contents.
 189          */
 190         static void copyContents(const AbstractAnalysisArrayData *src,
 191                                  AbstractAnalysisArrayData       *dest);
 192
 193     private:
 194         virtual AnalysisDataFrameRef tryGetDataFrameInternal(int index) const;
 195         virtual bool requestStorageInternal(int nframes);
 196
 197         int                            rowCount_;
 198         AnalysisDataPointSetInfo       pointSetInfo_;
 199         std::vector<AnalysisDataValue> value_;
 200         real                           xstart_;
 201         real                           xstep_;
 202         bool                           bReady_;
 203
 204         // Copy and assign disallowed by base.
 205 };
 206
 207 /*! \brief
 208  * Simple in-memory data array.
 209  *
 210  * This class is a simple alternative to AnalysisData for in-memory data arrays
 211  * that are constructed in-place.
 212  *
 213  * Public accessor methods in this class do not throw, but assert if data is
 214  * accessed before it is available.
 215  *
 216  * \if libapi
 217  * This class exposes the protected functions of AbstractAnalysisArrayData for
 218  * users.
 219  * \endif
 220  *
 221  * \inpublicapi
 222  * \ingroup module_analysisdata
 223  */
 224 class AnalysisArrayData : public AbstractAnalysisArrayData
 225 {
 226     public:
 227         /*! \brief
 228          * Initializes an empty array data object.
 229          *
 230          * \throws std::bad_alloc if out of memory.
 231          */
 232         AnalysisArrayData() {}
 233
 234         // TODO: These statements cause Doxygen to generate confusing
 235         // documentation.
 236         using AbstractAnalysisArrayData::setColumnCount;
 237         using AbstractAnalysisArrayData::setRowCount;
 238         using AbstractAnalysisArrayData::allocateValues;
 239         using AbstractAnalysisArrayData::setXAxis;
 240         using AbstractAnalysisArrayData::value;
 241         using AbstractAnalysisArrayData::valuesReady;
 242
 243         // Copy and assign disallowed by base.
 244 };
 245
 246 } // namespace gmx
 247
 248 #endif