Upversioned julia to 1.10, updated dynamic variables

Author: e-duar-do

.github/workflows/CI.yml

@@ -23,7 +23,7 @@ jobs:
       fail-fast: false
       matrix:
         version:
-          - '1.6'
+          - '1.10'
         os:
           - ubuntu-latest
         arch:

.gitignore

@@ -1,6 +1,7 @@
+.vscode/
 *.jl.*.cov
 *.jl.cov
 *.jl.mem
 /Manifest.toml
 /docs/Manifest.toml
-/docs/build/
+/docs/build/

src/dynamic_functions/dynamic_variables.jl

@@ -1,158 +1,172 @@
 """
-    DynamicVariableIndex(value::Int64, phase::DynamicVariableIndex)
+    DynamicVariableIndex(value::Int64, phase::PhaseIndex)
 
-An object for use in referencing dynamic variables in a model.
+Represent the dynamic variable ``\boldsymbol{y}_j(\cdot)`` in an expression.
 
-It is a sub-type of [`AbstractDynamicFunction`](@ref). It represents a
-dynamic variable ``t_i \\mapsto y_j(t_i)`` defined in the domain
-``[t_i^0, t_i^f]``. The `Int64` index value is stored in the `value` field.
+It is a subtype of [`AbstractDynamicFunction`](@ref).
 To allow for deletion, indices need not be consecutive.
 """
 struct DynamicVariableIndex <: AbstractDynamicFunction
     value::Int64
     phase::PhaseIndex
 end
 
-function MOI.Utilities._to_string(
-    ::MOI.Utilities._PrintOptions,
-    ::MOI.ModelLike,
-    index::DynamicVariableIndex,
-)
-    return string("DynamicVariableIndex(", index.value, ")")
+function Base.show(io::IO, ::MIME"text/plain", dyn_var::DynamicVariableIndex)
+    return print(io, "DOI.DynamicVariableIndex($(dyn_var.value))")
 end
 
 phase_index(dyn_var::DynamicVariableIndex) = dyn_var.phase
 
+## Dynamic Variables in Models
+
 """
-    supports_dynamic_variable(model::MOI.ModelLike)::Bool
+    supports_dynamic_variables(model::MOI.ModelLike)::Bool
 
-Return a `Bool` indicating whether `model` supports dynamic variables.
+Indicate whether `model` supports dynamic variables.
 """
-supports_dynamic_variable(::MOI.ModelLike) = false
+supports_dynamic_variables(::MOI.ModelLike) = false
 
 """
-    UnsupportedDynamicVariable(message::String)
+    UnsupportedDynamicVariablesError(message::String)
 
-An error indicating that dynamic variables are not supported by the model.
+The model does not support dynamic variables.
 
-That is, that [`supports_dynamic_variable`](@ref) returns `false`. The message
-`String` is stored in the `message` field.
+That is, [`supports_dynamic_variables`](@ref) returns `false`.
 """
-struct UnsupportedDynamicVariable <: MOI.UnsupportedError
+struct UnsupportedDynamicVariablesError <: MOI.UnsupportedError
     message::String
 end
 
 """
-    AddDynamicVariableNotAllowed(message::String)
+    add_dynamic_variable(model::MOI.ModelLike, phase::PhaseIndex)::DynamicVariableIndex
 
-An error indicating that dynamic variables cannot be added to the model
-in its current state.
+Add a dynamic variable to `model`, returning a [`DynamicVariableIndex`](@ref).
 
-The `String` error message is stored in the `message` field.
+An [`AddDynamicVariableNotAllowedError`](@ref) is thrown if a dynamic variable cannot be
+added to `model` in its current state.
 """
-struct AddDynamicVariableNotAllowed <: MOI.NotAllowedError
-    message::String
+function add_dynamic_variable(::MOI.ModelLike, ::PhaseIndex)
+    return throw(AddDynamicVariableNotAllowedError(""))
 end
 
-MOI.operation_name(::AddDynamicVariableNotAllowed) = "Adding a dynamic variable"
+"""
+    AddDynamicVariableNotAllowedError(message::String)
 
+Dynamic variables cannot be added to the model in its current state.
 """
-    add_dynamic_variable(model::MOI.ModelLike, phase::PhaseIndex)::DynamicVariableIndex
+struct AddDynamicVariableNotAllowedError <: MOI.NotAllowedError
+    message::String
+end
 
-Add a dynamic variable to `model`, returning a [`DynamicVariableIndex`](@ref).
+MOI.operation_name(::AddDynamicVariableNotAllowedError) = "Adding a dynamic variable"
 
-An [`AddDynamicVariableNotAllowed`](@ref) is thrown if a dynamic variable cannot be added
-to `model` in its current state.
 """
-add_dynamic_variable(::MOI.ModelLike, ::PhaseIndex) =
-    throw(AddDynamicVariableNotAllowed(""))
+    MOI.is_valid(model::MOI.ModelLike, dyn_var::DynamicVariableIndex)::Bool
 
+Indicate whether `dyn_var` refers to a valid [`DynamicVariableIndex`](@ref) in `model`.
 """
-    MOI.is_valid(model::MOI.ModelLike, index::DynamicVariableIndex)::Bool
+MOI.is_valid(::MOI.ModelLike, ::DynamicVariableIndex) = false
 
