Skip to content

Add use of MatrixAlgebraKit.default_algorithm to decomposition documentation #167

@leburgel

Description

@leburgel

In order to customize decompositions using keyword arguments rather than passing explicit algorithm instances, e.g.

f(A; kwargs...) -> F...

currently, it's a bit tricky to figure out which keyword arguments are available, since these are very algorithm-dependent. While this algorithm-dependence is emphasized in the documentation and all the algorithm docstrings nicely document their kwargs, it is not actually that obvious how a user can figure out which algorithm is used for which decomposition by default.

To address this, it would be nice to explicitly mention the use of MatrixAlgebraKit.default_algorithm as a quick way to figure out what algorithm is used by default, and by extension what keyword arguments a user can pass to a decomposition.

I'm happy to file a PR containing a few lines that try to explain this. One potential problem with this is that default_algorithm is not currently exported, so explicitly advertising its use might look a bit weird. Would there be any issues with exporting default_algorithm?

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions