eprop_archiving_node_recurrent.h

Go to the documentation of this file.

/*
 *  eprop_archiving_node_recurrent.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_RECURRENT_H
#define EPROP_ARCHIVING_NODE_RECURRENT_H
 
// models
#include "eprop_archiving_node.h"
 
// nestkernel
#include "histentry.h"
#include "nest_time.h"
#include "nest_types.h"
#include "node.h"
 
namespace nest
{
 
template < bool hist_shift_required >
class EpropArchivingNodeRecurrent : public EpropArchivingNode< HistEntryEpropRecurrent >
{
 
public:
  EpropArchivingNodeRecurrent();
 
  EpropArchivingNodeRecurrent( const EpropArchivingNodeRecurrent& other );
 
  typedef double (
    EpropArchivingNodeRecurrent::*surrogate_gradient_function )( double, double, double, double, double );
 
  surrogate_gradient_function find_surrogate_gradient( const std::string& surrogate_gradient_function_name );
 
  double compute_piecewise_linear_surrogate_gradient( const double r,
    const double v_m,
    const double v_th,
    const double height,
    const double width );
 
  double compute_exponential_surrogate_gradient( const double r,
    const double v_m,
    const double v_th,
    const double height,
    const double width );
 
  double compute_fast_sigmoid_derivative_surrogate_gradient( const double r,
    const double v_m,
    const double v_th,
    const double height,
    const double width );
 
  double compute_arctan_derivative_surrogate_gradient( const double r,
    const double v_m,
    const double v_th,
    const double height,
    const double width );
 
  void append_new_eprop_history_entry( const long time_step );
 
  void write_surrogate_gradient_to_history( const long time_step, const double surrogate_gradient );
 
  void write_learning_signal_to_history( const long time_step, const double learning_signal );
 
  void write_firing_rate_reg_to_history( const long t_current_update, const double f_target, const double c_reg );
 
  void write_firing_rate_reg_to_history( const long time_step,
    const double z,
    const double f_target,
    const double kappa_reg,
    const double c_reg );
 
  double get_firing_rate_reg_history( const long time_step );
 
  double get_learning_signal_from_history( const long time_step );
 
  void erase_used_firing_rate_reg_history();
 
  void count_spike();
 
  void reset_spike_count();
 
  void get_status( Dictionary& d ) const override;
  void set_status( const Dictionary& d ) override;
 
  double firing_rate_reg_;
 
  double f_av_;
 
protected:
  long model_dependent_history_shift_() const override;
 
  surrogate_gradient_function compute_surrogate_gradient_ =
    &EpropArchivingNodeRecurrent::compute_piecewise_linear_surrogate_gradient;
 
private:
  size_t n_spikes_;
 
  std::vector< HistEntryEpropFiringRateReg > firing_rate_reg_history_;
 
  static std::map< std::string, surrogate_gradient_function > surrogate_gradient_funcs_;
};
 
template < bool hist_shift_required >
inline void
EpropArchivingNodeRecurrent< hist_shift_required >::get_status( Dictionary& d ) const
{
  FlushEventMechanism::get_status( d );
  IgnoreAndSpikeMechanism::get_status( d );
 
  if constexpr ( not hist_shift_required )
  {
    d[ names::eprop_isi_trace_cutoff ] = eprop_isi_trace_cutoff_;
  }
}
 
template < bool hist_shift_required >
inline void
EpropArchivingNodeRecurrent< hist_shift_required >::set_status( const Dictionary& d )
{
  FlushEventMechanism::set_status( d, this, hist_shift_required );
  IgnoreAndSpikeMechanism::set_status( d, this );
 
  if constexpr ( not hist_shift_required )
  {
    double eprop_isi_trace_cutoff_tmp = eprop_isi_trace_cutoff_;
 
    update_value_param( d, names::eprop_isi_trace_cutoff, eprop_isi_trace_cutoff_tmp, this );
 
    if ( eprop_isi_trace_cutoff_tmp < 0.0 )
    {
      throw BadProperty( "eprop_isi_trace_cutoff ≥ 0 required." );
    }
 
    eprop_isi_trace_cutoff_ = eprop_isi_trace_cutoff_tmp;
  }
}
 
template < bool hist_shift_required >
inline void
EpropArchivingNodeRecurrent< hist_shift_required >::count_spike()
{
  ++n_spikes_;
}
 
template < bool hist_shift_required >
inline void
EpropArchivingNodeRecurrent< hist_shift_required >::reset_spike_count()
{
  n_spikes_ = 0;
}
 
template < bool hist_shift_required >
long
EpropArchivingNodeRecurrent< hist_shift_required >::model_dependent_history_shift_() const
{
  if constexpr ( hist_shift_required )
  {
    return get_shift();
  }
  else
  {
    return -delay_rec_out_;
  }
}
 
}
 
#endif