fixed attributes, added tests

JuDO-dev · Jul 26, 2024 · c790e57 · c790e57 · e-duar-do · Jul 26, 2024
1 parent a269639
commit c790e57
Show file tree

Hide file tree

Showing 23 changed files with 329 additions and 440 deletions.
diff --git a/Project.toml b/Project.toml
@@ -1,7 +1,7 @@
 name = "DynOptInterface"
 uuid = "6c38235a-427b-4736-80fa-cf75909744ec"
 authors = ["Eduardo M. G. Vila <[email protected]> and contributors"]
-version = "0.0.0"
+version = "0.1.0"
 
 [deps]
 MathOptInterface = "b8f27783-ece8-5eb3-8dc8-9495eed66fee"

diff --git a/docs/make.jl b/docs/make.jl
@@ -6,7 +6,7 @@ using DocumenterMermaid
 DocMeta.setdocmeta!(DynOptInterface, :DocTestSetup, :(import DynOptInterface as DOI); recursive=true)
 
 const _PAGES = [
-    #"Home" => "index.md",
+    "Home" => "index.md",
     "API Reference" => [
         "Dynamic Functions" => [
             "reference/dynamic_functions/abstraction.md",
@@ -17,9 +17,9 @@ const _PAGES = [
         ],
         "reference/boundary_functions.md",
         "reference/nonlinear_support.md",
-        "reference/attributes.md",
         "reference/solutions.md",
     ],
+    "Changelog" => "changelog.md",
 ]
 
 links = InterLinks(

diff --git a/docs/src/changelog.md b/docs/src/changelog.md
@@ -0,0 +1,12 @@
+```@meta
+CurrentModule = DynOptInterface
+```
+
+# Changelog
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## v0.1.0 (July 26, 2024)
+
+- Initial release
diff --git a/docs/src/reference/attributes.md b/docs/src/reference/attributes.md
diff --git a/docs/src/reference/dynamic_functions/dynamic_variables.md b/docs/src/reference/dynamic_functions/dynamic_variables.md
@@ -8,8 +8,21 @@ CurrentModule = DynOptInterface
 DynamicVariableIndex
 supports_dynamic_variable
 UnsupportedDynamicVariable
-add_dynamic_variable
 AddDynamicVariableNotAllowed
+add_dynamic_variable
 MOI.is_valid(::MOI.ModelLike, ::DynamicVariableIndex)
 InvalidDynamicVariableIndex
+```
+
+# Attributes
+
+The [`DynamicVariableIndex`](@ref) object is compatible with the following attributes:
+* [`MOI.VariableName`](@extref MathOptInterface.VariableName) with value types `String`
+* [`MOI.VariablePrimal`](@extref MathOptInterface.VariablePrimal) with value types [`AbstractDynamicSolution`](@ref)
+* [`MOI.VariablePrimalStart`](@extref MathOptInterface.VariablePrimalStart) with value types [`AbstractDynamicSolution`](@ref)
+
+```@docs
+MOI.supports(::MOI.ModelLike, ::MOI.AbstractVariableAttribute, ::Type{DynamicVariableIndex})
+MOI.set(::MOI.ModelLike, ::MOI.AbstractVariableAttribute, ::DynamicVariableIndex, ::Any)
+MOI.get(::MOI.ModelLike, ::MOI.AbstractVariableAttribute, ::DynamicVariableIndex)
 ```
diff --git a/docs/src/reference/dynamic_functions/expressions.md b/docs/src/reference/dynamic_functions/expressions.md
@@ -11,10 +11,10 @@ LinearDynamicTerm
 LinearDynamicFunction
 ```
 
-## Squared
+## Pure Quadratic
 ```@docs
-SquaredDynamicTerm
-SquaredDynamicFunction
+PureQuadraticDynamicTerm
+PureQuadraticDynamicFunction
 ```
 
 ## Nonlinear

diff --git a/docs/src/reference/dynamic_functions/phases.md b/docs/src/reference/dynamic_functions/phases.md
@@ -12,4 +12,17 @@ AddPhaseNotAllowed
 add_phase
 MOI.is_valid(::MOI.ModelLike, ::PhaseIndex)
 InvalidPhaseIndex
+```
+
+# Attributes
+
+The [`PhaseIndex`](@ref) object is compatible with the following attributes:
+* [`MOI.VariableName`](@extref MathOptInterface.VariableName) with value types `String`
+* [`MOI.VariablePrimal`](@extref MathOptInterface.VariablePrimal) with value types `Tuple{<:Real,<:Real}`
+* [`MOI.VariablePrimalStart`](@extref MathOptInterface.VariablePrimalStart) with value types `Tuple{<:Real,<:Real}`
+
+```@docs
+MOI.supports(::MOI.ModelLike, ::MOI.AbstractVariableAttribute, ::Type{PhaseIndex})
+MOI.set(::MOI.ModelLike, ::MOI.AbstractVariableAttribute, ::PhaseIndex, ::Any)
+MOI.get(::MOI.ModelLike, ::MOI.AbstractVariableAttribute, ::PhaseIndex)
 ```
diff --git a/src/DynOptInterface.jl b/src/DynOptInterface.jl
@@ -12,8 +12,6 @@ include("boundary_functions.jl")
 
 include("nonlinear_support.jl")
 
-include("attributes.jl")
-
 include("solutions.jl")
 
 end
diff --git a/src/attributes.jl b/src/attributes.jl