Add docs for matrix functions and exponential#251
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. 🚀 New features to boost your workflow:
|
lkdvos
left a comment
lkdvos
left a comment
There was a problem hiding this comment.
Thanks for getting this started! Left some small comments/suggestions, but overall this looks good!
|
|
||
| ```@autodocs; canonical=false | ||
| Modules = [MatrixAlgebraKit] | ||
| Filter = t -> t isa Type && (t <: MatrixAlgebraKit.MatrixFunctionViaLA || t <: MatrixAlgebraKit.MatrixFunctionViaEig || t <: MatrixAlgebraKit.MatrixFunctionViaEigh) |
There was a problem hiding this comment.
I think here we either want to add a union type for matrixfunction algorithms, or just replace this with a @docs block, it is probably overkill to search through all algorithms and then only filter for 3 specific ones, since in that case we can just manually list them :)
| | [`SVDViaPolar`](@ref) | SVD | `fixgauge`, `tol` | | ||
| | [`PolarViaSVD`](@ref) | polar | positional `svd_alg` argument | | ||
| | [`PolarNewton`](@ref) | polar | `maxiter`, `tol` | | ||
| | [`MatrixFunctionViaLA`](@ref) | exponential | | |
There was a problem hiding this comment.
Do we want to specifically separate out the matrix functions from the decompositions? It might be more clear to keep these separate
There was a problem hiding this comment.
That's a good idea. A suggestion on how to do this is in the latest commit.
Co-authored-by: Lukas Devos <ldevos98@gmail.com>
Co-authored-by: Jutho <Jutho@users.noreply.github.com>
Co-authored-by: Jutho <Jutho@users.noreply.github.com>
3 participants
Add documentation for general matrix functions, specifically for
exponential.