Skip to content

Commit 9670dd6

Browse files
Fix failing precompilation related to Glossaries.jl (#567)
* fix failing precompilation related to Glossaries.jl * Fix a few more typos that only showed up now that Glossaries.jl errors a bit more. Fixes a typo. * format * bump version and add news entry * Apply suggestions --------- Co-authored-by: Ronny Bergmann <git@ronnybergmann.net>
1 parent 82fe6c2 commit 9670dd6

20 files changed

Lines changed: 35 additions & 29 deletions

Changelog.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,12 @@ The file was started with Version `0.4`.
66
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
77
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
88

9+
## [0.5.32] January 15, 2026
10+
11+
### Fixed
12+
13+
* Fixed failing precompilation related to the release of Glossaries.jl v0.1.1 (#567).
14+
915
## [0.5.31] January 11, 2026
1016

1117
### Changed

Project.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
name = "Manopt"
22
uuid = "0fc0a36d-df90-57f3-8f93-d78a9fc72bb5"
3-
version = "0.5.31"
3+
version = "0.5.32"
44
authors = ["Ronny Bergmann <manopt@ronnybergmann.net>"]
55

66
[workspace]
@@ -47,7 +47,7 @@ ColorTypes = "0.9.1, 0.10, 0.11, 0.12"
4747
Colors = "0.11.2, 0.12, 0.13"
4848
DataStructures = "0.17, 0.18, 0.19"
4949
Dates = "1.10"
50-
Glossaries = "0.1.0"
50+
Glossaries = "0.1.1"
5151
JuMP = "1.15"
5252
LRUCache = "1.4"
5353
LineSearches = "7.2.0"

_typos.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
methodes = "methodes" # french
33
Serie = "Serie" # french
44
sur = "sur" # french
5-
cmo = "cmo" # often ussed abbreciation for constrained manifold objective
5+
cmo = "cmo" # often used abbreviation for constrained manifold objective
66

77
[files]
88
extend-exclude = [
99
"tutorials/*.html",
1010
# rendered from tutorials/*.qmd -Z we do not want typos twice
1111
"docs/src/tutorials/*.md",
1212
"joss/paper.md",
13-
]
13+
]

src/documentation_glossary.jl

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ _tex_Cal(letter) = raw"\mathcal{" * "$letter" * "}"
5454
Glossaries.define!(_glossary_tex_terms, :Cal, :math, _tex_Cal)
5555
function _tex_cases(cases...)
5656
return raw"\begin{cases}" *
57-
"$(join([" $(ci)" for ci in c], raw"\\\\ "))" *
57+
"$(join([" $(ci)" for ci in cases], raw"\\\\ "))" *
5858
raw"\end{cases}"
5959
end
6060
Glossaries.define!(_glossary_tex_terms, :cases, :math, _tex_cases)
@@ -80,7 +80,7 @@ Glossaries.define!(_glossary_tex_terms, :inner, :math, _tex_inner)
8080
Glossaries.define!(_glossary_tex_terms, :log, :math, raw"\log")
8181
Glossaries.define!(_glossary_tex_terms, :max, :math, raw"\max")
8282
Glossaries.define!(_glossary_tex_terms, :min, :math, raw"\min")
83-
_tex_norm(v; index = "") = raw"\lVert " * "$v" * raw" \rVert" * "_{$index}"
83+
_tex_norm(v; index = "") = raw"\lVert " * "$v" * raw" \rVert" * (length(index) > 0 ? "_{$index}" : "")
8484
Glossaries.define!(_glossary_tex_terms, :norm, :math, _tex_norm)
8585
_tex_pmatrix(lines...) = raw"\begin{pmatrix} " * join(lines, raw"\\ ") * raw"\end{pmatrix}"
8686
Glossaries.define!(_glossary_tex_terms, :pmatrix, :math, _tex_pmatrix)

src/helpers/checks.jl

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -165,13 +165,13 @@ no plot is generated.
165165
# Keyword arguments
166166
167167
* `check_grad=true`:
168-
verify that ``$(_tex(:grad))f(p) ∈ $(_math(:TangentSpace)))``.
168+
verify that ``$(_tex(:grad))f(p) ∈ $(_math(:TangentSpace))``.
169169
* `check_linearity=true`:
170170
verify that the Hessian is linear, see [`is_Hessian_linear`](@ref) using `a`, `b`, `X`, and `Y`
171171
* `check_symmetry=true`:
172172
verify that the Hessian is symmetric, see [`is_Hessian_symmetric`](@ref)
173173
* `check_vector=false`:
174-
verify that `$(_tex(:Hess)) f(p)[X] ∈ $(_math(:TangentSpace)))`` using `is_vector`.
174+
verify that `$(_tex(:Hess)) f(p)[X] ∈ $(_math(:TangentSpace))`` using `is_vector`.
175175
* `mode=:Default`:
176176
specify the mode for the verification; the default assumption is,
177177
that the retraction provided is of second order. Otherwise one can also verify the Hessian

