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