https://github.com/ornl/hykkt
HyKKT is an experimental linear solver for Karush-Kuhn-Tucker type of systems.
https://github.com/ornl/hykkt
Last synced: about 2 months ago
JSON representation
HyKKT is an experimental linear solver for Karush-Kuhn-Tucker type of systems.
- Host: GitHub
- URL: https://github.com/ornl/hykkt
- Owner: ORNL
- License: other
- Created: 2023-02-14T18:28:43.000Z (over 2 years ago)
- Default Branch: develop
- Last Pushed: 2025-03-14T03:57:46.000Z (3 months ago)
- Last Synced: 2025-03-24T20:23:04.451Z (2 months ago)
- Language: C++
- Homepage:
- Size: 93.1 MB
- Stars: 15
- Watchers: 3
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# HyKKT
## Description
HyKKT (pronounced as _hiked_) is a package for solving systems of equations and unknowns resulting from an iterative solution of an optimization
problem, for example optimal power flow, which uses hardware accelerators (GPUs) efficiently.
The HyKKT package contains a linear solver tailored for Karush Kuhn Tucker (KKT) linear systems and
deployment on hardware accelerator hardware such as GPUs. The solver requires
all blocks of the $4\times 4$ block system:
```math
\begin{bmatrix}
H + D_x & 0 & J_c^T & J_d^T \\
0 & D_s & 0 & -I \\
J_c & 0 & 0 & 0 \\
J_d & -I & 0 & 0
\end{bmatrix}
\begin{bmatrix}
\Delta x \\ \Delta s \\ \Delta y_c \\ \Delta y_d
\end{bmatrix} =
\begin{bmatrix}
\tilde{r}_x \\ r_s \\ r_c \\ r_d
\end{bmatrix}
```
separately and solves the system to a desired
numerical precision exactly via block reduction and conjugate gradient on the
schur complement. Please see the [HyKKT paper](https://www.tandfonline.com/doi/abs/10.1080/10556788.2022.2124990) for mathematical details.
## Installation and build instructions
Clone the repository
```
git clone https://gitlab.pnnl.gov/exasgd/solvers/hykkt.git
```
Make sure you have following build dependencies installed:
* C++ compiler supporting C++11 standard or higher
* CMake >= 3.19
* CUDA >= 11.0
To build HyKKT library and drivers simply
```
mkdir build
cd build
cmake ../hykkt
make
make test
```
## Usage
The executable `hybrid_solver` provides an example driver for HyKKT solver
This executable can be run with an appropriate batch script with 10 arguments
1. `h_file_name` - contains the sparse symmetric $H+D_x$ matrix block in matrix market format
2. `ds_file_name` - contains the diagonal $D_s$ matrix block in matrix market format
3. `jc_file_name` - contains the sparse $J_c$ matrix block in matrix market format
4. `jd_file_name` - contains the sparse $J_d$ matrix block in matrix market format
5. `rx_file_name` - contains the $r_{x}$ vector block in matrix market format
6. `rs_file_name` - contains the $r_{s}$ vector block in matrix market format
7. `ryc_file_name` - contains the $r_{yc}$ vector block in matrix market format
8. `ryd_file_name` - contains the $r_{yd}$ vector block in matrix market format
9. `skip` - number of header lines to ignore in the .mtx matrix files
10. `gamma` - constant to make $H_\gamma= H + D_x + J_d^T D_s J_d + \gamma J_c^T J_c$ more positive definite (typically $10^4-10^6$)
In the case of solution of multiple systems, the first 8 arguments are repated for the next matrix in the series. Both matrices must have the same sparsity structure.
Examples of this script can be found in [`src/old_scripts`](./src/old_scripts)
# Clang-format
Clang-format version 13 should be used, and format is loosely based off [llvm code style](https://llvm.org/docs/CodingStandards.html) with custom alterations made as discussed in [CONTRIBUTING.md](https://gitlab.pnnl.gov/exasgd/solvers/hykkt/-/blob/develop/CONTRIBUTING.md).
To test clang formatting of code base use:
`make clangformat`
To autofix the formatting of the code base use:
`make clangformat-fix`
## Support
To receive support or ask a question, submit an [issue](https://github.com/ORNL/hykkt/issues).
## Contributing
Please see [the developer guidelines](CONTRIBUTE.md) before attempting to contribute.
## Authors
* Shaked Regev
* Maksudul Alam
* Ryan Danahy
* Cameron Rutherford
* Kasia Swirydowicz
* Slaven Peles
## Acknowledgement
This package is developed as a part of [ExaSGD](https://www.exascaleproject.org/research-project/exasgd/) subproject of the [Exascale Computing Project](https://www.exascaleproject.org/).
## License
Copyright © 2023, UT-Battelle, LLC, and Battelle Memorial Institute.
HyKKT is a free software distributed under a BSD-style license. See the [LICENSE](LICENSE) and [NOTICE](NOTICE) files for details. All new contributions to HyKKT must be made under the smae licensing terms.