Skip to content

Commit

Permalink
Fix docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
kellertuer committed Jan 9, 2025
1 parent e430d73 commit 5a59142
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 3 deletions.
17 changes: 17 additions & 0 deletions docs/src/solvers/mesh_adaptive_direct_search.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,13 +23,30 @@ CurrentModule = Manopt
LowerTriangularAdaptivePoll
```

as well as the internal functions

```@docs
Manopt.get_descent_direction(::LowerTriangularAdaptivePoll)
Manopt.is_successful(::LowerTriangularAdaptivePoll)
Manopt.get_candidate(::LowerTriangularAdaptivePoll)
Manopt.get_basepoint(::LowerTriangularAdaptivePoll)
Manopt.update_basepoint!(M, ltap::LowerTriangularAdaptivePoll{P}, p::P) where {P}
```

## Search

```@docs
AbstractMeshSearchFunction
DefaultMeshAdaptiveDirectSearch
```

as well as the internal functions

```@docs
Manopt.is_successful(::DefaultMeshAdaptiveDirectSearch)
Manopt.get_candidate(::DefaultMeshAdaptiveDirectSearch)
```

## Additional stopping criteria

```@docs
Expand Down
15 changes: 12 additions & 3 deletions src/plans/mesh_adaptive_plan.jl
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,13 @@ A subtype of this The functor has to fulfil
* be callable as `poll!(problem, mesh_size; kwargs...)` and modify the state
as well as
as well as to provide functions
* provide a `is_successful(poll!)` function that indicates whether the last poll was successful in finding a new candidate,
this returns the last successful mesh vector used.
* `is_successful(poll!)` that indicates whether the last poll was successful in finding a new candidate
* `get_basepoint(poll!)` that returns the base point at which the mesh is build
* `get_candidate(poll!)` that returns the last found candidate if the poll was successful. Otherwise the base point is returned
* `get_descent_direction(poll!)` the the vector that points from the base point to the candidate. If the last poll was not successful, the zero vector is returned
* `update_basepoint!(M, poll!, p)` that updates the base point to `p` and all necessary internal data to a new point to build a mesh at
The `kwargs...` could include
* `scale_mesh=1.0`: to rescale the mesh globally
Expand All @@ -26,6 +29,12 @@ Should be callable as search!(problem, mesh_size, p, X; kwargs...)
where `X` is the last successful poll direction from the tangent space at `p``
if that exists and the zero vector otherwise.
Besides that the following functions should be implemented
* `is_successful(search!)` that indicates whether the last search was successful in finding a new candidate
* `get_candidate(search!)` that returns the last found candidate
"""
abstract type AbstractMeshSearchFunction end

Expand Down

0 comments on commit 5a59142

Please sign in to comment.