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

//! Handle-based FFI API for numerical tensor operations.

use std::ptr;

use ndarray::ArrayD;
use ndarray::IxDyn;

use crate::ffi_apis::ffi_api::update_last_error;
use crate::numerical::tensor::{
    self,
};

/// Creates a new tensor from shape and 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_tensor_create(
    shape: *const usize,
    ndim: usize,
    data: *const f64,
    data_len: usize,
) -> *mut ArrayD<f64> {
    unsafe {
        if shape.is_null() || data.is_null() {
            update_last_error(
                "Null pointer passed to \
             rssn_num_tensor_create"
                    .to_string(),
            );

            return ptr::null_mut();
        }

        let s = { std::slice::from_raw_parts(shape, ndim) };

        let d = { std::slice::from_raw_parts(data, data_len) };

        match ArrayD::from_shape_vec(IxDyn(s), d.to_vec()) {
            | Ok(arr) => Box::into_raw(Box::new(arr)),
            | Err(e) => {
                update_last_error(e.to_string());

                ptr::null_mut()
            },
        }
    }
}

/// Frees a tensor object.
///
/// # 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_tensor_free(tensor: *mut ArrayD<f64>) {
    if !tensor.is_null() {
        unsafe {
            let _ = Box::from_raw(tensor);
        }
    }
}

/// Returns the number of dimensions.
///
/// # 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_tensor_get_ndim(tensor: *const ArrayD<f64>) -> usize {
    if tensor.is_null() {
        return 0;
    }

    unsafe { (*tensor).ndim() }
}

/// Returns the shape of the tensor.
///
/// # 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_tensor_get_shape(
    tensor: *const ArrayD<f64>,
    out_shape: *mut usize,
) -> i32 {
    if tensor.is_null() || out_shape.is_null() {
        return -1;
    }

    let t = unsafe { &*tensor };

    let shape = t.shape();

    unsafe {
        ptr::copy_nonoverlapping(shape.as_ptr(), out_shape, shape.len());
    }

    0
}

/// Tensor contraction (tensordot).
///
/// # 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_tensor_tensordot(
    a: *const ArrayD<f64>,
    b: *const ArrayD<f64>,
    axes_a: *const usize,
    axes_a_len: usize,
    axes_b: *const usize,
    axes_b_len: usize,
) -> *mut ArrayD<f64> {
    unsafe {
        if a.is_null() || b.is_null() || axes_a.is_null() || axes_b.is_null() {
            return ptr::null_mut();
        }

        let ta = { &*a };

        let tb = { &*b };

        let aa = { std::slice::from_raw_parts(axes_a, axes_a_len) };

        let ab = { std::slice::from_raw_parts(axes_b, axes_b_len) };

        match tensor::tensordot(ta, tb, aa, ab) {
            | Ok(res) => Box::into_raw(Box::new(res)),
            | Err(e) => {
                update_last_error(e);

                ptr::null_mut()
            },
        }
    }
}

/// Outer product of two tensors.
///
/// # 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_tensor_outer_product(
    a: *const ArrayD<f64>,
    b: *const ArrayD<f64>,
) -> *mut ArrayD<f64> {
    unsafe {
        if a.is_null() || b.is_null() {
            return ptr::null_mut();
        }

        let ta = { &*a };

        let tb = { &*b };

        match tensor::outer_product(ta, tb) {
            | Ok(res) => Box::into_raw(Box::new(res)),
            | Err(e) => {
                update_last_error(e);

                ptr::null_mut()
            },
        }
    }
}

/// Frobenius norm of a tensor.
///
/// # 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_tensor_norm(tensor: *const ArrayD<f64>) -> f64 {
    if tensor.is_null() {
        return 0.0;
    }

    let t = unsafe { &*tensor };

    tensor::norm(t)
}