Skip to main content

AStarPlanner

Struct AStarPlanner 

Source
pub struct AStarPlanner { /* private fields */ }
Expand description

A* path planner

Implementations§

Source§

impl AStarPlanner

Source

pub fn new(ox: &[f64], oy: &[f64], config: AStarConfig) -> Self

Create a new A* planner with obstacle positions

Source

pub fn try_new( ox: &[f64], oy: &[f64], config: AStarConfig, ) -> RoboticsResult<Self>

Create a validated A* planner with obstacle positions

Source

pub fn from_obstacles( ox: &[f64], oy: &[f64], resolution: f64, robot_radius: f64, ) -> Self

Create from obstacle x/y vectors with default config

Source

pub fn from_obstacle_points( obstacles: &Obstacles, config: AStarConfig, ) -> RoboticsResult<Self>

Create a validated A* planner from typed obstacle points

Source

pub fn planning( &self, sx: f64, sy: f64, gx: f64, gy: f64, ) -> Option<(Vec<f64>, Vec<f64>)>

👎Deprecated:

use plan() or plan_xy() instead

Plan a path returning (rx, ry) vectors (legacy interface)

Source

pub fn plan(&self, start: Point2D, goal: Point2D) -> RoboticsResult<Path2D>

Plan a path without requiring the PathPlanner trait in scope

Source

pub fn plan_xy( &self, sx: f64, sy: f64, gx: f64, gy: f64, ) -> RoboticsResult<Path2D>

Plan a path from raw coordinates without requiring the PathPlanner trait in scope

Source

pub fn plan_with_stats( &self, start: Point2D, goal: Point2D, ) -> RoboticsResult<(Path2D, AStarSearchStats)>

Plan a path and return per-query search-effort statistics.

Source

pub fn plan_with_observer( &self, start: Point2D, goal: Point2D, on_expand: impl FnMut(Point2D), ) -> RoboticsResult<Path2D>

Plans a path while observing each expanded cell in search order.

The callback receives world coordinates, once per expanded cell, including the start and (when reached) the goal. It is also called during unsuccessful searches; invalid queries emit no cells. The ordinary planning methods do not allocate or retain this history.

Source

pub fn grid_map(&self) -> &GridMap

Get reference to the grid map

Trait Implementations§

Source§

impl PathPlanner for AStarPlanner

Source§

fn plan(&self, start: Point2D, goal: Point2D) -> Result<Path2D, RoboticsError>

Plan a path from start to goal

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V