-Return a `Bool` indicating whether `index` refers to a valid [`DynamicVariableIndex`](@ref)
-in `model`.
 """
-MOI.is_valid(model::MOI.ModelLike, index::DynamicVariableIndex) = false
+    InvalidDynamicVariableError(dyn_var::DynamicVariableIndex)
 
+The dynamic variable `dyn_var` is not valid in the model.
 """
-    InvalidDynamicVariableIndex(index::DynamicVariableIndex)
+struct InvalidDynamicVariableError <: Exception
+    dyn_var::DynamicVariableIndex
+end
+
+## Dynamic Variable Attributes
 
-An error indicating that the dynamic variable `index` is not valid.
 """
-struct InvalidDynamicVariableIndex <: Exception
-    index::DynamicVariableIndex
-end
+    AbstractDynamicVariableAttribute
 
-## Attributes
+Supertype for dynamic variable attributes.
+"""
+abstract type AbstractDynamicVariableAttribute end
 
 """
     MOI.supports(
         model::MOI.ModelLike,
-        attr::MOI.AbstractVariableAttribute,
-        ::Type{DynamicVariableIndex},
+        attr::MOI.AbstractDynamicVariableAttribute,
     )::Bool
 
-Return a `Bool` indicating whether `model` supports the attribute `attr` for
-[`DynamicVariableIndex`](@ref)s.
+Indicate whether `model` supports the dynamic variable attribute `attr`.
 """
-function MOI.supports(
-    ::MOI.ModelLike,
-    ::MOI.AbstractVariableAttribute,
-    ::Type{DynamicVariableIndex},
-)
+function MOI.supports(::MOI.ModelLike, ::MOI.AbstractDynamicVariableAttribute)
     return false
 end
 
 """
     MOI.set(
         model::MOI.ModelLike,
-        attr::MOI.AbstractVariableAttribute,
-        index::DynamicVariableIndex,
-        value,
+        attr::MOI.AbstractDynamicVariableAttribute,
+        dyn_var::DynamicVariableIndex,
+        value::Any,
     )
 
-Assign `value` to the attribute `attr` of dynamic variable `index` in model `model`.
-
-An [`MOI.UnsupportedAttribute`](@extref MathOptInterface.UnsupportedAttribute)
-error is thrown if `model` does not support the attribute `attr`, and a
-[`MOI.SetAttributeNotAllowed`](@extref MathOptInterface.SetAttributeNotAllowed)
-error is thrown if it supports the attribute `attr` but it cannot be set.
+Assign `value` to the attribute `attr` of dynamic variable `dyn_var` in model `model`.
 """
 function MOI.set(
     model::MOI.ModelLike,
-    attr::MOI.AbstractVariableAttribute,
-    index::DynamicVariableIndex,
-    ::Any,
+    attr::MOI.AbstractDynamicVariableAttribute,
+    ::DynamicVariableIndex,
+    value::Any,
 )
-    if MOI.supports(model, attr, typeof(index))
-        throw(MOI.SetAttributeNotAllowed(attr))
+    if MOI.supports(model, attr)
+        throw(ArgumentError(
+            "$(typeof(model)) does not currently allow setting the attribute $(attr) to $(value)."
+        ))
     else
-        throw(MOI.UnsupportedAttribute(attr))
+        throw(ArgumentError(
+            "$(typeof(model)) does not support attribute $(attr)."
+        ))
     end
     return nothing
 end
 
 """
     MOI.get(
         model::MOI.ModelLike,
-        attr::MOI.AbstractVariableAttribute,
-        index::DynamicVariableIndex,
+        attr::MOI.AbstractDynamicVariableAttribute,
+        dyn_var::DynamicVariableIndex,
     )
 
-Return the value of the attribute `attr` set to dynamic variable `index` in model `model`.
+Return the value of the attribute `attr` set to dynamic variable `dyn_var` in model `model`.
 
 If the attribute `attr` is not supported by `model` then an error should be thrown.
 If the attribute is supported but has not been set, `nothing` is returned.
 """
 function MOI.get(
     model::MOI.ModelLike,
-    attr::MOI.AbstractVariableAttribute,
-    index::DynamicVariableIndex,
+    attr::MOI.AbstractDynamicVariableAttribute,
+    dyn_var::DynamicVariableIndex,
 )
-    throw(MOI.GetAttributeNotAllowed(
-        attr,
-        "$(typeof(model)) does not support getting the attribute $(attr) for $(typeof(index)).",
-    ))
+    throw(ArgumentError(
+        "$(typeof(model)) does not support getting the attribute $(attr) for $(typeof(dyn_var))."
+        ))
     return nothing
-end
+end
+
+"""
+    DynamicVariableName
+
+A dynamic variable attribute for a `String` identifying a dynamic variable.
+"""
+struct DynamicVariableName <: AbstractDynamicVariableAttribute end
+
+"""
+    DynamicVariableInitialStart
+
+A dynamic variable attribute for the start value of the dynamic variable at the initial
+phase boundary.
+"""
+struct DynamicVariableInitialPrimalStart <: AbstractDynamicVariableAttribute end
+
+"""
+    DynamicVariableFinalStart
+
+A dynamic variable attribute for the start value of the dynamic variable at the final phase
+boundary.
+"""
+struct DynamicVariableFinalStart <: AbstractDynamicVariableAttribute end