SLI Interface functions of the NEST kernel.

This group contains the functions that form the SLI interface of the NEST kernel. More...

Classes
class	nest::NestModule::ChangeSubnet_iFunction
class	nest::NestModule::CurrentSubnetFunction
class	nest::NestModule::GetNodes_i_D_b_bFunction
class	nest::NestModule::GetLeaves_i_D_bFunction
class	nest::NestModule::GetChildren_i_D_bFunction
class	nest::NestModule::GetStatus_iFunction
class	nest::NestModule::GetStatus_CFunction
class	nest::NestModule::GetStatus_aFunction
class	nest::NestModule::SetStatus_idFunction
class	nest::NestModule::SetStatus_CDFunction
class	nest::NestModule::Cva_CFunction
class	nest::NestModule::SetStatus_aaFunction
class	nest::NestModule::SetDefaults_l_DFunction
class	nest::NestModule::GetDefaults_lFunction
class	nest::NestModule::CopyModel_l_l_DFunction
class	nest::NestModule::GetConnections_DFunction
class	nest::NestModule::SimulateFunction
class	nest::NestModule::ResumeSimulationFunction
class	nest::NestModule::Create_l_iFunction
class	nest::NestModule::RestoreNodes_aFunction
class	nest::NestModule::DataConnect_i_D_sFunction
class	nest::NestModule::DataConnect_aFunction
class	nest::NestModule::Connect_i_i_lFunction
class	nest::NestModule::Connect_i_i_d_d_lFunction
class	nest::NestModule::Connect_i_i_D_lFunction
class	nest::NestModule::Connect_g_g_D_DFunction
class	nest::NestModule::DivergentConnect_i_ia_a_a_lFunction
class	nest::NestModule::RDivergentConnect_i_i_ia_da_da_b_b_lFunction
class	nest::NestModule::ConvergentConnect_ia_i_a_a_lFunction
class	nest::NestModule::RConvergentConnect_ia_i_i_da_da_b_b_lFunction
class	nest::NestModule::RConvergentConnect_ia_ia_ia_daa_daa_b_b_lFunction
class	nest::NestModule::ResetKernelFunction
class	nest::NestModule::ResetNetworkFunction
class	nest::NestModule::MemoryInfoFunction
class	nest::NestModule::PrintNetworkFunction
class	nest::NestModule::RankFunction
class	nest::NestModule::NumProcessesFunction
class	nest::NestModule::SetFakeNumProcessesFunction_i
class	nest::NestModule::SetNumRecProcessesFunction_i
class	nest::NestModule::SyncProcessesFunction
class	nest::NestModule::TimeCommunication_i_i_bFunction
class	nest::NestModule::TimeCommunicationv_i_iFunction
class	nest::NestModule::TimeCommunicationAlltoall_i_iFunction
class	nest::NestModule::TimeCommunicationAlltoallv_i_iFunction
class	nest::NestModule::ProcessorNameFunction
class	nest::NestModule::MPIAbort_iFunction
class	nest::NestModule::GetVpRngFunction
class	nest::NestModule::GetGlobalRngFunction
class	nest::NestModule::Cvdict_CFunction
class	nest::NestModule::Cvgidcollection_i_iFunction
class	nest::NestModule::Cvgidcollection_iaFunction
class	nest::NestModule::Cvgidcollection_ivFunction
class	nest::NestModule::Size_gFunction
class	nest::NestModule::SetAcceptableLatencyFunction
class	nest::NestModule::SetMaxBufferedFunction

