eprop_archiving_node.h

Go to the documentation of this file.

/*
 *  eprop_archiving_node.h
 *
 *  This file is part of NEST.
 *
 *  Copyright (C) 2004 The NEST Initiative
 *
 *  NEST 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 2 of the License, or
 *  (at your option) any later version.
 *
 *  NEST 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 NEST.  If not, see <http://www.gnu.org/licenses/>.
 *
 */
 
#ifndef EPROP_ARCHIVING_NODE_H
#define EPROP_ARCHIVING_NODE_H
 
// nestkernel
#include "flush_event_mechanism.h"
#include "histentry.h"
#include "ignore_and_spike_mechanism.h"
#include "nest_time.h"
#include "nest_types.h"
#include "node.h"
 
namespace nest
{
template < typename HistEntryT >
class EpropArchivingNode : public Node, public FlushEventMechanism, public IgnoreAndSpikeMechanism
{
public:
  EpropArchivingNode();
 
  EpropArchivingNode( const EpropArchivingNode& n );
 
  void register_eprop_connection() override;
  void initialize_update_history() override;
 
  void write_update_to_history( const long t_previous_update,
    const long t_current_update,
    const bool is_flush_event,
    const bool previous_was_flush_event ) override;
 
  void require_eprop_history_entry( const typename std::vector< HistEntryT >::iterator eprop_hist_it,
    const long time_step ) const;
 
  std::vector< HistEntryEpropUpdate >::iterator get_update_history( const long time_step );
 
  typename std::vector< HistEntryT >::iterator get_eprop_history( const long time_step );
 
  void erase_used_eprop_history() override;
 
  void erase_used_eprop_history( const long t_spike, const long t_spike_previous ) override;
 
  double get_eprop_history_duration() const;
 
  long
  get_eprop_isi_trace_cutoff() const
  {
    return Time( Time::ms( eprop_isi_trace_cutoff_ ) ).get_steps();
  }
 
protected:
  virtual long model_dependent_history_shift_() const = 0;
 
  size_t eprop_indegree_;
 
  double eprop_isi_trace_cutoff_;
 
  std::vector< HistEntryEpropUpdate > update_history_;
 
  std::vector< HistEntryT > eprop_history_;
 
  // The following shifts are, for now, hardcoded to 1 time step since the current
  // implementation only works if all the delays are equal to the simulation resolution.
 
  const long offset_gen_ = 1;
 
  const long delay_in_rec_ = 1;
 
  const long delay_rec_out_ = 1;
 
  const long delay_out_norm_ = 1;
 
  const long delay_out_rec_ = 1;
};
 
}  // namespace nest
 
#endif  // EPROP_ARCHIVING_NODE_H