russcip 0.8.2

Rust interface for SCIP
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
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146

use std::fmt;
use std::rc::Rc;

use crate::scip::ScipPtr;
use crate::variable::Variable;
use crate::{ffi, scip_call_panic};

/// A wrapper for a SCIP solution.
#[derive(Clone)]
pub struct Solution {
    pub(crate) raw: *mut ffi::SCIP_SOL,
    pub(crate) scip_ptr: Rc<ScipPtr>,
}

impl Solution {
    /// Returns a raw pointer to the underlying `ffi::SCIP_SOL` struct.
    pub fn inner(&self) -> *mut ffi::SCIP_SOL {
        self.raw
    }

    /// Returns the objective value of the solution.
    pub fn obj_val(&self) -> f64 {
        unsafe { ffi::SCIPgetSolOrigObj(self.scip_ptr.raw, self.raw) }
    }

    /// Returns the value of a variable in the solution.
    pub fn val(&self, var: &Variable) -> f64 {
        unsafe { ffi::SCIPgetSolVal(self.scip_ptr.raw, self.raw, var.raw) }
    }

    /// Sets the value of a variable in the solution.
    pub fn set_val(&self, var: &Variable, val: f64) {
        scip_call_panic!(ffi::SCIPsetSolVal(
            self.scip_ptr.raw,
            self.raw,
            var.raw,
            val
        ));
    }

    /// Returns the solution as a var-name to value map.
    pub fn as_name_map(&self) -> std::collections::HashMap<String, f64> {
        let vars = unsafe { ffi::SCIPgetVars(self.scip_ptr.raw) };
        let n_vars = unsafe { ffi::SCIPgetNVars(self.scip_ptr.raw) };
        let mut map = std::collections::HashMap::new();
        for i in 0..n_vars {
            let var = unsafe { *vars.offset(i as isize) };
            let val = unsafe { ffi::SCIPgetSolVal(self.scip_ptr.raw, self.raw, var) };
            let eps = unsafe { ffi::SCIPepsilon(self.scip_ptr.raw) };
            if val > eps || val < -eps {
                let name_ptr = unsafe { ffi::SCIPvarGetName(var) };
                // from CString
                let name = unsafe { std::ffi::CStr::from_ptr(name_ptr).to_str().unwrap() };
                map.insert(name.to_string(), val);
            }
        }
        map
    }

    /// Returns the solution as a var-id to value map.
    pub fn as_id_map(&self) -> std::collections::HashMap<i32, f64> {
        let vars = unsafe { ffi::SCIPgetVars(self.scip_ptr.raw) };
        let n_vars = unsafe { ffi::SCIPgetNVars(self.scip_ptr.raw) };
        let mut map = std::collections::HashMap::new();
        for i in 0..n_vars {
            let var = unsafe { *vars.offset(i as isize) };
            let val = unsafe { ffi::SCIPgetSolVal(self.scip_ptr.raw, self.raw, var) };
            let eps = unsafe { ffi::SCIPepsilon(self.scip_ptr.raw) };
            if val > eps || val < -eps {
                let id = unsafe { ffi::SCIPvarGetProbindex(var) };
                map.insert(id, val);
            }
        }
        map
    }
}

impl fmt::Debug for Solution {
    /// Formats the solution for debugging purposes.
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        let obj_val = self.obj_val();
        writeln!(f, "Solution with obj val: {obj_val}")?;
        let vars = unsafe { ffi::SCIPgetOrigVars(self.scip_ptr.raw) };
        let n_vars = unsafe { ffi::SCIPgetNOrigVars(self.scip_ptr.raw) };
        for i in 0..n_vars {
            let var = unsafe { *vars.offset(i as isize) };
            let val = unsafe { ffi::SCIPgetSolVal(self.scip_ptr.raw, self.raw, var) };
            let eps = unsafe { ffi::SCIPepsilon(self.scip_ptr.raw) };
            if val > eps || val < -eps {
                let name_ptr = unsafe { ffi::SCIPvarGetName(var) };
                // from CString
                let name = unsafe { std::ffi::CStr::from_ptr(name_ptr).to_str().unwrap() };
                writeln!(f, "Var {name}={val}")?;
            }
        }
        Ok(())
    }
}

/// Represents and error that can occur when adding a solution.
#[derive(Debug, PartialEq, Eq)]
pub enum SolError {
    /// The solution is infeasible.
    Infeasible,
}

#[cfg(test)]
mod tests {
    use crate::*;

    #[test]
    fn sol_methods() {
        let model = Model::new()
            .hide_output()
            .include_default_plugins()
            .read_prob("data/test/simple.lp")
            .unwrap()
            .solve();

        let status = model.status();
        assert_eq!(status, Status::Optimal);

        //test solution values
        let sol = model.best_sol().unwrap();
        assert!(!sol.inner().is_null());

        let debug_str = format!("{:?}", sol);
        assert!(debug_str.contains("Solution with obj val: 200"));
        assert!(debug_str.contains("Var x1=40"));
        assert!(debug_str.contains("Var x2=20"));

        let vars = model.vars();
        assert_eq!(sol.val(&vars[0]), 40.);
        assert_eq!(sol.val(&vars[1]), 20.);

        assert_eq!(sol.obj_val(), model.obj_val());

        let sol_name_map = sol.as_name_map();
        assert_eq!(sol_name_map.get("t_x1").unwrap(), &40.);
        assert_eq!(sol_name_map.get("t_x2").unwrap(), &20.);

        let sol_id_map = sol.as_id_map();
        assert_eq!(sol_id_map.get(&0).unwrap(), &40.);
        assert_eq!(sol_id_map.get(&1).unwrap(), &20.);
    }
}