Struct CaField 

pub struct CaField<M>
where
    M: GridModel,
{ /* private fields */ }

Double-buffered u8 cells stepped by M’s neighbourhood rule.

Implementations

impl<M> CaField<M>

where M: GridModel,

pub fn grid(&self) -> &Grid2D<u8>

Read access for tests and for M::stats.

pub fn grid_mut(&mut self) -> &mut Grid2D<u8>

Write access, for an action that rewrites the cells.

pub fn parallel_jobs(&self) -> usize

Number of rayon jobs one tick splits into.

pub fn with_seed( extent: Extent, params: &[ParamValue], seed: Option<u64>, ) -> CaField<M>

Builds a field seeded from seed, or from GRID_INIT_SEED when it is None.

pub fn from_cells(extent: Extent, cells: &[u8]) -> Option<CaField<M>>

Builds a field holding cells, seeded from GRID_INIT_SEED.

Returns None unless cells is exactly the length extent implies.

Trait Implementations

impl<M> Debug for CaField<M>

where M: GridModel,

Prints the model’s name and the grid’s size, not its cells.

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

Formats the value using the given formatter.

impl<M> FieldLayer for CaField<M>

where M: GridModel,

const KIND: &'static str = "Cellular automaton"

Name of this layer in the Model panel.

type Params = <M as GridModel>::Params

Hot parameters, rebuilt once per tick.

type Read<'a> = &'a [u8]

The field as an agent kernel sees it.

type DepositLanes = ()

Per agent deposit lanes, filled by the agent passes, or () for a field without deposit lanes.

fn param_descriptors() -> Vec<ParamDescriptor>

Returns this layer’s own parameters, listed after the model’s parameters.

fn from_params(params: &[ParamValue]) -> <M as GridModel>::Params

Extracts the hot parameters for one tick.

fn new(extent: Extent, params: &[ParamValue]) -> CaField<M>

Creates the layer over extent, from this layer’s own slice of the parameters.

fn read(&self) -> &[u8]

Returns the field as an agent kernel reads it.

fn alloc_deposits(&self, _n: usize)

Allocates deposit lanes for n agents. The engine reuses them every tick.

fn update(&mut self, _: &(), p: &<M as GridModel>::Params, tick: u64)

Advances the layer by one tick, with this tick’s deposits.

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

Returns the cells to draw, or None for a layer without a grid.

fn cell_count(&self) -> usize

Number of cells.

fn heap_bytes(&self) -> usize

Heap memory held by the layer, in bytes.

const HAS_GRID: bool = true

Whether the layer draws a grid. It must agree with Self::grid_view.

fn prepare_view(&mut self)

Turns cells into palette indices. The engine calls it before each snapshot.