sp_manager.h

Go to the documentation of this file.

/*
 *  sp_manager.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 SP_MANAGER_H
#define SP_MANAGER_H
 
// C++ includes:
#include <vector>
 
// Includes from libnestutil:
#include "manager_interface.h"
 
// Includes from nestkernel:
#include "growth_curve_factory.h"
#include "nest_time.h"
#include "nest_types.h"
#include "node_collection.h"
 
 
namespace nest
{
class Node;
 
class SPBuilder;
 
class SPManager : public ManagerInterface
{
 
public:
  SPManager();
  ~SPManager() override;
 
  void initialize( const bool ) override;
  void finalize( const bool ) override;
 
  void get_status( Dictionary& ) override;
 
  void set_status( const Dictionary& ) override;
 
  GrowthCurve* new_growth_curve( std::string name );
 
  template < typename GrowthCurve >
  void register_growth_curve( const std::string& name );
 
  void disconnect( NodeCollectionPTR sources,
    NodeCollectionPTR targets,
    const Dictionary& conn_spec,
    const std::vector< Dictionary >& syn_specs );
 
  void disconnect( const size_t snode_id, Node* target, size_t target_thread, const size_t syn_id );
 
  void update_structural_plasticity();
  void update_structural_plasticity( SPBuilder* );
 
  void enable_structural_plasticity();
 
  void disable_structural_plasticity();
 
  bool is_structural_plasticity_enabled() const;
 
  double get_structural_plasticity_update_interval() const;
 
  long builder_min_delay() const;
 
  long builder_max_delay() const;
 
  // Creation of synapses
  bool create_synapses( std::vector< size_t >& pre_vacant_id,
    std::vector< int >& pre_vacant_n,
    std::vector< size_t >& post_vacant_id,
    std::vector< int >& post_vacant_n,
    SPBuilder* sp_conn_builder );
  // Deletion of synapses on the pre synaptic side
  void delete_synapses_from_pre( const std::vector< size_t >& pre_deleted_id,
    std::vector< int >& pre_deleted_n,
    const size_t synapse_model,
    const std::string& se_pre_name,
    const std::string& se_post_name );
  // Deletion of synapses on the postsynaptic side
  void delete_synapses_from_post( std::vector< size_t >& post_deleted_id,
    std::vector< int >& post_deleted_n,
    size_t synapse_model,
    std::string se_pre_name,
    std::string se_post_name );
  // Deletion of synapses
  void delete_synapse( size_t source, size_t target, long syn_id, std::string se_pre_name, std::string se_post_name );
 
  void get_synaptic_elements( std::string se_name,
    std::vector< size_t >& se_vacant_id,
    std::vector< int >& se_vacant_n,
    std::vector< size_t >& se_deleted_id,
    std::vector< int >& se_deleted_n );
 
  void serialize_id( std::vector< size_t >& id, std::vector< int >& n, std::vector< size_t >& res );
 
private:
  double structural_plasticity_update_interval_;
 
  bool structural_plasticity_enabled_;
  std::vector< SPBuilder* > sp_conn_builders_;
 
  std::vector< GenericGrowthCurveFactory* > growthcurve_factories_;
 
  Dictionary growthcurvedict_;  
};
 
inline GrowthCurve*
SPManager::new_growth_curve( std::string name )
{
  const long nc_id = growthcurvedict_.get< long >( name );
  return growthcurve_factories_.at( nc_id )->create();
}
 
inline bool
SPManager::is_structural_plasticity_enabled() const
{
  return structural_plasticity_enabled_;
}
 
inline double
SPManager::get_structural_plasticity_update_interval() const
{
  return structural_plasticity_update_interval_;
}
 
}  // namespace nest
 
#endif /* #ifndef SP_MANAGER_H */