Skip to content

Commit c555a05

Browse files
committed
improve changelog
1 parent 36a195d commit c555a05

1 file changed

Lines changed: 11 additions & 8 deletions

File tree

Changelog.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,21 @@ 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-
## [Unreleased]
9+
## [0.5.28] November 17, 2025
10+
11+
### Changed
12+
13+
* Unified the interfaces for line search related functions, especially,
14+
* `linesearch_backtrack(M, F, p, X, s, decrease, contract, η, f0; kwargs...)` now has `lf0=` and `gradient=` keyword arguments instead of positional ones for `X` and the last `f0`, respectively. It additionally has a `Dlf0=` keyword argument to pass the evaluated differential instead of the gradient, which otherwise defaults to calling the inner product.
15+
* Refactor the nonmonotone linesearch stepsize to have an initial guess that can be set. For now it still afterwards performs the Barzilai-Borwein initial guess,
16+
so a constant initial guess is recommended here. The initial guess may be refactored in the future in a non-breaking release and the meaning of the initial guess in nonmonotone line search may change.
1017

1118
### Fixed
1219

1320
* Change the construction of the product manifold in `interior_point_newton` from `×` to `ProductManifold`, so that the algorithm also work on Product manifolds `M`, where it now correctly wraps `M` instead of extending it.
14-
* unifies the doc strings for constrained problems
15-
* fixes a few typos in the doc strings of matrix update formulae within the quasi-Newton and CG solver.
16-
* unified the interfaces for line search related functions, especially,
17-
* `linesearch_backtrack(M, F, p, X, s, decrease, contract, η, f0; kwargs...)` now has `lf0=` and `gradient=` keyword arguments instead of positional ones for `X` and the last `f0`, respectively. It additionally has a `Dlf0=` keyword argument to pass the evaluated differential instead of the gradient, which otherwise defaults to calling the inner product.
18-
* refactor the nonmonotone linesearch stepsize to have an initial guess that can be set. For now it still afterwards performs the Barzilein Borwein initial guess,
19-
so a constant initial guess is recommended here for not.
20-
* covers one last line in `proximal_gradient_plan`
21+
* Unified the doc strings for constrained problems.
22+
* Fixed a few typos in the doc strings of matrix update formulae within the quasi-Newton and CG solver.
23+
* Covered one last line in `proximal_gradient_plan`
2124

2225
## [0.5.27] November 11, 2025
2326

0 commit comments

Comments
 (0)