Skip to content

Commit 35f736c

Browse files
committed
docs update
1 parent b1edfdc commit 35f736c

3 files changed

Lines changed: 17 additions & 4 deletions

File tree

CHANGELOG.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Changelog
22

3-
## [2.0.0] - Planned
3+
## [2.0.0] - 2026-01-06
44

55
- Remove solver + precon API which is not based on precs or directly overloading `\`.
66
Fully rely on LinearSolve (besides `\`)
7-
- Move AMGBuilder etc corresponding packages (depending on the PRs)
7+
- Move AMGBuilder etc to corresponding packages (depending on the PRs)
88
- Keep ILUZeroPreconBuilder, JacobiPreconBuilder
99
- ExtendableSparseMatrix is now GenericExtendableSparseMatrix{SparseMatrixLNK}
1010
- Changes should be non-breaking if only ExtendableSparseMatrix was used, and no solvers or preconditioners

docs/src/extensions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Matrix extensions
1+
# Matrix extensions
22

33
## AbstractSparseMatrixExtension
44
```@docs

docs/src/extsparse.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,23 @@
11
# Extendable matrices
2+
The type hierarchy of extendable matrices in this package is as follows:
3+
4+
[`ExtendableSparse.AbstractExtendableSparseMatrixCSC`](@ref) `<: SparseArrays.AbstractSparseMatrixCSC <: SparseArrays.AbstractSparseMatrix <: AbstractMatrix`
5+
6+
The package defines two [subtypes](#Subtypes-of-AbstractExtendableSparseMatrixCSC) of [`ExtendableSparse.AbstractExtendableSparseMatrixCSC`](@ref) which are parametrized by types of [extension matrices](/extensions/#Matrix-extensions):
7+
- [`ExtendableSparse.GenericExtendableSparseMatrixCSC`](@ref) for single threaded assembly
8+
- [`ExtendableSparse.GenericMTExtendableSparseMatrixCSC`](@ref) for multithreaded assembly
9+
10+
User facing defaults are defined by [type aliases](#Type-aliases):
11+
- `const MTExtendableSparseMatrixCSC = GenericMTExtendableSparseMatrixCSC{SparseMatrixDILNKC}`
12+
- `const STExtendableSparseMatrixCSC = GenericExtendableSparseMatrixCSC{SparseMatrixLNK}`
13+
- `const ExtendableSparseMatrixCSC = STExtendableSparseMatrixCSC`
14+
- `const ExtendableSparseMatrix = ExtendableSparseMatrixCSC`
215

316
## Abstract type
417
```@docs
518
ExtendableSparse.AbstractExtendableSparseMatrixCSC
619
```
7-
## Implemented subtypes
20+
## Subtypes of AbstractExtendableSparseMatrixCSC
821
```@docs
922
ExtendableSparse.GenericExtendableSparseMatrixCSC
1023
ExtendableSparse.GenericMTExtendableSparseMatrixCSC

0 commit comments

Comments
 (0)