Skip to content

Commit 76fe1d8

Browse files
jlumpeChrisRackauckas
jlumpe
authored and
ChrisRackauckas
committed
API documentation skeleton for DiffEqBase
1 parent 7248f08 commit 76fe1d8

16 files changed

+639
-0
lines changed

‎docs/make.jl

+15
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,21 @@ makedocs(modules=[DiffEqBase,DiffEqProblemLibrary,DiffEqBiological],
8787
"models/external_modeling.md"
8888
],
8989
"APIs" => Any[
90+
"DiffEqBase API" => [
91+
"Overview" => "apis/diffeqbase/overview.md",
92+
"apis/diffeqbase/functions.md",
93+
"apis/diffeqbase/problems.md",
94+
"apis/diffeqbase/solutions.md",
95+
"apis/diffeqbase/solvers.md",
96+
"apis/diffeqbase/de_types.md",
97+
"apis/diffeqbase/operators.md",
98+
"apis/diffeqbase/callbacks.md",
99+
"apis/diffeqbase/interpolation.md",
100+
"apis/diffeqbase/ensembles.md",
101+
"apis/diffeqbase/data_arrays.md",
102+
"apis/diffeqbase/noise.md",
103+
"apis/diffeqbase/utility.md",
104+
],
90105
"apis/diffeqbio.md"
91106
],
92107
"Extra Details" => Any[

‎docs/src/apis/diffeqbase/callbacks.md

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Callbacks
2+
3+
4+
## Types
5+
6+
```@docs
7+
DiffEqBase.DECallback
8+
DiffEqBase.AbstractDiscreteCallback
9+
DiscreteCallback
10+
DiffEqBase.AbstractContinuousCallback
11+
ContinuousCallback
12+
VectorContinuousCallback
13+
CallbackSet
14+
DiffEqBase.CallbackCache
15+
```
16+
17+
18+
## Functions
19+
20+
```@docs
21+
DiffEqBase.split_callbacks
22+
DiffEqBase.initialize!(cb::CallbackSet, u, t, integrator)
23+
```

‎docs/src/apis/diffeqbase/data_arrays.md

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Data arrays
2+
3+
4+
## Types
5+
6+
```@docs
7+
DEDataArray
8+
```
9+
10+
### Aliases
11+
12+
* `DEDataVector{T}`: `DEDataArray{T, 1}`
13+
* `DEDataMatrix{T}`: `DEDataArray{T, 2}`

‎docs/src/apis/diffeqbase/de_types.md

+219
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,219 @@
1+
# [DE types](@id de_types)
2+
3+
4+
## Discrete
5+
6+
```@docs
7+
DiffEqBase.AbstractDiscreteFunction
8+
DiscreteFunction
9+
DiffEqBase.AbstractDiscreteProblem
10+
DiscreteProblem
11+
```
12+
13+
## ODE
14+
15+
```@docs
16+
DiffEqBase.AbstractODEFunction
17+
ODEFunction
18+
DiffEqBase.AbstractODEProblem
19+
ODEProblem
20+
DiffEqBase.StandardODEProblem
21+
DiffEqBase.AbstractODESolution
22+
DiffEqBase.ODESolution
23+
DiffEqBase.AbstractODEAlgorithm
24+
DiffEqBase.AbstractODEIntegrator
25+
```
26+
27+
### Dynamical ODEs
28+
29+
```@docs
30+
DynamicalODEFunction
31+
DiffEqBase.AbstractDynamicalODEProblem
32+
DynamicalODEProblem
33+
```
34+
35+
### Second-order ODEs
36+
37+
```@docs
38+
DiffEqBase.AbstractSecondOrderODEProblem
39+
SecondOrderODEProblem
40+
DiffEqBase.AbstractSecondOrderODEAlgorithm
41+
DiffEqBase.AbstractSecondOrderODEIntegrator
42+
```
43+
44+
### Split ODEs
45+
46+
```@docs
47+
SplitFunction
48+
DiffEqBase.AbstractSplitODEProblem
49+
SplitODEProblem
50+
```
51+
52+
### Steady state problems
53+
54+
```@docs
55+
DiffEqBase.AbstractSteadyStateProblem
56+
SteadyStateProblem
57+
DiffEqBase.AbstractSteadyStateSolution
58+
DiffEqBase.SteadyStateSolution
59+
DiffEqBase.AbstractSteadyStateAlgorithm
60+
DiffEqBase.AbstractSteadyStateIntegrator
61+
```
62+
63+
### Boundary value problems
64+
65+
```@docs
66+
DiffEqBase.TwoPointBVPFunction
67+
DiffEqBase.AbstractBVProblem
68+
DiffEqBase.StandardBVProblem
69+
BVProblem
70+
TwoPointBVProblem
71+
```
72+
73+
### Analytical problems
74+
75+
```@docs
76+
AbstractAnalyticalProblem
77+
AnalyticalProblem
78+
DiffEqBase.AbstractAnalyticalSolution
79+
```
80+
81+
82+
## SDE
83+
84+
SDE problems are subtypes of RODE problems.
85+
86+
```@docs
87+
DiffEqBase.AbstractSDEFunction
88+
SDEFunction
89+
DiffEqBase.AbstractSDEProblem
90+
DiffEqBase.StandardSDEProblem
91+
SDEProblem
92+
DiffEqBase.AbstractSDEAlgorithm
93+
DiffEqBase.AbstractSDEIntegrator
94+
```
95+
96+
### Split SDEs
97+
98+
```@docs
99+
SplitSDEFunction
100+
DiffEqBase.AbstractSplitSDEProblem
101+
SplitSDEProblem
102+
```
103+
104+
105+
## RODE
106+
107+
```@docs
108+
DiffEqBase.AbstractRODEFunction
109+
RODEFunction
110+
DiffEqBase.AbstractRODEProblem
111+
RODEProblem
112+
DiffEqBase.AbstractRODESolution
113+
DiffEqBase.RODESolution
114+
DiffEqBase.AbstractRODEAlgorithm
115+
DiffEqBase.AbstractRODEIntegrator
116+
```
117+
118+
119+
## DDE
120+
121+
```@docs
122+
DiffEqBase.AbstractDDEFunction
123+
DDEFunction
124+
DiffEqBase.AbstractDDEProblem
125+
DDEProblem
126+
DiffEqBase.AbstractConstantLagDDEProblem
127+
DiffEqBase.AbstractDDESolution
128+
DiffEqBase.AbstractDDEAlgorithm
129+
DiffEqBase.AbstractDDEIntegrator
130+
DiffEqBase.AbstractHistoryFunction
131+
```
132+
133+
134+
## SDDE
135+
136+
```@docs
137+
DiffEqBase.AbstractSDDEFunction
138+
SDDEFunction
139+
DiffEqBase.AbstractSDDEProblem
140+
SDDEProblem
141+
DiffEqBase.AbstractConstantLagSDDEProblem
142+
DiffEqBase.AbstractSDDEAlgorithm
143+
DiffEqBase.AbstractSDDEIntegrator
144+
```
145+
146+
147+
## DAE
148+
149+
```@docs
150+
DiffEqBase.AbstractDAEFunction
151+
DAEFunction
152+
DiffEqBase.AbstractDAEProblem
153+
DAEProblem
154+
DiffEqBase.AbstractDAESolution
155+
DiffEqBase.DAESolution
156+
DiffEqBase.AbstractDAEAlgorithm
157+
DiffEqBase.AbstractDAEIntegrator
158+
```
159+
160+
161+
### PDE
162+
163+
```@docs
164+
DiffEqBase.AbstractPDEProblem
165+
PDEProblem
166+
```
167+
168+
169+
## Jump problems
170+
171+
```@docs
172+
DiffEqBase.AbstractJumpProblem
173+
```
174+
175+
176+
## Noise problems
177+
178+
```@docs
179+
DiffEqBase.AbstractNoiseProblem
180+
NoiseProblem
181+
```
182+
183+
184+
## Basic problems (for testing?)
185+
186+
### Linear
187+
188+
```@docs
189+
DiffEqBase.AbstractLinearProblem
190+
DiffEqBase.LinearProblem
191+
DiffEqBase.AbstractLinearSolution
192+
DiffEqBase.LinearSolution
193+
DiffEqBase.AbstractLinearAlgorithm
194+
```
195+
196+
### Nonlinear
197+
198+
```@docs
199+
DiffEqBase.AbstractNonlinearProblem
200+
DiffEqBase.NonlinearProblem
201+
DiffEqBase.AbstractNonlinearSolution
202+
DiffEqBase.AbstractNonlinearAlgorithm
203+
```
204+
205+
### Quadrature
206+
207+
```@docs
208+
DiffEqBase.AbstractQuadratureProblem
209+
DiffEqBase.QuadratureProblem
210+
DiffEqBase.AbstractQuadratureSolution
211+
DiffEqBase.AbstractQuadratureAlgorithm
212+
```
213+
214+
215+
## Sensitivity problems
216+
```@docs
217+
DiffEqBase.DESensitivity
218+
DiffEqBase.AbstractSensitivitySolution
219+
```

‎docs/src/apis/diffeqbase/ensembles.md

+86
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
# Ensembles
2+
3+
4+
## Types
5+
6+
```@docs
7+
DiffEqBase.AbstractEnsembleProblem
8+
EnsembleProblem
9+
DiffEqBase.AbstractEnsembleSolution
10+
EnsembleSolution
11+
EnsembleTestSolution
12+
EnsembleSummary
13+
DiffEqBase.EnsembleAlgorithm
14+
DiffEqBase.BasicEnsembleAlgorithm
15+
DiffEqBase.AbstractEnsembleEstimator
16+
EnsembleSerial
17+
EnsembleDistributed
18+
EnsembleThreads
19+
EnsembleSplitThreads
20+
```
21+
22+
23+
## Functions
24+
25+
```@docs
26+
DiffEqBase.calculate_ensemble_errors
27+
DiffEqBase.batch_func
28+
DiffEqBase.solve_batch
29+
DiffEqBase.thread_monte
30+
DiffEqBase.vector_batch_data_to_arr
31+
```
32+
33+
### Analysis
34+
35+
```@docs
36+
EnsembleAnalysis.get_timestep
37+
EnsembleAnalysis.get_timepoint
38+
EnsembleAnalysis.timestep_mean
39+
EnsembleAnalysis.timestep_median
40+
EnsembleAnalysis.timestep_meancor
41+
EnsembleAnalysis.timestep_meancov
42+
EnsembleAnalysis.timestep_meanvar
43+
EnsembleAnalysis.timestep_quantile
44+
EnsembleAnalysis.timestep_weighted_meancov
45+
EnsembleAnalysis.timepoint_mean
46+
EnsembleAnalysis.timepoint_median
47+
EnsembleAnalysis.timepoint_meancor
48+
EnsembleAnalysis.timepoint_meancov
49+
EnsembleAnalysis.timepoint_meanvar
50+
EnsembleAnalysis.timepoint_quantile
51+
EnsembleAnalysis.timepoint_weighted_meancov
52+
EnsembleAnalysis.timeseries_steps_mean
53+
EnsembleAnalysis.timeseries_steps_median
54+
EnsembleAnalysis.timeseries_steps_meancor
55+
EnsembleAnalysis.timeseries_steps_meancov
56+
EnsembleAnalysis.timeseries_steps_meanvar
57+
EnsembleAnalysis.timeseries_steps_quantile
58+
EnsembleAnalysis.timeseries_steps_weighted_meancov
59+
EnsembleAnalysis.timeseries_point_mean
60+
EnsembleAnalysis.timeseries_point_median
61+
EnsembleAnalysis.timeseries_point_meancor
62+
EnsembleAnalysis.timeseries_point_meancov
63+
EnsembleAnalysis.timeseries_point_meanvar
64+
EnsembleAnalysis.timeseries_point_quantile
65+
EnsembleAnalysis.timeseries_point_weighted_meancov
66+
EnsembleAnalysis.componentwise_mean
67+
EnsembleAnalysis.componentwise_meancor
68+
EnsembleAnalysis.componentwise_meancov
69+
EnsembleAnalysis.componentwise_meanvar
70+
EnsembleAnalysis.componentwise_vectors_timestep
71+
EnsembleAnalysis.componentwise_weighted_meancov
72+
EnsembleAnalysis.componentwise_vectors_timepoint
73+
```
74+
75+
76+
## Deprecated "Monte Carlo" aliases
77+
78+
The following are deprecated and are just aliases to the `Ensemble` equivalents:
79+
80+
* `AbstractMonteCarloProblem`: [`AbstractEnsembleProblem`](@ref DiffEqBase.AbstractEnsembleProblem)
81+
* `MonteCarloProblem`: [`EnsembleProblem`](@ref)
82+
* `MonteCarloAlgorithm`: [`EnsembleAlgorithm`](@ref DiffEqBase.EnsembleAlgorithm)
83+
* `AbstractMonteCarloSolution`: [`AbstractEnsembleSolution`](@ref DiffEqBase.AbstractEnsembleSolution)
84+
* `MonteCarloSolution`: [`EnsembleSolution`](@ref)
85+
* `MonteCarloSummary`: [`EnsembleSummary`](@ref)
86+
* `calculate_monte_errors`: [`calculate_ensemble_errors`](@ref DiffEqBase.calculate_ensemble_errors)

‎docs/src/apis/diffeqbase/functions.md

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# DE functions
2+
3+
4+
## Base Types
5+
6+
```@docs
7+
DiffEqBase.AbstractDiffEqFunction
8+
```
9+
10+
11+
## Type traits
12+
13+
```@docs
14+
isinplace
15+
DiffEqBase.is_diagonal_noise
16+
DiffEqBase.has_analytic
17+
DiffEqBase.has_jac
18+
DiffEqBase.has_tgrad
19+
DiffEqBase.has_Wfact
20+
DiffEqBase.has_Wfact_t
21+
DiffEqBase.has_paramjac
22+
DiffEqBase.has_syms
23+
```

0 commit comments

Comments
 (0)