Skip to content

Commit

Permalink
update docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
jClugstor committed Dec 12, 2024
1 parent dcd70ef commit b420a7b
Show file tree
Hide file tree
Showing 15 changed files with 47 additions and 18 deletions.
6 changes: 4 additions & 2 deletions src/problems/analytical_problems.jl
Original file line number Diff line number Diff line change
Expand Up @@ -41,12 +41,14 @@ end
Holds information on what variables to alias
when solving an AnalyticalProblem. Conforms to the AbstractAliasSpecifier interface.
AnalyticalAliasSpecifier(;alias_p = nothing, alias_f = nothing, alias_u0 = nothing, alias_du0 = nothing, alias_tstops = nothing, alias = nothing)
`AnalyticalAliasSpecifier(;alias_p = nothing, alias_f = nothing, alias_u0 = nothing, alias_du0 = nothing, alias_tstops = nothing, alias = nothing)`
When a keyword argument is `nothing`, the default behaviour of the solver is used.
### Keywords
* `alias_p::Union{Bool, Nothing}`
* `alias_f::Union{Bool, Nothing}`
* `alias_u0::Union{Bool, Nothing}`: alias the u0 array. Defaults to false .
* `alias_u0::Union{Bool, Nothing}`: alias the u0 array.
* `alias_du0::Union{Bool, Nothing}`: alias the du0 array for DAEs. Defaults to false.
* `alias_tstops::Union{Bool, Nothing}`: alias the tstops array
* `alias::Union{Bool, Nothing}`: sets all fields of the `AnalyticalAliasSpecifier` to `alias`
Expand Down
4 changes: 3 additions & 1 deletion src/problems/bvp_problems.jl
Original file line number Diff line number Diff line change
Expand Up @@ -453,7 +453,9 @@ end
Holds information on what variables to alias
when solving an BVP. Conforms to the AbstractAliasSpecifier interface.
BVPAliasSpecifier(;alias_p = nothing, alias_f = nothing, alias_u0 = nothing, alias_du0 = nothing, alias_tstops = nothing, alias = nothing)
`BVPAliasSpecifier(;alias_p = nothing, alias_f = nothing, alias_u0 = nothing, alias_du0 = nothing, alias_tstops = nothing, alias = nothing)`
When a keyword argument is `nothing`, the default behaviour of the solver is used.
### Keywords
* `alias_p::Union{Bool, Nothing}`
Expand Down
4 changes: 3 additions & 1 deletion src/problems/dae_problems.jl
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,9 @@ end
Holds information on what variables to alias
when solving a DAE. Conforms to the AbstractAliasSpecifier interface.
DAEAliasSpecifier(;alias_p = nothing, alias_f = nothing, alias_u0 = nothing, alias_du0 = nothing, alias_tstops = nothing, alias = nothing)
`DAEAliasSpecifier(;alias_p = nothing, alias_f = nothing, alias_u0 = nothing, alias_du0 = nothing, alias_tstops = nothing, alias = nothing)`
When a keyword argument is `nothing`, the default behaviour of the solver is used.
### Keywords
* `alias_p::Union{Bool, Nothing}`
Expand Down
4 changes: 3 additions & 1 deletion src/problems/dde_problems.jl
Original file line number Diff line number Diff line change
Expand Up @@ -409,7 +409,9 @@ end
Holds information on what variables to alias
when solving a DDE. Conforms to the AbstractAliasSpecifier interface.
DDEAliasSpecifier(;alias_p = nothing, alias_f = nothing, alias_u0 = nothing, alias_du0 = nothing, alias_tstops = nothing, alias = nothing)
`DDEAliasSpecifier(;alias_p = nothing, alias_f = nothing, alias_u0 = nothing, alias_du0 = nothing, alias_tstops = nothing, alias = nothing)`
When a keyword argument is `nothing`, the default behaviour of the solver is used.
### Keywords
* `alias_p::Union{Bool, Nothing}`
Expand Down
4 changes: 3 additions & 1 deletion src/problems/discrete_problems.jl
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,9 @@ end
Holds information on what variables to alias
when solving a DiscreteProblem. Conforms to the AbstractAliasSpecifier interface.
DiscreteAliasSpecifier(;alias_p = nothing, alias_f = nothing, alias_u0 = nothing, alias = nothing)
`DiscreteAliasSpecifier(;alias_p = nothing, alias_f = nothing, alias_u0 = nothing, alias = nothing)`
When a keyword argument is `nothing`, the default behaviour of the solver is used.
### Keywords
* `alias_p::Union{Bool, Nothing}`
Expand Down
4 changes: 3 additions & 1 deletion src/problems/implicit_discrete_problems.jl
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,9 @@ end
Holds information on what variables to alias
when solving an ODE. Conforms to the AbstractAliasSpecifier interface.
DiscreteAliasSpecifier(;alias_p = nothing, alias_f = nothing, alias_u0 = nothing, alias = nothing)
`DiscreteAliasSpecifier(;alias_p = nothing, alias_f = nothing, alias_u0 = nothing, alias = nothing)`
When a keyword argument is `nothing`, the default behaviour of the solver is used.
### Keywords
* `alias_p::Union{Bool, Nothing}`
Expand Down
4 changes: 3 additions & 1 deletion src/problems/integral_problems.jl
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,9 @@ end
Holds information on what variables to alias
when solving an IntegralProblem. Conforms to the AbstractAliasSpecifier interface.
IntegralAliasSpecifier(;alias_p = nothing, alias_f = nothing, alias_u0 = nothing, alias = nothing)
`IntegralAliasSpecifier(;alias_p = nothing, alias_f = nothing, alias_u0 = nothing, alias = nothing)``
When a keyword argument is `nothing`, the default behaviour of the solver is used.
### Keywords
* `alias_p::Union{Bool, Nothing}`
Expand Down
5 changes: 4 additions & 1 deletion src/problems/linear_problems.jl
Original file line number Diff line number Diff line change
Expand Up @@ -83,8 +83,11 @@ struct LinearAliasSpecifier <: AbstractAliasSpecifier
end

@doc doc"""
Holds information on what variables to alias
Holds information on what variables to alias
when solving a LinearProblem. Conforms to the AbstractAliasSpecifier interface.
`LinearAliasSpecifier(;alias_p = nothing, alias_f = nothing, alias_A = nothing, alias_b = nothing, alias = nothing)`
When a keyword argument is `nothing`, the default behaviour of the solver is used.
### Keywords
Expand Down
8 changes: 5 additions & 3 deletions src/problems/nonlinear_problems.jl
Original file line number Diff line number Diff line change
Expand Up @@ -558,15 +558,17 @@ struct NonlinearAliasSpecifier <: AbstractAliasSpecifier
end

@doc doc"""
Holds information on what variables to alias when solving a `NonlinearProblem`.
Holds information on what variables to alias when solving a `NonlinearProblem`.
Conforms to the AbstractAliasSpecifier interface.
`NonlinearAliasSpecifier(;alias_p = nothing, alias_f = nothing, alias_u0 = nothing, alias = nothing)`
When a keyword argument is `nothing`, the default behaviour of the solver is used.
### Keywords
* `alias_p::Union{Bool, Nothing}`
* `alias_f::Union{Bool, Nothing}`
* `alias_A::Union{Bool, Nothing}`: alias the `A` array.
* `alias_b::Union{Bool, Nothing}`: alias the `b` array.
* `alias_u0::Union{Bool, Nothing}`: alias the `u0` array.
* `alias::Union{Bool, Nothing}`: sets all fields of the `NonlinearAliasSpecifier` to `alias`.
"""
function NonlinearAliasSpecifier(;alias_p = nothing, alias_f = nothing, alias_u0 = nothing, alias = nothing)
Expand Down
4 changes: 3 additions & 1 deletion src/problems/ode_problems.jl
Original file line number Diff line number Diff line change
Expand Up @@ -525,7 +525,9 @@ end
Holds information on what variables to alias
when solving an ODE. Conforms to the AbstractAliasSpecifier interface.
ODEAliasSpecifier(;alias_p = nothing, alias_f = nothing, alias_u0 = false, alias_du0 = false, alias_tstops = false, alias = nothing)
`ODEAliasSpecifier(;alias_p = nothing, alias_f = nothing, alias_u0 = false, alias_du0 = false, alias_tstops = false, alias = nothing)`
When a keyword argument is `nothing`, the default behaviour of the solver is used.
### Keywords
* `alias_p::Union{Bool, Nothing}`
Expand Down
2 changes: 1 addition & 1 deletion src/problems/optimization_problems.jl
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ end
Holds information on what variables to alias
when solving an OptimizationProblem. Conforms to the AbstractAliasSpecifier interface.
OptimizationAliasSpecifier(;alias_p = nothing, alias_f = nothing, alias_u0 = false, alias = nothing)
`OptimizationAliasSpecifier(;alias_p = nothing, alias_f = nothing, alias_u0 = false, alias = nothing)`
### Keywords
* `alias_p::Union{Bool, Nothing}`
Expand Down
4 changes: 3 additions & 1 deletion src/problems/rode_problems.jl
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,9 @@ end
Holds information on what variables to alias
when solving an RODEProblem. Conforms to the AbstractAliasSpecifier interface.
ODEAliasSpecifier(;alias_p = nothing, alias_f = nothing, alias_u0 = false, alias_du0 = false, alias_tstops = false, alias = nothing)
`RODEAliasSpecifier(;alias_p = nothing, alias_f = nothing, alias_u0 = false, alias_du0 = false, alias_tstops = false, alias = nothing)`
When a keyword argument is `nothing`, the default behaviour of the solver is used.
### Keywords
* `alias_p::Union{Bool, Nothing}`
Expand Down
4 changes: 3 additions & 1 deletion src/problems/sdde_problems.jl
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,9 @@ end
Holds information on what variables to alias
when solving an SDDEProblem. Conforms to the AbstractAliasSpecifier interface.
SDDEAliasSpecifier(;alias_p = nothing, alias_f = nothing, alias_u0 = nothing, alias_du0 = nothing, alias_tstops = nothing, alias = nothing)
`SDDEAliasSpecifier(;alias_p = nothing, alias_f = nothing, alias_u0 = nothing, alias_du0 = nothing, alias_tstops = nothing, alias = nothing)`
When a keyword argument is `nothing`, the default behaviour of the solver is used.
### Keywords
* `alias_p::Union{Bool, Nothing}`
Expand Down
4 changes: 3 additions & 1 deletion src/problems/sde_problems.jl
Original file line number Diff line number Diff line change
Expand Up @@ -225,7 +225,9 @@ end
Holds information on what variables to alias
when solving an SDEProblem. Conforms to the AbstractAliasSpecifier interface.
SDEAliasSpecifier(;alias_p = nothing, alias_f = nothing, alias_u0 = nothing, alias_tstops = nothing, alias = nothing)
`SDEAliasSpecifier(;alias_p = nothing, alias_f = nothing, alias_u0 = nothing, alias_tstops = nothing, alias = nothing)`
When a keyword argument is `nothing`, the default behaviour of the solver is used.
### Keywords
* `alias_p::Union{Bool, Nothing}`
Expand Down
4 changes: 3 additions & 1 deletion src/problems/steady_state_problems.jl
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,9 @@ end
Holds information on what variables to alias
when solving a SteadyStateProblem. Conforms to the AbstractAliasSpecifier interface.
ODEAliasSpecifier(;alias_p = nothing, alias_f = nothing, alias_u0 = nothing, alias_du0 = nothing, alias_tstops = nothing, alias = nothing)
`SteadyStateAliasSpecifier(;alias_p = nothing, alias_f = nothing, alias_u0 = nothing, alias_du0 = nothing, alias_tstops = nothing, alias = nothing)`
When a keyword argument is `nothing`, the default behaviour of the solver is used.
### Keywords
* `alias_p::Union{Bool, Nothing}`
Expand Down

0 comments on commit b420a7b

Please sign in to comment.