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

use std::ffi::c_char;

use crate::ffi_apis::common::from_json_string;
use crate::ffi_apis::common::to_json_string;
use crate::symbolic::core::Expr;
use crate::symbolic::vector::Vector;
use crate::symbolic::vector::curl;
use crate::symbolic::vector::divergence;
use crate::symbolic::vector::gradient;

/// Computes the magnitude of a vector.
/// Takes a JSON string representing a `Vector`.
/// Returns a JSON string representing the `Expr` of its magnitude.
#[unsafe(no_mangle)]
pub extern "C" fn rssn_json_vector_magnitude(v_json: *const c_char) -> *mut c_char {
    let v: Option<Vector> = from_json_string(v_json);

    if let Some(vector) = v {
        let result = vector.magnitude();

        to_json_string(&result)
    } else {
        std::ptr::null_mut()
    }
}

/// Computes the dot product of two vectors.
/// Takes two JSON strings representing `Vector` objects.
/// Returns a JSON string representing the `Expr` of their dot product.
#[unsafe(no_mangle)]
pub extern "C" fn rssn_json_vector_dot(
    v1_json: *const c_char,
    v2_json: *const c_char,
) -> *mut c_char {
    let v1: Option<Vector> = from_json_string(v1_json);

    let v2: Option<Vector> = from_json_string(v2_json);

    match (v1, v2) {
        | (Some(vec1), Some(vec2)) => {
            let result = vec1.dot(&vec2);

            to_json_string(&result)
        },
        | _ => std::ptr::null_mut(),
    }
}

/// Computes the cross product of two vectors.
/// Takes two JSON strings representing `Vector` objects.
/// Returns a JSON string representing the `Vector` of their cross product.
#[unsafe(no_mangle)]
pub extern "C" fn rssn_json_vector_cross(
    v1_json: *const c_char,
    v2_json: *const c_char,
) -> *mut c_char {
    let v1: Option<Vector> = from_json_string(v1_json);

    let v2: Option<Vector> = from_json_string(v2_json);

    match (v1, v2) {
        | (Some(vec1), Some(vec2)) => {
            let result = vec1.cross(&vec2);

            to_json_string(&result)
        },
        | _ => std::ptr::null_mut(),
    }
}

/// Normalizes a vector.
/// Takes a JSON string representing a `Vector`.
/// Returns a JSON string representing the normalized `Vector`.
#[unsafe(no_mangle)]
pub extern "C" fn rssn_json_vector_normalize(v_json: *const c_char) -> *mut c_char {
    let v: Option<Vector> = from_json_string(v_json);

    if let Some(vector) = v {
        let result = vector.normalize();

        to_json_string(&result)
    } else {
        std::ptr::null_mut()
    }
}

/// Computes the gradient of a scalar field.
///
/// Takes a JSON string representing an `Expr` (scalar field) and three C-style strings for the variable names (x, y, z).
/// Returns a JSON string representing the `Vector` of the gradient.
/// Computes the gradient of a scalar field.
/// Takes a JSON string representing an `Expr` (scalar field) and three C-style strings for the variable names (x, y, z).
/// Returns a JSON string representing the `Vector` of the gradient.
#[unsafe(no_mangle)]
pub extern "C" fn rssn_json_vector_gradient(
    scalar_field_json: *const c_char,
    x_var: *const c_char,
    y_var: *const c_char,
    z_var: *const c_char,
) -> *mut c_char {
    let scalar_field: Option<Expr> = from_json_string(scalar_field_json);

    let x_str = unsafe {
        if x_var.is_null() {
            None
        } else {
            std::ffi::CStr::from_ptr(x_var).to_str().ok()
        }
    };

    let y_str = unsafe {
        if y_var.is_null() {
            None
        } else {
            std::ffi::CStr::from_ptr(y_var).to_str().ok()
        }
    };

    let z_str = unsafe {
        if z_var.is_null() {
            None
        } else {
            std::ffi::CStr::from_ptr(z_var).to_str().ok()
        }
    };

    match (scalar_field, x_str, y_str, z_str) {
        | (Some(field), Some(x), Some(y), Some(z)) => {
            let result = gradient(&field, (x, y, z));

            to_json_string(&result)
        },
        | _ => std::ptr::null_mut(),
    }
}

/// Computes the divergence of a vector field.
///
/// Takes a JSON string representing a `Vector` and three C-style strings for the variable names (x, y, z).
/// Returns a JSON string representing the `Expr` of the divergence.
#[unsafe(no_mangle)]
pub extern "C" fn rssn_json_vector_divergence(
    v_json: *const c_char,
    x_var: *const c_char,
    y_var: *const c_char,
    z_var: *const c_char,
) -> *mut c_char {
    let v: Option<Vector> = from_json_string(v_json);

    let x_str = unsafe {
        if x_var.is_null() {
            None
        } else {
            std::ffi::CStr::from_ptr(x_var).to_str().ok()
        }
    };

    let y_str = unsafe {
        if y_var.is_null() {
            None
        } else {
            std::ffi::CStr::from_ptr(y_var).to_str().ok()
        }
    };

    let z_str = unsafe {
        if z_var.is_null() {
            None
        } else {
            std::ffi::CStr::from_ptr(z_var).to_str().ok()
        }
    };

    match (v, x_str, y_str, z_str) {
        | (Some(vector), Some(x), Some(y), Some(z)) => {
            let result = divergence(&vector, (x, y, z));

            to_json_string(&result)
        },
        | _ => std::ptr::null_mut(),
    }
}

/// Computes the curl of a 3D vector field.
///
/// Takes a JSON string representing a `Vector` and three C-style strings for the variable names (x, y, z).
/// Returns a JSON string representing the `Vector` of the curl.
#[unsafe(no_mangle)]
pub extern "C" fn rssn_json_vector_curl(
    v_json: *const c_char,
    x_var: *const c_char,
    y_var: *const c_char,
    z_var: *const c_char,
) -> *mut c_char {
    let v: Option<Vector> = from_json_string(v_json);

    let x_str = unsafe {
        if x_var.is_null() {
            None
        } else {
            std::ffi::CStr::from_ptr(x_var).to_str().ok()
        }
    };

    let y_str = unsafe {
        if y_var.is_null() {
            None
        } else {
            std::ffi::CStr::from_ptr(y_var).to_str().ok()
        }
    };

    let z_str = unsafe {
        if z_var.is_null() {
            None
        } else {
            std::ffi::CStr::from_ptr(z_var).to_str().ok()
        }
    };

    match (v, x_str, y_str, z_str) {
        | (Some(vector), Some(x), Some(y), Some(z)) => {
            let result = curl(&vector, (x, y, z));

            to_json_string(&result)
        },
        | _ => std::ptr::null_mut(),
    }
}