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

//! Bincode-based FFI API for numerical signal processing.

use rustfft::num_complex::Complex;
use serde::Deserialize;

use crate::ffi_apis::common::BincodeBuffer;
use crate::ffi_apis::common::from_bincode_buffer;
use crate::ffi_apis::common::to_bincode_buffer;
use crate::ffi_apis::ffi_api::FfiResult;
use crate::numerical::signal;

#[derive(Deserialize)]
struct FftInput {
    data: Vec<Complex<f64>>,
}

#[derive(Deserialize)]
struct ConvolveInput {
    a: Vec<f64>,
    v: Vec<f64>,
}

/// Computes the Fast Fourier Transform (FFT) of complex data using bincode serialization.
///
/// The FFT converts a signal from time/space domain to frequency domain using the
/// Cooley-Tukey algorithm in O(N log N) time.
///
/// # Arguments
///
/// * `buffer` - A bincode-encoded buffer containing `FftInput` with:
///   - `data`: Array of complex numbers to transform
///
/// # Returns
///
/// A bincode-encoded buffer containing `FfiResult<Vec<Complex<f64>>, String>` with
/// the frequency domain representation.
///
/// # Safety
///
/// This function is unsafe because it receives raw pointers through FFI.
/// The caller must ensure the input buffer contains valid bincode data.
///
/// # 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_num_signal_fft_bincode(buffer: BincodeBuffer) -> BincodeBuffer {
    let mut input: FftInput = match from_bincode_buffer(&buffer) {
        | Some(i) => i,
        | None => {
            return to_bincode_buffer(&FfiResult::<Vec<Complex<f64>>, String> {
                ok: None,
                err: Some("Invalid Bincode input".to_string()),
            });
        },
    };

    let result = signal::fft(&mut input.data);

    let ffi_res = FfiResult {
        ok: Some(result),
        err: None::<String>,
    };

    to_bincode_buffer(&ffi_res)
}

/// Computes the discrete convolution of two signals using bincode serialization.
///
/// The convolution is defined as (a * v)\[n\] = Σ a\[k\]v\[n-k\], representing the
/// combined effect of two systems or filtering operation.
///
/// # Arguments
///
/// * `buffer` - A bincode-encoded buffer containing `ConvolveInput` with:
///   - `a`: First signal array
///   - `v`: Second signal array (kernel)
///
/// # Returns
///
/// A bincode-encoded buffer containing `FfiResult<Vec<f64>, String>` with
/// the convolution result.
///
/// # Safety
///
/// This function is unsafe because it receives raw pointers through FFI.
/// The caller must ensure the input buffer contains valid bincode data.
///
/// # 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_num_signal_convolve_bincode(buffer: BincodeBuffer) -> BincodeBuffer {
    let input: ConvolveInput = match from_bincode_buffer(&buffer) {
        | Some(i) => i,
        | None => {
            return to_bincode_buffer(&FfiResult::<Vec<f64>, String> {
                ok: None,
                err: Some("Invalid Bincode input".to_string()),
            });
        },
    };

    let result = signal::convolve(&input.a, &input.v);

    let ffi_res = FfiResult {
        ok: Some(result),
        err: None::<String>,
    };

    to_bincode_buffer(&ffi_res)
}

/// Computes the cross-correlation of two signals using bincode serialization.
///
/// Cross-correlation measures similarity between signals as a function of lag:
/// (a ⋆ v)\[n\] = Σ a\[k\]v\[n+k\].
///
/// # Arguments
///
/// * `buffer` - A bincode-encoded buffer containing `ConvolveInput` with:
///   - `a`: First signal array
///   - `v`: Second signal array
///
/// # Returns
///
/// A bincode-encoded buffer containing `FfiResult<Vec<f64>, String>` with
/// the cross-correlation result.
///
/// # Safety
///
/// This function is unsafe because it receives raw pointers through FFI.
/// The caller must ensure the input buffer contains valid bincode data.
///
/// # 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_num_signal_cross_correlation_bincode(
    buffer: BincodeBuffer
) -> BincodeBuffer {
    let input: ConvolveInput = match from_bincode_buffer(&buffer) {
        | Some(i) => i,
        | None => {
            return to_bincode_buffer(&FfiResult::<Vec<f64>, String> {
                ok: None,
                err: Some("Invalid Bincode input".to_string()),
            });
        },
    };

    let result = signal::cross_correlation(&input.a, &input.v);

    let ffi_res = FfiResult {
        ok: Some(result),
        err: None::<String>,
    };

    to_bincode_buffer(&ffi_res)
}