Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Ronny Bergmann <git@ronnybergmann.net>
  • Loading branch information
mateuszbaran and kellertuer authored Sep 3, 2024
1 parent e90e8c1 commit 74b8cb3
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions src/ManifoldDiffEq.jl
Original file line number Diff line number Diff line change
Expand Up @@ -71,9 +71,11 @@ abstract type AbstractManifoldDiffEqAlgorithm <: OrdinaryDiffEqAlgorithm end
isadaptive(::AbstractManifoldDiffEqAlgorithm) = false

"""
abstract type AbstractManifoldDiffEqAdaptiveAlgorithm end
AbstractManifoldDiffEqAdaptiveAlgorithm <: AbstractManifoldDiffEqAlgorithm
An abstract subtype of `AbstractManifoldDiffEqAlgorithm` for adaptive algorithms.
This is the manifold-aware analogue of `OrdinaryDiffEqAdaptiveAlgorithm`.
Counterpart of `OrdinaryDiffEqAdaptiveAlgorithm`.
"""
abstract type AbstractManifoldDiffEqAdaptiveAlgorithm <: AbstractManifoldDiffEqAlgorithm end

Expand All @@ -98,8 +100,8 @@ Fields:
* `alg`: [`AbstractManifoldDiffEqAlgorithm`](@ref) used to obtain the solution.
* `interp` [`ManifoldInterpolationData`](@ref)
* `dense`: `true` if ODE solution is saved at every step and `false` otherwise.
* `stats`: [`DEStats`](https://docs.sciml.ai/DiffEqDocs/stable/basics/solution/#SciMLBase.DEStats) of solver
* `retcode`: [`ReturnCode`}(https://docs.sciml.ai/SciMLBase/stable/interfaces/Solutions/#retcodes) of the solution.
* `stats`: [`DEStats`](https://docs.sciml.ai/DiffEqDocs/stable/basics/solution/#SciMLBase.DEStats) of the solver
* `retcode`: [`ReturnCode`](https://docs.sciml.ai/SciMLBase/stable/interfaces/Solutions/#retcodes) of the solution.
"""
struct ManifoldODESolution{
T<:Real,
Expand Down

0 comments on commit 74b8cb3

Please sign in to comment.