clarabel 0.11.1

Clarabel Conic Interior Point Solver for Rust / Python
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

// ---------------------------------
// enum for managing callbacks
// ---------------------------------

use std::sync::{Arc, Mutex};

pub(crate) type CallbackFcnFFI<FFI> =
    extern "C" fn(info: *const FFI, data: *mut std::ffi::c_void) -> std::ffi::c_int;
pub trait ClarabelCallbackFn<I>: FnMut(&I) -> bool + Send + Sync {}
impl<I, T: FnMut(&I) -> bool + Send + Sync> ClarabelCallbackFn<I> for T {}

#[derive(Debug)]
pub(crate) struct CallbackUserDataFFI {
    ptr: Mutex<*mut std::ffi::c_void>,
}
unsafe impl Send for CallbackUserDataFFI {}
unsafe impl Sync for CallbackUserDataFFI {}

impl CallbackUserDataFFI {
    pub fn new(ptr: *mut std::ffi::c_void) -> Self {
        Self {
            ptr: Mutex::new(ptr),
        }
    }
}

#[derive(Default)]
pub(crate) enum Callback<I, FFI> {
    #[default]
    None,
    Rust(Box<dyn ClarabelCallbackFn<I> + Send + Sync>),
    C(CallbackFcnFFI<FFI>, Arc<CallbackUserDataFFI>),
}

impl<I, FFI> std::fmt::Debug for Callback<I, FFI> {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            Callback::None => write!(f, "Callback::None"),
            Callback::Rust(_) => write!(f, "Callback::Rust(<closure>)"),
            Callback::C(fcn, data) => {
                write!(f, "Callback::C(fcn: {:?}, data: {:?})", fcn, data)
            }
        }
    }
}

impl<I, FFI> Callback<I, FFI>
where
    FFI: From<I>,
    I: Clone + Sized,
{
    pub fn new_c(function: CallbackFcnFFI<FFI>, user_data: *mut std::ffi::c_void) -> Self {
        Callback::C(function, Arc::new(CallbackUserDataFFI::new(user_data)))
    }

    // Call the callback function
    fn call(&mut self, info: &I) -> bool {
        match self {
            Callback::None => false,
            Callback::Rust(ref mut f) => f(info),
            Callback::C(f, data) => {
                let ffi_info = FFI::from(info.clone());
                let rawptr = *data
                    .ptr
                    .lock()
                    .expect("Callback mutex is corrupt / poisoned");
                f(&ffi_info as *const FFI, rawptr) != (0 as std::ffi::c_int)
            }
        }
    }
}

#[derive(Debug)]
pub(crate) struct SolverCallbacks<I, FFI> {
    /// callback for termination
    pub termination_callback: Callback<I, FFI>,
}

impl<I, FFI> Default for SolverCallbacks<I, FFI> {
    // Create a new set of callbacks
    fn default() -> Self {
        Self {
            termination_callback: Callback::None,
        }
    }
}

impl<I, FFI> SolverCallbacks<I, FFI>
where
    FFI: From<I>,
    I: Clone + Sized,
{
    pub(crate) fn check_termination(&mut self, info: &I) -> bool {
        // check termination conditions
        self.termination_callback.call(info)
    }
}