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
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116

#![allow(non_snake_case)]

#[cfg(test)]
mod callback_test {

    use clarabel::solver::default::ffi::DefaultInfoFFI;
    use clarabel::solver::DefaultInfo;
    use clarabel::{algebra::*, solver::*};
    use core::ffi::{c_int, c_void};

    // setup a custom termination function
    fn callback_r(info: &DefaultInfo<f64>) -> bool {
        if info.iterations < 3 {
            false //continue
        } else {
            true // stop
        }
    }

    #[no_mangle]
    pub extern "C" fn callback_fcn(
        _info: *const DefaultInfoFFI<f64>,
        _data_ptr: *mut c_void,
    ) -> c_int {
        // just terminate immediately
        1
    }

    // First, define a struct to hold your state
    struct CallbackState {
        counter: c_int,
    }
    impl CallbackState {
        fn new() -> Self {
            CallbackState { counter: -1 }
        }
    }

    #[no_mangle]
    pub extern "C" fn callback_with_state_fcn(
        _info: *const DefaultInfoFFI<f64>,
        data_ptr: *mut c_void,
    ) -> c_int {
        let state = unsafe { &mut *(data_ptr as *mut CallbackState) };
        state.counter += 1;
        if state.counter >= 3 {
            1 // terminate
        } else {
            0 // continue
        }
    }

    #[test]
    fn test_callbacks() {
        let P = CscMatrix::identity(1);
        let c = [0.];
        let A = CscMatrix::identity(1);
        let b = [1.];
        let cones = [NonnegativeConeT(1)];

        let settings = DefaultSettings::default();
        let mut solver = DefaultSolver::new(&P, &c, &A, &b, &cones, settings).unwrap();

        solver.set_termination_callback(callback_r);
        solver.solve();
        assert_eq!(solver.solution.status, SolverStatus::CallbackTerminated);
        assert_eq!(solver.solution.iterations, 3);

        // turn it off and run again
        solver.unset_termination_callback();
        solver.solve();
        assert_eq!(solver.solution.status, SolverStatus::Solved);

        // turn it back on with a C implemented callback
        solver.set_termination_callback_c(callback_fcn, std::ptr::null_mut());
        solver.solve();
        assert_eq!(solver.solution.status, SolverStatus::CallbackTerminated);
        assert_eq!(solver.solution.iterations, 0);
    }

    #[test]
    fn test_callbacks_with_state() {
        let P = CscMatrix::identity(1);
        let c = [0.];
        let A = CscMatrix::identity(1);
        let b = [1.];
        let cones = [NonnegativeConeT(1)];

        let settings = DefaultSettings::default();
        let mut solver = DefaultSolver::new(&P, &c, &A, &b, &cones, settings).unwrap();

        solver.set_termination_callback(callback_r);
        solver.solve();
        assert_eq!(solver.solution.status, SolverStatus::CallbackTerminated);
        assert_eq!(solver.solution.iterations, 3);

        // turn it off and run again
        solver.unset_termination_callback();
        solver.solve();
        assert_eq!(solver.solution.status, SolverStatus::Solved);

        // turn it back on with a C implemented callback
        solver.set_termination_callback_c(callback_fcn, std::ptr::null_mut());
        solver.solve();
        assert_eq!(solver.solution.status, SolverStatus::CallbackTerminated);
        assert_eq!(solver.solution.iterations, 0);

        // turn it on with a stateful C implemented callback
        let state = &mut CallbackState::new();
        let ptr = state as *mut _ as *mut c_void;
        solver.set_termination_callback_c(callback_with_state_fcn, ptr);
        solver.solve();
        assert_eq!(solver.solution.status, SolverStatus::CallbackTerminated);
        assert_eq!(solver.solution.iterations, 3);
    }
}