Variables
nest::NestModule::ChangeSubnet_iFunction	nest::NestModule::changesubnet_ifunction
nest::NestModule::CurrentSubnetFunction	nest::NestModule::currentsubnetfunction
nest::NestModule::GetNodes_i_D_b_bFunction	nest::NestModule::getnodes_i_D_b_bfunction
nest::NestModule::GetLeaves_i_D_bFunction	nest::NestModule::getleaves_i_D_bfunction
nest::NestModule::GetChildren_i_D_bFunction	nest::NestModule::getchildren_i_D_bfunction
nest::NestModule::GetStatus_iFunction	nest::NestModule::getstatus_ifunction
nest::NestModule::GetStatus_CFunction	nest::NestModule::getstatus_Cfunction
nest::NestModule::GetStatus_aFunction	nest::NestModule::getstatus_afunction
nest::NestModule::SetStatus_idFunction	nest::NestModule::setstatus_idfunction
nest::NestModule::SetStatus_CDFunction	nest::NestModule::setstatus_CDfunction
nest::NestModule::Cva_CFunction	nest::NestModule::cva_cfunction
nest::NestModule::SetStatus_aaFunction	nest::NestModule::setstatus_aafunction
nest::NestModule::SetDefaults_l_DFunction	nest::NestModule::setdefaults_l_Dfunction
nest::NestModule::GetDefaults_lFunction	nest::NestModule::getdefaults_lfunction
nest::NestModule::CopyModel_l_l_DFunction	nest::NestModule::copymodel_l_l_Dfunction
nest::NestModule::GetConnections_DFunction	nest::NestModule::getconnections_Dfunction
nest::NestModule::SimulateFunction	nest::NestModule::simulatefunction
nest::NestModule::ResumeSimulationFunction	nest::NestModule::resumesimulationfunction
nest::NestModule::Create_l_iFunction	nest::NestModule::create_l_ifunction
nest::NestModule::RestoreNodes_aFunction	nest::NestModule::restorenodes_afunction
nest::NestModule::DataConnect_i_D_sFunction	nest::NestModule::dataconnect_i_D_sfunction
nest::NestModule::DataConnect_aFunction	nest::NestModule::dataconnect_afunction
nest::NestModule::Connect_i_i_lFunction	nest::NestModule::connect_i_i_lfunction
nest::NestModule::Connect_i_i_d_d_lFunction	nest::NestModule::connect_i_i_d_d_lfunction
nest::NestModule::Connect_i_i_D_lFunction	nest::NestModule::connect_i_i_D_lfunction
nest::NestModule::Connect_g_g_D_DFunction	nest::NestModule::connect_g_g_D_Dfunction
nest::NestModule::DivergentConnect_i_ia_a_a_lFunction	nest::NestModule::divergentconnect_i_ia_a_a_lfunction
nest::NestModule::RDivergentConnect_i_i_ia_da_da_b_b_lFunction	nest::NestModule::rdivergentconnect_i_i_ia_da_da_b_b_lfunction
nest::NestModule::ConvergentConnect_ia_i_a_a_lFunction	nest::NestModule::convergentconnect_ia_i_a_a_lfunction
nest::NestModule::RConvergentConnect_ia_i_i_da_da_b_b_lFunction	nest::NestModule::rconvergentconnect_ia_i_i_da_da_b_b_lfunction
nest::NestModule::RConvergentConnect_ia_ia_ia_daa_daa_b_b_lFunction	nest::NestModule::rconvergentconnect_ia_ia_ia_daa_daa_b_b_lfunction
nest::NestModule::ResetKernelFunction	nest::NestModule::resetkernelfunction
nest::NestModule::ResetNetworkFunction	nest::NestModule::resetnetworkfunction
nest::NestModule::MemoryInfoFunction	nest::NestModule::memoryinfofunction
nest::NestModule::PrintNetworkFunction	nest::NestModule::printnetworkfunction
nest::NestModule::RankFunction	nest::NestModule::rankfunction
nest::NestModule::NumProcessesFunction	nest::NestModule::numprocessesfunction
nest::NestModule::SetFakeNumProcessesFunction_i	nest::NestModule::setfakenumprocesses_ifunction
nest::NestModule::SetNumRecProcessesFunction_i	nest::NestModule::setnumrecprocesses_ifunction
nest::NestModule::SyncProcessesFunction	nest::NestModule::syncprocessesfunction
nest::NestModule::TimeCommunication_i_i_bFunction	nest::NestModule::timecommunication_i_i_bfunction
nest::NestModule::TimeCommunicationv_i_iFunction	nest::NestModule::timecommunicationv_i_ifunction
nest::NestModule::TimeCommunicationAlltoall_i_iFunction	nest::NestModule::timecommunicationalltoall_i_ifunction
nest::NestModule::TimeCommunicationAlltoallv_i_iFunction	nest::NestModule::timecommunicationalltoallv_i_ifunction
nest::NestModule::ProcessorNameFunction	nest::NestModule::processornamefunction
nest::NestModule::MPIAbort_iFunction	nest::NestModule::mpiabort_ifunction
nest::NestModule::GetVpRngFunction	nest::NestModule::getvprngfunction
nest::NestModule::GetGlobalRngFunction	nest::NestModule::getglobalrngfunction
nest::NestModule::Cvdict_CFunction	nest::NestModule::cvdict_Cfunction
nest::NestModule::Cvgidcollection_i_iFunction	nest::NestModule::cvgidcollection_i_ifunction
nest::NestModule::Cvgidcollection_iaFunction	nest::NestModule::cvgidcollection_iafunction
nest::NestModule::Cvgidcollection_ivFunction	nest::NestModule::cvgidcollection_ivfunction
nest::NestModule::Size_gFunction	nest::NestModule::size_gfunction
nest::NestModule::SetAcceptableLatencyFunction	nest::NestModule::setacceptablelatency_l_dfunction
nest::NestModule::SetMaxBufferedFunction	nest::NestModule::setmaxbuffered_l_ifunction

