Skip to content

Commit 44e2bfc

Browse files
authored
Kellertuer/fix math typos2 (#536)
* Fix another typo * Fix typos and extend doc string for CG. * add changelog entry * Fix another typo.
1 parent 9f241df commit 44e2bfc

5 files changed

Lines changed: 7 additions & 5 deletions

File tree

Changelog.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1010

1111
### Fixed
1212

13-
* fixes a few typos in the doc strings of matrix update formulae within the quasi-Newton solver.
13+
* fixes a few typos in the doc strings of matrix update formulae within the quasi-Newton and CG solver.
1414

1515
## [0.5.27] November 11, 2025
1616

src/plans/conjugate_gradient_plan.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ The following fields from above <re keyword arguments
5252
$(_var(:Keyword, :X, "initial_gradient"))
5353
$(_var(:Keyword, :p; add = :as_Initial))
5454
* `coefficient=[`ConjugateDescentCoefficient`](@ref)`()`: specify a CG coefficient, see also the [`ManifoldDefaultsFactory`](@ref).
55-
* `restart_condition=[`NeverRestart`](@ref)`()`: specify a [restart condition](@ref cg-restart). It defaults to never restart.
55+
* `restart_condition=`[`NeverRestart`](@ref)`()`: specify a [restart condition](@ref cg-restart). It defaults to never restart.
5656
$(_var(:Keyword, :stepsize; default = "[`default_stepsize`](@ref)`(M, ConjugateGradientDescentState; retraction_method=retraction_method)`"))
5757
$(_var(:Keyword, :stopping_criterion; default = "[`StopAfterIteration`](@ref)`(500)`$(_sc(:Any))[`StopWhenGradientNormLess`](@ref)`(1e-8)`)"))
5858
$(_var(:Keyword, :retraction_method))

src/plans/solver_state.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -367,7 +367,7 @@ For the point storage use `PointStorageKey`. For tangent vector storage use
367367
368368
# Constructors
369369
370-
StoreStateAction(s::Vector{Symbol})
370+
StoreStateAction(s::Vector{Symbol})
371371
372372
This is equivalent as providing `s` to the keyword `store_fields`, just that here, no manifold
373373
is necessity for the construction.

src/solvers/conjugate_gradient_descent.jl

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ $(_var(:Argument, :p))
8383
rule to compute the descent direction update coefficient ``β_k``, as a functor, where
8484
the resulting function maps are `(amp, cgs, k) -> β` with `amp` an [`AbstractManoptProblem`](@ref),
8585
`cgs` is the [`ConjugateGradientDescentState`](@ref), and `k` is the current iterate.
86-
* `restart_condition::AbstractRestartCondition=`[`NeverRestart`]`)(@ref)`()`:
86+
* `restart_condition::AbstractRestartCondition=`[`NeverRestart`](@ref)`()`:
8787
rule when the algorithm should restart, i.e. use the negative gradient instead of the computed direction,
8888
as a functior where the resulting function maps are `(amp, cgs, k) -> corr::Bool` with `amp` an [`AbstractManoptProblem`](@ref),
8989
`cgs` is the [`ConjugateGradientDescentState`](@ref), and `k` is the current iterate.
@@ -97,6 +97,8 @@ $(_var(:Keyword, :vector_transport_method))
9797
If you provide the [`ManifoldFirstOrderObjective`](@ref) directly, the `evaluation=` keyword is ignored.
9898
The decorations are still applied to the objective.
9999
100+
$(_note(:OtherKeywords))
101+
100102
$(_note(:OutputSection))
101103
"""
102104

tutorials/AutomaticDifferentiation.qmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ F: ℝ^{n+1} → ℝ,\quad F(\mathbf x) = \frac{\mathbf x^\mathrm{T}A\mathbf x}
8181

8282
Minimizing this function yields the smallest eigenvalue $\lambda_1$ as a value and the corresponding minimizer $\mathbf x^*$ is a corresponding eigenvector.
8383

84-
Since the length of an eigenvector is irrelevant, there is an ambiguity in the cost function. It can be better phrased on the sphere $ 𝕊^n$ of unit vectors in $ℝ^{n+1}$,
84+
Since the length of an eigenvector is irrelevant, there is an ambiguity in the cost function. It can be better phrased on the sphere $𝕊^n$ of unit vectors in $ℝ^{n+1}$,
8585

8686
```math
8787
\operatorname*{arg\,min}_{p ∈ 𝕊^n}\ f(p) = \operatorname*{arg\,min}_{\ p ∈ 𝕊^n} p^\mathrm{T}Ap

0 commit comments

Comments
 (0)