Skip to main content

IkConfig

Struct IkConfig 

Source
pub struct IkConfig {
    pub max_iterations: usize,
    pub tolerance: f64,
    pub damping: f64,
    pub min_damping: f64,
    pub max_damping: f64,
    pub step_scale: f64,
    pub respect_limits: bool,
    pub locked: Vec<usize>,
}
Expand description

Solver settings. IkConfig::default is tuned for robot-arm-sized problems: metres and radians, goals within reach, a seed that is not exactly at a singularity.

Fields§

§max_iterations: usize

Maximum Levenberg–Marquardt iterations, counting rejected trials.

§tolerance: f64

Convergence threshold on the largest single residual component — metres for position rows, radians for orientation rows.

§damping: f64

Initial damping λ. Larger is slower and steadier.

§min_damping: f64

Floor on λ. Keeps the normal equations conditioned near singularities; zero is legal but asks for a numerically exact rank decision.

§max_damping: f64

Ceiling on λ. Once damping has to exceed this to make progress, the solver has stalled and returns.

§step_scale: f64

Fraction of the computed step to take. 1.0 is the LM step; lower it only when the model has joints whose Jacobian changes violently.

§respect_limits: bool

Enforce single-DOF joint limits by clamping after each accepted step.

§locked: Vec<usize>

Velocity-index DOFs to hold fixed (indices into 0..model.nv).

Trait Implementations§

Source§

impl Clone for IkConfig

Source§

fn clone(&self) -> IkConfig

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for IkConfig

Source§

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

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

impl Default for IkConfig

Source§

fn default() -> IkConfig

Returns the “default value” for a type. Read more
Source§

impl PartialEq for IkConfig

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for IkConfig

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

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.