rhai-sci 0.2.2

Scientific computing in the Rhai scripting language
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

#![warn(clippy::all)]
#![warn(missing_docs)]
#![warn(clippy::missing_docs_in_private_items)]
#![doc = include_str!("../README.md")]
#![doc = include_str!(concat!(env!("OUT_DIR"), "/rhai-sci-docs.md"))]
#![doc = include_str!("../docs/highlight.html")]

mod patterns;
pub use patterns::*;
use rhai::{def_package, packages::Package, plugin::*, Engine, EvalAltResult};
mod matrices_and_arrays;
pub use matrices_and_arrays::matrix_functions;
mod statistics;
pub use statistics::stats;
mod misc;
pub use misc::misc_functions;
mod cumulative;
pub use cumulative::cum_functions;
mod integration_and_differentiation;
pub use integration_and_differentiation::int_and_diff;
mod assertions;
pub use assertions::assert_functions;
mod constants;
pub use constants::constant_definitions;
mod moving;
pub use moving::moving_functions;
mod sets;
pub use sets::set_functions;
mod validate;
pub use validate::validation_functions;
mod trig;
pub use trig::trig_functions;

def_package! {
    /// Package for scientific computing
    pub SciPackage(lib) {

        combine_with_exported_module!(lib, "rhai_sci_matrix_function", matrix_functions);
        combine_with_exported_module!(lib, "rhai_sci_miscellaneous_functions", misc_functions);
        combine_with_exported_module!(lib, "rhai_sci_basic_stats", stats);
        combine_with_exported_module!(lib, "rhai_sci_cumulative", cum_functions);
        combine_with_exported_module!(lib, "rhai_sci_int_and_diff", int_and_diff);
        combine_with_exported_module!(lib, "rhai_sci_assertions", assert_functions);
        combine_with_exported_module!(lib, "rhai_sci_constants", constant_definitions);
        combine_with_exported_module!(lib, "rhai_sci_sets", set_functions);
        combine_with_exported_module!(lib, "rhai_sci_moving", moving_functions);
        combine_with_exported_module!(lib, "rhai_sci_validation", validation_functions);
        combine_with_exported_module!(lib, "rhai_sci_trig", trig_functions);
    }
}

/// This provides the ability to easily evaluate a line (or lines) of code without explicitly
/// setting up a script engine
/// ```
/// use rhai_sci::eval;
/// use rhai::FLOAT;
/// print!("{:?}", eval::<FLOAT>("let x = max(5, 2); x + min(3, 72)"));
/// ```
pub fn eval<T: Clone + std::marker::Send + std::marker::Sync + 'static>(
    script: &str,
) -> Result<T, Box<EvalAltResult>> {
    let mut engine = Engine::new();
    engine.register_global_module(SciPackage::new().as_shared_module());
    engine.eval::<T>(script)
}