Header menu logo issie

FastRun Module

Nested modules

Modules Description

Constants

Functions and values

Function or value Description

buildFastSimulation simulationArraySize diagramName graph

Full Usage: buildFastSimulation simulationArraySize diagramName graph

Parameters:
Returns: Result<FastSimulation, SimulationError>

Create a fast simulation data structure, with all necessary arrays, and components ordered for evaluation. This function also creates the reducer functions for each component similar to the reducer builder in Builder, but with inputs and outputs using the FastSimulation mutable arrays

simulationArraySize : int
diagramName : string
graph : SimulationGraph
Returns: Result<FastSimulation, SimulationError>

buildFastSimulationFData simulationArraySize diagramName graph

Full Usage: buildFastSimulationFData simulationArraySize diagramName graph

Parameters:
Returns: Result<FastSimulation, SimulationError>
simulationArraySize : int
diagramName : string
graph : SimulationGraph
Returns: Result<FastSimulation, SimulationError>

calculateTotalSimArraySizePerStep activeComps fs

Full Usage: calculateTotalSimArraySizePerStep activeComps fs

Parameters:
Returns: FastSimulation

Calculates the size in bytes / clock step of the simulation arrays bigint arrayshave very uncertain size, so an estimate of 16 bytes is assumed. this should be revisited for more accuracy

activeComps : FastComponent array
fs : FastSimulation
Returns: FastSimulation

canBeReduced fs step fc

Full Usage: canBeReduced fs step fc

Parameters:
Returns: bool
Modifiers: inline

True if all conditions are fulfiled for the component to be in the next batch to be reduced. Used when ordering components.

fs : FastSimulation
step : int
fc : FastComponent
Returns: bool

checkAndValidate fs

Full Usage: checkAndValidate fs

Parameters:
Returns: Result<FastSimulation, SimulationError>

Check all the active FastComponents to ensure everything is valid Use data from initialisation to write any not-yet-written component output widths

fs : FastSimulation
Returns: Result<FastSimulation, SimulationError>

checkAndValidateFData fs

Full Usage: checkAndValidateFData fs

Parameters:
Returns: Result<FastSimulation, SimulationError>
fs : FastSimulation
Returns: Result<FastSimulation, SimulationError>

createFastArrays fs gather

Full Usage: createFastArrays fs gather

Parameters:
Returns: FastSimulation
fs : FastSimulation
gather : GatherData
Returns: FastSimulation

isComb comp

Full Usage: isComb comp

Parameters:
Returns: bool
Modifiers: inline

True if the component is combinational

comp : FastComponent
Returns: bool

printComp fs step fc

Full Usage: printComp fs step fc

Parameters:
Returns: string

print function for debugging

fs : FastSimulation
step : int
fc : FastComponent
Returns: string

runCombinationalLogic step fastSim

Full Usage: runCombinationalLogic step fastSim

Parameters:

Re-evaluates the combinational logic for the given timestep - used if a combinational input has changed

step : int
fastSim : FastSimulation

runCombinationalLogicFData step fastSim

Full Usage: runCombinationalLogicFData step fastSim

Parameters:
step : int
fastSim : FastSimulation

runFastSimulation timeOut lastStepNeeded fs

Full Usage: runFastSimulation timeOut lastStepNeeded fs

Parameters:
Returns: float option

Run an existing fast simulation up to the given number of steps. This function will mutate the write-once data arrays of simulation data and only simulate the new steps needed, so it may return immediately doing no work. If the simulation data arrays are not large enough they are extended up to a limit. After that, they act as a circular buffer. TimeOut if not None is the cutoff time after which the simulation terminates execution unfinished. Use fs.ClockTick to determine whether simulation has completed. returns speed, in clock cycles per ms, or None if complete

timeOut : float option
lastStepNeeded : int
fs : FastSimulation
Returns: float option

Type something to start searching.