diff --git a/Changelog.md b/Changelog.md index 988dac3044..902ff269c7 100644 --- a/Changelog.md +++ b/Changelog.md @@ -10,7 +10,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Fixed -* fixes a few typos in the doc strings of matrix update formulae within the quasi-Newton solver. +* fixes a few typos in the doc strings of matrix update formulae within the quasi-Newton and CG solver. ## [0.5.27] November 11, 2025 diff --git a/src/plans/conjugate_gradient_plan.jl b/src/plans/conjugate_gradient_plan.jl index 1e30fb3933..d9d27e2856 100644 --- a/src/plans/conjugate_gradient_plan.jl +++ b/src/plans/conjugate_gradient_plan.jl @@ -52,7 +52,7 @@ The following fields from above β` with `amp` an [`AbstractManoptProblem`](@ref), `cgs` is the [`ConjugateGradientDescentState`](@ref), and `k` is the current iterate. -* `restart_condition::AbstractRestartCondition=`[`NeverRestart`]`)(@ref)`()`: +* `restart_condition::AbstractRestartCondition=`[`NeverRestart`](@ref)`()`: rule when the algorithm should restart, i.e. use the negative gradient instead of the computed direction, as a functior where the resulting function maps are `(amp, cgs, k) -> corr::Bool` with `amp` an [`AbstractManoptProblem`](@ref), `cgs` is the [`ConjugateGradientDescentState`](@ref), and `k` is the current iterate. @@ -97,6 +97,8 @@ $(_var(:Keyword, :vector_transport_method)) If you provide the [`ManifoldFirstOrderObjective`](@ref) directly, the `evaluation=` keyword is ignored. The decorations are still applied to the objective. +$(_note(:OtherKeywords)) + $(_note(:OutputSection)) """ diff --git a/tutorials/AutomaticDifferentiation.qmd b/tutorials/AutomaticDifferentiation.qmd index 18627c3e38..948dedb89b 100644 --- a/tutorials/AutomaticDifferentiation.qmd +++ b/tutorials/AutomaticDifferentiation.qmd @@ -81,7 +81,7 @@ F: ℝ^{n+1} → ℝ,\quad F(\mathbf x) = \frac{\mathbf x^\mathrm{T}A\mathbf x} Minimizing this function yields the smallest eigenvalue $\lambda_1$ as a value and the corresponding minimizer $\mathbf x^*$ is a corresponding eigenvector. -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}$, +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}$, ```math \operatorname*{arg\,min}_{p ∈ 𝕊^n}\ f(p) = \operatorname*{arg\,min}_{\ p ∈ 𝕊^n} p^\mathrm{T}Ap