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

//! Handle-based FFI API for numerical functional analysis.

use crate::ffi_apis::ffi_api::update_last_error;
use crate::numerical::functional_analysis;

/// Helper to convert raw pointers to (x, y) tuples.
///
/// # 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 fn to_points(
    x: *const f64,
    y: *const f64,
    len: usize,
) -> Vec<(f64, f64)> {
    unsafe {
        let x_slice = std::slice::from_raw_parts(x, len);

        let y_slice = std::slice::from_raw_parts(y, len);

        x_slice
            .iter()
            .zip(y_slice.iter())
            .map(|(&xi, &yi)| (xi, yi))
            .collect()
    }
}

/// Calculates the L1 norm.
///
/// # 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_fa_l1_norm(
    x: *const f64,
    y: *const f64,
    len: usize,
) -> f64 {
    unsafe {
        if x.is_null() || y.is_null() {
            return 0.0;
        }

        let points = to_points(x, y, len);

        functional_analysis::l1_norm(&points)
    }
}

/// Calculates the L2 norm.
///
/// # 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_fa_l2_norm(
    x: *const f64,
    y: *const f64,
    len: usize,
) -> f64 {
    unsafe {
        if x.is_null() || y.is_null() {
            return 0.0;
        }

        let points = to_points(x, y, len);

        functional_analysis::l2_norm(&points)
    }
}

/// Calculates the L-infinity norm.
///
/// # 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_fa_infinity_norm(
    x: *const f64,
    y: *const f64,
    len: usize,
) -> f64 {
    unsafe {
        if x.is_null() || y.is_null() {
            return 0.0;
        }

        let points = to_points(x, y, len);

        functional_analysis::infinity_norm(&points)
    }
}

/// Calculates the inner product.
///
/// # 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_fa_inner_product(
    x1: *const f64,
    y1: *const f64,
    len1: usize,
    x2: *const f64,
    y2: *const f64,
    len2: usize,
    result: *mut f64,
) -> i32 {
    unsafe {
        if x1.is_null() || y1.is_null() || x2.is_null() || y2.is_null() || result.is_null() {
            return -1;
        }

        let p1 = to_points(x1, y1, len1);

        let p2 = to_points(x2, y2, len2);

        match functional_analysis::inner_product(&p1, &p2) {
            | Ok(val) => {
                *result = val;

                0
            },
            | Err(e) => {
                update_last_error(e);

                -1
            },
        }
    }
}