Struct State 

pub struct State<S: UserState> { /* private fields */ }

The state of the [trellis] solver

This contains generic fields common to all solvers, as well as a user-defined state S which contains application specific fields.

Implementations

impl<S> State<S>

where S: UserState, <S as UserState>::Float: FloatCore,

pub fn terminate_due_to(self, reason: Cause) -> Self

Terminates the solver for Cause

pub fn take_specific(&mut self) -> S

Removes the specific state from the state and returns it

pub fn relative_tolerance(self, relative_tolerance: S::Float) -> Self

Set the relative tolerance target

pub fn absolute_tolerance(self, absolute_tolerance: S::Float) -> Self

Set the relative tolerance target

pub fn max_iters(self, max_iter: usize) -> Self

Set the maximum allowable iteration count

pub fn set_specific(self, specific: S) -> Self

Set the internal state object