Skip to content

Commit

Permalink
Fix a few typos on ALM docs. (#413)
Browse files Browse the repository at this point in the history
* Fix two typos in Manopt.jl

* add new entry to changelog.
  • Loading branch information
kellertuer authored Sep 26, 2024
1 parent a22ed65 commit 02d06d1
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 4 deletions.
6 changes: 6 additions & 0 deletions Changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@ All notable Changes to the Julia package `Manopt.jl` will be documented in this
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [0.5.2] – unreleased

### Changed

* fix a few typos in the docstrings.

## [0.5.1] – September 4, 2024

### Changed
Expand Down
10 changes: 8 additions & 2 deletions src/documentation_glossary.jl
Original file line number Diff line number Diff line change
Expand Up @@ -216,14 +216,17 @@ define!(
end,
)

#
#
# Problems
define!(
:Problem,
:Constrained,
(; M="M", p="p") -> """
```math
\\begin{aligned}
\\min_{$p$(_tex(:Cal, M))} & f($p)\\\\
$(_tex(:text, "subject to")) &g_i($p) ≤ 0 \\quad $(_tex(:text, " for ")) i= 1, …, m,\\\\
$(_tex(:text, "subject to"))$(_tex(:quad))&g_i($p) ≤ 0 \\quad $(_tex(:text, " for ")) i= 1, …, m,\\\\
\\quad & h_j($p)=0 \\quad $(_tex(:text, " for ")) j=1,…,n,
\\end{aligned}
```
Expand Down Expand Up @@ -299,8 +302,11 @@ define!(
return "* `$(display)$(type ? "::$(length(t) > 0 ? t : _var(s, :type))" : "")=`$(length(default) > 0 ? default : _var(s, :default; kwargs...))$(description ? ": $(_var(s, :description; kwargs...))" : "")$(disp_add)"
end,
)

#
#
#
# Actual variables
# variables / Names used in Arguments, Fields, and Keywords

define!(
:Variable,
Expand Down
4 changes: 2 additions & 2 deletions src/solvers/augmented_Lagrangian_method.jl
Original file line number Diff line number Diff line change
Expand Up @@ -231,9 +231,9 @@ This method can work in-place of `p`.
The aim of the ALM is to find the solution of the constrained optimisation task
$_problem(:Constrained)
$(_problem(:Constrained))
where `M` is a Riemannian manifold, and ``f``, ``$(_math(:Sequence, "g", "i", "1", "n"))`` and ``$(_math(:Sequence, "h", "j", "1", "m"))
where `M` is a Riemannian manifold, and ``f``, ``$(_math(:Sequence, "g", "i", "1", "n"))`` and ``$(_math(:Sequence, "h", "j", "1", "m"))``
are twice continuously differentiable functions from `M` to ℝ.
In every step ``k`` of the algorithm, the [`AugmentedLagrangianCost`](@ref)
``$(_doc_AL_Cost("k"))`` is minimized on $(_tex(:Cal, "M")),
Expand Down

0 comments on commit 02d06d1

Please sign in to comment.