Struct Solution

pub struct Solution<T, const R: usize, const C: usize, D>
where
    T: Real,
    D: CallBackData,
{
    pub t: Vec<T>,
    pub y: Vec<SMatrix<T, R, C>>,
    pub status: Status<T, R, C, D>,
    pub evals: usize,
    pub steps: usize,
    pub rejected_steps: usize,
    pub accepted_steps: usize,
    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<SMatrix<T, R, C>>

Outputted dependent variable points.

status: Status<T, R, C, D>

Status of the solver.

evals: usize

Number of function evaluations.

steps: usize

Total number of steps taken by the solver.

rejected_steps: usize

Number of rejected steps where the solution step-size had to be reduced.

accepted_steps: usize

Number of accepted steps where the solution moved closer to tf.

timer: Timer<T>

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

Implementations

impl<T, const R: usize, const C: usize, D> Solution<T, R, C, D>

where T: Real, D: CallBackData,

pub fn new() -> Self

Creates a new Solution object.

impl<T, const R: usize, const C: usize, D> Solution<T, R, C, D>

where T: Real, D: CallBackData,

pub fn push(&mut self, t: T, y: SMatrix<T, R, C>)

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, SMatrix<T, R, C>)>

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, const R: usize, const C: usize, D> Solution<T, R, C, D>

where T: Real, D: CallBackData,

pub fn into_tuple(self) -> (Vec<T>, Vec<SMatrix<T, R, C>>)

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, &SMatrix<T, R, C>), 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<'_, SMatrix<T, R, C>>>

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, const R: usize, const C: usize, D> Clone for Solution<T, R, C, D>

where T: Real + Clone, D: CallBackData + Clone,

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T, const R: usize, const C: usize, D> Debug for Solution<T, R, C, D>

where T: Real + Debug, D: CallBackData + Debug,

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

Formats the value using the given formatter.