differential_equations

Enum ControlFlag

pub enum ControlFlag<T = f64, V = f64, D = String>where
    T: Real,
    V: State<T>,
    D: CallBackData,{
    Continue,
    ModifyState(T, V),
    Terminate(D),
}

Expand description

Control flag for solver execution flow

ControlFlag is a command to the solver about how to proceed with integration. Used by both event functions and solout functions to control solver execution.

Variants§

Continue

Continue to next step

ModifyState(T, V)

Modify State and continue to next step

Terminate(D)

Terminate solver with the given reason/data

Trait Implementations§

impl<T, V, D> Clone for ControlFlag<T, V, D>
where T: Real + Clone, V: State<T> + Clone, D: CallBackData + Clone,

fn clone(&self) -> ControlFlag<T, V, D>

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

impl<T, V, D> Debug for ControlFlag<T, V, D>
where T: Real + Debug, V: State<T> + Debug, D: CallBackData + Debug,

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

impl<T, V, D> Freeze for ControlFlag<T, V, D>
where T: Freeze, V: Freeze, D: Freeze,

impl<T, V, D> RefUnwindSafe for ControlFlag<T, V, D>
where T: RefUnwindSafe, V: RefUnwindSafe, D: RefUnwindSafe,

impl<T, V, D> Send for ControlFlag<T, V, D>
where V: Send, D: Send,

impl<T, V, D> Sync for ControlFlag<T, V, D>
where V: Sync, D: Sync,

impl<T, V, D> Unpin for ControlFlag<T, V, D>
where T: Unpin, V: Unpin, D: Unpin,

impl<T, V, D> UnwindSafe for ControlFlag<T, V, D>
where T: UnwindSafe, V: UnwindSafe, D: UnwindSafe,

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

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

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> Same for T

type Output = T

Should always be Self

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<T> CallBackData for T
where T: Clone + Debug,