BaseSimulationFunction

simulation.BaseSimulationFunction()

A function which runs in the context of a simulation to produce a value (as a numpy array). This base class exists to share functionality without limiting the function signature of evaluate().

Instances may access the context in which they are being evaluated using attributes and methods present on “self”: name, data, scope, time_frame, ipm, rng, and dim, and may use methods like defer to pass their context on to another function for direct evaluation.

BaseSimulationFunction is an abstract class.

See Also

Refer to SimulationFunction and SimulationTickFunction for more concrete subclasses.