6 releases

new 0.2.7+0.108.9 Apr 11, 2024
0.2.6+0.108.9 Oct 27, 2023
0.2.4+0.108.8 May 18, 2023
0.2.2+0.108.7 Mar 28, 2023

#1710 in Algorithms

Download history 9/week @ 2024-01-22 39/week @ 2024-02-19 25/week @ 2024-02-26 12/week @ 2024-03-04 16/week @ 2024-03-11 13/week @ 2024-03-18 14/week @ 2024-03-25 36/week @ 2024-04-01

82 downloads per month
Used in 6 crates (3 directly)

Apache-2.0

1.5MB
30K SLoC

C++ 30K SLoC // 0.2% comments Automake 145 SLoC // 0.5% comments Rust 120 SLoC Shell 55 SLoC // 0.3% comments

Osi-src

Package Documentation License

description

Osi-src crate is a *-src crate. This links Osi libraries to executable build by cargo, but does not provide Rust bindings.Osi build with CoinUtils (CoinUtils-src) support.

By this package, you don't need to worry about installing Osi in the system, and it's a package for all platforms.

Osi (Open Solver Interface) provides an abstract base class to a generic linear programming (LP) solver, along with derived classes for specific solvers. Many applications may be able to use the Osi to insulate themselves from a specific LP solver. That is, programs written to the OSI standard may be linked to any solver with an OSI interface and should produce correct results. The OSI has been significantly extended compared to its first incarnation. Currently, the OSI supports linear programming solvers and has rudimentary support for integer programming.

Usage

  1. Add the following to your Cargo.toml:

    [dependencies]
    osi-src = "\*"
    
  2. Add the following to your lib.rs:

    extern crate osi_src;
    

This package does not provide bindings. Please use coincbc-sys, coinclp-sys to use Cbc, Clp, e.g.

[dependencies]
coincbc-sys = { version = "0.2" }

Configuration

Features

The following Cargo features are supported:

  • default to build Osi without any solver support;
  • osicpx to enable the Cplex support;
  • osiglpk to enable the GLPK support;
  • osigrb to enable the Gurobi support;
  • osimsk to enable the Mosek support;
  • osispx to enable the Soplex support;
  • osixpr to enable the XPRESS support;

Environment

The package build from the source and link statically by default. It also provide the following environment variables to allow users to link to system library customly:

  • CARGO_COINUTILS_STATIC to link to CoinUtils statically;
  • CARGO_COINUTILS_SYSTEM to link to CoinUtils system library;
  • CARGO_OSI_STATIC to link to Osi statically;
  • CARGO_OSI_SYSTEM to link to Osi system library;

Set the environment variable to 1 to enable the feature. For example, to link to system library dynamically, set CARGO_${LIB_NAME}_SYSTEM to 1; to link to system library statically, set both CARGO_${LIB_NAME}_SYSTEM and CARGO_${LIB_NAME}_STATIC to 1.

Windows and vcpkg

On Windows, if ${LIB_NAME}_SYSTEM is set to 1, osi-src will use vcpkg to find Osi. Before building, you must have the correct Osi installed for your target triplet and kind of linking. For instance, to link dynamically for the x86_64-pc-windows-msvc toolchain, install osi for the x64-windows triplet:

vcpkg install osi --triplet x64-windows

To link Osi statically, install osi for the x64-windows-static-md triplet:

vcpkg install osi --triplet x64-windows-static-md

To link Osi and C Runtime (CRT) statically, install osi for the x64-windows-static triplet:

vcpkg install osi --triplet x64-windows-static

and build with +crt-static option

RUSTFLAGS='-C target-feature=+crt-static' cargo build --target x86_64-pc-windows-msvc

Please see the "Static and dynamic C runtimes" in The Rust reference for detail.

Cross Compilation

you can compile it for the other target by providing the --target option to cargo build.

Target supported
arm-unknown-linux-gnueabi
arm-unknown-linux-gnueabihf
armv7-unknown-linux-gnueabi
armv7-unknown-linux-gnueabihf
armv7-unknown-linux-musleabi
armv7-unknown-linux-musleabihf
aarch64-unknown-linux-gnu
aarch64-unknown-linux-musl
riscv64gc-unknown-linux-gnu
x86_64-pc-windows-msvc
x86_64-unknown-linux-gnu
x86_64-unknown-linux-musl
others not test

Contribution

Your contribution is highly appreciated. Do not hesitate to open an issue or a pull request. Note that any contribution submitted for inclusion in the project will be licensed according to the terms given in LICENSE.

Dependencies

~2.5MB
~62K SLoC