src/gromacs/analysisdata/arraydata.cpp

   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 /*! \internal \file
  36  * \brief
  37  * Implements classes in arraydata.h.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \ingroup module_analysisdata
  41  */
  42 #include "gromacs/analysisdata/arraydata.h"
  43
  44 #include <algorithm>
  45
  46 #include "gromacs/analysisdata/dataframe.h"
  47 #include "gromacs/analysisdata/datamodulemanager.h"
  48 #include "gromacs/utility/exceptions.h"
  49 #include "gromacs/utility/gmxassert.h"
  50
  51 namespace gmx
  52 {
  53
  54 AbstractAnalysisArrayData::AbstractAnalysisArrayData()
  55     : rowCount_(0), pointSetInfo_(0, 0, 0, 0), xstart_(0.0), xstep_(1.0),
  56       bReady_(false)
  57 {
  58 }
  59
  60 AbstractAnalysisArrayData::~AbstractAnalysisArrayData()
  61 {
  62 }
  63
  64
  65 AnalysisDataFrameRef
  66 AbstractAnalysisArrayData::tryGetDataFrameInternal(int index) const
  67 {
  68     if (!isAllocated())
  69     {
  70         return AnalysisDataFrameRef();
  71     }
  72     std::vector<AnalysisDataValue>::const_iterator begin
  73         = value_.begin() + index * columnCount();
  74     return AnalysisDataFrameRef(
  75             AnalysisDataFrameHeader(index, xvalue(index), 0.0),
  76             AnalysisDataValuesRef(begin, begin + columnCount()),
  77             AnalysisDataPointSetInfosRef(&pointSetInfo_, 1));
  78 }
  79
  80
  81 bool
  82 AbstractAnalysisArrayData::requestStorageInternal(int /*nframes*/)
  83 {
  84     return true;
  85 }
  86
  87
  88 void
  89 AbstractAnalysisArrayData::setColumnCount(int ncols)
  90 {
  91     GMX_RELEASE_ASSERT(!isAllocated(),
  92                        "Cannot change column count after data has been allocated");
  93     AbstractAnalysisData::setColumnCount(0, ncols);
  94     pointSetInfo_ = AnalysisDataPointSetInfo(0, ncols, 0, 0);
  95 }
  96
  97
  98 void
  99 AbstractAnalysisArrayData::setRowCount(int rowCount)
 100 {
 101     GMX_RELEASE_ASSERT(rowCount > 0, "Invalid number of rows");
 102     GMX_RELEASE_ASSERT(!isAllocated(),
 103                        "Cannot change row count after data has been allocated");
 104     rowCount_ = rowCount;
 105 }
 106
 107
 108 void
 109 AbstractAnalysisArrayData::allocateValues()
 110 {
 111     GMX_RELEASE_ASSERT(!isAllocated(), "Can only allocate values once");
 112     GMX_RELEASE_ASSERT(rowCount() > 0 && columnCount() > 0,
 113                        "Row and column counts must be set before allocating values");
 114     value_.resize(rowCount() * columnCount());
 115     std::vector<AnalysisDataValue>::iterator i;
 116     for (i = value_.begin(); i != value_.end(); ++i)
 117     {
 118         i->setValue(0.0);
 119     }
 120 }
 121
 122
 123 void
 124 AbstractAnalysisArrayData::setXAxis(real start, real step)
 125 {
 126     GMX_RELEASE_ASSERT(!bReady_, "X axis cannot be set after data is finished");
 127     xstart_ = start;
 128     xstep_  = step;
 129 }
 130
 131
 132 void
 133 AbstractAnalysisArrayData::valuesReady()
 134 {
 135     GMX_RELEASE_ASSERT(isAllocated(), "There must be some data");
 136     if (bReady_)
 137     {
 138         return;
 139     }
 140     bReady_ = true;
 141
 142     std::vector<AnalysisDataValue>::const_iterator valueIter = value_.begin();
 143     AnalysisDataModuleManager                     &modules   = moduleManager();
 144     modules.notifyDataStart(this);
 145     for (int i = 0; i < rowCount(); ++i, valueIter += columnCount())
 146     {
 147         AnalysisDataFrameHeader header(i, xvalue(i), 0);
 148         modules.notifyFrameStart(header);
 149         modules.notifyPointsAdd(
 150                 AnalysisDataPointSetRef(
 151                         header, pointSetInfo_,
 152                         AnalysisDataValuesRef(valueIter,
 153                                               valueIter + columnCount())));
 154         modules.notifyFrameFinish(header);
 155     }
 156     modules.notifyDataFinish();
 157 }
 158
 159
 160 void
 161 AbstractAnalysisArrayData::copyContents(const AbstractAnalysisArrayData *src,
 162                                         AbstractAnalysisArrayData       *dest)
 163 {
 164     GMX_RELEASE_ASSERT(src->isAllocated(), "Source data must not be empty");
 165     GMX_RELEASE_ASSERT(!dest->isAllocated(),
 166                        "Destination data must not be allocated");
 167     dest->setColumnCount(src->columnCount());
 168     dest->setRowCount(src->rowCount());
 169     dest->allocateValues();
 170     dest->setXAxis(src->xstart(), src->xstep());
 171     std::copy(src->value_.begin(), src->value_.end(), dest->value_.begin());
 172 }
 173
 174 } // namespace gmx