https://github.com/atraplet/ecos4j
ECOS Solver for Java
https://github.com/atraplet/ecos4j
conic-optimization conic-programs convex-optimization interior-point-method java linear-programming operations-research optimization optimization-algorithms quadratic-programming semidefinite-programming
Last synced: about 2 months ago
JSON representation
ECOS Solver for Java
- Host: GitHub
- URL: https://github.com/atraplet/ecos4j
- Owner: atraplet
- License: gpl-3.0
- Created: 2023-09-17T16:30:16.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2025-07-22T15:23:28.000Z (8 months ago)
- Last Synced: 2025-07-22T17:30:46.673Z (8 months ago)
- Topics: conic-optimization, conic-programs, convex-optimization, interior-point-method, java, linear-programming, operations-research, optimization, optimization-algorithms, quadratic-programming, semidefinite-programming
- Language: Java
- Homepage:
- Size: 227 KB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Note
The repository of the underlying solver ECOS is inactive. Moreover, ECOS has known issues with performance and numerical stability.
Hence, we decided to stop the development of ecos4j and to archive it.
If you are interested in solving convex optimization problems with Java, then you may use our project [clarabel4j](https://github.com/atraplet/clarabel4j).
The underlying native solver Clarabel improves the algorithm and implementation of ECOS and is under active development.
# ECOS Solver for Java
[](https://github.com/atraplet/ecos4j/actions/workflows/build.yml)
[](https://codecov.io/github/atraplet/ecos4j)
[](https://central.sonatype.com/artifact/com.ustermetrics/ecos4j)
[](https://github.com/atraplet/ecos4j/blob/master/LICENSE)
*This library requires JDK 23 as it depends on
Java's [Foreign Function and Memory (FFM) API](https://docs.oracle.com/en/java/javase/23/core/foreign-function-and-memory-api.html).*
ecos4j (ECOS Solver for Java) is a Java library that provides an interface from the Java programming language to the
native open source mathematical programming solver [ECOS](https://github.com/embotech/ecos). It invokes the solver
through
Java's [Foreign Function and Memory (FFM) API](https://docs.oracle.com/en/java/javase/23/core/foreign-function-and-memory-api.html).
## Usage
### Dependency
Add the latest version from [Maven Central](https://central.sonatype.com/artifact/com.ustermetrics/ecos4j) to
your `pom.xml`
```
com.ustermetrics
ecos4j
x.y.z
```
### Native Library
Either add the latest version of [ecos4j-native](https://github.com/atraplet/ecos4j-native)
from [Maven Central](https://central.sonatype.com/artifact/com.ustermetrics/ecos4j-native) to
your `pom.xml`
```
com.ustermetrics
ecos4j-native
x.y.z
runtime
```
or install the native solver on the machine and add the location to the `java.library.path`. ecos4j dynamically loads
the native solver.
### Run Code
Since ecos4j invokes some restricted methods of the FFM API, use `--enable-native-access=com.ustermetrics.ecos4j`
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.ecos4j.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 platform dependent path with relative platform independent path in
the comments. Remove unused includes. Second, `./bindings/generate_bindings.sh` generates the actual Java bindings.
Add `NativeLoader.loadLibrary.` Remove platform dependent layout constants and make the code platform independent.
## 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/ecos4j/releases) and update the release.
## Credits
This project is based on the native open source mathematical programming
solver [ECOS](https://github.com/embotech/ecos),
which is developed and maintained by [embotech](https://www.embotech.com), Alexander Domahidi, and others.