Struct SRobotPath 

pub struct SRobotPath<const N: usize, T: Float = f32> { /* private fields */ }

Statically-sized robot path backed by Vec<SRobotQ<N, T>>.

SRobotPath is guaranteed to have at least 2 waypoints, so it always has a defined start and end configuration.

Implementations

impl<const N: usize, T: Float> SRobotPath<N, T>

pub fn try_new(waypoints: Vec<SRobotQ<N, T>>) -> DekeResult<Self>

pub fn new_prechecked( first: SRobotQ<N, T>, last: SRobotQ<N, T>, middle: Vec<SRobotQ<N, T>>, ) -> Self

pub fn from_two(start: SRobotQ<N, T>, goal: SRobotQ<N, T>) -> Self

pub fn len(&self) -> usize

pub fn get(&self, index: usize) -> Option<&SRobotQ<N, T>>

pub fn first(&self) -> &SRobotQ<N, T>

pub fn last(&self) -> &SRobotQ<N, T>

pub fn iter(&self) -> Iter<'_, SRobotQ<N, T>>

pub fn iter_mut(&mut self) -> IterMut<'_, SRobotQ<N, T>>

pub fn segments(&self) -> impl Iterator<Item = (&SRobotQ<N, T>, &SRobotQ<N, T>)>

pub fn push(&mut self, q: SRobotQ<N, T>)

pub fn pop(&mut self) -> Option<SRobotQ<N, T>>

pub fn truncate(&mut self, len: usize)

pub fn reverse(&mut self)

pub fn reversed(&self) -> Self

pub fn arc_length(&self) -> T

pub fn segment_lengths(&self) -> Vec<T>

pub fn cumulative_lengths(&self) -> Vec<T>

pub fn max_segment_length(&self) -> T

pub fn max_joint_step(&self) -> T

pub fn sample(&self, t: T) -> Option<SRobotQ<N, T>>

pub fn densify(&self, max_dist: T) -> Self

pub fn deduplicate(&self, tol: T) -> Self

Removes consecutive duplicate waypoints within tol distance of each other.

pub fn simplify(&self, tol: T) -> Self

pub fn to_robot_path(&self) -> RobotPath<T>

Trait Implementations

impl<const N: usize, T: Float> AsRef<[SRobotQ<N, T>]> for SRobotPath<N, T>

fn as_ref(&self) -> &[SRobotQ<N, T>]

Converts this type into a shared reference of the (usually inferred) input type.

impl<const N: usize, T: Clone + Float> Clone for SRobotPath<N, T>

fn clone(&self) -> SRobotPath<N, T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const N: usize, T: Debug + Float> Debug for SRobotPath<N, T>

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

Formats the value using the given formatter.

impl<const N: usize, T: Float> From<&SRobotPath<N, T>> for RobotPath<T>

fn from(sp: &SRobotPath<N, T>) -> Self

Converts to this type from the input type.

impl<const N: usize> From<SRobotPath<N>> for RobotPath<f64>

fn from(sp: SRobotPath<N, f32>) -> Self

Converts to this type from the input type.

impl<const N: usize> From<SRobotPath<N>> for SRobotPath<N, f64>

fn from(path: SRobotPath<N, f32>) -> Self

Converts to this type from the input type.

impl<const N: usize, T: Float> From<SRobotPath<N, T>> for RobotPath<T>

fn from(sp: SRobotPath<N, T>) -> Self

Converts to this type from the input type.

impl<const N: usize> From<SRobotPath<N, f64>> for RobotPath<f32>

fn from(sp: SRobotPath<N, f64>) -> Self

Converts to this type from the input type.

impl<const N: usize> From<SRobotPath<N, f64>> for SRobotPath<N, f32>

fn from(path: SRobotPath<N, f64>) -> Self

Converts to this type from the input type.

impl<const N: usize, T: Float> Index<usize> for SRobotPath<N, T>

type Output = SRobotQ<N, T>

The returned type after indexing.

fn index(&self, i: usize) -> &SRobotQ<N, T>

Performs the indexing (container[index]) operation.

impl<const N: usize, T: Float> IndexMut<usize> for SRobotPath<N, T>

fn index_mut(&mut self, i: usize) -> &mut SRobotQ<N, T>

Performs the mutable indexing (container[index]) operation.

impl<'a, const N: usize, T: Float> IntoIterator for &'a SRobotPath<N, T>

type Item = &'a SRobotQ<N, T>

The type of the elements being iterated over.

type IntoIter = Iter<'a, SRobotQ<N, T>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<const N: usize, T: Float> IntoIterator for SRobotPath<N, T>

type Item = SRobotQ<N, T>

The type of the elements being iterated over.

type IntoIter = IntoIter<SRobotQ<N, T>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<const N: usize, T: Float> TryFrom<&[SRobotQ<N, T>]> for SRobotPath<N, T>

type Error = DekeError

The type returned in the event of a conversion error.

fn try_from(waypoints: &[SRobotQ<N, T>]) -> Result<Self, Self::Error>

Performs the conversion.

impl<const N: usize, T: Float> TryFrom<&ArrayBase<OwnedRepr<T>, Dim<[usize; 2]>>> for SRobotPath<N, T>

type Error = DekeError

The type returned in the event of a conversion error.

fn try_from(arr: &RobotPath<T>) -> Result<Self, Self::Error>

Performs the conversion.

impl<const N: usize, T: Float> TryFrom<&Vec<SRobotQ<N, T>>> for SRobotPath<N, T>

type Error = DekeError

The type returned in the event of a conversion error.

fn try_from(waypoints: &Vec<SRobotQ<N, T>>) -> Result<Self, Self::Error>

Performs the conversion.

impl<const N: usize, T: Float> TryFrom<ArrayBase<OwnedRepr<T>, Dim<[usize; 2]>>> for SRobotPath<N, T>

type Error = DekeError

The type returned in the event of a conversion error.

fn try_from(arr: RobotPath<T>) -> Result<Self, Self::Error>

Performs the conversion.

impl<const N: usize> TryFrom<ArrayBase<OwnedRepr<f32>, Dim<[usize; 2]>>> for SRobotPath<N, f64>

type Error = DekeError

The type returned in the event of a conversion error.

fn try_from(arr: RobotPath<f32>) -> Result<Self, Self::Error>

Performs the conversion.

impl<const N: usize> TryFrom<ArrayBase<OwnedRepr<f64>, Dim<[usize; 2]>>> for SRobotPath<N, f32>

type Error = DekeError

The type returned in the event of a conversion error.

fn try_from(arr: RobotPath<f64>) -> Result<Self, Self::Error>

Performs the conversion.

impl<const N: usize, T: Float> TryFrom<Vec<SRobotQ<N, T>>> for SRobotPath<N, T>

type Error = DekeError

The type returned in the event of a conversion error.

fn try_from(waypoints: Vec<SRobotQ<N, T>>) -> Result<Self, Self::Error>

Performs the conversion.