Refactor to use MOI.Nonlinear (#2955)

Author: odow

Project.toml

@@ -4,28 +4,18 @@ repo = "https://github.com/jump-dev/JuMP.jl.git"
 version = "1.1.1"
 
 [deps]
-Calculus = "49dc2e85-a5d0-5ad3-a950-438e2897f1b9"
-DataStructures = "864edb3b-99cc-5e75-8d2d-829cb0a9cfe8"
-ForwardDiff = "f6369f11-7733-5829-9624-2563aa707210"
 LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
 MathOptInterface = "b8f27783-ece8-5eb3-8dc8-9495eed66fee"
 MutableArithmetics = "d8a4904e-b15c-11e9-3269-09a3773c0cb0"
-NaNMath = "77ba4419-2d1f-58cd-9bb1-8ffee604a2e3"
 OrderedCollections = "bac558e1-5e72-5ebc-8fee-abe8a469f55d"
 Printf = "de0858da-6303-5e67-8744-51eddeeeb8d7"
 SparseArrays = "2f01184e-e22b-5df5-ae63-d93ebab69eaf"
-SpecialFunctions = "276daf66-3868-5448-9aa4-cd146d93841b"
 
 [compat]
-Calculus = "0.5"
-DataStructures = "0.18"
-ForwardDiff = "~0.5.0, ~0.6, ~0.7, ~0.8, ~0.9, ~0.10"
 JSON = "0.21"
-MathOptInterface = "1.1.1"
+MathOptInterface = "1.3.0"
 MutableArithmetics = "1"
-NaNMath = "0.3, 1"
 OrderedCollections = "1"
-SpecialFunctions = "0.8, 1, 2"
 julia = "1.6"
 
 [extras]

docs/src/manual/nlp.md

@@ -245,7 +245,7 @@ julia> @NLconstraint(model, *(x...) <= 1.0)
 x[1] * x[2] * x[3] - 1.0 ≤ 0
 
 julia> @NLconstraint(model, *((x / 2)...) <= 0.0)
-ERROR: LoadError: Unexpected expression in (*)(x / 2...). JuMP supports splatting only symbols. For example, x... is ok, but (x + 1)..., [x; y]... and g(f(y)...) are not.
+ERROR: Unsupported use of the splatting operator. JuMP supports splatting only symbols. For example, `x...` is ok, but `(x + 1)...`, `[x; y]...` and `g(f(y)...)` are not.
 ```
 
 ## User-defined Functions
@@ -531,8 +531,7 @@ The [`NLPEvaluator`](@ref) *does not evaluate derivatives of linear or quadratic
 constraints or objectives*.
 
 The [`index`](@ref) method applied to a nonlinear constraint reference object
-returns its index as a [`NonlinearConstraintIndex`](@ref). The `.value` field of
-[`NonlinearConstraintIndex`](@ref) stores the raw integer index. For example:
+returns its index as a [`MOI.Nonlinear.ConstraintIndex`](@ref). For example:
 
 ```jldoctest
 julia> model = Model();
@@ -544,13 +543,13 @@ julia> @NLconstraint(model, cons1, sin(x) <= 1);
 julia> @NLconstraint(model, cons2, x + 5 == 10);
 
 julia> typeof(cons1)
-NonlinearConstraintRef{ScalarShape} (alias for ConstraintRef{Model, NonlinearConstraintIndex, ScalarShape})
+NonlinearConstraintRef{ScalarShape} (alias for ConstraintRef{Model, MathOptInterface.Nonlinear.ConstraintIndex, ScalarShape})
 
 julia> index(cons1)
-NonlinearConstraintIndex(1)
+MathOptInterface.Nonlinear.ConstraintIndex(1)
 
 julia> index(cons2)
-NonlinearConstraintIndex(2)
+MathOptInterface.Nonlinear.ConstraintIndex(2)
 ```
 
 ```@meta

docs/src/reference/nlp.md

@@ -3,12 +3,18 @@
 More information can be found in the [Nonlinear Modeling](@ref) section of the
 manual.
 
+## [Models](@id ref_nl_models)
+
+
+```@docs
+nonlinear_model
+```
+
 ## [Constraints](@id ref_nl_constraints)
 
 ```@docs
 @NLconstraint
 @NLconstraints
-NonlinearConstraintIndex
 num_nonlinear_constraints
 add_nonlinear_constraint
 all_nonlinear_constraints

src/JuMP.jl

@@ -46,18 +46,12 @@ Shorthand for the MathOptInterface.Bridges package.
 """
 const MOIB = MOI.Bridges
 
-import Calculus
 import OrderedCollections.OrderedDict
-import ForwardDiff
-include("_Derivatives/_Derivatives.jl")
-using ._Derivatives
 
 include("Containers/Containers.jl")
 
 # Exports are at the end of the file.
 
-include("utils.jl")
-
 const _MOIVAR = MOI.VariableIndex
 const _MOICON{F,S} = MOI.ConstraintIndex{F,S}
 
@@ -149,7 +143,7 @@ mutable struct Model <: AbstractModel
     # where kwargs get passed along to subsequent solve calls.
     optimize_hook::Any
     # TODO: Document.
-    nlp_data::Any
+    nlp_model::Union{Nothing,MOI.Nonlinear.Model}
     # Dictionary from variable and constraint names to objects.
     obj_dict::Dict{Symbol,Any}
     # Number of times we add large expressions. Incremented and checked by
@@ -166,6 +160,23 @@ mutable struct Model <: AbstractModel
     set_string_names_on_creation::Bool
 end
 
+function Base.getproperty(model::Model, name::Symbol)
+    if name == :nlp_data
+        error(
+            "The internal field `.nlp_data` was removed from `Model` in JuMP " *
+            "v.1.2.0. If you encountered this message without going " *
+            "`model.nlp_data`, it means you are using a package that is " *
+            "incompatible with your installed version of JuMP. As a " *
+            "temporary fix, install a compatible version with " *
+            "`import Pkg; Pkg.pkg\"add [email protected]\"`, then restart Julia for " *
+            "the changes to take effect. In addition, you should open a " *
+            "GitHub issue for the package you are using so that the issue " *
+            "can be fixed for future users.",
+        )
+    end
+    return getfield(model, name)
+end
+
 """
     Model()
 
@@ -590,7 +601,7 @@ function Base.empty!(model::Model)::Model
     #   message (so keeping it helps to discover inefficiencies).
     MOI.empty!(model.moi_backend)
     empty!(model.shapes)
-    model.nlp_data = nothing
+    model.nlp_model = nothing
     empty!(model.obj_dict)
     empty!(model.ext)
     model.is_model_dirty = false
@@ -607,7 +618,7 @@ apart from optimizer attributes.
 function Base.isempty(model::Model)
     MOI.is_empty(model.moi_backend) || return false
     isempty(model.shapes) || return false
-    model.nlp_data === nothing || return false
+    model.nlp_model === nothing || return false
     isempty(model.obj_dict) && isempty(model.ext) || return false
     return !model.is_model_dirty
 end
@@ -619,15 +630,6 @@ Returns number of variables in `model`.
 """
 num_variables(model::Model)::Int64 = MOI.get(model, MOI.NumberOfVariables())
 
