core/accumulators/TimeSeries.hpp

Go to the documentation of this file.

/*
 * Copyright (C) 2010-2022 The ESPResSo project
 *
 * This file is part of ESPResSo.
 *
 * ESPResSo is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * ESPResSo is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
#pragma once
 
#include "AccumulatorBase.hpp"
#include "observables/Observable.hpp"
 
#include <cstddef>
#include <memory>
#include <string>
#include <utility>
#include <vector>
 
namespace Accumulators {
 
/**
 * @brief Record values of an observable.
 *
 * This is a very simple accumulator that stores
 * the current value of an observable every time
 * it is updated.
 *
 */
class TimeSeries : public AccumulatorBase {
public:
  TimeSeries(::System::System const *system, int delta_N,
             std::shared_ptr<Observables::Observable> obs)
      : AccumulatorBase(system, delta_N), m_obs(std::move(obs)) {}
 
  void update(boost::mpi::communicator const &comm) override;
  std::string get_internal_state() const final;
  void set_internal_state(std::string const &) final;
 
  const std::vector<std::vector<double>> &time_series() const { return m_data; }
  std::vector<std::size_t> shape() const override {
    std::vector<std::size_t> shape{m_data.size()};
    auto obs_shape = m_obs->shape();
    shape.insert(shape.end(), obs_shape.begin(), obs_shape.end());
    return shape;
  }
  void clear() { m_data.clear(); }
 
private:
  std::shared_ptr<Observables::Observable> m_obs;
  std::vector<std::vector<double>> m_data;
};
 
} // namespace Accumulators