Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/problems/analytical_problems.jl
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,10 @@ end
export AnalyticalProblem, AbstractAnalyticalProblem

@doc doc"""
AnalyticalAliasSpecifier(;alias_p = nothing, alias_f = nothing, alias_u0 = nothing, alias_du0 = nothing, alias_tstops = nothing, alias = nothing)

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)`

When a keyword argument is `nothing`, the default behaviour of the solver is used.

Expand Down
2 changes: 1 addition & 1 deletion src/problems/bvp_problems.jl
Original file line number Diff line number Diff line change
Expand Up @@ -444,10 +444,10 @@ function TwoPointSecondOrderBVProblem(
end

@doc doc"""
BVPAliasSpecifier(;alias_p = nothing, alias_f = nothing, alias_u0 = nothing, alias_du0 = nothing, alias_tstops = nothing, alias = nothing)

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)`

When a keyword argument is `nothing`, the default behaviour of the solver is used.

Expand Down
2 changes: 1 addition & 1 deletion src/problems/dae_problems.jl
Original file line number Diff line number Diff line change
Expand Up @@ -121,10 +121,10 @@ function ConstructionBase.constructorof(::Type{P}) where {P <: DAEProblem}
end

@doc doc"""
DAEAliasSpecifier(;alias_p = nothing, alias_f = nothing, alias_u0 = nothing, alias_du0 = nothing, alias_tstops = nothing, alias = nothing)

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)`

When a keyword argument is `nothing`, the default behaviour of the solver is used.

Expand Down
2 changes: 1 addition & 1 deletion src/problems/dde_problems.jl
Original file line number Diff line number Diff line change
Expand Up @@ -398,10 +398,10 @@ function SecondOrderDDEProblem(f::DynamicalDDEFunction, args...; kwargs...)
end

@doc doc"""
DDEAliasSpecifier(;alias_p = nothing, alias_f = nothing, alias_u0 = nothing, alias_du0 = nothing, alias_tstops = nothing, alias = nothing)

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)`

When a keyword argument is `nothing`, the default behaviour of the solver is used.

Expand Down
2 changes: 1 addition & 1 deletion src/problems/discrete_problems.jl
Original file line number Diff line number Diff line change
Expand Up @@ -166,10 +166,10 @@ function DiscreteProblem(u0::Union{AbstractArray, Number}, tspan,
end

@doc doc"""
DiscreteAliasSpecifier(;alias_p = nothing, alias_f = nothing, alias_u0 = nothing, alias = nothing)

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)`

When a keyword argument is `nothing`, the default behaviour of the solver is used.

Expand Down
2 changes: 1 addition & 1 deletion src/problems/implicit_discrete_problems.jl
Original file line number Diff line number Diff line change
Expand Up @@ -132,10 +132,10 @@ function ConstructionBase.constructorof(::Type{P}) where {P <: ImplicitDiscreteP
end

@doc doc"""
ImplicitDiscreteAliasSpecifier(;alias_p = nothing, alias_f = nothing, alias_u0 = nothing, alias = nothing)

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)`

When a keyword argument is `nothing`, the default behaviour of the solver is used.

Expand Down
2 changes: 1 addition & 1 deletion src/problems/integral_problems.jl
Original file line number Diff line number Diff line change
Expand Up @@ -169,10 +169,10 @@ struct SampledIntegralProblem{Y, X, K} <: AbstractIntegralProblem{false}
end

@doc doc"""
IntegralAliasSpecifier(;alias_p = nothing, alias_f = nothing, alias_u0 = nothing, alias = nothing)

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)``

When a keyword argument is `nothing`, the default behaviour of the solver is used.

Expand Down
3 changes: 2 additions & 1 deletion src/problems/linear_problems.jl
Original file line number Diff line number Diff line change
Expand Up @@ -144,9 +144,10 @@ function SymbolicIndexingInterface.set_parameter!(
end

@doc doc"""
LinearAliasSpecifier(; alias_A = nothing, alias_b = nothing, alias = nothing)