-"""
-    num_nonlinear_constraints(model::Model)
-
-Returns the number of nonlinear constraints associated with the `model`.
-"""
-function num_nonlinear_constraints(model::Model)
-    return model.nlp_data !== nothing ? length(model.nlp_data.nlconstr) : 0
-end
-
 """
     object_dictionary(model::Model)
 
@@ -1346,35 +1348,11 @@ function operator_warn(model::Model)
     end
 end
 
-"""
-    NonlinearExpression <: AbstractJuMPScalar
-
-A struct to represent a nonlinear expression.
-
-Create an expression using [`@NLexpression`](@ref).
-"""
-struct NonlinearExpression <: AbstractJuMPScalar
-    model::Model
-    index::Int
-end
-
-"""
-    NonlinearParameter <: AbstractJuMPScalar
-
-A struct to represent a nonlinear parameter.
-
-Create a parameter using [`@NLparameter`](@ref).
-"""
-struct NonlinearParameter <: AbstractJuMPScalar
-    model::Model
-    index::Int
-end
-
 include("copy.jl")
+include("nlp.jl")
 include("operators.jl")
 include("macros.jl")
 include("optimizer_interface.jl")
-include("nlp.jl")
 include("print.jl")
 include("solution_summary.jl")
 include("lp_sensitivity2.jl")