Skip to main content

DiscretePid

Struct DiscretePid 

Source
pub struct DiscretePid {
    pub kp: f64,
    pub ki: f64,
    pub kd: f64,
    pub n: f64,
    pub period: f64,
    pub method: DiscreteIntegrationMethod,
}
Expand description

A discrete PID’s own configuration — kp/ki/kd the usual gains, n the derivative filter coefficient (this codebase’s own existing name for the concept the source manual calls Kf — same idea, kept consistent with the continuous crate::Pid’s own field name rather than importing a second spelling for it), period the sample period T baked in at construction (from the declaring block’s own SampleTimeSpec::Periodic, not a separate netlist field — the discretized recursion’s own coefficients need the same period the block is scheduled at, so there is exactly one place to declare it).

Fields§

§kp: f64§ki: f64§kd: f64§n: f64§period: f64§method: DiscreteIntegrationMethod

Implementations§

Source§

impl DiscretePid

Source

pub fn step(&self, state: &mut DiscretePidState, e: f64) -> f64

One step: given this step’s own error e, advances state in place and returns the unsaturated controller output u[k] = Kp*e[k] + Ki*int_output[k] + Kd*v[k] — the caller (dae-runtime) applies anti-windup clamping on top of this, the same tentative-step/reject logic the continuous Pid’s own arm already uses (this method itself has no notion of saturation limits at all).

Trait Implementations§

Source§

impl Clone for DiscretePid

Source§

fn clone(&self) -> DiscretePid

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 DiscretePid

Source§

impl Debug for DiscretePid

Source§

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

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

impl PartialEq for DiscretePid

Source§

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

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.