https://github.com/atraplet/scip4j
SCIP Solver for Java
https://github.com/atraplet/scip4j
conic-optimization conic-programs convex-optimization java linear-programming mixed-integer-programming operations-research optimization optimization-algorithms quadratic-programming
Last synced: about 2 months ago
JSON representation
SCIP Solver for Java
- Host: GitHub
- URL: https://github.com/atraplet/scip4j
- Owner: atraplet
- License: apache-2.0
- Created: 2024-07-06T14:16:55.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2026-01-13T19:45:43.000Z (2 months ago)
- Last Synced: 2026-01-13T21:43:19.750Z (2 months ago)
- Topics: conic-optimization, conic-programs, convex-optimization, java, linear-programming, mixed-integer-programming, operations-research, optimization, optimization-algorithms, quadratic-programming
- Language: Java
- Homepage:
- Size: 1.32 MB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Copyright: COPYRIGHT
Awesome Lists containing this project
README
# SCIP Solver for Java
[](https://github.com/atraplet/scip4j/actions/workflows/build.yml)
[](https://codecov.io/github/atraplet/scip4j)
[](https://central.sonatype.com/artifact/com.ustermetrics/scip4j)
[](https://github.com/atraplet/scip4j/blob/master/LICENSE)
*Work in progress*
*This library requires JDK 22 as it depends on Java's
new [Foreign Function and Memory (FFM) API](https://docs.oracle.com/en/java/javase/22/core/foreign-function-and-memory-api.html).*
scip4j (SCIP Solver for Java) is a Java library that provides an interface from the Java programming language to the
native open source mathematical programming solver [SCIP](https://www.scipopt.org). It invokes the solver
through Java's
new [Foreign Function and Memory (FFM) API](https://docs.oracle.com/en/java/javase/22/core/foreign-function-and-memory-api.html).
## Usage
### Dependency
Add the latest version from [Maven Central](https://central.sonatype.com/artifact/com.ustermetrics/scip4j) to
your `pom.xml`
```
com.ustermetrics
scip4j
x.y.z
```
### Native Library
Either add the latest version of [scip4j-native](https://github.com/atraplet/scip4j-native)
from [Maven Central](https://central.sonatype.com/artifact/com.ustermetrics/scip4j-native) to
your `pom.xml`
```
com.ustermetrics
scip4j-native
x.y.z
runtime
```
or install the native solver on the machine and add the location to the `java.library.path`. scip4j dynamically loads
the native solver.
### Run Code
Since scip4j invokes some restricted methods of the FFM API, use `--enable-native-access=com.ustermetrics.scip4j`
or `--enable-native-access=ALL-UNNAMED` (if you are not using the Java Platform Module System) to avoid warnings from
the Java runtime.
## Build
### Java bindings
The directory `./bindings` contains the files and scripts needed to generate the Java bindings. The actual bindings are
under `./src/main/java` in the package `com.ustermetrics.scip4j.bindings`.
The scripts depend on the [jextract](https://jdk.java.net/jextract/) tool, which mechanically generates Java bindings
from native library headers.
The bindings are generated in two steps: First, `./bindings/generate_includes.sh` generates the dumps of the included
symbols in the `includes.txt` file. Replace absolute path with relative path in the comments.
Second, `./bindings/generate_bindings.sh` generates the actual Java bindings. Finally, add `NativeLoader.loadLibrary`
and remove the platform dependent layout constants.
## Release
Update the version in the `pom.xml`, create a tag, and push it by running
```
export VERSION=X.Y.Z
git checkout --detach HEAD
sed -i -E "s/[0-9]+\-SNAPSHOT<\/version>/$VERSION<\/version>/g" pom.xml
git commit -m "v$VERSION" pom.xml
git tag v$VERSION
git push origin v$VERSION
```
This will trigger the upload of the package to Maven Central via GitHub Actions.
Then, go to the GitHub repository [releases page](https://github.com/atraplet/scip4j/releases) and update the release.
## Credits
This project is based on the native open source mathematical programming
solver [SCIP](https://www.scipopt.org),
which is developed and maintained by the [current team members](https://scipopt.org/index.php#developers).