GeNN  4.9.0
GPU enhanced Neuronal Networks (GeNN)
pygenn.genn_groups.Group Class Reference

Parent class of NeuronGroup, SynapseGroup and CurrentSource. More...

Inheritance diagram for pygenn.genn_groups.Group:
pygenn.genn_groups.CurrentSource pygenn.genn_groups.CustomUpdate pygenn.genn_groups.NeuronGroup pygenn.genn_groups.SynapseGroup

Public Member Functions

def __init__ (self, name, model)
 Init Group. More...
 
def set_var (self, var_name, values)
 Set values for a Variable. More...
 
def add_extra_global_param (self, param_name, param_values)
 Set extra global parameter. More...
 
def set_extra_global_param (self, param_name, param_values)
 Set extra global parameter. More...
 
def pull_state_from_device (self)
 Wrapper around GeNNModel.pull_state_from_device. More...
 
def pull_var_from_device (self, var_name)
 Wrapper around GeNNModel.pull_var_from_device. More...
 
def pull_extra_global_param_from_device (self, egp_name, size=None)
 Wrapper around GeNNModel.pull_extra_global_param_from_device. More...
 
def push_state_to_device (self)
 Wrapper around GeNNModel.push_state_to_device. More...
 
def push_var_to_device (self, var_name)
 Wrapper around GeNNModel.push_var_to_device. More...
 
def push_extra_global_param_to_device (self, egp_name, size=None)
 Wrapper around GeNNModel.push_extra_global_param_to_device. More...
 

Public Attributes

 name
 
 vars
 
 extra_global_params
 

Detailed Description

Parent class of NeuronGroup, SynapseGroup and CurrentSource.

Constructor & Destructor Documentation

◆ __init__()

def pygenn.genn_groups.Group.__init__ (   self,
  name,
  model 
)

Init Group.

Parameters
namestring name of the Group
modelpygenn.genn_model.GeNNModel this group is part of

Member Function Documentation

◆ add_extra_global_param()

def pygenn.genn_groups.Group.add_extra_global_param (   self,
  param_name,
  param_values 
)

Set extra global parameter.

Parameters
param_namestring with the name of the extra global parameter
param_valuesiterable or a single value

◆ pull_extra_global_param_from_device()

def pygenn.genn_groups.Group.pull_extra_global_param_from_device (   self,
  egp_name,
  size = None 
)

Wrapper around GeNNModel.pull_extra_global_param_from_device.

Parameters
egp_namestring with the name of the variable
sizenumber of entries in EGP array

◆ pull_state_from_device()

def pygenn.genn_groups.Group.pull_state_from_device (   self)

◆ pull_var_from_device()

def pygenn.genn_groups.Group.pull_var_from_device (   self,
  var_name 
)

Wrapper around GeNNModel.pull_var_from_device.

Parameters
var_namestring with the name of the variable

◆ push_extra_global_param_to_device()

def pygenn.genn_groups.Group.push_extra_global_param_to_device (   self,
  egp_name,
  size = None 
)

Wrapper around GeNNModel.push_extra_global_param_to_device.

Parameters
egp_namestring with the name of the variable
sizenumber of entries in EGP array

◆ push_state_to_device()

def pygenn.genn_groups.Group.push_state_to_device (   self)

◆ push_var_to_device()

def pygenn.genn_groups.Group.push_var_to_device (   self,
  var_name 
)

Wrapper around GeNNModel.push_var_to_device.

Parameters
var_namestring with the name of the variable

◆ set_extra_global_param()

def pygenn.genn_groups.Group.set_extra_global_param (   self,
  param_name,
  param_values 
)

Set extra global parameter.

Parameters
param_namestring with the name of the extra global parameter
param_valuesiterable or a single value

◆ set_var()

def pygenn.genn_groups.Group.set_var (   self,
  var_name,
  values 
)

Set values for a Variable.

Parameters
var_namestring with the name of the variable
valuesiterable or a single value

Member Data Documentation

◆ extra_global_params

pygenn.genn_groups.Group.extra_global_params

◆ name

pygenn.genn_groups.Group.name

◆ vars

pygenn.genn_groups.Group.vars

The documentation for this class was generated from the following file: