Merge branch 'master' into kellertuer/JuMP-on-non-array-points

Author: kellertuer

.github/workflows/CompatHelper.yml

@@ -22,7 +22,7 @@ jobs:
       - uses: julia-actions/julia-buildpkg@v1
       - uses: julia-actions/julia-runtest@v1
       - uses: julia-actions/julia-processcoverage@v1
-      - uses: codecov/codecov-action@v5
+      - uses: codecov/codecov-action@v6
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
           file: ./lcov.info

.github/workflows/ci.yml

@@ -18,10 +18,10 @@ jobs:
         with:
           version: "1.12"
       - name: Julia Cache
-        uses: julia-actions/cache@v2
+        uses: julia-actions/cache@v3
       - name: Cache Quarto
         id: cache-quarto
-        uses: actions/cache@v4
+        uses: actions/cache@v5
         env:
           cache-name: cache-quarto
         with:
@@ -31,7 +31,7 @@ jobs:
             ${{ runner.os }}-${{ env.cache-name }}-
       - name: Cache Documenter
         id: cache-documenter
-        uses: actions/cache@v4
+        uses: actions/cache@v5
         env:
           cache-name: cache-documenter
         with:

.github/workflows/documenter.yml

@@ -0,0 +1,13 @@
+name: Spell Check
+
+on: [pull_request, workflow_dispatch]
+
+jobs:
+  typos-check:
+    name: Spell Check with Typos
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Actions Repository
+        uses: actions/checkout@v6
+      - name: Check spelling
+        uses: crate-ci/typos@v1.45.0

.github/workflows/spell_check.yml