src/plans/conjugate_residual_plan.jl

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
# Objective.
44
_doc_CR_cost = """
55
```math
6-
f(X) = $(_tex(:frac, 1, 2)) $(_tex(:norm, _tex(:Cal, "A") * "[X] + b"; index = "p"))^2,\\qquad X ∈ $(_math(:TangentSpace))),
6+
f(X) = $(_tex(:frac, 1, 2)) $(_tex(:norm, _tex(:Cal, "A") * "[X] + b"; index = "p"))^2,\\qquad X ∈ $(_math(:TangentSpace)),
77
```
88
"""
99
@doc """
@@ -13,7 +13,7 @@ Model the objective
1313
1414
$(_doc_CR_cost)
1515
16-
defined on the tangent space ``$(_math(:TangentSpace)))`` at ``p`` on the manifold ``$(_math(:Manifold)))``.
16+
defined on the tangent space ``$(_math(:TangentSpace))`` at ``p`` on the manifold ``$(_math(:Manifold))``.
1717
1818
In other words this is an objective to solve ``$(_tex(:Cal, "A")) = -b(p)``
1919
for some linear symmetric operator and a vector function.
@@ -290,7 +290,7 @@ Stop when re relative residual in the [`conjugate_residual`](@ref)
290290
is below a certain threshold, i.e.
291291
292292
```math
293-
$(_tex(:displaystyle))$(_tex(:frac, _tex(:norm, "r^{(k)"), "c")) ≤ ε,
293+
$(_tex(:displaystyle))$(_tex(:frac, _tex(:norm, "r^{(k)}"), "c")) ≤ ε,
294294
```
295295
296296
where ``c = $(_tex(:norm, "b"))`` of the initial vector from the vector field in ``$(_tex(:Cal, "A"))(p)[X] + b(p) = 0_p``,

src/plans/first_order_plan.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1002,7 +1002,7 @@ end
10021002
PreconditionedDirection(M::AbstractManifold, preconditioner; kwargs...)
10031003
10041004
Add a preconditioner to a gradient processor following the [motivation for optimization](https://en.wikipedia.org/wiki/Preconditioner#Preconditioning_in_optimization),
1005-
as a linear invertible map ``P: $(_math(:TangentSpace)))$(_math(:TangentSpace)))`` that usually should be
1005+
as a linear invertible map ``P: $(_math(:TangentSpace))$(_math(:TangentSpace))`` that usually should be
10061006
10071007
* symmetric: ``⟨X, P(Y)⟩ = ⟨P(X), Y⟩``
10081008
* positive definite ``⟨X, P(X)⟩ > 0`` for ``X`` not the zero-vector

src/plans/hessian_plan.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -246,7 +246,7 @@ A functor to approximate the Hessian by a finite difference of gradient evaluati
246246
247247
Given a point `p` and a direction `X` and the gradient ``$(_tex(:grad)) f(p)``
248248
of a function ``f`` the Hessian is approximated as follows:
249-
let ``c`` be a stepsize, ``X ∈ $(_math(:TangentSpace)))`` a tangent vector and ``q = $_doc_ApproxHessian_step``
249+
let ``c`` be a stepsize, ``X ∈ $(_math(:TangentSpace))`` a tangent vector and ``q = $_doc_ApproxHessian_step``
250250
be a step in direction ``X`` of length ``c`` following a retraction
251251
Then the Hessian is approximated by the finite difference of the gradients,
252252
where ``$(_math(:VectorTransport))`` is a vector transport.

src/plans/quasi_newton_plan.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -515,7 +515,7 @@ end
515515
_doc_QN_B = """
516516
```math
517517
$(_tex(:Cal, "B"))_k^{(0)}[⋅]
518-
= $(_tex(:frac, "$(_tex(:inner, "s_{k-1}", "y_{k-1}"; index = "p_k"))", "$(_tex(:inner, "y_{k-1}", "y_{k-1}"; index = "p_k"))"))$(_tex(:Id))_{$(_math(:TangentSpace)))}[⋅]
518+
= $(_tex(:frac, "$(_tex(:inner, "s_{k-1}", "y_{k-1}"; index = "p_k"))", "$(_tex(:inner, "y_{k-1}", "y_{k-1}"; index = "p_k"))"))$(_tex(:Id))_{$(_math(:TangentSpace))}[⋅]
519519
```
520520
"""
521521

src/plans/stepsize/stepsize.jl

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -182,7 +182,7 @@ end
182182
183183
Specify a step size that performs an Armijo line search. Given a Function ``f:$(_math(:Manifold))nifold))nifold))nifold)))→ℝ``
184184
and its Riemannian Gradient ``$(_tex(:grad))f: $(_math(:Manifold))nifold))nifold))nifold)))→$(_math(:TangentBundle))``,
185-
the current point ``p∈$(_math(:Manifold))nifold))nifold)))`` and a search direction ``X∈$(_math(:TangentSpace)))``.
185+
the current point ``p∈$(_math(:Manifold))nifold))nifold)))`` and a search direction ``X∈$(_math(:TangentSpace))``.
186186
187187
Then the step size ``s`` is found by reducing the initial step size ``s`` until
188188
@@ -1630,7 +1630,7 @@ See [`WolfePowellLinesearch`](@ref) for the math details
16301630
$(_fields(:X; name = "candidate_direction"))
16311631
$(_fields(:p; name = "candidate_point"))
16321632
as temporary storage for candidates
1633-
$(_fields(:X, "candidate_tangent"))
1633+
$(_fields(:X, name = "candidate_tangent"))
16341634
* `last_stepsize::R`
16351635
* `max_stepsize::R`
16361636
$(_fields(:retraction_method))

0 commit comments

Comments
 (0)