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

use crate::compute::computation::ComputationProgress;
use crate::compute::state::State;

/// A trait for objects that can perform a computation.
///
/// Implementors of this trait represent a unit of work that can be executed
/// by the compute engine.
pub trait Computable {
    /// Performs the computation.
    ///
    /// # Arguments
    /// * `state` - The current state of the computation.
    /// * `progress` - A mutable reference to update the progress.
    ///
    /// # Returns
    /// * `Result<(), String>` - `Ok(())` if successful, or `Err(String)` with an error message.
    ///
    /// # Errors
    /// Returns an error string if the computation fails.
    fn compute(
        &self,
        state: &mut State,
        progress: &mut ComputationProgress,
    ) -> Result<(), String>;
}