Struct PreparedFlowField 

pub struct PreparedFlowField { /* private fields */ }

Prepared same-goal flow field (integration + direction per cell).

Immutable after FlowFieldBuilder::preprocess. Safe to sample from many independent starts without mutating the field.

Implementations

impl PreparedFlowField

pub fn name(&self) -> &'static str

Stable algorithm label for capture reports.

pub fn grid(&self) -> &Grid

Grid snapshot used during preprocess.

pub fn goal(&self) -> Point

Shared goal the field was built for.

pub fn width(&self) -> usize

Grid width in cells.

pub fn height(&self) -> usize

Grid height in cells.

pub fn integration_at(&self, point: Point) -> Option<u32>

Distance-to-goal in grid steps, if the cell can reach the goal.

pub fn direction_at(&self, point: Point) -> FlowDirection

Greedy cardinal step stored for point, or FlowDirection::None when out of bounds, blocked, goal, or unreachable.

pub fn sample_path( &self, start: Point, ) -> Result<SearchOutcome<Path, SearchStats>, GridSearchError>

Greedy walk along the flow field from start toward the goal.

On uniform unit-cost 4-way grids, length matches A*. Stops on goal, stuck cell, or max_steps (default: width*height).

Errors

Returns GridSearchError::InvalidStart when start is blocked or outside the prepared grid.

pub fn sample_path_limited( &self, start: Point, max_steps: usize, ) -> Result<SearchOutcome<Path, SearchStats>, GridSearchError>

Samples at most max_steps flow edges.

Errors

Returns GridSearchError::InvalidStart when start is blocked or outside the prepared grid. GridSearchError::StepLimitReached reports a reachable sample truncated by max_steps.

Trait Implementations

impl Clone for PreparedFlowField

fn clone(&self) -> PreparedFlowField

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PreparedFlowField

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

Formats the value using the given formatter.