Skip to content

fix README #55

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
DanecLacey merged 1 commit into from
Dec 13, 2025
Merged

fix README #55

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
# SmaxKernels

**S**parse **MA**trix mpi+**X** **Kernels** is a lightweight, portable C++ library providing high-performance implementations of popular sparse matrix kernels of the form `C = A op B`.
**S**parse **MA**tri**X** **Kernels** is a lightweight, portable C++ library providing high-performance implementations of popular sparse matrix kernels of the form `C = A op B`.

## Supported Kernels and Platforms ##
| Sparse Kernel | OpenMP | CUDA | MPI | Matrix Formats |
|-------------- |---------- |----------|---------- | ----------|
| Matrix-Vector Multiplication -- **SpMV** | ✅ | ✅ | ❌ | CRS, BCRS, Sell-C-sigma |
| Matrix-Multiple Vector Multiplication -- **SpMM** | ✅ | ❌ | ❌ | CRS |
| Matrix-Sparse Matrix Multiplication -- **SpGEMM** | ✅ | ❌ | ❌ | CRS |
| Triangular Solve -- **SpTRSV** | ✅ | ❌ | ❌ | CRS |
| Batched Triangular Solve -- **SpTRSM** | ✅ | ❌ | ❌ | CRS |
| Sparse Kernel | OpenMP | CUDA | Matrix Formats |
|-------------- |---------- |----------| ----------|
| Matrix-Vector Multiplication -- **SpMV** | ✅ | ✅ | CRS, BCRS, Sell-C-sigma |
| Matrix-Multiple Vector Multiplication -- **SpMM** | ✅ | ❌ | CRS |
| Matrix-Sparse Matrix Multiplication -- **SpGEMM** | ✅ | ❌ | CRS |
| Triangular Solve -- **SpTRSV** | ✅ | ❌ | CRS |
| Batched Triangular Solve -- **SpTRSM** | ✅ | ❌ | CRS |

## Features ##
* Clean, minimalist library interface
Expand Down Expand Up @@ -46,4 +46,4 @@ This project is very much still in development, and many features may be unfinis
* 2025-06-19: It is strongly recommended to use intel compilers when interating with tests in `examples/validation` for ABI compatability.

## Contributing ##
Contributions are welcome! We follow a branching strategy as detailed [in this blog post](https://nvie.com/posts/a-successful-git-branching-model/). To report an issue or propose additions / changes, please open an issue.
Contributions are welcome! We follow a branching strategy as detailed [in this blog post](https://nvie.com/posts/a-successful-git-branching-model/). To report an issue or propose additions / changes, please open an issue.