Detailed Description

This group contains the functions that form the SLI interface of the NEST kernel.

Name mangling

All function names are mangled, so that type checking can occur using type tries in the SLI interpreter. No unmangled names should be introduced.

Name mangling is based on the following principles:

1. For each argument expected, _# is appended to the function name in the order in which arguments are expected on the stack, i.e., deepest first.
2. # is a (sequence of) lowercase letter for plain data types, an uppercase letter for compound types.
3. For compound types, a lowercase letter can be appended to indicate the type of the elements expected (eg. Ai for array of int).

Codes for plain data types

• i : int (actually long)
• d : double
• u : numeric (long or double)
• s : string
• l : literal
• f : function
• r : rng
• is : input stream
• os : output stream
• t : any token
• C : connectiontype
• cg : connectiongeneratortype
• g : gid collection

Codes for compund data types

• A : array
• D : dictionary
• V : vector

Conventions

1. All interface functions expect and return nodes as vectors of GIDs (Vi).
2. Functions must document how they loop over GID vectors and how the function is applied to subnets provided as arguments.
3. Functions that do not require overloading on the SLI level, need not carry their argument list in the SLI function name and need not be wrapped by SLI tries.
4. Functions which expect a model or synapse type as argument, must be given this argument as a literal, e.g.,

        /iaf_neuron 6 Create

   Literals will be looked up in the corresponding dictionaries (modeldict, synapsedict).
5. The network is accessed using the get_network() accessor function.
6. Each interface function shall verify that there are enough elements on the stack using (replace n by correct integer)

   *    i->assert_stack_load(n);
   *    

7. Errors should trigger C++ exceptions. They will be caught in the main interpreter loop.

SLI Documentation

SLI documentation should be provided in nestmodule.cpp, ahead of each group of related functions.

Variable Documentation

nest::NestModule::ChangeSubnet_iFunction nest::NestModule::changesubnet_ifunction

Referenced by nest::NestModule::init().

nest::NestModule::Connect_g_g_D_DFunction nest::NestModule::connect_g_g_D_Dfunction

Referenced by nest::NestModule::init().

