Struct GridModelState 

pub struct GridModelState<M: GridModel> { /* private fields */ }

Engine wrapper that implements SimState for any GridModel.

Implementations

impl<M: GridModel> GridModelState<M>

pub fn from_params(params: &[ParamValue]) -> Self

Builds a state from the full parameter list, with its RNG starting from GRID_INIT_SEED.

pub fn from_params_seeded(params: &[ParamValue], seed: Option<u64>) -> Self

Builds a state whose RNG starts from seed, or GRID_INIT_SEED when it is None.

pub fn from_cells(params: &[ParamValue], cells: &[u8]) -> Option<Self>

Builds a state whose grid holds cells, with the default seeds.

Returns None unless cells is exactly the length params implies.

Trait Implementations

impl<M: GridModel> Debug for GridModelState<M>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<M: GridModel> SimState for GridModelState<M>

fn step(&mut self)

Advances the state by one tick.

fn tick(&self) -> u64

Number of ticks stepped so far.

fn grid_view(&self) -> Option<GridView<'_>>

Returns the grid layer to draw, if the state has one.

fn stats(&self) -> Vec<StatEntry>

Returns the current statistics, one entry per declared series.

fn set_param(&mut self, index: usize, value: &ParamValue) -> bool

Sets parameter index to value, and returns whether the state accepted the edit.

fn act(&mut self, index: usize) -> bool

Runs the model’s action at index, between ticks, and returns whether it ran.

fn population(&self) -> u64

Size of the population: its cells, its agents or its live nodes.

fn heap_bytes(&self) -> usize

Approximate size in bytes of the memory this state owns, on the host for a CPU state and on the device for a GPU state.

fn parallel_jobs(&self) -> Option<usize>

Number of jobs that one step splits into. None if a backend has no such split.

fn point_view(&self) -> Option<PointView<'_>>

Returns the agents to draw, if the state has any.

fn edge_view(&self) -> Option<EdgeView<'_>>

Returns the edges to draw between the positions from SimState::point_view.

fn prepare_view(&mut self)

Prepares the views before a snapshot is built.

fn set_layout(&mut self, _on: bool, _budget_ms: f32) -> bool

Turns the layout on or off, with a time budget per publish in milliseconds.

fn relax_layout(&mut self)

Runs the layout for one time budget, if it is on.