rssn 0.2.9

A comprehensive scientific computing library for Rust, aiming for feature parity with NumPy and SymPy.
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
65
66
67
68
69

use std::sync::Arc;
use std::sync::Condvar;
use std::sync::Mutex;
use std::sync::atomic::AtomicBool;

use serde::Deserialize;
use serde::Serialize;

use crate::compute::state::State;
use crate::symbolic::core::Expr;

// Using String for now, but could be a more complex type
/// The type of the result of a computation. Currently a String.
pub type Value = String;

/// The status of a computation.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
pub enum ComputationStatus {
    /// The computation is pending execution.
    Pending,
    /// The computation is currently running.
    Running,
    /// The computation is paused.
    Paused,
    /// The computation has completed successfully.
    Completed,
    /// The computation failed with an error message.
    Failed(String),
}

/// Represents the progress of a computation.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ComputationProgress {
    /// The percentage of completion (0.0 to 100.0).
    pub percentage: f32,
    /// A description of the current step.
    pub description: String,
}

/// Represents a computation task.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Computation {
    /// A unique identifier for the computation.
    pub id: String,
    /// The expression being computed.
    pub expr: Arc<Expr>,
    /// The current status of the computation.
    pub status: ComputationStatus,
    /// The current progress of the computation.
    pub progress: ComputationProgress,
    /// The result of the computation, if available.
    pub result: Option<Value>,
    /// The state associated with the computation.
    pub state: State,
    /// Synchronization primitives for pausing/resuming.
    #[serde(skip, default = "default_pause")]
    pub pause: Arc<(Mutex<bool>, Condvar)>,
    /// A signal to cancel the computation.
    #[serde(skip, default = "default_cancel_signal")]
    pub cancel_signal: Arc<AtomicBool>,
}

pub(crate) fn default_pause() -> Arc<(Mutex<bool>, Condvar)> {
    Arc::new((Mutex::new(false), Condvar::new()))
}

fn default_cancel_signal() -> Arc<AtomicBool> {
    Arc::new(AtomicBool::new(false))
}