nest::NestModule::Connect_i_i_d_d_lFunction nest::NestModule::connect_i_i_d_d_lfunction

Referenced by nest::NestModule::init().

nest::NestModule::Connect_i_i_D_lFunction nest::NestModule::connect_i_i_D_lfunction

Referenced by nest::NestModule::init().

nest::NestModule::Connect_i_i_lFunction nest::NestModule::connect_i_i_lfunction

Referenced by nest::NestModule::init().

nest::NestModule::ConvergentConnect_ia_i_a_a_lFunction nest::NestModule::convergentconnect_ia_i_a_a_lfunction

Referenced by nest::NestModule::init().

nest::NestModule::CopyModel_l_l_DFunction nest::NestModule::copymodel_l_l_Dfunction

Referenced by nest::NestModule::init().

nest::NestModule::Create_l_iFunction nest::NestModule::create_l_ifunction

Referenced by nest::NestModule::init().

nest::NestModule::CurrentSubnetFunction nest::NestModule::currentsubnetfunction

Referenced by nest::NestModule::init().

nest::NestModule::Cva_CFunction nest::NestModule::cva_cfunction

Referenced by nest::NestModule::init().

nest::NestModule::Cvdict_CFunction nest::NestModule::cvdict_Cfunction

Referenced by nest::NestModule::init().

nest::NestModule::Cvgidcollection_i_iFunction nest::NestModule::cvgidcollection_i_ifunction

Referenced by nest::NestModule::init().

nest::NestModule::Cvgidcollection_iaFunction nest::NestModule::cvgidcollection_iafunction

Referenced by nest::NestModule::init().

nest::NestModule::Cvgidcollection_ivFunction nest::NestModule::cvgidcollection_ivfunction

Referenced by nest::NestModule::init().

nest::NestModule::DataConnect_aFunction nest::NestModule::dataconnect_afunction

Referenced by nest::NestModule::init().

nest::NestModule::DataConnect_i_D_sFunction nest::NestModule::dataconnect_i_D_sfunction

Referenced by nest::NestModule::init().

nest::NestModule::DivergentConnect_i_ia_a_a_lFunction nest::NestModule::divergentconnect_i_ia_a_a_lfunction

Referenced by nest::NestModule::init().

nest::NestModule::GetChildren_i_D_bFunction nest::NestModule::getchildren_i_D_bfunction

Referenced by nest::NestModule::init().

nest::NestModule::GetConnections_DFunction nest::NestModule::getconnections_Dfunction

Referenced by nest::NestModule::init().

nest::NestModule::GetDefaults_lFunction nest::NestModule::getdefaults_lfunction

Referenced by nest::NestModule::init().

nest::NestModule::GetGlobalRngFunction nest::NestModule::getglobalrngfunction

Referenced by nest::NestModule::init().

nest::NestModule::GetLeaves_i_D_bFunction nest::NestModule::getleaves_i_D_bfunction

Referenced by nest::NestModule::init().

nest::NestModule::GetNodes_i_D_b_bFunction nest::NestModule::getnodes_i_D_b_bfunction

Referenced by nest::NestModule::init().

nest::NestModule::GetStatus_aFunction nest::NestModule::getstatus_afunction

Referenced by nest::NestModule::init().

nest::NestModule::GetStatus_CFunction nest::NestModule::getstatus_Cfunction

Referenced by nest::NestModule::init().

nest::NestModule::GetStatus_iFunction nest::NestModule::getstatus_ifunction

Referenced by nest::NestModule::init().

nest::NestModule::GetVpRngFunction nest::NestModule::getvprngfunction

Referenced by nest::NestModule::init().

nest::NestModule::MemoryInfoFunction nest::NestModule::memoryinfofunction

Referenced by nest::NestModule::init().

nest::NestModule::MPIAbort_iFunction nest::NestModule::mpiabort_ifunction

Referenced by nest::NestModule::init().

