Struct TemporalField 

pub struct TemporalField { /* private fields */ }

The temporal field - ring buffer with decay and pub/sub events.

Every write and tick checks thresholds and fires events to observers. The brain does not poll - one spark cascades.

See crate-level documentation for full architecture explanation and examples.

Clone behavior

Cloning a TemporalField copies the field state (frames, config, triggers) but NOT the observers. The clone starts with no subscribers.

Implementations

impl TemporalField

pub fn new(config: FieldConfig) -> Self

Create a new temporal field.

After creation, configure the field:

1. Add monitored regions with monitor_region()
2. Subscribe observers with subscribe()
3. Writers write with write_region(), readers receive events

pub fn monitor_region(&mut self, region: MonitoredRegion)

Add a monitored region after construction.

pub fn set_convergence_threshold(&mut self, threshold: usize)

Set convergence threshold.

pub fn subscribe(&mut self, observer: Arc<dyn FieldObserver>)

Subscribe an observer to receive field events.

pub fn clear_observers(&mut self)

Remove all observers.

pub fn tick(&mut self)

Advance time by one tick - decay all frames, may fire RegionQuiet events.

pub fn tick_n(&mut self, n: usize)

Advance multiple ticks.

pub fn advance_write_head(&mut self)

Advance write head to next frame.

pub fn write_region(&mut self, signals: &[Signal], range: Range<usize>)

Write Signals to a region of the current frame (additive) - may fire events.

pub fn set_region(&mut self, signals: &[Signal], range: Range<usize>)

Set Signals in a region of the current frame (replace) - may fire events.

pub fn write_full(&mut self, vector: &FieldVector)

Add a full vector to current frame - may fire events.

pub fn clear_current(&mut self)

Clear the current frame.

pub fn read_current(&self) -> &FieldVector

Read the current frame.

pub fn read_region(&self, range: Range<usize>) -> Vec<Signal>

Read a specific region from current frame.

pub fn region_energy(&self, range: Range<usize>) -> u64

Get energy in a region of current frame.

pub fn region_active(&self, range: Range<usize>, threshold: u64) -> bool

Check if region is active (energy above threshold).

pub fn read_window(&self, n: usize) -> Vec<&FieldVector>

Read the last N frames in chronological order (oldest first).

pub fn region_peak(&self, range: Range<usize>, window: usize) -> Vec<Signal>

Get peak values in a region over the last N frames. Returns the frame with highest energy.

pub fn region_mean(&self, range: Range<usize>, window: usize) -> Vec<Signal>

Get mean values in a region over the last N frames. Returns averaged Signal values using the full p×m×k range.

pub fn config(&self) -> &FieldConfig

Get configuration.

pub fn triggers(&self) -> &TriggerConfig

Get trigger configuration.

pub fn regions(&self) -> &[MonitoredRegion]

Get monitored regions.

pub fn tick_count(&self) -> u64

Get current tick count.

pub fn write_head(&self) -> usize

Get write head position.

pub fn dims(&self) -> usize

Get total dimensions.

pub fn frame_count(&self) -> usize

Get frame count.

pub fn max_magnitude(&self) -> u16

Get maximum effective magnitude in field.

pub fn total_activity(&self) -> usize

Get total non-zero count.

pub fn clear(&mut self)

Clear entire field.

pub fn ticks_to_ms(&self, ticks: u64) -> u32

Convert tick difference to milliseconds.

pub fn ms_to_ticks(&self, ms: u32) -> u64

Convert milliseconds to ticks.

Trait Implementations

impl Clone for TemporalField

fn clone(&self) -> Self

Clone the field state but NOT the observers. The clone starts with no subscribers.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TemporalField

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

Formats the value using the given formatter.