Skip to content

Commit 6e9d685

Browse files
committed
Merge branch 'kellertuer/refactor-initial-guess' of github.com:JuliaManifolds/Manopt.jl into kellertuer/refactor-initial-guess
2 parents c010472 + 4b0c1a3 commit 6e9d685

1 file changed

Lines changed: 15 additions & 0 deletions

File tree

docs/src/plans/stepsize.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,14 @@ WolfePowellLinesearch
3232
WolfePowellBinaryLinesearch
3333
```
3434

35+
Additionally, initial stepsize guesses are handled by subtypes of `AbstractInitialLinesearchGuess`:
36+
37+
```@docs
38+
ConstantInitialGuess
39+
ArmijoInitialGuess
40+
HagerZhangInitialGuess
41+
```
42+
3543
Some step sizes use [`max_stepsize`](@ref) function as a rough upper estimate for the trust region size.
3644
It is by default equal to injectivity radius of the exponential map but in some cases a different value is used.
3745
For the `FixedRankMatrices` manifold an estimate from Manopt is used.
@@ -58,6 +66,13 @@ Then the following state can be used to wrap these locally
5866
StepsizeState
5967
```
6068

69+
The Hager-Zhang initial guess uses two helper functions to determine initial stepsize in the first iteration on manifolds which have "expected minimizer", for example the zero point on the Euclidean manifold:
70+
71+
```@docs
72+
default_vector_norm
73+
default_point_distance
74+
```
75+
6176
## Literature
6277

6378
```@bibliography

0 commit comments

Comments
 (0)