Holds information on what variables to alias
when solving a LinearProblem. Conforms to the AbstractAliasSpecifier interface.
`LinearAliasSpecifier(; alias_A = nothing, alias_b = nothing, alias = nothing)`

When a keyword argument is `nothing`, the default behaviour of the solver is used.

Expand Down
3 changes: 2 additions & 1 deletion src/problems/nonlinear_problems.jl
Original file line number Diff line number Diff line change
Expand Up @@ -566,9 +566,10 @@ function SymbolicIndexingInterface.set_parameter!(prob::SCCNonlinearProblem, val
end

@doc doc"""
NonlinearAliasSpecifier(;alias_p = nothing, alias_f = nothing, alias_u0 = nothing, alias = nothing)

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.

Expand Down
2 changes: 1 addition & 1 deletion src/problems/ode_problems.jl
Original file line number Diff line number Diff line change
Expand Up @@ -512,10 +512,10 @@ function IncrementingODEProblem{iip}(f::IncrementingODEFunction, u0, tspan,
end

@doc doc"""
ODEAliasSpecifier(;alias_p = nothing, alias_f = nothing, alias_u0 = false, alias_du0 = false, alias_tstops = false, alias = nothing)

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)`

When a keyword argument is `nothing`, the default behaviour of the solver is used.

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 @@ -155,10 +155,10 @@ isinplace(f::OptimizationFunction{iip}) where {iip} = iip
isinplace(f::OptimizationProblem{iip}) where {iip} = iip

@doc doc"""
OptimizationAliasSpecifier(;alias_p = nothing, alias_f = nothing, alias_u0 = false, alias = nothing)

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)`

### Keywords
* `alias_p::Union{Bool, Nothing}`
Expand Down
2 changes: 1 addition & 1 deletion src/problems/rode_problems.jl
Original file line number Diff line number Diff line change
Expand Up @@ -92,10 +92,10 @@ function RODEProblem(f, u0, tspan, p = NullParameters(); kwargs...)
end

@doc doc"""
RODEAliasSpecifier(;alias_p = nothing, alias_f = nothing, alias_u0 = false, alias_du0 = false, alias_tstops = false, alias = nothing)

Holds information on what variables to alias
when solving an RODEProblem. Conforms to the AbstractAliasSpecifier interface.
`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.

Expand Down
2 changes: 1 addition & 1 deletion src/problems/sdde_problems.jl
Original file line number Diff line number Diff line change
Expand Up @@ -175,10 +175,10 @@ end
SymbolicIndexingInterface.get_history_function(prob::AbstractSDDEProblem) = prob.h

@doc doc"""
SDDEAliasSpecifier(;alias_p = nothing, alias_f = nothing, alias_u0 = nothing, alias_du0 = nothing, alias_tstops = nothing, alias = nothing)

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)`

When a keyword argument is `nothing`, the default behaviour of the solver is used.

Expand Down
2 changes: 1 addition & 1 deletion src/problems/sde_problems.jl
Original file line number Diff line number Diff line change
Expand Up @@ -223,10 +223,10 @@ function DynamicalSDEProblem{iip}(f::DynamicalSDEFunction, v0, u0, tspan,
end

@doc doc"""
SDEAliasSpecifier(;alias_p = nothing, alias_f = nothing, alias_u0 = nothing, alias_tstops = nothing, alias = nothing)

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)`

When a keyword argument is `nothing`, the default behaviour of the solver is used.

Expand Down
2 changes: 1 addition & 1 deletion src/problems/steady_state_problems.jl
Original file line number Diff line number Diff line change
Expand Up @@ -136,10 +136,10 @@ end
SymbolicIndexingInterface.is_time_dependent(::SteadyStateProblem) = true

@doc doc"""
SteadyStateAliasSpecifier(;alias_p = nothing, alias_f = nothing, alias_u0 = nothing, alias_du0 = nothing, alias_tstops = nothing, alias = nothing)

Holds information on what variables to alias
when solving a SteadyStateProblem. Conforms to the AbstractAliasSpecifier interface.
`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.

Expand Down
Loading