Skip to main content

Proximal Augmented Lagrangian method for Quadratic Programs

Project description

Python Wheels Matlab Package Test Coverage

Proximal Augmented Lagrangian method for Quadratic Programs

QPALM is a numerical optimization package that finds stationary points of (possibly nonconvex) quadratic programs, that is

minimize        ½ xᵀQx + qᵀx

subject to      l ≤ Ax ≤ u

Documentation

The documentation can be found at: https://kul-optec.github.io/QPALM/Doxygen
Examples are included as well: https://kul-optec.github.io/QPALM/Doxygen/examples.html

Installation

Python

The QPALM Python interface is available from PyPI, you can install it using:

python3 -m pip install qpalm

Julia

In the Julia console, press ] to enter the Pkg REPL and install QPALM using:

add QPALM

Matlab

To install the Matlab interface, download qpalm-matlab-linux.tar.gz or qpalm-matlab-windows.zip from the releases page, and extract it into the ~/Documents/MATLAB folder.
As a one-liner for Linux:

wget https://github.com/kul-optec/QPALM/releases/download/1.0.0/qpalm-matlab-linux.tar.gz -O- | tar xz -C ~/Documents/MATLAB

Building QPALM from source

For the full instructions to build QPALM from source, please see https://kul-optec.github.io/QPALM/Doxygen/installation-md.html

Supported platforms

QPALM is written in C, with interfaces for C++, Python, Julia and Matlab.
The code itself is portable across all popular platforms. Binaries are available for Linux on x86-64 and AArch64* and for Windows on x86-64.

(*) Except Matlab.

Benchmarks

Check out the papers below for detailed benchmark tests comparing QPALM with state-of-the-art solvers.

Citing

If you use QPALM in your research, please cite the following paper:

@inproceedings{hermans2019qpalm,
	author      = {Hermans, B. and Themelis, A. and Patrinos, P.},
	booktitle   = {58th IEEE Conference on Decision and Control},
	title       = {{QPALM}: {A} {N}ewton-type {P}roximal {A}ugmented {L}agrangian {M}ethod for {Q}uadratic {P}rograms},
	year        = {2019},
	volume      = {},
	number      = {},
	pages       = {},
	doi         = {},
	issn        = {},
	month       = {Dec.},
}

Previous versions

The original repository by Ben Hermans at https://github.com/Benny44/QPALM_vLADEL will no longer be maintained.

License

QPALM is licensed under LGPL v3.0. Some modules are used in this software:

  • LADEL: authored by Ben Hermans and licensed under LGPL-v3.
  • LOBPCG: the version of LOBPCG used here was written by Ben Hermans and licensed under the GNU Lesser General Public License v3.0, see LOBPCG/LICENSE.
  • LAPACK: authored by The University of Tennessee and The University of Tennessee Research Foundation, The University of California Berkeley, and The University of Colorado Denver, and licensed under BSD-3, see here.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

qpalm-1.0.0.tar.gz (436.6 kB view hashes)

Uploaded Source

Built Distributions

qpalm-1.0.0-cp310-cp310-win_amd64.whl (144.0 kB view hashes)

Uploaded CPython 3.10 Windows x86-64

qpalm-1.0.0-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.manylinux_2_27_x86_64.whl (2.5 MB view hashes)

Uploaded CPython 3.10 manylinux: glibc 2.17+ x86-64 manylinux: glibc 2.27+ x86-64

qpalm-1.0.0-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.manylinux_2_27_aarch64.whl (2.4 MB view hashes)

Uploaded CPython 3.10 manylinux: glibc 2.17+ ARM64 manylinux: glibc 2.27+ ARM64

qpalm-1.0.0-cp39-cp39-win_amd64.whl (142.2 kB view hashes)

Uploaded CPython 3.9 Windows x86-64

qpalm-1.0.0-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.manylinux_2_27_x86_64.whl (2.5 MB view hashes)

Uploaded CPython 3.9 manylinux: glibc 2.17+ x86-64 manylinux: glibc 2.27+ x86-64

qpalm-1.0.0-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.manylinux_2_27_aarch64.whl (2.4 MB view hashes)

Uploaded CPython 3.9 manylinux: glibc 2.17+ ARM64 manylinux: glibc 2.27+ ARM64

qpalm-1.0.0-cp38-cp38-win_amd64.whl (144.0 kB view hashes)

Uploaded CPython 3.8 Windows x86-64

qpalm-1.0.0-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.manylinux_2_27_x86_64.whl (2.5 MB view hashes)

Uploaded CPython 3.8 manylinux: glibc 2.17+ x86-64 manylinux: glibc 2.27+ x86-64

qpalm-1.0.0-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.manylinux_2_27_aarch64.whl (2.4 MB view hashes)

Uploaded CPython 3.8 manylinux: glibc 2.17+ ARM64 manylinux: glibc 2.27+ ARM64

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page