Updater.h

Go to the documentation of this file.

// n2p2 - A neural network potential package
// Copyright (C) 2018 Andreas Singraber (University of Vienna)
//
// This program 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.
//
// This program 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 <https://www.gnu.org/licenses/>.
 
#ifndef UPDATER_H
#define UPDATER_H
 
#include "Stopwatch.h"
 
#include <cstddef> // std::size_t
#include <map>     // std::map
#include <string>  // std::string
#include <vector>  // std::vector
 
namespace nnp
{
 
class Updater
{
public:
    virtual void                     setState(double* state) = 0;
    virtual void                     setError(
                                             double const* const error,
                                             std::size_t const   size = 1) = 0;
    virtual void                     setJacobian(
                                          double const* const jacobian,
                                          std::size_t const   columns = 1) = 0;
    virtual void                     update() = 0;
    virtual std::string              status(std::size_t epoch) const = 0;
    virtual std::vector<std::string> statusHeader() const = 0;
    virtual std::vector<std::string> info() const = 0;
    virtual void                     setupTiming(
                                            std::string const& prefix = "upd");
    virtual void                     resetTimingLoop();
    virtual
    std::map<std::string, Stopwatch> getTiming() const;
 
protected:
    Updater(std::size_t const sizeState);
 
    bool                             timing;
    bool                             timingReset;
    std::size_t                      sizeState;
    std::string                      prefix;
    std::map<std::string, Stopwatch> sw;
};
 
}
 
#endif