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

use crate::symbolic::core::SparsePolynomial;
use crate::symbolic::grobner::MonomialOrder;
use crate::symbolic::grobner::buchberger;
use crate::symbolic::grobner::poly_division_multivariate;

/// Computes a Gröbner basis using Buchberger's algorithm and returns it as a heap-allocated vector handle.
///
/// # Arguments
///
/// * `basis` - Pointer to a `Vec<SparsePolynomial>` representing the initial basis.
/// * `order` - [`MonomialOrder`] specifying the term ordering.
///
/// # Returns
///
/// A pointer to a heap-allocated `Vec<SparsePolynomial>` representing a Gröbner
/// basis, or null if the computation fails.
///
/// # Safety
///
/// This function is unsafe because it dereferences a raw pointer and returns
/// ownership of a heap-allocated vector that must be freed by the caller.
#[unsafe(no_mangle)]
pub extern "C" fn rssn_buchberger_handle(
    basis: *const Vec<SparsePolynomial>,
    order: MonomialOrder,
) -> *mut Vec<SparsePolynomial> {
    let basis_ref = unsafe { &*basis };

    match buchberger(basis_ref, order) {
        | Ok(result) => Box::into_raw(Box::new(result)),
        | Err(_) => std::ptr::null_mut(),
    }
}

/// Divides a multivariate polynomial by a list of divisors under a given monomial order
/// and returns quotient polynomials and remainder as a heap-allocated tuple.
///
/// # Arguments
///
/// * `dividend` - Pointer to the dividend `SparsePolynomial`.
/// * `divisors` - Pointer to a `Vec<SparsePolynomial>` of divisor polynomials.
/// * `order` - [`MonomialOrder`] specifying the term ordering.
///
/// # Returns
///
/// A pointer to a heap-allocated `(Vec<SparsePolynomial>, SparsePolynomial)` containing
/// the quotient polynomials and the remainder, or null if the computation fails.
///
/// # Safety
///
/// This function is unsafe because it dereferences raw pointers and returns ownership
/// of a heap-allocated tuple that must be freed by the caller.
#[unsafe(no_mangle)]
pub extern "C" fn rssn_poly_division_multivariate_handle(
    dividend: *const SparsePolynomial,
    divisors: *const Vec<SparsePolynomial>,
    order: MonomialOrder,
) -> *mut (Vec<SparsePolynomial>, SparsePolynomial) {
    let dividend_ref = unsafe { &*dividend };

    let divisors_ref = unsafe { &*divisors };

    match poly_division_multivariate(dividend_ref, divisors_ref, order) {
        | Ok(result) => Box::into_raw(Box::new(result)),
        | Err(_) => std::ptr::null_mut(),
    }
}