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

//! Handle-based FFI API for numerical finite field arithmetic.

use std::ptr;

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

/// Creates a new `PrimeFieldElement`.
#[unsafe(no_mangle)]
pub extern "C" fn rssn_num_ff_pfe_new(
    value: u64,
    modulus: u64,
) -> *mut PrimeFieldElement {
    Box::into_raw(Box::new(PrimeFieldElement::new(value, modulus)))
}

/// Frees a `PrimeFieldElement`.
///
/// # 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_ff_pfe_free(pfe: *mut PrimeFieldElement) {
    if !pfe.is_null() {
        unsafe {
            let _ = Box::from_raw(pfe);
        }
    }
}

/// Computes the inverse of a `PrimeFieldElement`.
///
/// # 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_ff_pfe_inverse(
    pfe: *const PrimeFieldElement
) -> *mut PrimeFieldElement {
    unsafe {
        if pfe.is_null() {
            return ptr::null_mut();
        }

        match (*pfe).inverse() {
            | Some(inv) => Box::into_raw(Box::new(inv)),
            | None => {
                update_last_error(
                    "Element is not \
                     invertible"
                        .to_string(),
                );

                ptr::null_mut()
            },
        }
    }
}

/// Computes (pfe^exp) mod modulus.
///
/// # 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_ff_pfe_pow(
    pfe: *const PrimeFieldElement,
    exp: u64,
) -> *mut PrimeFieldElement {
    if pfe.is_null() {
        return ptr::null_mut();
    }

    let res = unsafe { (*pfe).pow(exp) };

    Box::into_raw(Box::new(res))
}

/// Performs addition in GF(p).
///
/// # 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_ff_pfe_add(
    a: *const PrimeFieldElement,
    b: *const PrimeFieldElement,
) -> *mut PrimeFieldElement {
    if a.is_null() || b.is_null() {
        return ptr::null_mut();
    }

    let res = unsafe { *a + *b };

    Box::into_raw(Box::new(res))
}

/// Performs multiplication in GF(p).
///
/// # 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_ff_pfe_mul(
    a: *const PrimeFieldElement,
    b: *const PrimeFieldElement,
) -> *mut PrimeFieldElement {
    if a.is_null() || b.is_null() {
        return ptr::null_mut();
    }

    let res = unsafe { *a * *b };

    Box::into_raw(Box::new(res))
}

/// GF(2^8) addition.
#[unsafe(no_mangle)]
pub const extern "C" fn rssn_num_ff_gf256_add(
    a: u8,
    b: u8,
) -> u8 {
    finite_field::gf256_add(a, b)
}

/// GF(2^8) multiplication.
#[unsafe(no_mangle)]
pub extern "C" fn rssn_num_ff_gf256_mul(
    a: u8,
    b: u8,
) -> u8 {
    finite_field::gf256_mul(a, b)
}

/// GF(2^8) division.
/// Returns 0 and sets error if divisor is 0.
#[unsafe(no_mangle)]
pub extern "C" fn rssn_num_ff_gf256_div(
    a: u8,
    b: u8,
) -> u8 {
    match finite_field::gf256_div(a, b) {
        | Ok(res) => res,
        | Err(e) => {
            unsafe {
                update_last_error(e);
            }

            0
        },
    }
}