sciforge 0.0.3

A comprehensive scientific computing library in pure Rust with zero dependencies
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64

use super::integrator::IntegrationMethod;

/// Output of a simulation run.
pub struct SimulationResult {
    /// Time points.
    pub times: Vec<f64>,
    /// State vectors at each time point.
    pub states: Vec<Vec<f64>>,
    /// Number of state dimensions.
    pub dimension: usize,
    /// Integration method used.
    pub method: IntegrationMethod,
    /// Number of steps taken.
    pub steps_taken: usize,
}

impl SimulationResult {
    /// Returns the last state vector.
    pub fn final_state(&self) -> Option<&[f64]> {
        self.states.last().map(|v| v.as_slice())
    }

    /// Returns the state vector at the given index.
    pub fn state_at(&self, index: usize) -> Option<&[f64]> {
        self.states.get(index).map(|v| v.as_slice())
    }

    /// Returns the time at the given index.
    pub fn time_at(&self, index: usize) -> Option<f64> {
        self.times.get(index).copied()
    }

    /// Number of recorded time steps.
    pub fn len(&self) -> usize {
        self.times.len()
    }

    /// Returns `true` if no steps were recorded.
    pub fn is_empty(&self) -> bool {
        self.times.is_empty()
    }

    /// Extracts the time series for a single dimension.
    pub fn column(&self, dim_index: usize) -> Vec<f64> {
        self.states
            .iter()
            .filter_map(|s| s.get(dim_index).copied())
            .collect()
    }

    /// Returns the maximum value in the given dimension.
    pub fn max_of(&self, dim_index: usize) -> f64 {
        self.column(dim_index)
            .into_iter()
            .fold(f64::NEG_INFINITY, f64::max)
    }

    /// Returns the minimum value in the given dimension.
    pub fn min_of(&self, dim_index: usize) -> f64 {
        self.column(dim_index)
            .into_iter()
            .fold(f64::INFINITY, f64::min)
    }
}