clopath_archiving_node.h

Go to the documentation of this file.

/*
 *  clopath_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 CLOPATH_ARCHIVING_NODE_H
#define CLOPATH_ARCHIVING_NODE_H
 
// C++ includes:
#include <deque>
 
// Includes from nestkernel:
#include "archiving_node.h"
#include "histentry.h"
#include "nest_time.h"
#include "nest_types.h"
#include "synaptic_element.h"
 
 
namespace nest
{
 
class ClopathArchivingNode : public ArchivingNode
{
 
public:
  ClopathArchivingNode();
 
  ClopathArchivingNode( const ClopathArchivingNode& );
 
  double get_LTD_value( double t ) override;
 
  void get_LTP_history( double t1,
    double t2,
    std::deque< histentry_extended >::iterator* start,
    std::deque< histentry_extended >::iterator* finish ) override;
 
  double get_theta_plus() const;
 
  double get_theta_minus() const;
 
protected:
  void write_LTD_history( const double t_ltd_ms, double u_bar_minus, double u_bar_bar );
 
  void write_LTP_history( const double t_ltp_ms, double u, double u_bar_plus );
 
  void write_clopath_history( Time const& t_sp, double u, double u_bar_plus, double u_bar_minus, double u_bar_bar );
 
  void init_clopath_buffers();
  void get_status( Dictionary& d ) const override;
  void set_status( const Dictionary& d ) override;
 
private:
  std::vector< histentry_extended > ltd_history_;
  std::deque< histentry_extended > ltp_history_;
 
  double A_LTD_;
 
  double A_LTP_;
 
  double u_ref_squared_;
 
  double theta_plus_;
 
  double theta_minus_;
 
  bool A_LTD_const_;
 
  double delay_u_bars_;
  size_t delay_u_bars_steps_;
  std::vector< double > delayed_u_bar_plus_;
  std::vector< double > delayed_u_bar_minus_;
  size_t delayed_u_bars_idx_;
 
  size_t ltd_hist_len_;
 
  size_t ltd_hist_current_;
};
 
inline double
ClopathArchivingNode::get_theta_plus() const
{
  return theta_plus_;
}
 
inline double
ClopathArchivingNode::get_theta_minus() const
{
  return theta_minus_;
}
 
}  // of namespace
#endif