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
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
//! Handle-based FFI API for symbolic vector calculus functions.

use std::ffi::CStr;
use std::ffi::CString;
use std::os::raw::c_char;

use crate::input::parser::parse_expr;
use crate::symbolic::core::Expr;
use crate::symbolic::vector::Vector;
use crate::symbolic::vector_calculus::ParametricCurve;
use crate::symbolic::vector_calculus::ParametricSurface;
use crate::symbolic::vector_calculus::Volume;
use crate::symbolic::vector_calculus::line_integral_scalar;
use crate::symbolic::vector_calculus::line_integral_vector;
use crate::symbolic::vector_calculus::surface_integral;
use crate::symbolic::vector_calculus::volume_integral;

// Helper function to parse expression from C string
pub(crate) fn parse_expr_from_cstr(ptr: *const c_char) -> Option<Expr> {
    if ptr.is_null() {
        return None;
    }

    unsafe {
        let c_str = match CStr::from_ptr(ptr).to_str() {
            | Ok(s) => s,
            | Err(_) => {
                return None;
            },
        };

        match parse_expr(c_str) {
            | Ok(("", expr)) => Some(expr),
            | _ => None,
        }
    }
}

// ===== ParametricCurve Handle Functions =====

/// Creates a new `ParametricCurve`.
#[unsafe(no_mangle)]
pub extern "C" fn rssn_parametric_curve_new(
    r_x: *const c_char,
    r_y: *const c_char,
    r_z: *const c_char,
    t_var: *const c_char,
    t_lower: *const c_char,
    t_upper: *const c_char,
) -> *mut ParametricCurve {
    let r_x_expr = match parse_expr_from_cstr(r_x) {
        | Some(e) => e,
        | None => return std::ptr::null_mut(),
    };

    let r_y_expr = match parse_expr_from_cstr(r_y) {
        | Some(e) => e,
        | None => return std::ptr::null_mut(),
    };

    let r_z_expr = match parse_expr_from_cstr(r_z) {
        | Some(e) => e,
        | None => return std::ptr::null_mut(),
    };

    let t_lower_expr = match parse_expr_from_cstr(t_lower) {
        | Some(e) => e,
        | None => return std::ptr::null_mut(),
    };

    let t_upper_expr = match parse_expr_from_cstr(t_upper) {
        | Some(e) => e,
        | None => return std::ptr::null_mut(),
    };

    let t_var_str = unsafe {
        if t_var.is_null() {
            return std::ptr::null_mut();
        }

        match CStr::from_ptr(t_var).to_str() {
            | Ok(s) => s.to_string(),
            | Err(_) => return std::ptr::null_mut(),
        }
    };

    let curve = ParametricCurve {
        r: Vector::new(r_x_expr, r_y_expr, r_z_expr),
        t_var: t_var_str,
        t_bounds: (t_lower_expr, t_upper_expr),
    };

    Box::into_raw(Box::new(curve))
}

/// Frees a `ParametricCurve` handle.
#[unsafe(no_mangle)]
pub extern "C" fn rssn_parametric_curve_free(curve: *mut ParametricCurve) {
    if !curve.is_null() {
        unsafe {
            let _ = Box::from_raw(curve);
        }
    }
}

// ===== ParametricSurface Handle Functions =====

