Struct WeightedForcedWalk

#[non_exhaustive]
pub struct WeightedForcedWalk {
    pub cost: LengthInterval,
    pub shortest: LengthInterval,
    pub witness: Option<Point2>,
    pub converged: bool,
    pub cells: usize,
}

The cheapest walk from an origin to a target that enters a polygon, over weighted maps.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

cost: LengthInterval

Contains the cost of the cheapest walk that enters the polygon. Both ends are infinite when no walk from an origin to a target reaches the polygon.

shortest: LengthInterval

Contains the cost of the cheapest walk from any origin to any target, ignoring the polygon: cost is never below its lower end. Infinite when no target is reachable from an origin.

witness: Option<Point2>

A point of the polygon, in the free space, through which a walk costing at most cost.upper passes; None when no walk reaches the polygon.

converged: bool

Whether cost is no wider than the tolerance asked for plus the maps’ own brackets summed at the witness. When the cell budget runs out first it is still sound, only wider.

cells: usize

Cells examined.

Trait Implementations

impl Clone for WeightedForcedWalk

fn clone(&self) -> WeightedForcedWalk

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WeightedForcedWalk

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

Formats the value using the given formatter.

impl PartialEq for WeightedForcedWalk

fn eq(&self, other: &WeightedForcedWalk) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for WeightedForcedWalk

impl StructuralPartialEq for WeightedForcedWalk