pygrenade_vx.common.Population

class pygrenade_vx.common.Population

Bases: pygrenade_common.PartitionedVertex

__init__(*args, **kwargs)

Overloaded function.

__init__(self: pygrenade_common.Population, cell: pygrenade_common.Population.Cell, shape: pygrenade_common.MultiIndexSequence, parameter_space: pygrenade_common.Population.Cell.ParameterSpace, time_domain: Optional[pygrenade_common.TimeDomainOnTopology], execution_instance_on_executor: Optional[pygrenade_common.ExecutionInstanceOnExecutor] = None) -> None

Construct population.

__init__(self: pygrenade_common.Population, arg0: pygrenade_common.Population) -> None

Methods

`__init__`(args, *kwargs)	Overloaded function.
`copy`(self)
`get_cell`(self)	Get cell type property.
`get_input_ports`(self)	Get the input ports of the population.
`get_output_ports`(self)	Get the output ports of the population.
`get_parameter_space`(self)	Get parameter space of cell instances on the population.
`get_shape`(self)
`get_time_domain`(self)
`move`(self)
`set_cell`(self, cell)	Set cell type property.
`set_execution_instance_on_executor`(self, value)	Set execution instance on the executor.
`set_parameter_space`(self, parameter_space)	Set parameter space of cell instances on the population.
`set_shape`(self, value)	Set sequence of cells in population.
`set_time_domain`(self, value)	Set time domain.
`size`(self)	Get number of cells in population.
`valid`(self, time_domain_runtimes)	Get whether the time domain is valid for the population.
`valid_input_port_data`(self, …)	Get whether the data is valid for the input port on population.

class Cell

Bases: pybind11_builtins.pybind11_object

class Dynamics

Bases: pygrenade_common.BatchedPortData

get_section(self: pygrenade_common.Population.Cell.Dynamics, sequence: pygrenade_common.MultiIndexSequence) → pygrenade_common.Population.Cell.Dynamics: Get section of dynamics. The sequence is required to be included in the interval [0, size()).

size(self: pygrenade_common.Population.Cell.Dynamics) → int: Number of cell dynamics.

class ParameterSpace

Bases: pybind11_builtins.pybind11_object

class Parameterization

Bases: pygrenade_common.PortData

get_section(self: pygrenade_common.Population.Cell.ParameterSpace.Parameterization, sequence: pygrenade_common.MultiIndexSequence) → pygrenade_common.Population.Cell.ParameterSpace.Parameterization: Get section of parameterization. The sequence is required to be included in the interval [0, size()).

size(self: pygrenade_common.Population.Cell.ParameterSpace.Parameterization) → int: Number of cell parameterizations.

get_section(self: pygrenade_common.Population.Cell.ParameterSpace, sequence: pygrenade_common.MultiIndexSequence) → pygrenade_common.Population.Cell.ParameterSpace: Get section of parameter space. The sequence is required to be included in the interval [0, size()).

size(self: pygrenade_common.Population.Cell.ParameterSpace) → int: Number of cell parameter spaces.

valid(self: pygrenade_common.Population.Cell.ParameterSpace, input_port_on_cell: int, parameterization: pygrenade_common.Population.Cell.ParameterSpace.Parameterization) → bool: Check whether the parameterization is valid for the parameter space.

get_input_ports(self: pygrenade_common.Population.Cell) → list[pygrenade_common.Vertex.Port]: Get the input ports this cell exposes.

get_output_ports(self: pygrenade_common.Population.Cell) → list[pygrenade_common.Vertex.Port]: Get the output ports this cell exposes.

is_partitionable(self: pygrenade_common.Population.Cell) → bool: Get whether the cell is partitionable. This means that it can be assigned an execution instance on the executor.

requires_time_domain(self: pygrenade_common.Population.Cell) → bool: Get whether the cell requires a time domain.

valid(*args, **kwargs)

Overloaded function.

valid(self: pygrenade_common.Population.Cell, parameter_space: pygrenade_common.Population.Cell.ParameterSpace) -> bool

Get whether the parameter space is valid for the cell.

valid(self: pygrenade_common.Population.Cell, input_port_on_cell: int, dynamics: pygrenade_common.Population.Cell.Dynamics) -> bool

Get whether the dynamics are valid for the cell.

valid(self: pygrenade_common.Population.Cell, time_domain_runtimes: pygrenade_common.TimeDomainRuntimes) -> bool

Get whether the time domain runtimes are valid for the cell.

copy(self: pygrenade_common.Population) → pygrenade_common.Vertex

get_cell(self: pygrenade_common.Population) → pygrenade_common.Population.Cell: Get cell type property. The cell type defines the population cells’ computation performed, its parameters and the ports accessible per cell.

get_input_ports(self: pygrenade_common.Population) → list[pygrenade_common.Vertex.Port]: Get the input ports of the population. They match the input ports of the cell with the channels of each port being the cross product with the shape.

get_output_ports(self: pygrenade_common.Population) → list[pygrenade_common.Vertex.Port]: Get the output ports of the population. They match the output ports of the cell with the channels of each port being the cross product with the shape.

get_parameter_space(self: pygrenade_common.Population) → pygrenade_common.Population.Cell.ParameterSpace: Get parameter space of cell instances on the population.

get_shape(self: pygrenade_common.Population) → pygrenade_common.MultiIndexSequence

get_time_domain(self: pygrenade_common.Population) → Optional[pygrenade_common.TimeDomainOnTopology]

move(self: pygrenade_common.Population) → pygrenade_common.Vertex

set_cell(self: pygrenade_common.Population, cell: pygrenade_common.Population.Cell) → None: Set cell type property. The cell type defines the population cells’ computation performed, its parameters and the ports accessible per cell.

set_execution_instance_on_executor(self: pygrenade_common.Population, value: Optional[pygrenade_common.ExecutionInstanceOnExecutor]) → None: Set execution instance on the executor.

set_parameter_space(self: pygrenade_common.Population, parameter_space: pygrenade_common.Population.Cell.ParameterSpace) → None: Set parameter space of cell instances on the population.

set_shape(self: pygrenade_common.Population, value: pygrenade_common.MultiIndexSequence) → None: Set sequence of cells in population.

set_time_domain(self: pygrenade_common.Population, value: Optional[pygrenade_common.TimeDomainOnTopology]) → None: Set time domain.

size(self: pygrenade_common.Population) → int: Get number of cells in population. This equals the size of the parameter space as well as the shape.

valid(self: pygrenade_common.Population, time_domain_runtimes: pygrenade_common.TimeDomainRuntimes) → bool: Get whether the time domain is valid for the population. This matches the check defined for the cell.

valid_input_port_data(self: pygrenade_common.Population, input_port_on_vertex: int, data: pygrenade_common.PortData) → bool: Get whether the data is valid for the input port on population. This matches the checks for dynamics and parameterization defined for the cell and additionally checks for matching size.