/// Creates a new `ParametricSurface`.
#[unsafe(no_mangle)]
pub extern "C" fn rssn_parametric_surface_new(
    r_x: *const c_char,
    r_y: *const c_char,
    r_z: *const c_char,
    u_var: *const c_char,
    u_lower: *const c_char,
    u_upper: *const c_char,
    v_var: *const c_char,
    v_lower: *const c_char,
    v_upper: *const c_char,
) -> *mut ParametricSurface {
    let r_x_expr = match parse_expr_from_cstr(r_x) {
        | Some(e) => e,
        | None => return std::ptr::null_mut(),
    };

    let r_y_expr = match parse_expr_from_cstr(r_y) {
        | Some(e) => e,
        | None => return std::ptr::null_mut(),
    };

    let r_z_expr = match parse_expr_from_cstr(r_z) {
        | Some(e) => e,
        | None => return std::ptr::null_mut(),
    };

    let u_lower_expr = match parse_expr_from_cstr(u_lower) {
        | Some(e) => e,
        | None => return std::ptr::null_mut(),
    };

    let u_upper_expr = match parse_expr_from_cstr(u_upper) {
        | Some(e) => e,
        | None => return std::ptr::null_mut(),
    };

    let v_lower_expr = match parse_expr_from_cstr(v_lower) {
        | Some(e) => e,
        | None => return std::ptr::null_mut(),
    };

    let v_upper_expr = match parse_expr_from_cstr(v_upper) {
        | Some(e) => e,
        | None => return std::ptr::null_mut(),
    };

    let (u_var_str, v_var_str) = unsafe {
        if u_var.is_null() || v_var.is_null() {
            return std::ptr::null_mut();
        }

        let u = match CStr::from_ptr(u_var).to_str() {
            | Ok(s) => s.to_string(),
            | Err(_) => return std::ptr::null_mut(),
        };

        let v = match CStr::from_ptr(v_var).to_str() {
            | Ok(s) => s.to_string(),
            | Err(_) => return std::ptr::null_mut(),
        };

        (u, v)
    };

    let surface = ParametricSurface {
        r: Vector::new(r_x_expr, r_y_expr, r_z_expr),
        u_var: u_var_str,
        u_bounds: (u_lower_expr, u_upper_expr),
        v_var: v_var_str,
        v_bounds: (v_lower_expr, v_upper_expr),
    };

    Box::into_raw(Box::new(surface))
}

/// Frees a `ParametricSurface` handle.
#[unsafe(no_mangle)]
pub extern "C" fn rssn_parametric_surface_free(surface: *mut ParametricSurface) {
    if !surface.is_null() {
        unsafe {
            let _ = Box::from_raw(surface);
        }
    }
}

// ===== Volume Handle Functions =====

/// Creates a new Volume.
#[unsafe(no_mangle)]
pub extern "C" fn rssn_volume_new(
    z_lower: *const c_char,
    z_upper: *const c_char,
    y_lower: *const c_char,
    y_upper: *const c_char,
    x_lower: *const c_char,
    x_upper: *const c_char,
    x_var: *const c_char,
    y_var: *const c_char,
    z_var: *const c_char,
) -> *mut Volume {
    let z_lower_expr = match parse_expr_from_cstr(z_lower) {
        | Some(e) => e,
        | None => return std::ptr::null_mut(),
    };

    let z_upper_expr = match parse_expr_from_cstr(z_upper) {
        | Some(e) => e,
        | None => return std::ptr::null_mut(),
    };

    let y_lower_expr = match parse_expr_from_cstr(y_lower) {
        | Some(e) => e,
        | None => return std::ptr::null_mut(),
    };

    let y_upper_expr = match parse_expr_from_cstr(y_upper) {
        | Some(e) => e,
        | None => return std::ptr::null_mut(),
    };

    let x_lower_expr = match parse_expr_from_cstr(x_lower) {
        | Some(e) => e,
        | None => return std::ptr::null_mut(),
    };

    let x_upper_expr = match parse_expr_from_cstr(x_upper) {
        | Some(e) => e,
        | None => return std::ptr::null_mut(),
    };

    let (x_var_str, y_var_str, z_var_str) = unsafe {
        if x_var.is_null() || y_var.is_null() || z_var.is_null() {
            return std::ptr::null_mut();
        }

        let x = match CStr::from_ptr(x_var).to_str() {
            | Ok(s) => s.to_string(),
            | Err(_) => return std::ptr::null_mut(),
        };

        let y = match CStr::from_ptr(y_var).to_str() {
            | Ok(s) => s.to_string(),
            | Err(_) => return std::ptr::null_mut(),
        };

        let z = match CStr::from_ptr(z_var).to_str() {
            | Ok(s) => s.to_string(),
            | Err(_) => return std::ptr::null_mut(),
        };

        (x, y, z)
    };

    let volume = Volume {
        z_bounds: (z_lower_expr, z_upper_expr),
        y_bounds: (y_lower_expr, y_upper_expr),
        x_bounds: (x_lower_expr, x_upper_expr),
        vars: (x_var_str, y_var_str, z_var_str),
    };

    Box::into_raw(Box::new(volume))
}

