src/gromacs/analysisdata/arraydata.cpp

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