diffsol-c 0.1.0

A diffsol wrapper featuring runtime scalar/matrix/solver types and a C API
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

use std::os::raw::c_char;
use std::ptr;

use crate::c_invalid_arg;
use crate::scalar_type::ScalarType;

const SCALAR_TYPE_F32: &[u8] = b"f32\0";
const SCALAR_TYPE_F64: &[u8] = b"f64\0";

pub(crate) fn scalar_type_from_i32(value: i32) -> Option<ScalarType> {
    match value {
        0 => Some(ScalarType::F32),
        1 => Some(ScalarType::F64),
        _ => None,
    }
}

pub(crate) fn scalar_type_to_i32(value: ScalarType) -> i32 {
    match value {
        ScalarType::F32 => 0,
        ScalarType::F64 => 1,
    }
}

/// Return the number of scalar type enum values.
///
/// # Safety
/// This function is safe to call from C. It does not dereference any
/// caller-provided pointers.
#[unsafe(no_mangle)]
pub unsafe extern "C" fn diffsol_scalar_type_count() -> usize {
    2
}

/// Return whether a scalar type enum value is valid.
///
/// # Safety
/// This function is safe to call from C. It does not dereference any
/// caller-provided pointers.
#[unsafe(no_mangle)]
pub unsafe extern "C" fn diffsol_scalar_type_is_valid(value: i32) -> i32 {
    if scalar_type_from_i32(value).is_some() {
        1
    } else {
        c_invalid_arg!("invalid scalar_type");
        0
    }
}

/// Return the name of a scalar type enum value.
///
/// # Safety
/// The returned pointer is borrowed from static storage owned by this library
/// and must not be freed or mutated by the caller.
#[unsafe(no_mangle)]
pub unsafe extern "C" fn diffsol_scalar_type_name(value: i32) -> *const c_char {
    match scalar_type_from_i32(value) {
        Some(ScalarType::F32) => SCALAR_TYPE_F32.as_ptr() as *const c_char,
        Some(ScalarType::F64) => SCALAR_TYPE_F64.as_ptr() as *const c_char,
        None => {
            c_invalid_arg!("invalid scalar_type");
            ptr::null()
        }
    }
}