cplex-rs 0.1.10

Binding of IBM Cplex library
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
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183

pub mod limits;

use ffi::{
    CPXPARAM_Barrier_Algorithm, CPXPARAM_Barrier_ColNonzeros, CPXPARAM_Barrier_ConvergeTol,
    CPXPARAM_Barrier_Crossover, CPXPARAM_Barrier_Display, CPXPARAM_Barrier_QCPConvergeTol,
    CPXPARAM_Barrier_StartAlg,
};

use crate::errors::{self, Result};
use crate::parameters::{private, Parameter, ParameterValue};

impl private::Parameter for Algorithm {}
impl private::Parameter for ColNonzeros {}
impl private::Parameter for Crossover {}
impl private::Parameter for Display {}
impl private::Parameter for ConvergeTol {}
impl private::Parameter for QCPConvergeTol {}
impl private::Parameter for StartAlg {}

/// Barrier algorithm.
/// <https://www.ibm.com/docs/en/icos/22.1.1?topic=parameters-barrier-algorithm>
#[derive(Copy, Clone, Debug)]
pub enum Algorithm {
    Default,
    InfeasibilityEstimateStart,
    InfeasibilityConstantStart,
    StandardBarrier,
}

impl Parameter for Algorithm {
    fn value(&self) -> ParameterValue {
        ParameterValue::Integer(match self {
            Self::Default => 0,
            Self::InfeasibilityEstimateStart => 1,
            Self::InfeasibilityConstantStart => 2,
            Self::StandardBarrier => 3,
        })
    }

    fn id(&self) -> u32 {
        CPXPARAM_Barrier_Algorithm
    }
}

/// Barrier column nonzeros.
/// <https://www.ibm.com/docs/en/icos/22.1.1?topic=parameters-barrier-column-nonzeros>
#[derive(Copy, Clone, Debug)]
pub struct ColNonzeros(u32);

impl Parameter for ColNonzeros {
    fn value(&self) -> ParameterValue {
        ParameterValue::Integer(self.0 as i32)
    }

    fn id(&self) -> u32 {
        CPXPARAM_Barrier_ColNonzeros
    }
}

/// Barrier crossover algorithm.
/// <https://www.ibm.com/docs/en/icos/22.1.1?topic=parameters-barrier-crossover-algorithm>
#[derive(Copy, Clone, Debug)]
pub enum Crossover {
    Automatic,
    PrimalCrossover,
    DualCrossover,
}

impl Parameter for Crossover {
    fn value(&self) -> ParameterValue {
        ParameterValue::Integer(match self {
            Self::Automatic => 0,
            Self::PrimalCrossover => 1,
            Self::DualCrossover => 2,
        })
    }

    fn id(&self) -> u32 {
        CPXPARAM_Barrier_Crossover
    }
}

/// Barrier display information.
/// <https://www.ibm.com/docs/en/icos/22.1.1?topic=parameters-barrier-display-information>
#[derive(Copy, Clone, Debug)]
pub enum Display {
    None,
    NormalSetupAndIteration,
    Diagnostic,
}

impl Parameter for Display {
    fn value(&self) -> ParameterValue {
        ParameterValue::Integer(match self {
            Self::None => 0,
            Self::NormalSetupAndIteration => 1,
            Self::Diagnostic => 2,
        })
    }

    fn id(&self) -> u32 {
        CPXPARAM_Barrier_Display
    }
}

/// Convergence tolerance for LP and QP problems.
/// <https://www.ibm.com/docs/en/icos/22.1.1?topic=parameters-convergence-tolerance-lp-qp-problems>
#[derive(Copy, Clone, Debug)]
pub struct ConvergeTol(f64);

impl ConvergeTol {
    pub fn new(value: f64) -> Result<Self> {
        if value < 0.0 {
            return Err(errors::Input::from_message(
                "CPXPARAM_Barrier_ConvergeTol cannot be < 0.0".to_string(),
            )
            .into());
        }
        Ok(Self(value))
    }
}

impl Parameter for ConvergeTol {
    fn value(&self) -> ParameterValue {
        ParameterValue::Double(self.0)
    }

    fn id(&self) -> u32 {
        CPXPARAM_Barrier_ConvergeTol
    }
}

/// Convergence tolerance for QC problems.
/// <https://www.ibm.com/docs/en/icos/22.1.1?topic=parameters-convergence-tolerance-qc-problems>
#[derive(Copy, Clone, Debug)]
pub struct QCPConvergeTol(f64);

impl QCPConvergeTol {
    pub fn new(value: f64) -> Result<Self> {
        if value < 0.0 {
            return Err(errors::Input::from_message(
                "CPXPARAM_Barrier_QCPConvergeTol cannot be < 0.0".to_string(),
            )
            .into());
        }
        Ok(Self(value))
    }
}

impl Parameter for QCPConvergeTol {
    fn value(&self) -> ParameterValue {
        ParameterValue::Double(self.0)
    }

    fn id(&self) -> u32 {
        CPXPARAM_Barrier_QCPConvergeTol
    }
}

/// Barrier starting point algorithm.
/// <https://www.ibm.com/docs/en/icos/22.1.1?topic=parameters-barrier-starting-point-algorithm>
#[derive(Copy, Clone, Debug)]
pub enum StartAlg {
    DualIs0,
    EstimateDual,
    AverageOfPrimalEstimateDualIs0,
    AverageOfPrimalEstimateEstimateDual,
}

impl Parameter for StartAlg {
    fn value(&self) -> ParameterValue {
        ParameterValue::Integer(match self {
            Self::DualIs0 => 1,
            Self::EstimateDual => 2,
            Self::AverageOfPrimalEstimateDualIs0 => 3,
            Self::AverageOfPrimalEstimateEstimateDual => 4,
        })
    }

    fn id(&self) -> u32 {
        CPXPARAM_Barrier_StartAlg
    }
}