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
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131

//! Handle-based FFI API for thermodynamics functions.

use crate::symbolic::core::Expr;
use crate::symbolic::thermodynamics;

/// Calculates ideal gas Law expression: PV - nRT.
///
/// # Safety
///
/// This function is unsafe because it dereferences raw pointers as part of the FFI boundary.
/// The caller must ensure:
/// 1. All pointer arguments are valid and point to initialized memory.
/// 2. The memory layout of passed structures matches the expected C-ABI layout.
/// 3. Any pointers returned by this function are managed according to the API's ownership rules.
#[unsafe(no_mangle)]
pub unsafe extern "C" fn rssn_ideal_gas_law(
    p: *const Expr,
    v: *const Expr,
    n: *const Expr,
    r: *const Expr,
    t: *const Expr,
) -> *mut Expr {
    unsafe {
        if p.is_null() || v.is_null() || n.is_null() || r.is_null() || t.is_null() {
            return std::ptr::null_mut();
        }

        Box::into_raw(Box::new(thermodynamics::ideal_gas_law(
            &*p, &*v, &*n, &*r, &*t,
        )))
    }
}

/// Calculates enthalpy: U + PV.
///
/// # Safety
///
/// This function is unsafe because it dereferences raw pointers as part of the FFI boundary.
/// The caller must ensure:
/// 1. All pointer arguments are valid and point to initialized memory.
/// 2. The memory layout of passed structures matches the expected C-ABI layout.
/// 3. Any pointers returned by this function are managed according to the API's ownership rules.
#[unsafe(no_mangle)]
pub unsafe extern "C" fn rssn_enthalpy(
    u: *const Expr,
    p: *const Expr,
    v: *const Expr,
) -> *mut Expr {
    unsafe {
        if u.is_null() || p.is_null() || v.is_null() {
            return std::ptr::null_mut();
        }

        Box::into_raw(Box::new(thermodynamics::enthalpy(&*u, &*p, &*v)))
    }
}

/// Calculates Gibbs Free Energy: H - TS.
///
/// # Safety
///
/// This function is unsafe because it dereferences raw pointers as part of the FFI boundary.
/// The caller must ensure:
/// 1. All pointer arguments are valid and point to initialized memory.
/// 2. The memory layout of passed structures matches the expected C-ABI layout.
/// 3. Any pointers returned by this function are managed according to the API's ownership rules.
#[unsafe(no_mangle)]
pub unsafe extern "C" fn rssn_gibbs_free_energy(
    h: *const Expr,
    t: *const Expr,
    s: *const Expr,
) -> *mut Expr {
    unsafe {
        if h.is_null() || t.is_null() || s.is_null() {
            return std::ptr::null_mut();
        }

        Box::into_raw(Box::new(thermodynamics::gibbs_free_energy(&*h, &*t, &*s)))
    }
}

/// Calculates Carnot Efficiency: 1 - Tc/Th.
///
/// # Safety
///
/// This function is unsafe because it dereferences raw pointers as part of the FFI boundary.
/// The caller must ensure:
/// 1. All pointer arguments are valid and point to initialized memory.
/// 2. The memory layout of passed structures matches the expected C-ABI layout.
/// 3. Any pointers returned by this function are managed according to the API's ownership rules.
#[unsafe(no_mangle)]
pub unsafe extern "C" fn rssn_carnot_efficiency(
    tc: *const Expr,
    th: *const Expr,
) -> *mut Expr {
    unsafe {
        if tc.is_null() || th.is_null() {
            return std::ptr::null_mut();
        }

        Box::into_raw(Box::new(thermodynamics::carnot_efficiency(&*tc, &*th)))
    }
}

/// Calculates Boltzmann Distribution.
///
/// # Safety
///
/// This function is unsafe because it dereferences raw pointers as part of the FFI boundary.
/// The caller must ensure:
/// 1. All pointer arguments are valid and point to initialized memory.
/// 2. The memory layout of passed structures matches the expected C-ABI layout.
/// 3. Any pointers returned by this function are managed according to the API's ownership rules.
#[unsafe(no_mangle)]
pub unsafe extern "C" fn rssn_boltzmann_distribution(
    energy: *const Expr,
    temperature: *const Expr,
    partition_function: *const Expr,
) -> *mut Expr {
    unsafe {
        if energy.is_null() || temperature.is_null() || partition_function.is_null() {
            return std::ptr::null_mut();
        }

        Box::into_raw(Box::new(thermodynamics::boltzmann_distribution(
            &*energy,
            &*temperature,
            &*partition_function,
        )))
    }
}