Skip to main content

PidGains

Struct PidGains 

Source
pub struct PidGains {
    pub kp: f64,
    pub ki: f64,
    pub kd: f64,
    pub integral_max: f64,
}
Expand description

PID controller gains for frame time regulation.

§Mathematical Model

Let e_t = frame_time_t − target be the error signal at frame t.

The PID control output is:

u_t = Kp * e_t  +  Ki * Σ_{j=0..t} e_j  +  Kd * (e_t − e_{t−1})

The output u_t maps to degradation level adjustments:

  • u_t > degrade_threshold → degrade one level (if e-process permits)
  • u_t < -upgrade_threshold → upgrade one level
  • otherwise → hold current level

§Gain Selection Rationale

For a 16ms target (60fps):

  • Kp = 0.5: Proportional response. Moderate gain avoids oscillation while still reacting to single-frame overruns.
  • Ki = 0.05: Integral term. Low gain eliminates steady-state error over ~20 frames without integral windup issues.
  • Kd = 0.2: Derivative term. Provides anticipatory damping to reduce overshoot when frame times are trending upward.

§Stability Analysis

For a first-order plant model G(s) = 1/(τs + 1) with τ ≈ 1 frame:

  • Phase margin > 45° with these gains
  • Gain margin > 6dB
  • Settling time ≈ 8-12 frames for a step disturbance

Anti-windup: integral term is clamped to [-integral_max, +integral_max] to prevent runaway accumulation during sustained overload.

Fields§

§kp: f64

Proportional gain. Reacts to current error magnitude.

§ki: f64

Integral gain. Eliminates steady-state error over time.

§kd: f64

Derivative gain. Dampens oscillations by reacting to error rate.

§integral_max: f64

Maximum absolute value of the integral accumulator (anti-windup).

Trait Implementations§

Source§

impl Clone for PidGains

Source§

fn clone(&self) -> PidGains

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 PidGains

Source§

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

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

impl Default for PidGains

Source§

fn default() -> Self

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

impl PartialEq for PidGains

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for PidGains

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