Skip to content

Add algorithm section in the docs#199

Merged
lkdvos merged 3 commits intomainfrom
ld-algselect-docs
Mar 24, 2026
Merged

Add algorithm section in the docs#199
lkdvos merged 3 commits intomainfrom
ld-algselect-docs

Conversation

@lkdvos
Copy link
Member

@lkdvos lkdvos commented Mar 23, 2026

Fixes #192 .

@lkdvos lkdvos requested a review from leburgel March 23, 2026 17:36
@lkdvos lkdvos added the documentation Improvements or additions to documentation label Mar 23, 2026
@github-actions
Copy link

After the build completes, the updated documentation will be available here

@codecov
Copy link

codecov bot commented Mar 23, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

lkdvos and others added 2 commits March 23, 2026 15:54
Co-authored-by: Lander Burgelman <39218680+leburgel@users.noreply.github.com>
@lkdvos lkdvos enabled auto-merge (squash) March 23, 2026 20:00
@lkdvos lkdvos disabled auto-merge March 23, 2026 21:23
@lkdvos lkdvos merged commit efe23be into main Mar 24, 2026
8 of 9 checks passed
@lkdvos lkdvos deleted the ld-algselect-docs branch March 24, 2026 13:00
The following high-level algorithm types are available.
They all accept an optional `driver` keyword to select the computational backend; see [Driver Selection](@ref sec_driverselection) for details.

| Algorithm | Applicable decompositions | Key keyword arguments |
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Was "Key keyword arguments" intentional 😄 .

Filter = t -> t isa Type && t <: MatrixAlgebraKit.Driver
```

For example, to force LAPACK for a generic matrix type, or to use a GPU backend:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This does sound like we support forcing e.g. the GPU driver on CPU matrices, which could be something people want to do (thinking that the data will automatically be transferred to the GPU, GPU does the computation, and data comes back), but is not something we (currently) support afaik.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That might actually be a very reasonable feature to add though, (mostly in the other direction, e.g. for fallback definitions of missing decompositions on GPUs)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[docs] Algorithm selection

3 participants