otspot-model 0.3.0

Algebraic modeling API for otspot (Model, Variable, Expression, Constraint)
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

#![deny(clippy::print_stdout, clippy::print_stderr)]
//! Algebraic modeling API for `otspot`.
//!
//! Provides [`Model`], [`Variable`], [`Expression`], [`Constraint`],
//! the [`constraint!`] macro, and associated error/result types.
//!
//! # Example
//! ```
//! use otspot_model::{Model, constraint};
//!
//! let mut model = Model::new("example");
//! let x = model.add_var("x", 0.0, 10.0);
//! let y = model.add_var("y", 0.0, 10.0);
//! model.add_constraint(constraint!((x + y) <= 8.0));
//! model.minimize(2.0 * x + y);
//! let result = model.solve().unwrap();
//! assert!((result[x] + result[y]).abs() < 1e-4);
//! ```

pub mod constraint;
pub mod expression;
pub mod quad_expr;
pub mod variable;
mod model;

pub use constraint::{Constraint, ConstraintSense};
pub use expression::Expression;
pub use quad_expr::QuadExpr;
pub use variable::{VarKind, Variable};
pub use model::{Model, ModelError, ModelResult, SolutionProof, SolveError};