Skip to content

Commit 438300c

Browse files
committed
added nonlinear support functions
1 parent 24c83f1 commit 438300c

26 files changed

+706
-610
lines changed

docs/make.jl

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,18 +8,17 @@ DocMeta.setdocmeta!(DynOptInterface, :DocTestSetup, :(import DynOptInterface as
88
const _PAGES = [
99
"Home" => "index.md",
1010
"API Reference" => [
11-
"reference/abstractions.md",
12-
"reference/domains.md",
11+
"reference/phases.md",
1312
"reference/dynamic_variables.md",
14-
"reference/algebraic_functions.md",
15-
"reference/differential_functions.md",
13+
"reference/dynamic_functions.md",
1614
"reference/boundary_functions.md",
1715
"reference/integral_functions.md",
16+
"reference/nonlinear_support.md",
1817
],
1918
]
2019

2120
links = InterLinks(
22-
"MathOptInterface" => "https://jump.dev/MathOptInterface.jl/stable/objects.inv"
21+
"MathOptInterface" => "https://jump.dev/MathOptInterface.jl/v1.30/objects.inv"
2322
)
2423

2524
makedocs(;

docs/src/reference/abstractions.md

Lines changed: 0 additions & 21 deletions
This file was deleted.

docs/src/reference/algebraic_functions.md

Lines changed: 0 additions & 15 deletions
This file was deleted.

docs/src/reference/boundary_functions.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ CurrentModule = DynOptInterface
55
# Boundary Functions
66

77
```@docs
8+
AbstractBoundaryFunction
89
Initial
910
Final
1011
NonlinearBoundaryFunction

docs/src/reference/differential_functions.md

Lines changed: 0 additions & 11 deletions
This file was deleted.

docs/src/reference/domains.md

Lines changed: 0 additions & 35 deletions
This file was deleted.
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
```@meta
2+
CurrentModule = DynOptInterface
3+
```
4+
5+
# Dynamic Functions
6+
7+
```@docs
8+
LinearDynamicTerm
9+
LinearDynamicFunction
10+
SquaredDynamicTerm
11+
SquaredDynamicFunction
12+
NonlinearDynamicFunction
13+
ExplicitDifferentialFunction
14+
```

docs/src/reference/dynamic_variables.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,11 @@ CurrentModule = DynOptInterface
44

55
# Dynamic Variables
66

7-
## Type
7+
## Types
88

99
```@docs
1010
DynamicVariableIndex
11+
DynamicVariableDerivative
1112
```
1213

1314
## Errors
@@ -22,11 +23,15 @@ AddDynamicVariableNotAllowed
2223
```@docs
2324
supports_dynamic_variable
2425
add_dynamic_variable
26+
MOI.supports(::MOI.ModelLike, ::AbstractDynamicVariableAttribute, ::Type{DynamicVariableIndex})
27+
MOI.set(::MOI.ModelLike, ::AbstractDynamicVariableAttribute, ::DynamicVariableIndex, ::Any)
28+
MOI.get(::MOI.ModelLike, ::AbstractDynamicVariableAttribute, ::DynamicVariableIndex)
2529
```
2630

2731
## Attributes
2832

2933
```@docs
34+
AbstractDynamicVariableAttribute
3035
DynamicVariableName
3136
DynamicVariablePrimalStart
3237
DynamicVariablePrimal
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
```@meta
2+
CurrentModule = DynOptInterface
3+
```
4+
5+
# Nonlinear Support
6+
7+
## Errors
8+
```@docs
9+
UnsupportedObjectiveArgument
10+
UnsupportedConstraintArgument
11+
```
12+
13+
## Functions
14+
15+
```@docs
16+
supports_objective_argument
17+
supports_constraint_argument
18+
```

docs/src/reference/phases.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
```@meta
2+
CurrentModule = DynOptInterface
3+
```
4+
5+
# Phases
6+
7+
## Types
8+
9+
```@docs
10+
AbstractDynamicFunction
11+
PhaseIndex
12+
```
13+
14+
## Errors
15+
16+
```@docs
17+
UnsupportedPhase
18+
AddPhaseNotAllowed
19+
```
20+
21+
## Functions
22+
23+
```@docs
24+
supports_phase
25+
add_phase
26+
MOI.supports(::MOI.ModelLike, ::AbstractPhaseAttribute, ::Type{PhaseIndex})
27+
MOI.set(::MOI.ModelLike, ::AbstractPhaseAttribute, ::PhaseIndex, ::Any)
28+
MOI.get(::MOI.ModelLike, ::AbstractPhaseAttribute, ::PhaseIndex)
29+
```
30+
31+
## Attributes
32+
33+
```@docs
34+
AbstractPhaseAttribute
35+
PhaseName
36+
PhaseInitialPrimalStart
37+
PhaseFinalPrimalStart
38+
PhaseInitialPrimal
39+
PhaseFinalPrimal
40+
```

0 commit comments

Comments
 (0)