Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
13 changes: 13 additions & 0 deletions docs/src/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,16 @@
getstructure
sparsestructure
```

## Extension Point Functions

These functions are extension points that package extensions add methods to.
They return `nothing` unless the corresponding optional package is loaded.

```@docs
SparseMatrixIdentification.try_special_matrices
SparseMatrixIdentification.try_toeplitz
SparseMatrixIdentification.try_banded
SparseMatrixIdentification.try_blockbanded
SparseMatrixIdentification.try_almostbanded
```
2 changes: 1 addition & 1 deletion src/SparseMatrixIdentification.jl
Original file line number Diff line number Diff line change
Expand Up @@ -454,7 +454,7 @@ corresponding package is loaded. Load the relevant package to enable detection:
# Returns
One of the following matrix types based on detected structure:
- `Hilbert`: If A[i,j] = 1/(i+j-1) (requires SpecialMatrices)
- `Strang`: If the matrix is tridiagonal Toeplitz with pattern [2, -1, -1] (requires SpecialMatrices)
- `Strang`: If the matrix is tridiagonal Toeplitz with pattern `[2, -1, -1]` (requires SpecialMatrices)
- `Vandermonde`: If columns are powers of a base vector (requires SpecialMatrices)
- `Cauchy`: If A[i,j] = 1/(x[i] + y[j]) (requires SpecialMatrices)
- `Toeplitz`: If the matrix has constant diagonals (requires ToeplitzMatrices)
Expand Down
Loading