oximo 0.6.0

A Rust algebraic modeling library for solving optimization problems
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

#![doc = include_str!("../README.md")]
#![forbid(unsafe_code)]
#![cfg_attr(docsrs, feature(doc_cfg))]

// Lets the `::oximo::...` paths emitted by `oximo-macros` resolve inside this
// crate's own examples, tests, and doctests.
extern crate self as oximo;

pub use oximo_core as core;

// Runtime glue the modeling macros expand into.
#[doc(hidden)]
pub use oximo_core::__macro_support;
pub use oximo_expr as expr;
pub use oximo_solver as solver;

#[cfg(feature = "io")]
#[cfg_attr(docsrs, doc(cfg(feature = "io")))]
pub use oximo_io as io;

#[cfg(feature = "highs")]
#[cfg_attr(docsrs, doc(cfg(feature = "highs")))]
pub use oximo_highs::{HighsMethod, HighsOptions, HighsPresolve};

#[cfg(feature = "gurobi")]
#[cfg_attr(docsrs, doc(cfg(feature = "gurobi")))]
pub use oximo_gurobi::{
    Callback, CallbackLocation, CallbackMask, CbResult, GRB_METHOD_PDHG, GurobiOptions,
    GurobiPersistent, GurobiPresolve, Opcode, Status, Where,
};

#[cfg(feature = "mosek")]
#[cfg_attr(docsrs, doc(cfg(feature = "mosek")))]
pub use oximo_mosek::{MosekOptions, MosekPersistent};

#[cfg(feature = "gams")]
#[cfg_attr(docsrs, doc(cfg(feature = "gams")))]
pub use oximo_gams::{GamsOptions, GamsSolver};

#[cfg(feature = "baron")]
#[cfg_attr(docsrs, doc(cfg(feature = "baron")))]
pub use oximo_baron::BaronOptions;

#[cfg(feature = "clarabel")]
#[cfg_attr(docsrs, doc(cfg(feature = "clarabel")))]
pub use oximo_clarabel::{ClarabelDirectSolve, ClarabelOptions};

/// GAMS backend types: sub-solver selection and per-solver option structs.
#[cfg(feature = "gams")]
#[cfg_attr(docsrs, doc(cfg(feature = "gams")))]
pub mod gams {
    pub use oximo_gams::*;
}

#[cfg(feature = "pounce")]
#[cfg_attr(docsrs, doc(cfg(feature = "pounce")))]
pub mod pounce {
    pub use oximo_pounce::{
        MuStrategy, Pounce, PounceAlgorithm, PounceOptionValue, PounceOptions, PouncePersistent,
        PounceSolverSelection,
    };
}

pub mod prelude {
    //! Glob-import target. Brings the modeling and solver surface into scope.
    pub use oximo_core::prelude::*;
    pub use oximo_solver::{
        ConstraintEvaluation, DualStatus, HasUniversal, Iis, IisReport, InfeasibilityDiagnosis,
        ModelReport, PersistentSolver, PrimalStatus, SocEvaluation, SolutionPoint, Solver,
        SolverError, SolverResult, TerminationStatus, UniversalOptions, UniversalOptionsExt,
        VarBoundKind,
    };

    #[cfg(feature = "highs")]
    #[cfg_attr(docsrs, doc(cfg(feature = "highs")))]
    pub use oximo_highs::{HighsMethod, HighsOptions, HighsPersistent, HighsPresolve};

    #[cfg(feature = "gurobi")]
    #[cfg_attr(docsrs, doc(cfg(feature = "gurobi")))]
    pub use oximo_gurobi::{
        Callback, CallbackLocation, CallbackMask, CbResult, GRB_METHOD_PDHG, GurobiOptions,
        GurobiPersistent, GurobiPresolve, Opcode, Status, Where,
    };

    #[cfg(feature = "mosek")]
    #[cfg_attr(docsrs, doc(cfg(feature = "mosek")))]
    pub use oximo_mosek::{MosekOptions, MosekPersistent};

    #[cfg(feature = "gams")]
    #[cfg_attr(docsrs, doc(cfg(feature = "gams")))]
    pub use oximo_gams::{GamsOptions, GamsSolver};

    #[cfg(feature = "baron")]
    #[cfg_attr(docsrs, doc(cfg(feature = "baron")))]
    pub use oximo_baron::BaronOptions;

    #[cfg(feature = "clarabel")]
    #[cfg_attr(docsrs, doc(cfg(feature = "clarabel")))]
    pub use oximo_clarabel::{ClarabelDirectSolve, ClarabelOptions, ClarabelPersistent};

    #[cfg(feature = "pounce")]
    #[cfg_attr(docsrs, doc(cfg(feature = "pounce")))]
    pub use oximo_pounce::{
        Pounce, PounceAlgorithm, PounceOptions, PouncePersistent, PounceSolverSelection,
    };
}

pub mod solvers {
    //! Concrete solver backends, gated by cargo features.

    #[cfg(feature = "highs")]
    #[cfg_attr(docsrs, doc(cfg(feature = "highs")))]
    pub use oximo_highs::Highs;

    #[cfg(feature = "gurobi")]
    #[cfg_attr(docsrs, doc(cfg(feature = "gurobi")))]
    pub use oximo_gurobi::Gurobi;

    #[cfg(feature = "mosek")]
    #[cfg_attr(docsrs, doc(cfg(feature = "mosek")))]
    pub use oximo_mosek::Mosek;

    #[cfg(feature = "gams")]
    #[cfg_attr(docsrs, doc(cfg(feature = "gams")))]
    pub use oximo_gams::Gams;

    #[cfg(feature = "baron")]
    #[cfg_attr(docsrs, doc(cfg(feature = "baron")))]
    pub use oximo_baron::Baron;

    #[cfg(feature = "clarabel")]
    #[cfg_attr(docsrs, doc(cfg(feature = "clarabel")))]
    pub use oximo_clarabel::Clarabel;

    #[cfg(feature = "pounce")]
    #[cfg_attr(docsrs, doc(cfg(feature = "pounce")))]
    pub use oximo_pounce::Pounce;
}