Skip to main content

RamseteController

Struct RamseteController 

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

RAMSETE controller configuration and calculation.

The RAMSETE controller is a nonlinear trajectory tracker that computes velocity commands to follow a reference trajectory while correcting for position and heading errors.

§Parameters

  • b: Convergence gain that determines how aggressively the controller corrects lateral and heading errors. Higher values = faster convergence but potentially more oscillation. Typical value: 2.0
  • zeta: Damping ratio similar to a second-order system. Higher values reduce oscillation. Typical value: 0.7
  • epsilon: Small-angle threshold for sinc function to avoid division by zero. Default: 1e-6

Implementations§

Source§

impl RamseteController

Source

pub fn new() -> Self

Creates a RAMSETE controller with zero gains.

Use set to configure the tuning parameters.

§Example
let ramsete = RamseteController::new().set(2.0, 0.7);
Source

pub fn set(self, b: f64, zeta: f64) -> Self

Sets the RAMSETE tuning parameters.

§Arguments
  • b - Convergence gain (typical: 2.0)
  • zeta - Damping ratio (typical: 0.7)
§Returns

A new controller with the specified gains.

Source

pub fn with_epsilon(self, epsilon: f64) -> Self

Sets the small-angle epsilon for the sinc function.

When the heading error is smaller than epsilon, sinc(theta) returns 1.0 to avoid numerical instability from dividing by near-zero values.

§Arguments
  • epsilon - Small-angle threshold (default: 1e-6)
Source

pub fn calculate( &self, current: Pose, reference: RamseteReference, ) -> (f64, f64)

Computes the linear and angular velocity commands.

§Arguments
  • current - The robot’s current pose
  • reference - The desired trajectory reference point
§Returns

A tuple (v, w) where:

  • v is the commanded linear velocity in m/s
  • w is the commanded angular velocity in rad/s
§Algorithm
  1. Computes errors in the robot frame (e_x, e_y, e_theta)
  2. Calculates adaptive gain k based on reference velocities
  3. Applies RAMSETE equations to compute corrected velocities

Trait Implementations§

Source§

impl Clone for RamseteController

Source§

fn clone(&self) -> RamseteController

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for RamseteController

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Copy for RamseteController

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

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

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

fn is_in_subset(&self) -> bool

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

fn to_subset_unchecked(&self) -> SS

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

fn from_subset(element: &SS) -> SP

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

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.