/// Frees a Volume handle.
#[unsafe(no_mangle)]
pub extern "C" fn rssn_volume_free(volume: *mut Volume) {
    if !volume.is_null() {
        unsafe {
            let _ = Box::from_raw(volume);
        }
    }
}

// ===== Vector Calculus Operations =====

/// Computes the line integral of a scalar field along a curve.
#[unsafe(no_mangle)]
pub extern "C" fn rssn_line_integral_scalar(
    scalar_field: *const c_char,
    curve: *const ParametricCurve,
) -> *mut c_char {
    if curve.is_null() {
        return std::ptr::null_mut();
    }

    let field_expr = match parse_expr_from_cstr(scalar_field) {
        | Some(e) => e,
        | None => return std::ptr::null_mut(),
    };

    unsafe {
        let curve_ref = &*curve;

        let result = line_integral_scalar(&field_expr, curve_ref);

        let result_str = format!("{result}");

        match CString::new(result_str) {
            | Ok(c_str) => c_str.into_raw(),
            | Err(_) => std::ptr::null_mut(),
        }
    }
}

/// Computes the line integral of a vector field along a curve.
#[unsafe(no_mangle)]
pub extern "C" fn rssn_line_integral_vector(
    field_x: *const c_char,
    field_y: *const c_char,
    field_z: *const c_char,
    curve: *const ParametricCurve,
) -> *mut c_char {
    if curve.is_null() {
        return std::ptr::null_mut();
    }

    let field_x_expr = match parse_expr_from_cstr(field_x) {
        | Some(e) => e,
        | None => return std::ptr::null_mut(),
    };

    let field_y_expr = match parse_expr_from_cstr(field_y) {
        | Some(e) => e,
        | None => return std::ptr::null_mut(),
    };

    let field_z_expr = match parse_expr_from_cstr(field_z) {
        | Some(e) => e,
        | None => return std::ptr::null_mut(),
    };

    unsafe {
        let field = Vector::new(field_x_expr, field_y_expr, field_z_expr);

        let curve_ref = &*curve;

        let result = line_integral_vector(&field, curve_ref);

        let result_str = format!("{result}");

        match CString::new(result_str) {
            | Ok(c_str) => c_str.into_raw(),
            | Err(_) => std::ptr::null_mut(),
        }
    }
}

/// Computes the surface integral (flux) of a vector field.
#[unsafe(no_mangle)]
pub extern "C" fn rssn_surface_integral(
    field_x: *const c_char,
    field_y: *const c_char,
    field_z: *const c_char,
    surface: *const ParametricSurface,
) -> *mut c_char {
    if surface.is_null() {
        return std::ptr::null_mut();
    }

    let field_x_expr = match parse_expr_from_cstr(field_x) {
        | Some(e) => e,
        | None => return std::ptr::null_mut(),
    };

    let field_y_expr = match parse_expr_from_cstr(field_y) {
        | Some(e) => e,
        | None => return std::ptr::null_mut(),
    };

    let field_z_expr = match parse_expr_from_cstr(field_z) {
        | Some(e) => e,
        | None => return std::ptr::null_mut(),
    };

    unsafe {
        let field = Vector::new(field_x_expr, field_y_expr, field_z_expr);

        let surface_ref = &*surface;

        let result = surface_integral(&field, surface_ref);

        let result_str = format!("{result}");

        match CString::new(result_str) {
            | Ok(c_str) => c_str.into_raw(),
            | Err(_) => std::ptr::null_mut(),
        }
    }
}

/// Computes the volume integral of a scalar field.
#[unsafe(no_mangle)]
pub extern "C" fn rssn_volume_integral(
    scalar_field: *const c_char,
    volume: *const Volume,
) -> *mut c_char {
    if volume.is_null() {
        return std::ptr::null_mut();
    }

    let field_expr = match parse_expr_from_cstr(scalar_field) {
        | Some(e) => e,
        | None => return std::ptr::null_mut(),
    };

    unsafe {
        let volume_ref = &*volume;

        let result = volume_integral(&field_expr, volume_ref);

        let result_str = format!("{result}");

        match CString::new(result_str) {
            | Ok(c_str) => c_str.into_raw(),
            | Err(_) => std::ptr::null_mut(),
        }
    }
}