clarabel 0.3.0

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
117
118
119
120
121
122
123
124
125
126
127

#![allow(non_snake_case)]

use crate::algebra::CscMatrix;
use crate::solver::implementations::default::*;
use num_derive::FromPrimitive;
use std::slice;

// The types defined here are for exchanging data
// between Rust and Julia.

#[repr(C)]
#[derive(Debug)]
pub(crate) struct VectorJLRS<T> {
    pub p: *const T,
    pub len: libc::size_t,
}

impl<T> VectorJLRS<T>
where
    T: std::clone::Clone + std::fmt::Debug,
{
    pub(crate) fn to_slice(&self) -> &[T] {
        assert!(!self.p.is_null());
        unsafe { slice::from_raw_parts(self.p, self.len as usize) }
    }

    pub(crate) fn len(&self) -> usize {
        self.len as usize
    }
}

impl From<&VectorJLRS<i64>> for Vec<usize> {
    fn from(v: &VectorJLRS<i64>) -> Self {
        v.to_slice().iter().map(|&e| e as usize).collect()
    }
}

impl<T> From<&VectorJLRS<T>> for Vec<T>
where
    T: std::clone::Clone + std::fmt::Debug,
{
    fn from(v: &VectorJLRS<T>) -> Self {
        let sl = if v.len > 0 { v.to_slice() } else { &[] };
        sl.to_vec()
    }
}

impl<T> From<&Vec<T>> for VectorJLRS<T>
where
    T: std::clone::Clone + std::fmt::Debug,
{
    fn from(v: &Vec<T>) -> Self {
        let mut v = v.clone();
        let p = v.as_mut_ptr();
        let len = v.len();
        std::mem::forget(v);
        VectorJLRS::<T> { p, len }
    }
}

#[derive(Debug)]
#[repr(C)]
pub(crate) struct CscMatrixJLRS {
    pub m: usize,
    pub n: usize,
    pub colptr: VectorJLRS<i64>,
    pub rowval: VectorJLRS<i64>,
    pub nzval: VectorJLRS<f64>,
}

impl CscMatrixJLRS {
    pub(crate) fn to_CscMatrix(&self) -> CscMatrix {
        let mut colptr = Vec::<usize>::from(&self.colptr);
        let mut rowval = Vec::<usize>::from(&self.rowval);
        let nzval = Vec::<f64>::from(&self.nzval);

        //need to back shift all of the indices since
        //Julia stores matrices as 1-indexed
        for v in rowval.iter_mut() {
            *v -= 1
        }
        for v in colptr.iter_mut() {
            *v -= 1
        }
        CscMatrix::new(self.m, self.n, colptr, rowval, nzval)
    }
}

#[repr(C)]
#[derive(Debug)]
pub(crate) struct SolutionJLRS {
    pub x: VectorJLRS<f64>,
    pub z: VectorJLRS<f64>,
    pub s: VectorJLRS<f64>,
    pub status: u32, //0 indexed enum in RS/JL
    pub obj_val: f64,
    pub solve_time: f64,
    pub iterations: u32,
    pub r_prim: f64,
    pub r_dual: f64,
}

impl From<&DefaultSolution<f64>> for SolutionJLRS {
    fn from(sol: &DefaultSolution<f64>) -> Self {
        SolutionJLRS {
            x: VectorJLRS::<f64>::from(&sol.x),
            z: VectorJLRS::<f64>::from(&sol.z),
            s: VectorJLRS::<f64>::from(&sol.s),
            status: sol.status as u32,
            obj_val: sol.obj_val,
            solve_time: sol.solve_time,
            iterations: sol.iterations,
            r_prim: sol.r_prim,
            r_dual: sol.r_dual,
        }
    }
}

#[repr(u8)]
#[derive(FromPrimitive)]
pub(crate) enum ConeEnumJLRS {
    ZeroConeT = 0,
    NonnegativeConeT = 1,
    SecondOrderConeT = 2,
    ExponentialConeT = 3,
    PowerConeT = 4,
}