Struct Solution

pub struct Solution<T, V, D>
where
    T: Real,
    V: State<T>,
    D: CallBackData,
{
    pub t: Vec<T>,
    pub y: Vec<V>,
    pub status: Status<T, V, D>,
    pub evals: Evals,
    pub steps: Steps,
    pub timer: Timer<T>,
}

Solution of returned by differential equation solvers

Fields

• y - Outputted dependent variable points.
• t - Outputted independent variable points.
• status - Status of the solver.
• evals - Number of function evaluations.
• steps - Number of steps.
• rejected_steps - Number of rejected steps.
• accepted_steps - Number of accepted steps.
• timer - Timer for tracking solution time.

Fields

t: Vec<T>

Outputted independent variable points.

y: Vec<V>

Outputted dependent variable points.

status: Status<T, V, D>

Status of the solver.

evals: Evals

Number of function, jacobian, etc evaluations.

steps: Steps

Number of steps taken during the solution.

timer: Timer<T>

Timer for tracking solution time - Running during solving, Completed after finalization

Implementations

impl<T, V, D> Solution<T, V, D>

where T: Real, V: State<T>, D: CallBackData,

pub fn new() -> Self

Creates a new Solution object.

impl<T, V, D> Solution<T, V, D>

where T: Real, V: State<T>, D: CallBackData,

pub fn push(&mut self, t: T, y: V)

Puhes a new point to the solution, e.g. t and y vecs.

Arguments

• t - The time point.
• y - The state vector.

pub fn pop(&mut self) -> Option<(T, V)>

Pops the last point from the solution, e.g. t and y vecs.

Returns

• Option<(T, SMatrix<T, R, C>)> - The last point in the solution.

pub fn truncate(&mut self, index: usize)

Truncates the solution’s (t, y) points to the given index.

Arguments

• index - The index to truncate to.

impl<T, V, D> Solution<T, V, D>

where T: Real, V: State<T>, D: CallBackData,

pub fn into_tuple(self) -> (Vec<T>, Vec<V>)

Simplifies the Solution into a tuple of vectors in form (t, y). By doing so, the Solution will be consumed and the status, evals, steps, rejected_steps, and accepted_steps will be discarded.

Returns

• (Vec<T>, Vec<V) - Tuple of time and state vectors.

pub fn last(&self) -> Result<(&T, &V), Box<dyn Error>>

Returns the last accepted step of the solution in form (t, y).

Returns

• Result<(T, V), Box<dyn std::error::Error>> - Result of time and state vector.

pub fn iter(&self) -> Zip<Iter<'_, T>, Iter<'_, V>>

Returns an iterator over the solution.

Returns

• std::iter::Zip<std::slice::Iter<'_, T>, std::slice::Iter<'_, V>> - An iterator yielding (t, y) tuples.

pub fn to_csv(&self, filename: &str) -> Result<(), Box<dyn Error>>

Creates a CSV file of the solution using standard library functionality.

Note the columns will be named t, y0, y1, …, yN.

Arguments

• filename - Name of the file to save the solution.

Returns

• Result<(), Box<dyn std::error::Error>> - Result of writing the file.

Trait Implementations

impl<T, V, D> Clone for Solution<T, V, D>

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

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

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T, V, D> Debug for Solution<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.

impl<T, V, D> Default for Solution<T, V, D>

where T: Real, V: State<T>, D: CallBackData,

fn default() -> Self

Returns the “default value” for a type.