Skip to content

Commit 9a32830

Browse files
authored
Docs: fix build, highlight non-square options (#363)
- fix the documentation build (the upgrade to Documenter 1.0 may be responsible) - increase the visibility of the least-squares solvers and clarifies that all algorithms in "What method should I use for linear systems?" refer only to square linear systems. Closes #353
1 parent e5d10e2 commit 9a32830

File tree

3 files changed

+9
-2
lines changed

3 files changed

+9
-2
lines changed

docs/Project.toml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
[deps]
22
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
3+
IterativeSolvers = "42fd0dbc-a981-5370-80f2-aaf504508153"
34

45
[compat]
5-
Documenter = "~0.26, 0.27, 1.0, 1.1"
6+
Documenter = "1"

docs/make.jl

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ makedocs(
1010
),
1111
doctest = false,
1212
clean = true,
13+
checkdocs = :none, # consider changing to :exports, but, e.g., `?IterativeSolvers` itself seems silly to include in the docs
1314
sitename = "IterativeSolvers.jl",
1415
pages = [
1516
"Home" => "index.md",

docs/src/index.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ For more information on future methods have a look at the package [roadmap](http
88

99
## What method should I use for linear systems?
1010

11+
### Square linear systems
12+
1113
When solving linear systems $Ax = b$ for a square matrix $A$ there are quite some options. The typical choices are listed below:
1214

1315
| Method | When to use it |
@@ -22,7 +24,10 @@ We also offer [Chebyshev iteration](@ref Chebyshev) as an alternative to Conjuga
2224

2325
Stationary methods like [Jacobi](@ref), [Gauss-Seidel](@ref), [SOR](@ref) and [SSOR](@ref) can be used as smoothers to reduce high-frequency components in the error in just a few iterations.
2426

25-
When solving **least-squares** problems we currently offer just [LSMR](@ref LSMR) and [LSQR](@ref LSQR).
27+
### Non-square systems: least squares
28+
29+
When solving **least-squares** problems we currently offer [LSMR](@ref LSMR) and [LSQR](@ref LSQR).
30+
LSMR generally converges more quickly than LSQR.
2631

2732
## Eigenproblems and SVD
2833

0 commit comments

Comments
 (0)