Skip to main content

DubinsPlanner

Struct DubinsPlanner 

Source
pub struct DubinsPlanner {
    pub curvature: f64,
}
Expand description

Dubins path planner.

Computes the shortest forward-only path between two Pose2D waypoints for a vehicle whose minimum turning radius is 1.0 / curvature.

§Example

use rust_robotics_planning::dubins_path::DubinsPlanner;
use rust_robotics_core::types::Pose2D;

let planner = DubinsPlanner::new(1.0);
let start = Pose2D::new(0.0, 0.0, 0.0);
let goal  = Pose2D::new(5.0, 5.0, std::f64::consts::FRAC_PI_2);
let path  = planner.plan(start, goal).unwrap();
assert!(path.total_length > 0.0);

Fields§

§curvature: f64

Curvature = 1 / minimum turning radius [1/m].

Implementations§

Source§

impl DubinsPlanner

Source

pub fn new(curvature: f64) -> Self

Create a new planner with the given curvature (1 / min turning radius).

§Errors

Returns InvalidParameter if curvature is not positive and finite.

Source

pub fn plan(&self, start: Pose2D, goal: Pose2D) -> RoboticsResult<DubinsPath>

Plan the shortest Dubins path from start to goal.

§Errors

Returns PlanningError if no valid path can be found (should not happen for finite inputs—included for robustness).

Source

pub fn sample_path(&self, path: &DubinsPath, step: f64) -> Path2D

Sample evenly-spaced points along a previously computed DubinsPath.

step is the distance [m] between consecutive sample points.

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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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