@@ -17,6 +17,7 @@ The following is a set of guidelines to [`Manopt.jl`](https://juliamanifolds.git
     - [Provide a new example](#Provide-a-new-example)
     - [Code style](#Code-style)
     - [Concerning the documentation](#Concerning-the-documentation)
+    - [Spell checking](#Spell-checking)
 ## I just have a question
 
 The developer can most easily be reached in the Julia Slack channel [#manifolds](https://julialang.slack.com/archives/CP4QF0K5Z).
@@ -83,4 +84,20 @@ Please follow a few internal conventions:
 
 If you implement a new feature, a tutorial how to use it would be appreciated as well. Tutorials are written as [Quarto](https://quarto.org/) documents and stored in the `tutorials/` folder. This is rendered automatically into the documentation page, you just have to add a menu entry within the tutorial sub menu.
 
-If you implement an algorithm with a certain numerical example in mind, it would be great, if this could be added to the [ManoptExamples.jl](https://github.com/JuliaManifolds/ManoptExamples.jl) package as well.
+If you implement an algorithm with a certain numerical example in mind, it would be great, if this could be added to the [ManoptExamples.jl](https://github.com/JuliaManifolds/ManoptExamples.jl) package as well.
+
+### Spell checking
+
+We use [crate-ci/typos](https://github.com/crate-ci/typos) for spell checking, which is run automatically on GitHub Actions, but you can also run it locally using their command line tool.
+
+### On the use of AI
+
+Following the [Julia Discourse Guidelines – Keep it tidy](https://discourse.julialang.org/faq#keep-tidy),
+please do not open PRs or issues that are pure AI generated. `Manopt.jl` is in its aspects,
+especially the code, the documentation, as well as the tests, carefully curated to be concise,
+well-documented, comprehensive, but in tests also in a (hopefully) good balance between
+ensuring functionality and “over testing”.
+
+Of course it is ok to get help from an AI, e.g. when refactoring parts of the code,
+but please always carefully reflect on the results proposed and do not “[vibe code](https://en.wikipedia.org/wiki/Vibe_coding)”. That usually does not work well nor fit the exact mathematical definitions,
+reliability and stability as well as and abstractions of the provided algorithms `Manopt.jl` aims to provide.

CONTRIBUTING.md

@@ -6,18 +6,70 @@ The file was started with Version `0.4`.
 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.30] unreleased
+## [0.6.0] unreleased
+
+This is a breaking change since the JuMP extension is dropped. 
+
+### Changed
+
+* removed the JuMP extension, since it was a bit incomplete and hard to maintain, and not possible to extend to all manifolds. The main reason is, that matrices are a bit tough to represent in JuMP, which is vector based, and types points are nearly impossible to represent. Distinguishing between points and tangent vectors is also a bit hard to track.
+ 
+## [0.5.35] April 3, 2026
+
+### Changed
+
+* Improved formatting of the references in the Readme.md (#586)
+* Bump compat for RecursiveArrayTools.jl to include version 4
+* deactivate CompatHelper Action and solely use dependabot
+
+## [0.5.34] March 3, 2026
+
+### Fixed
+
+* `Float32` support in `trust_regions` solver was broken in the previous release, which is now fixed.
+
+## [0.5.33] February 18, 2026
+
+### Added
+
+* A clarification on the use of AI in the [CONTRIBUTING.md](https://manoptjl.org/stable/contributing/) (#573)
+* `_produce_type` now accepts the point `p` as an optional third argument, which can be used to produce objects with specific point type for internal buffers. The addition has been utilized in `DirectionUpdateRule`s and `Stepsize`s to improve GPU and custom floating point type compatibility. (#577)
+* Added another package and paper using `Manopt.jl` to the about page (#576).
+
+### Fixed
+
+* `DistanceOverGradientsStepsize` now requires explicitly passing a point as the second argument because it logically depends on receiving the initial point. (#577)
+
+## [0.5.32] January 15, 2026
+
+### Fixed
+
+* Fixed failing precompilation related to the release of Glossaries.jl v0.1.1 (#567).
+
+## [0.5.31] January 11, 2026
 
 ### Changed
 
-* removed the JuMP extension, since it was a bit incomplete and hard to maintain,
- and not possible to extend to all manifolds. The main reason is, that matrices are a bit tough to represent in JuMP, which is vector based, and types points are nearly impossible to represent. Distinguishing between points and tangent vectors is also a bit hard to track.
+Moved the documentation glossaries to using the new [Glossaries.jl](https://github.com/JuliaManifolds/Glossaries.jl) package.
+
+## [0.5.30] December 10, 2025
+
+### Added
+
+* add keyword argument `is_feasible_error` to `interior_point_Newton` to control how to handle infeasible starting points (#556)
+* add keyword argument `at_init` to some debug options to control whether they print already at the initialisation and hence before the first iteration (#552)
+
+### Fixed
+
+* fixed a few typos in the documentation (#557)
+* fixed a bug in `StopWhenRepeated` where it stopped already at initialisation if the interior stopping criterion was satisfied (#558)
 
 ## [0.5.29] November 26, 2025
 
 ### Added
 
 * a keyword argument `atol` to the `ConstrainedManifoldObjective` to set a tolerance for constraint satisfaction. (#545)
+* a spell checker following [crate-ci/typos](https://github.com/crate-ci/typos)
 
 ### Fixed
 
@@ -28,7 +80,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 * Removed `atol` from `DebugFeasibility` and instead use the one newly added `atol` from the `ConstrainedManifoldObjective`. (#546)
 * Move from CompatHelper to dependabot to keep track of dependency updates in Julia packages. (#547)
 * moved the `ManoptTestSuite` module to a sub module `Manopt.Test` within `Manopt.jl`,
-so it can be easier resused by others as well (#550)
+so it can be easier reused by others as well (#550)
 * moved to using a `Project.toml` for tests and an overall `[Workspace]`.
   This also allows finally to run single test files without installing all packages manually, but instead just switching to and instantiating the test environment. (#550)
 * for compatibility, state also `[source]` entries consistently in the sub `Project.toml` files. (#550)
@@ -253,7 +305,7 @@ present; they were changed to `retact_fused!`.
 * A scaling error that appeared only when calling `get_cost_function` on the new `ScaledManifoldObjective`.
 * Documentation issues for quasi-Newton solvers.
 * fixes a scaling error in quasi newton
-* Fixes printing of JuMP models containg Manopt solver.
+* Fixes printing of JuMP models containing Manopt solver.
 
 ## [0.5.12] April 13, 2025
 

Changelog.md

@@ -1,14 +1,18 @@
 name = "Manopt"
 uuid = "0fc0a36d-df90-57f3-8f93-d78a9fc72bb5"
-authors = ["Ronny Bergmann <manopt@ronnybergmann.net>"]
-version = "0.5.29"
+version = "0.5.34"
+authors = [{family-names = "Bergmann", given-names = "Ronny", alias = "kellertuer", city = "Trondheim", affiliation = "Norwegian University of Science and Technology", country = "NO", email = "manopt@ronnybergmann.net", orcid = "https://orcid.org/0000-0001-8342-7218", website = "https://ronnybergmann.net"}]
+
+[workspace]
+projects = ["test", "docs", "tutorials"]
 
 [deps]
 ColorSchemes = "35d6a980-a343-548e-a6ea-1d62b119f2f4"
 ColorTypes = "3da002f7-5984-5a60-b8a6-cbb66c0b333f"
 Colors = "5ae59095-9a9b-59fe-a467-6f913c188581"
 DataStructures = "864edb3b-99cc-5e75-8d2d-829cb0a9cfe8"
 Dates = "ade2ca70-3891-5945-98fb-dc099432e06a"
+Glossaries = "8f48dd54-e453-4cdc-9500-53b96149560b"
 LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
 ManifoldDiff = "af67fdf4-a580-4b9f-bbec-742ef357defd"
 ManifoldsBase = "3362f125-f0bb-47a3-aa74-596ffd7ef2fb"
@@ -42,24 +46,22 @@ ColorTypes = "0.9.1, 0.10, 0.11, 0.12"
 Colors = "0.11.2, 0.12, 0.13"
 DataStructures = "0.17, 0.18, 0.19"
 Dates = "1.10"
+Glossaries = "0.1.1"
 JuMP = "1.15"
-LinearAlgebra = "1.10"
-LineSearches = "7.2.0"
 LRUCache = "1.4"
+LineSearches = "7.2.0"
+LinearAlgebra = "1.10"
 ManifoldDiff = "0.3.8, 0.4"
-ManifoldsBase = "2.2.0"
 Manifolds = "0.11.2"
+ManifoldsBase = "2.3.1"
 Markdown = "1.10"
 Plots = "1.30"
 Preferences = "1.4"
 Printf = "1.10"
 QuadraticModels = "0.9"
 Random = "1.10"
-RecursiveArrayTools = "2, 3"
+RecursiveArrayTools = "2, 3, 4"
 RipQP = "0.6.4, 0.7"
 SparseArrays = "1.10"
 Statistics = "1.10"
 julia = "1.10"
-
-[workspace]
-projects = ["test", "docs", "tutorials"]

Project.toml

@@ -38,6 +38,13 @@ using Pkg; Pkg.add("Manopt");
 
 and then checkout the [🏔️ Get started with Manopt.jl](https://manoptjl.org/stable/tutorials/getstarted/) tutorial.
 
+You can also watch an introduction given at JuliaCon 2022
+
+[<img src ="https://img.youtube.com/vi/thbekfsyhCE/maxresdefault.jpg" style="width:66%; align:center;">](https://youtu.be/thbekfsyhCE)
+
+or look at the slides from the presentation [here](https://ronnybergmann.net/talks/2022-JuliaCon-Manoptjl-extended.pdf).
+
+
 ## Related packages
 
 Manopt.jl is based on [`ManifoldsBase.jl`](https://juliamanifolds.github.io/ManifoldsBase.jl/stable/),
@@ -54,6 +61,15 @@ The following packages are related to `Manopt.jl`
 
 If you use `Manopt.jl` in your work, please cite the following
 
+> _Bergmann, R._ (2022).
+> **Manopt.jl: Optimization on Manifolds in Julia**,
+> Journal of Open Source Software, 7(70), 3866.<br/>
+> doi: [10.21105/joss.03866](https://doi.org/10.21105/joss.03866)
+
+<details>
+
+<summary><code>Bergmann:2022</code> (BibLaTeX) </summary>
+
 ```biblatex
 @article{Bergmann2022,
     Author    = {Ronny Bergmann},
@@ -68,8 +84,17 @@ If you use `Manopt.jl` in your work, please cite the following
 }
 ```
 
+</details>
+
 To refer to a certain version or the source code in general please cite for example
 
+> _Bergmann, R._ (2026). **Manopt.jl**, Zenodo. <br/>
+> doi: [10.5281/zenodo.4290905](https://doi.org/10.5281/zenodo.4290905)
+
+<details>
+
+  <summary><code>Manoptjl-zenodo-mostrecent</code> (BibLaTeX)</summary>
+
 ```biblatex
 @software{manoptjl-zenodo-mostrecent,
     Author    = {Ronny Bergmann},
@@ -81,10 +106,22 @@ To refer to a certain version or the source code in general please cite for exam
 }
 ```
 
-for the most recent version or a corresponding version specific DOI, see [the list of all versions](https://zenodo.org/search?page=1&size=20&q=conceptrecid:%224290905%22&sort=-version&all_versions=True).
+</details>
+
+for the most recent version.
+For a corresponding version specific DOI, see [the list of all versions](https://zenodo.org/search?page=1&size=20&q=conceptrecid:%224290905%22&sort=-version&all_versions=True).
 
 If you are also using [`Manifolds.jl`](https://juliamanifolds.github.io/Manifolds.jl/stable/) please consider to cite
 
+> _Axen, S. D., Baran, M., Bergmann, R., Rzecki, K._ (2023).
+> **Manifolds.jl: An Extensible Julia Framework for Data Analysis on Manifolds**,
+> ACM Transactions on Mathematical Software, Volume 49, Issue 4, Article No. 33, pages 1–23. <br>
+> doi: [10.1145/3618296](https://doi.org/10.1145/3618296),
+> arXiv: [2106.08777](https://arxiv.org/abs/2106.08777)
+<details>
+
+  <summary><code>AxenBaranBergmannRzecki:2023</code>(BibLaTeX)</summary>
+
 ```biblatex
 @article{AxenBaranBergmannRzecki:2023,
     AUTHOR    = {Axen, Seth D. and Baran, Mateusz and Bergmann, Ronny and Rzecki, Krzysztof},
@@ -93,14 +130,15 @@ If you are also using [`Manifolds.jl`](https://juliamanifolds.github.io/Manifold
     JOURNAL   = {ACM Transactions on Mathematical Software},
     MONTH     = {dec},
     NUMBER    = {4},
-    TITLE     = {Manifolds.jl: An Extensible Julia Framework for Data Analysis on Manifolds},
+    TITLE     = {Manifolds.Jl: An Extensible Julia Framework for Data Analysis on Manifolds},
     VOLUME    = {49},
     YEAR      = {2023}
 }
 ```
 
+</details>
+
 as well.
-Note that all citations are in [BibLaTeX](https://ctan.org/pkg/biblatex) format.
 
 `Manopt.jl` belongs to the Manopt family:
 

Readme.md

@@ -0,0 +1,13 @@
+[default.extend-words]
+methodes = "methodes" # french
+Serie = "Serie" # french
+sur = "sur" # french
+cmo = "cmo" # often used abbreviation for constrained manifold objective
+
+[files]
+extend-exclude = [
+"tutorials/*.html",
+# rendered from tutorials/*.qmd -Z we do not want typos twice
+"docs/src/tutorials/*.md",
+"joss/paper.md",
+]

_typos.toml

@@ -44,5 +44,5 @@ ManifoldsBase = "2"
 Manopt = "0.5"
 Plots = "1"
 QuadraticModels = "0.9.6"
-RecursiveArrayTools = "2, 3"
+RecursiveArrayTools = "2, 3, 4"
 RipQP = "0.6.4, 0.7"