Skip to main content

Coefficients

Struct Coefficients 

Source
#[repr(C)]
pub struct Coefficients { pub kp: i32, pub ki_period: i32, pub derivative_decay: i32, pub derivative_gain: i32, pub position_gain: i32, pub velocity_gain: i32, pub reference_gain: i32, pub output_min: i32, pub output_max: i32, pub integral_min: i32, pub integral_max: i32, }
Expand description

C-layout signed Q8.24 coefficients and output/integral bounds.

Fields§

§kp: i32

Proportional error gain, nonnegative.

§ki_period: i32

Integral gain times sample period, nonnegative.

§derivative_decay: i32

Filter decay in the inclusive interval [0, 2^24].

§derivative_gain: i32

Filtered derivative gain on the measurement difference, nonnegative.

§position_gain: i32

Discrete LQR position state feedback.

§velocity_gain: i32

Discrete LQR velocity state feedback; zero for the scalar thermal model.

§reference_gain: i32

Steady-state reference prefilter gain.

§output_min: i32

Minimum actuator command.

§output_max: i32

Maximum actuator command.

§integral_min: i32

Minimum PID integral state.

§integral_max: i32

Maximum PID integral state.

Implementations§

Source§

impl Coefficients

Source

pub fn validate(&self) -> Result<(), InvalidCoefficients>

Check bounds, nonnegative PID gains and stable derivative filter decay.

Trait Implementations§

Source§

impl Clone for Coefficients

Source§

fn clone(&self) -> Coefficients

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 Copy for Coefficients

Source§

impl Debug for Coefficients

Source§

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

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

impl Eq for Coefficients

Source§

impl PartialEq for Coefficients

Source§

fn eq(&self, other: &Coefficients) -> 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 Coefficients

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, 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.