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

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

use std::ptr;

use rustfft::num_complex::Complex;

use crate::ffi_apis::ffi_api::update_last_error;
use crate::numerical::matrix::Matrix;
use crate::numerical::signal;

/// Computes the FFT and returns a `Matrix<Complex<f64>` as a `Matrix<f64>` (real, imag interleaved).
///
/// # 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(
    real: *const f64,
    imag: *const f64,
    len: usize,
) -> *mut Matrix<f64> {
    unsafe {
        if real.is_null() || imag.is_null() {
            update_last_error(
                "Null pointer passed to \
             rssn_num_signal_fft"
                    .to_string(),
            );

            return ptr::null_mut();
        }

        let mut input: Vec<Complex<f64>> = (0..len)
            .map(|i| Complex::new(*real.add(i), *imag.add(i)))
            .collect();

        let output = signal::fft(&mut input);

        let mut flat = Vec::with_capacity(output.len() * 2);

        for c in output {
            flat.push(c.re);

            flat.push(c.im);
        }

        Box::into_raw(Box::new(Matrix::new(len, 2, flat)))
    }
}

/// Computes the convolution of two sequences.
///
/// # 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(
    a: *const f64,
    a_len: usize,
    v: *const f64,
    v_len: usize,
) -> *mut Matrix<f64> {
    unsafe {
        if a.is_null() || v.is_null() {
            update_last_error(
                "Null pointer passed to \
             rssn_num_signal_convolve"
                    .to_string(),
            );

            return ptr::null_mut();
        }

        let a_slice = std::slice::from_raw_parts(a, a_len);

        let v_slice = std::slice::from_raw_parts(v, v_len);

        let result = signal::convolve(a_slice, v_slice);

        let n = result.len();

        Box::into_raw(Box::new(Matrix::new(1, n, result)))
    }
}

/// Computes the cross-correlation of two sequences.
///
/// # 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(
    a: *const f64,
    a_len: usize,
    v: *const f64,
    v_len: usize,
) -> *mut Matrix<f64> {
    unsafe {
        if a.is_null() || v.is_null() {
            update_last_error(
                "Null pointer passed to rssn_num_signal_cross_correlation".to_string(),
            );

            return ptr::null_mut();
        }

        let a_slice = std::slice::from_raw_parts(a, a_len);

        let v_slice = std::slice::from_raw_parts(v, v_len);

        let result = signal::cross_correlation(a_slice, v_slice);

        let n = result.len();

        Box::into_raw(Box::new(Matrix::new(1, n, result)))
    }
}

/// Generates a Hann window.
///
/// # 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_hann_window(n: usize) -> *mut Matrix<f64> {
    let window = signal::hann_window(n);

    Box::into_raw(Box::new(Matrix::new(1, n, window)))
}

/// Generates a Hamming window.
///
/// # 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_hamming_window(n: usize) -> *mut Matrix<f64> {
    let window = signal::hamming_window(n);

    Box::into_raw(Box::new(Matrix::new(1, n, window)))
}