Skip to content

Commit 1d5b5af

Browse files
Merge pull request #1015 from SciML/ChrisRackauckas-patch-2
Update optimization_solutions.jl
2 parents 804e650 + 49143f3 commit 1d5b5af

File tree

1 file changed

+11
-2
lines changed

1 file changed

+11
-2
lines changed

src/solutions/optimization_solutions.jl

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,12 +45,11 @@ end
4545
"""
4646
$(TYPEDEF)
4747
48-
Representation of the solution to a non-linear optimization defined by an OptimizationProblem
48+
Representation of the solution to a non-linear optimization defined by an OptimizationProblem.
4949
5050
## Fields
5151
5252
- `u`: the representation of the optimization's solution.
53-
- `cache::AbstractOptimizationCache`: the optimization cache` that was solved.
5453
- `alg`: the algorithm type used by the solver.
5554
- `objective`: Objective value of the solution
5655
- `retcode`: the return code from the solver. Used to determine whether the solver solved
@@ -59,6 +58,16 @@ Representation of the solution to a non-linear optimization defined by an Optimi
5958
- `original`: if the solver is wrapped from a external solver, e.g.
6059
Optim.jl, then this is the original return from said solver library.
6160
- `stats`: statistics of the solver, such as the number of function evaluations required.
61+
62+
## Internal Fields
63+
64+
- `cache::AbstractOptimizationCache`: the optimization cache that was solved.
65+
66+
## Interface
67+
68+
`OptimizationSolution` is a `SciMLBase.AbstractNoTimeSolution`. For more information on the SciML
69+
solution interfaces, check out the
70+
[SciML Solution Interface documentation page](https://docs.sciml.ai/SciMLBase/stable/interfaces/Solutions/)
6271
"""
6372
struct OptimizationSolution{T, N, uType, C <: AbstractOptimizationCache, A, OV, O, ST} <:
6473
AbstractOptimizationSolution{T, N}

0 commit comments

Comments
 (0)