archiving_node.h

Go to the documentation of this file.

/*
 *  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 ARCHIVING_NODE_H
#define ARCHIVING_NODE_H
 
// C++ includes:
#include <algorithm>
#include <deque>
 
// Includes from nestkernel:
#include "histentry.h"
#include "ignore_and_spike_mechanism.h"
#include "nest_time.h"
#include "nest_types.h"
#include "node.h"
#include "structural_plasticity_node.h"
 
 
#define DEBUG_ARCHIVER 1
 
namespace nest
{
 
class ArchivingNode : public StructuralPlasticityNode, public IgnoreAndSpikeMechanism
{
public:
  ArchivingNode();
 
  ArchivingNode( const ArchivingNode& );
 
  double get_K_value( double t ) override;
 
  void get_K_values( double t, double& Kminus, double& nearest_neighbor_Kminus, double& Kminus_triplet ) override;
 
  double get_K_triplet_value( const std::deque< histentry >::iterator& iter );
 
  void get_history( double t1,
    double t2,
    std::deque< histentry >::iterator* start,
    std::deque< histentry >::iterator* finish ) override;
 
  void register_stdp_connection( double t_first_read, double delay ) override;
 
  void get_status( Dictionary& d ) const override;
  void set_status( const Dictionary& d ) override;
 
protected:
  void set_spiketime( Time const& t_sp, double offset = 0.0 );
 
  inline double get_spiketime_ms() const;
 
  void clear_history();
 
  size_t n_incoming_;
 
private:
  // sum exp(-(t-ti)/tau_minus)
  double Kminus_;
 
  // sum exp(-(t-ti)/tau_minus_triplet)
  double Kminus_triplet_;
 
  double tau_minus_;
  double tau_minus_inv_;
 
  // time constant for triplet low pass filtering of "post" spike train
  double tau_minus_triplet_;
  double tau_minus_triplet_inv_;
 
  double max_delay_;
  double trace_;
 
  double last_spike_;
 
  // spiking history needed by stdp synapses
  std::deque< histentry > history_;
};
 
inline double
ArchivingNode::get_spiketime_ms() const
{
  return last_spike_;
}
 
}  // of namespace
#endif