Coinpopt-sys

coinipopt-sys crate is a *-sys crate. The package provides Low-level bindings to the Ipopt library.

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

Ipopt (Coin-or linear programming) is an open-source linear programming solver. It is primarily meant to be used as a callable library, but a basic, stand-alone executable version is also available.

Usage

Just add the following to your Cargo.toml:

[dependencies]
coinipopt-sys = "0.2"

Configuration

The following Cargo features are supported:

• default to osiclp and clpsolver feature;
• osiclp to build with Osi supported;
• clpsolver to build ClpSolver lib and crate the api for Rust. If you do not use Clp directly, you can disable this feature to reduce the build time;

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_IPOPT_STATIC to link to Ipopt statically;
• CARGO_IPOPT_SYSTEM to link to Ipopt 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.

You can also use ipopt-sys with no-default-features, and add ipopt-src to the Cargo.toml and enable the related feature defined by ipopt-src. Please see Ipopt-src.

Windows and vcpkg

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

vcpkg install ipopt --triplet x64-windows

To link Ipopt statically, install ipopt for the x64-windows-static-md triplet:

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

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

vcpkg install ipopt --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

Because [openblas-src]'s Issue #101, we can't cross compile the package with openblas-static feature. So, if you want to cross compile the package, you could use mike-kfed instead.

Add this to your project/.cargo/config.toml.

[patch.crates-io]
openblas-src = { git = "https://github.com/mike-kfed/openblas-src.git", branch = "arm-cross-compile" }

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

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.