nest::NestModule::NumProcessesFunction nest::NestModule::numprocessesfunction

Referenced by nest::NestModule::init().

nest::NestModule::PrintNetworkFunction nest::NestModule::printnetworkfunction

Referenced by nest::NestModule::init().

nest::NestModule::ProcessorNameFunction nest::NestModule::processornamefunction

Referenced by nest::NestModule::init().

nest::NestModule::RankFunction nest::NestModule::rankfunction

Referenced by nest::NestModule::init().

nest::NestModule::RConvergentConnect_ia_i_i_da_da_b_b_lFunction nest::NestModule::rconvergentconnect_ia_i_i_da_da_b_b_lfunction

Referenced by nest::NestModule::init().

nest::NestModule::RConvergentConnect_ia_ia_ia_daa_daa_b_b_lFunction nest::NestModule::rconvergentconnect_ia_ia_ia_daa_daa_b_b_lfunction

Referenced by nest::NestModule::init().

nest::NestModule::RDivergentConnect_i_i_ia_da_da_b_b_lFunction nest::NestModule::rdivergentconnect_i_i_ia_da_da_b_b_lfunction

Referenced by nest::NestModule::init().

nest::NestModule::ResetKernelFunction nest::NestModule::resetkernelfunction

Referenced by nest::NestModule::init().

nest::NestModule::ResetNetworkFunction nest::NestModule::resetnetworkfunction

Referenced by nest::NestModule::init().

nest::NestModule::RestoreNodes_aFunction nest::NestModule::restorenodes_afunction

Referenced by nest::NestModule::init().

nest::NestModule::ResumeSimulationFunction nest::NestModule::resumesimulationfunction

Referenced by nest::NestModule::init().

nest::NestModule::SetAcceptableLatencyFunction nest::NestModule::setacceptablelatency_l_dfunction

Referenced by nest::NestModule::init().

nest::NestModule::SetDefaults_l_DFunction nest::NestModule::setdefaults_l_Dfunction

Referenced by nest::NestModule::init().

nest::NestModule::SetFakeNumProcessesFunction_i nest::NestModule::setfakenumprocesses_ifunction

Referenced by nest::NestModule::init().

nest::NestModule::SetMaxBufferedFunction nest::NestModule::setmaxbuffered_l_ifunction

Referenced by nest::NestModule::init().

nest::NestModule::SetNumRecProcessesFunction_i nest::NestModule::setnumrecprocesses_ifunction

Referenced by nest::NestModule::init().

nest::NestModule::SetStatus_aaFunction nest::NestModule::setstatus_aafunction

Referenced by nest::NestModule::init().

nest::NestModule::SetStatus_CDFunction nest::NestModule::setstatus_CDfunction

Referenced by nest::NestModule::init().

nest::NestModule::SetStatus_idFunction nest::NestModule::setstatus_idfunction

Referenced by nest::NestModule::init().

nest::NestModule::SimulateFunction nest::NestModule::simulatefunction

Referenced by nest::NestModule::init().

nest::NestModule::Size_gFunction nest::NestModule::size_gfunction

Referenced by nest::NestModule::init().

nest::NestModule::SyncProcessesFunction nest::NestModule::syncprocessesfunction

Referenced by nest::NestModule::init().

nest::NestModule::TimeCommunication_i_i_bFunction nest::NestModule::timecommunication_i_i_bfunction

Referenced by nest::NestModule::init().

nest::NestModule::TimeCommunicationAlltoall_i_iFunction nest::NestModule::timecommunicationalltoall_i_ifunction

Referenced by nest::NestModule::init().

nest::NestModule::TimeCommunicationAlltoallv_i_iFunction nest::NestModule::timecommunicationalltoallv_i_ifunction

Referenced by nest::NestModule::init().

nest::NestModule::TimeCommunicationv_i_iFunction nest::NestModule::timecommunicationv_i_ifunction

Referenced by nest::NestModule::init().