re-structuring

JuDO-dev · Jul 16, 2024 · 6c58408 · 6c58408
1 parent 438300c
commit 6c58408
Show file tree

Hide file tree

Showing 28 changed files with 1,061 additions and 821 deletions.
diff --git a/Project.toml b/Project.toml
@@ -8,7 +8,7 @@ MathOptInterface = "b8f27783-ece8-5eb3-8dc8-9495eed66fee"
 
 [compat]
 julia = "1.6"
-MathOptInterface = "1.30"
+MathOptInterface = "1.31"
 
 [extras]
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"

diff --git a/docs/make.jl b/docs/make.jl
@@ -6,19 +6,24 @@ using DocumenterMermaid
 DocMeta.setdocmeta!(DynOptInterface, :DocTestSetup, :(import DynOptInterface as DOI); recursive=true)
 
 const _PAGES = [
-    "Home" => "index.md",
+    #"Home" => "index.md",
     "API Reference" => [
-        "reference/phases.md",
-        "reference/dynamic_variables.md",
-        "reference/dynamic_functions.md",
+        "Dynamic Functions" => [
+            "reference/dynamic_functions/abstraction.md",
+            "reference/dynamic_functions/phases.md",
+            "reference/dynamic_functions/dynamic_variables.md",
+            "reference/dynamic_functions/expressions.md",
+            "reference/dynamic_functions/derivatives.md",
+        ],
         "reference/boundary_functions.md",
-        "reference/integral_functions.md",
         "reference/nonlinear_support.md",
+        "reference/attributes.md",
+        "reference/solutions.md",
     ],
 ]
 
 links = InterLinks(
-    "MathOptInterface" => "https://jump.dev/MathOptInterface.jl/v1.30/objects.inv"
+    "MathOptInterface" => "https://jump.dev/MathOptInterface.jl/v1.31/objects.inv"
 )
 
 makedocs(;

diff --git a/docs/src/reference/attributes.md b/docs/src/reference/attributes.md
@@ -0,0 +1,22 @@
+```@meta
+CurrentModule = DynOptInterface
+```
+
+# Attributes
+
+# Variable Attributes
+
+The following table defines which `DynOptInterface` objects are compatible with sub-types of
+[`MOI.AbstractVariableAttribute`](@extref MathOptInterface.AbstractVariableAttribute)s.
+
+| Attribute | ``t`` | ``t^0`` | ``t^f`` | ``y(\cdot)`` | ``y(t^0)`` | ``y(t^f)`` |
+|:-:|:-:|:-:|:-:|:-:|:-:|:-:|
+| [`MOI.VariableName`](@extref MathOptInterface.VariableName) | ✅ | ❌ | ❌ | ✅ | ❌ | ❌ |
+| [`MOI.VariablePrimal`](@extref MathOptInterface.VariablePrimal) | ❌ | ✅ | ✅ | ✅ | ✅ | ✅ |
+| [`MOI.VariablePrimalStart`](@extref MathOptInterface.VariablePrimalStart) | ❌ | ✅ | ✅ | ✅ | ✅ | ✅ |
+
+```@docs
+MOI.supports
+MOI.set
+MOI.get
+```
diff --git a/docs/src/reference/boundary_functions.md b/docs/src/reference/boundary_functions.md
@@ -4,9 +4,33 @@ CurrentModule = DynOptInterface
 
 # Boundary Functions
 
+## Abstraction
+
 ```@docs
 AbstractBoundaryFunction
+```
+
+## Initial & Final
+
+```@docs
 Initial
 Final
+```
+
+## Linkage
+
+```@docs
+Linkage
+```
+
+## Nonlinear
+
+```@docs
 NonlinearBoundaryFunction
+```
+
+## Integrals
+```@docs
+Integral
+Bolza
 ```
diff --git a/docs/src/reference/dynamic_functions/abstraction.md b/docs/src/reference/dynamic_functions/abstraction.md
@@ -0,0 +1,11 @@
+```@meta
+CurrentModule = DynOptInterface
+```
+
+# Abstraction
+
+```@docs
+AbstractDynamicFunction
+phase_index
+MixedPhases
+```
diff --git a/docs/src/reference/dynamic_functions/derivatives.md b/docs/src/reference/dynamic_functions/derivatives.md
@@ -0,0 +1,10 @@
+```@meta
+CurrentModule = DynOptInterface
+```
+
+# Derivatives
+
+```@docs
+DynamicVariableDerivative
+ExplicitDifferentialFunction
+```
diff --git a/docs/src/reference/dynamic_functions/dynamic_variables.md b/docs/src/reference/dynamic_functions/dynamic_variables.md
@@ -0,0 +1,13 @@
+```@meta
+CurrentModule = DynOptInterface
+```
+
+# Dynamic Variables
+
+```@docs
+DynamicVariableIndex
+supports_dynamic_variable
+UnsupportedDynamicVariable
+add_dynamic_variable
+AddDynamicVariableNotAllowed
+```
diff --git a/docs/src/reference/dynamic_functions.md → ...eference/dynamic_functions/expressions.md b/docs/src/reference/dynamic_functions.md → ...eference/dynamic_functions/expressions.md
@@ -2,13 +2,22 @@
 CurrentModule = DynOptInterface
 ```
 
-# Dynamic Functions
+# Expressions
+
+## Linear
 
 ```@docs
 LinearDynamicTerm
 LinearDynamicFunction
+```
+
+## Squared
+```@docs
 SquaredDynamicTerm
 SquaredDynamicFunction
+```
+
+## Nonlinear
+```@docs
 NonlinearDynamicFunction
-ExplicitDifferentialFunction
 ```
diff --git a/docs/src/reference/dynamic_functions/phases.md b/docs/src/reference/dynamic_functions/phases.md
@@ -0,0 +1,13 @@
+```@meta
+CurrentModule = DynOptInterface
+```
+
+# Phases
+
+```@docs
+PhaseIndex
+supports_phase
+UnsupportedPhase
+AddPhaseNotAllowed
+add_phase
+```
diff --git a/docs/src/reference/dynamic_variables.md b/docs/src/reference/dynamic_variables.md
diff --git a/docs/src/reference/integral_functions.md b/docs/src/reference/integral_functions.md
diff --git a/docs/src/reference/nonlinear_support.md b/docs/src/reference/nonlinear_support.md
@@ -4,15 +4,9 @@ CurrentModule = DynOptInterface
 
 # Nonlinear Support
 
-## Errors
-```@docs
-UnsupportedObjectiveArgument
-UnsupportedConstraintArgument
-```
-
-## Functions
-
 ```@docs
 supports_objective_argument
+UnsupportedObjectiveArgument
 supports_constraint_argument
+UnsupportedConstraintArgument
 ```
diff --git a/docs/src/reference/phases.md b/docs/src/reference/phases.md
diff --git a/docs/src/reference/solutions.md b/docs/src/reference/solutions.md
@@ -0,0 +1,10 @@
+```@meta
+CurrentModule = DynOptInterface
+```
+
+# Solutions
+
+```@docs
+AbstractDynamicSolution
+AbstractDynamicSolution(::Real)
+```
diff --git a/src/DynOptInterface.jl b/src/DynOptInterface.jl
@@ -2,12 +2,18 @@ module DynOptInterface
 
 import MathOptInterface as MOI
 
-include("phases.jl")
-include("dynamic_variables.jl")
-include("nonlinear_support.jl")
-include("dynamic_functions.jl")
+include("dynamic_functions/abstraction.jl")
+include("dynamic_functions/phases.jl")
+include("dynamic_functions/dynamic_variables.jl")
+include("dynamic_functions/expressions.jl")
+include("dynamic_functions/derivatives.jl")
+
 include("boundary_functions.jl")
-include("integral_functions.jl")
 
+include("nonlinear_support.jl")
+
+include("attributes.jl")
+
+include("solutions.jl")
 
 end