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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202

//! JSON-based FFI API for symbolic elementary functions.

use std::os::raw::c_char;

use crate::ffi_apis::common::from_json_string;
use crate::ffi_apis::common::to_c_string;
use crate::ffi_apis::common::to_json_string;
use crate::symbolic::core::Expr;
use crate::symbolic::elementary;

/// Creates a sine expression from JSON: sin(expr).
///
/// # Arguments
/// * `json_expr` - JSON-serialized Expr
///
/// # Returns
/// JSON-serialized Expr or null on error
///
/// # 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_sin_json(json_expr: *const c_char) -> *mut c_char {
    let expr: Expr = match from_json_string(json_expr) {
        | Some(e) => e,
        | None => return std::ptr::null_mut(),
    };

    to_json_string(&elementary::sin(expr))
}

/// Creates a cosine expression from JSON: cos(expr).
///
/// # 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_cos_json(json_expr: *const c_char) -> *mut c_char {
    let expr: Expr = match from_json_string(json_expr) {
        | Some(e) => e,
        | None => return std::ptr::null_mut(),
    };

    to_json_string(&elementary::cos(expr))
}

/// Creates a tangent expression from JSON: tan(expr).
///
/// # 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_tan_json(json_expr: *const c_char) -> *mut c_char {
    let expr: Expr = match from_json_string(json_expr) {
        | Some(e) => e,
        | None => return std::ptr::null_mut(),
    };

    to_json_string(&elementary::tan(expr))
}

/// Creates an exponential expression from JSON: e^(expr).
///
/// # 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_exp_json(json_expr: *const c_char) -> *mut c_char {
    let expr: Expr = match from_json_string(json_expr) {
        | Some(e) => e,
        | None => return std::ptr::null_mut(),
    };

    to_json_string(&elementary::exp(expr))
}

/// Creates a natural logarithm expression from JSON: ln(expr).
///
/// # 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_ln_json(json_expr: *const c_char) -> *mut c_char {
    let expr: Expr = match from_json_string(json_expr) {
        | Some(e) => e,
        | None => return std::ptr::null_mut(),
    };

    to_json_string(&elementary::ln(expr))
}

/// Creates a square root expression from JSON: sqrt(expr).
///
/// # 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_sqrt_json(json_expr: *const c_char) -> *mut c_char {
    let expr: Expr = match from_json_string(json_expr) {
        | Some(e) => e,
        | None => return std::ptr::null_mut(),
    };

    to_json_string(&elementary::sqrt(expr))
}

/// Creates a power expression from JSON: base^exp.
///
/// # Arguments
/// * `json_base` - JSON-serialized base Expr
/// * `json_exp` - JSON-serialized exponent Expr
///
/// # 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_pow_json(
    json_base: *const c_char,
    json_exp: *const c_char,
) -> *mut c_char {
    let base: Expr = match from_json_string(json_base) {
        | Some(e) => e,
        | None => return std::ptr::null_mut(),
    };

    let exp: Expr = match from_json_string(json_exp) {
        | Some(e) => e,
        | None => return std::ptr::null_mut(),
    };

    to_json_string(&elementary::pow(base, exp))
}

/// Returns Pi as JSON.
#[unsafe(no_mangle)]
pub extern "C" fn rssn_pi_json() -> *mut c_char {
    to_json_string(&elementary::pi())
}

/// Returns Euler's number (e) as JSON.
#[unsafe(no_mangle)]
pub extern "C" fn rssn_e_json() -> *mut c_char {
    to_json_string(&elementary::e())
}

/// Expands a symbolic expression from JSON.
///
/// # 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_expand_json(json_expr: *const c_char) -> *mut c_char {
    let expr: Expr = match from_json_string(json_expr) {
        | Some(e) => e,
        | None => return std::ptr::null_mut(),
    };

    to_json_string(&elementary::expand(expr))
}

/// Computes binomial coefficient C(n, k) and returns as JSON string.
#[unsafe(no_mangle)]
pub extern "C" fn rssn_binomial_coefficient_json(
    n: usize,
    k: usize,
) -> *mut c_char {
    let result = elementary::binomial_coefficient(n, k);

    to_c_string(format!("{{\"result\":\"{result}\"}}"))
}