Struct Controller

Source
pub struct Controller<T> { /* private fields */ }
Expand description

Used for adaptive step size control

Implementations§

Source§

impl<T: FloatNumber> Controller<T>

Source

pub fn new( alpha: T, beta: T, fac_max: T, fac_min: T, h_max: T, safety_factor: T, posneg: T, ) -> Controller<T>

Creates a controller responsible for adaptive step size control.

§Arguments
  • alpha - α coefficient of the PI controller
  • beta - β coefficient of the PI controller
  • fac_max - Maximum factor between two successive steps
  • fac_min - Minimum factor between two successive steps
  • h_max - Maximum step size
  • safety_factor - Safety factor of the PI controller
Source

pub fn accept(&mut self, err: T, h: T, h_new: &mut T) -> bool

Determines if the step must be accepted or rejected and adapts the step size accordingly.

Source

pub fn h_max(&self) -> T

Returns the maximum step size allowed.

Auto Trait Implementations§

§

impl<T> Freeze for Controller<T>
where T: Freeze,

§

impl<T> RefUnwindSafe for Controller<T>
where T: RefUnwindSafe,

§

impl<T> Send for Controller<T>
where T: Send,

§

impl<T> Sync for Controller<T>
where T: Sync,

§

impl<T> Unpin for Controller<T>
where T: Unpin,

§

impl<T> UnwindSafe for Controller<T>
where T: UnwindSafe,

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