Begin refactor from modifyconstraint(m, c, set) to

`set!(m, ConstraintSet(), c, set)`. This patch currently errors as
it needs to be implemented for src/Utilities/model.jl, but I'm not
sure where to start.

Author: odow

perf/cachingoptimizer.jl

@@ -12,8 +12,8 @@ MOIU.resetoptimizer!(caching_optimizer) # detach optimizer
 v = MOI.addvariables!(caching_optimizer, 2)
 cf = MOI.ScalarAffineFunction(v, [0.0, 0.0], 0.0)
 c = MOI.addconstraint!(caching_optimizer, cf, MOI.Interval(-Inf, 1.0))
-@btime MOI.modifyconstraint!($caching_optimizer, $c, $(MOI.Interval(0.0, 2.0)))
+@btime MOI.set!($caching_optimizer, $(MOI.ConstraintSet()), $c, $(MOI.Interval(0.0, 2.0)))
 MOIU.attachoptimizer!(caching_optimizer)
-@btime MOI.modifyconstraint!($caching_optimizer, $c, $(MOI.Interval(0.0, 2.0)))
-@btime MOI.modifyconstraint!($(caching_optimizer.model_cache), $c, $(MOI.Interval(0.0, 2.0)))
-@btime MOI.modifyconstraint!($(caching_optimizer.optimizer), $(caching_optimizer.model_to_optimizer_map[c]), $(MOI.Interval(0.0, 2.0)))
+@btime MOI.set!($caching_optimizer, $(MOI.ConstraintSet()), $c, $(MOI.Interval(0.0, 2.0)))
+@btime MOI.set!($(caching_optimizer.model_cache), $(MOI.ConstraintSet()), $c, $(MOI.Interval(0.0, 2.0)))
+@btime MOI.set!($(caching_optimizer.optimizer), $(MOI.ConstraintSet()), $(caching_optimizer.model_to_optimizer_map[c]), $(MOI.Interval(0.0, 2.0)))

src/Bridges/intervalbridge.jl

@@ -56,7 +56,9 @@ function MOI.modifyconstraint!(model::MOI.ModelLike, c::SplitIntervalBridge, cha
     MOI.modifyconstraint!(model, c.lower, change)
     MOI.modifyconstraint!(model, c.upper, change)
 end
-function MOI.modifyconstraint!(model::MOI.ModelLike, c::SplitIntervalBridge, change::MOI.Interval)
-    MOI.modifyconstraint!(model, c.lower, MOI.GreaterThan(change.lower))
-    MOI.modifyconstraint!(model, c.upper, MOI.LessThan(change.upper))
+
+MOI.canset(model::MOI.ModelLike, ::MOI.ConstraintSet, c::SplitIntervalBridge, ::Type{MOI.Interval}) = true
+function MOI.set!(model::MOI.ModelLike, ::MOI.ConstraintSet, c::SplitIntervalBridge, change::MOI.Interval)
+    MOI.set!(model, MOI.ConstraintSet(), c.lower, MOI.GreaterThan(change.lower))
+    MOI.set!(model, MOI.ConstraintSet(), c.upper, MOI.LessThan(change.upper))
 end

src/MathOptInterface.jl

@@ -150,8 +150,8 @@ function copy! end
 include("indextypes.jl")
 include("functions.jl")
 include("sets.jl")
-include("constraints.jl")
 include("attributes.jl")
+include("constraints.jl")
 include("objectives.jl")
 include("variables.jl")
 include("nlp.jl")

src/Test/contlinear.jl

@@ -229,8 +229,8 @@ function linear1test(model::MOI.ModelLike, config::TestConfig)
     # s.t. x + y + z <= 1
     # x >= -1
     # y,z >= 0
-    @test MOI.canmodifyconstraint(model, vc1, MOI.GreaterThan{Float64})
-    MOI.modifyconstraint!(model, vc1, MOI.GreaterThan(-1.0))
+    @test MOI.canset(model, MOI.ConstraintSet(), vc1, MOI.GreaterThan{Float64})
+    MOI.set!(model, MOI.ConstraintSet(), vc1, MOI.GreaterThan(-1.0))
 
     if config.solve
         MOI.optimize!(model)
@@ -255,8 +255,8 @@ function linear1test(model::MOI.ModelLike, config::TestConfig)
     # max x + 2z
     # s.t. x + y + z <= 1
     # x, y >= 0, z = 0 (vc3)
-    @test MOI.canmodifyconstraint(model, vc1, MOI.GreaterThan{Float64})
-    MOI.modifyconstraint!(model, vc1, MOI.GreaterThan(0.0))
+    @test MOI.canset(model, MOI.ConstraintSet(), vc1, MOI.GreaterThan{Float64})
+    MOI.set!(model, MOI.ConstraintSet(), vc1, MOI.GreaterThan(0.0))
 
     @test MOI.candelete(model, vc3)
     MOI.delete!(model, vc3)
@@ -666,8 +666,8 @@ function linear4test(model::MOI.ModelLike, config::TestConfig)
     # Min  x - y
     # s.t. 100.0 <= x
     #               y <= 0.0
-    @test MOI.canmodifyconstraint(model, c1, MOI.GreaterThan{Float64})
-    MOI.modifyconstraint!(model, c1, MOI.GreaterThan(100.0))
+    @test MOI.canset(model, MOI.ConstraintSet(), c1, MOI.GreaterThan{Float64})
+    MOI.set!(model, MOI.ConstraintSet(), c1, MOI.GreaterThan(100.0))
     if config.solve
         MOI.optimize!(model)
         @test MOI.get(model, MOI.TerminationStatus()) == MOI.Success
@@ -681,8 +681,8 @@ function linear4test(model::MOI.ModelLike, config::TestConfig)
     # Min  x - y
     # s.t. 100.0 <= x
     #               y <= -100.0
-    @test MOI.canmodifyconstraint(model, c2, MOI.LessThan{Float64})
-    MOI.modifyconstraint!(model, c2, MOI.LessThan(-100.0))
+    @test MOI.canset(model, MOI.ConstraintSet(), c2, MOI.LessThan{Float64})
+    MOI.set!(model, MOI.ConstraintSet(), c2, MOI.LessThan(-100.0))
     if config.solve
         MOI.optimize!(model)
         @test MOI.get(model, MOI.TerminationStatus()) == MOI.Success
@@ -778,8 +778,8 @@ function linear5test(model::MOI.ModelLike, config::TestConfig)
     #        1 x + 2 y <= 4
     #        x >= 0, y >= 0
     #
-    #   solution: x = 2, y = 0, objv = 2  
-    
+    #   solution: x = 2, y = 0, objv = 2
+
     if config.modify_lhs
         @test MOI.canmodifyconstraint(model, c1, MOI.ScalarCoefficientChange{Float64})
         MOI.modifyconstraint!(model, c1, MOI.ScalarCoefficientChange(y, 3.0))
@@ -790,7 +790,7 @@ function linear5test(model::MOI.ModelLike, config::TestConfig)
         @test MOI.canaddconstraint(model, typeof(cf1), MOI.LessThan{Float64})
         c1 = MOI.addconstraint!(model, cf1, MOI.LessThan(4.0))
     end
-    
+
     if config.solve
         MOI.optimize!(model)
 
@@ -905,8 +905,8 @@ function linear6test(model::MOI.ModelLike, config::TestConfig)
     # Min  x - y
     # s.t. 100.0 <= x
     #               y <= 0.0
-    @test MOI.canmodifyconstraint(model, c1, MOI.GreaterThan{Float64})
-    MOI.modifyconstraint!(model, c1, MOI.GreaterThan(100.0))
+    @test MOI.canset(model, MOI.ConstraintSet(), c1, MOI.GreaterThan{Float64})
+    MOI.set!(model, MOI.ConstraintSet(), c1, MOI.GreaterThan(100.0))
     if config.solve
         MOI.optimize!(model)
         @test MOI.get(model, MOI.TerminationStatus()) == MOI.Success
@@ -920,8 +920,8 @@ function linear6test(model::MOI.ModelLike, config::TestConfig)
     # Min  x - y
     # s.t. 100.0 <= x
     #               y <= -100.0
-    @test MOI.canmodifyconstraint(model, c2, MOI.LessThan{Float64})
-    MOI.modifyconstraint!(model, c2, MOI.LessThan(-100.0))
+    @test MOI.canset(model, MOI.ConstraintSet(), c2, MOI.LessThan{Float64})
+    MOI.set!(model, MOI.ConstraintSet(), c2, MOI.LessThan(-100.0))
     if config.solve
         MOI.optimize!(model)
         @test MOI.get(model, MOI.TerminationStatus()) == MOI.Success
@@ -984,11 +984,11 @@ function linear7test(model::MOI.ModelLike, config::TestConfig)
         MOI.modifyconstraint!(model, c1, MOI.VectorConstantChange([-100.0]))
     else
         @test MOI.candelete(model, c1)
-        MOI.delete!(model, c1)        
+        MOI.delete!(model, c1)
         @test MOI.canaddconstraint(model, MOI.VectorAffineFunction{Float64}, MOI.Nonnegatives)
-        c1 = MOI.addconstraint!(model, MOI.VectorAffineFunction([MOI.VectorAffineTerm(1, MOI.ScalarAffineTerm(1.0, x))], [-100.0]), MOI.Nonnegatives(1))        
+        c1 = MOI.addconstraint!(model, MOI.VectorAffineFunction([MOI.VectorAffineTerm(1, MOI.ScalarAffineTerm(1.0, x))], [-100.0]), MOI.Nonnegatives(1))
     end
-    
+
     if config.solve
         MOI.optimize!(model)
         @test MOI.get(model, MOI.TerminationStatus()) == MOI.Success
@@ -1012,7 +1012,7 @@ function linear7test(model::MOI.ModelLike, config::TestConfig)
         @test MOI.canaddconstraint(model, MOI.VectorAffineFunction{Float64}, MOI.Nonpositives)
         c2 = MOI.addconstraint!(model, MOI.VectorAffineFunction([MOI.VectorAffineTerm(1, MOI.ScalarAffineTerm(1.0, y))], [100.0]), MOI.Nonpositives(1))
     end
-    
+
     if config.solve
         MOI.optimize!(model)
         @test MOI.get(model, MOI.TerminationStatus()) == MOI.Success
@@ -1330,8 +1330,8 @@ function linear10test(model::MOI.ModelLike, config::TestConfig)
         end
     end
 
-    @test MOI.canmodifyconstraint(model, c, MOI.Interval{Float64})
-    MOI.modifyconstraint!(model, c, MOI.Interval(2.0, 12.0))
+    @test MOI.canset(model, MOI.ConstraintSet(), c, MOI.Interval{Float64})
+    MOI.set!(model, MOI.ConstraintSet(), c, MOI.Interval(2.0, 12.0))
 
     if config.query
         @test MOI.canget(model, MOI.ConstraintSet(), typeof(c))

src/Utilities/cachingoptimizer.jl

@@ -247,14 +247,21 @@ function MOI.modifyconstraint!(m::CachingOptimizer, cindex::CI, change)
     return
 end
 
-function MOI.modifyconstraint!(m::CachingOptimizer, cindex::CI{F,S}, set::S) where {F<:MOI.AbstractFunction, S<:MOI.AbstractSet}
-    if m.mode == Automatic && m.state == AttachedOptimizer && !MOI.canmodifyconstraint(m.optimizer, cindex, S)
+function MOI.canset(m::CachingOptimizer, ::MOI.ConstraintSet, cindex::CI, ::Type{S}) where S <: MOI.AbstractSet
+    MOI.canset(m.model_cache, MOI.ConstraintSet(), cindex, S) || return false
+    if m.state == AttachedOptimizer && m.mode == Manual
+        MOI.canset(m.optimizer, MOI.ConstraintSet(), m.model_to_optimizer_map[cindex], S) || return false
+    end
+    return true
+end
+function MOI.set!(m::CachingOptimizer, ::MOI.ConstraintSet, cindex::CI{F,S}, set::S) where {F<:MOI.AbstractFunction, S<:MOI.AbstractSet}
+    if m.mode == Automatic && m.state == AttachedOptimizer && !MOI.canset(m.optimizer, MOI.ConstraintSet(), cindex, S)
         resetoptimizer!(m)
     end
-    @assert MOI.canmodifyconstraint(m, cindex, S)
-    MOI.modifyconstraint!(m.model_cache, cindex, set)
+    @assert MOI.canset(m, MOI.ConstraintSet(), cindex, S)
+    MOI.set!(m.model_cache, MOI.ConstraintSet(), cindex, set)
     if m.state == AttachedOptimizer
-        MOI.modifyconstraint!(m.optimizer, m.model_to_optimizer_map[cindex], set)
+        MOI.set!(m.optimizer, MOI.ConstraintSet(), m.model_to_optimizer_map[cindex], set)
     end
     return
 end

src/Utilities/mockoptimizer.jl

@@ -210,8 +210,9 @@ function MOI.modifyconstraint!(mock::MockOptimizer, c::CI, change)
     MOI.modifyconstraint!(mock.inner_model, xor_index(c), xor_variables(change))
 end
 
-function MOI.modifyconstraint!(mock::MockOptimizer, c::CI{F,S}, set::S) where {F<:MOI.AbstractFunction, S<:MOI.AbstractSet}
-    MOI.modifyconstraint!(mock.inner_model, xor_index(c), set)
+MOI.canset(mock::MockOptimizer, ::MOI.ConstraintSet, c::CI{F,S}, set::Type{S}) where {F<:MOI.AbstractFunction, S<:MOI.AbstractSet} = true
+function MOI.set!(mock::MockOptimizer, ::MOI.ConstraintSet, c::CI{F,S}, set::S) where {F<:MOI.AbstractFunction, S<:MOI.AbstractSet}
+    MOI.set!(mock.inner_model, ConstraintSet(), xor_index(c), set)
 end
 
 function MOI.canmodifyobjective(mock::MockOptimizer, change)

src/Utilities/model.jl

@@ -326,6 +326,7 @@ MOIU.broadcastcall(constrs -> _addcon(solver, constrs), model)
 ```
 """
 function broadcastcall end
+
 """
 broadcastvcat(f::Function, model::AbstractModel)
 
@@ -339,6 +340,7 @@ _getfun(ci, f, s) = f
 _getfun(cindices::Tuple) = _getfun(cindices...)
 _getfuns(constrs::Vector) = _getfun.(constrs)
 MOIU.broadcastvcat(_getfuns, model)
+```
 """
 function broadcastvcat end
 

src/Utilities/universalfallback.jl

@@ -155,6 +155,14 @@ MOI.addconstraint!(uf::UniversalFallback, f::MOI.AbstractFunction, s::MOI.Abstra
 MOI.canmodifyconstraint(uf::UniversalFallback, ci::CI, change) = MOI.canmodifyconstraint(uf.model, ci, change)
 MOI.modifyconstraint!(uf::UniversalFallback, ci::CI, change) = MOI.modifyconstraint!(uf.model, ci, change)
 
+function MOI.canset(uf::UniversalFallback, cs::MOI.ConstraintSet, ci::CI, ::Type{S}) where S <: MOI.AbstractSet
+    MOI.canset(uf.model, ci, S)
+end
+function MOI.set!(uf::UniversalFallback, cs::MOI.ConstraintSet, ci::CI, set::AbstractSet)
+    MOI.set!(uf.model, ci, set)
+end
+
+
 # Objective
 MOI.canmodifyobjective(uf::UniversalFallback, ::Type{M}) where M<:MOI.AbstractFunctionModification = MOI.canmodifyobjective(uf.model, M)
 MOI.modifyobjective!(uf::UniversalFallback, change::MOI.AbstractFunctionModification) = MOI.modifyobjective!(uf.model, change)

src/attributes.jl

@@ -491,8 +491,8 @@ If `N` is omitted, it is 1 by default.
 
 Given a constraint `function-in-set`, the `ConstraintPrimal` is the value of the
 function evaluated at the primal solution of the variables. For example, given
-the constraint `ScalarAffineFunction([x,y], [1, 2], 3)`-in-`Interval(0, 20)` and 
-a primal solution of `(x,y) = (4,5)`, the `ConstraintPrimal` solution of the 
+the constraint `ScalarAffineFunction([x,y], [1, 2], 3)`-in-`Interval(0, 20)` and
+a primal solution of `(x,y) = (4,5)`, the `ConstraintPrimal` solution of the
 constraint is `1 * 4 + 2 * 5 + 3 = 17`.
 """
 struct ConstraintPrimal <: AbstractConstraintAttribute

src/constraints.jl

@@ -43,18 +43,44 @@ function addconstraints! end
 # default fallback
 addconstraints!(model::ModelLike, funcs, sets) = addconstraint!.(model, funcs, sets)
 
+
 """
-## Modify Function
+    canset(model::ModelLike, ::ConstraintSet, c::ConstraintIndex{F,S}, ::Type{S})::Bool
 
-    canmodifyconstraint(model::ModelLike, c::ConstraintIndex{F,S}, ::Type{F})::Bool
+Return a `Bool` indicating whether the set in constraint `c` can be replaced by
+another set of the same type `S` as the original set.
+"""
+canset(model::ModelLike, ::ConstraintSet, c::ConstraintIndex, ::Type{S}) where S = false
 
-Return a `Bool` indicating whether the function in constraint `c` can be replaced by another function of the same type `F` as the original function.
+"""
+    set!(model::ModelLike, ::ConstraintSet, c::ConstraintIndex{F,S}, set::S)
+
+Change the set of constraint `c` to the new set `set` which should be of the
+same type as the original set.
+
+### Examples
+
+If `c` is a `ConstraintIndex{F,Interval}`
+
+```julia
+set!(model, ConstraintSet(), c, Interval(0, 5))
+set!(model, ConstraintSet(), c, NonPositives)    # Error
+```
+"""
+function set!(model::ModelLike, cs::ConstraintSet, c::ConstraintIndex{F,S1}, s::S2) where F where  S1 where S2
+    if S1 != S2  # throw helpful error
+        error("Cannot modify sets of different types. Use `transformconstraint!` instead.")
+    else  # throw original error suggesting that it is not implemented
+        throw(MethodError(set!, (model, cs, c, s)))
+    end
+end
 
-## Modify Set
+"""
+## Modify Function
 
-    canmodifyconstraint(model::ModelLike, c::ConstraintIndex{F,S}, ::Type{S})::Bool
+    canmodifyconstraint(model::ModelLike, c::ConstraintIndex{F,S}, ::Type{F})::Bool
 
-Return a `Bool` indicating whether the set in constraint `c` can be replaced by another set of the same type `S` as the original set.
+Return a `Bool` indicating whether the function in constraint `c` can be replaced by another function of the same type `F` as the original function.
 
 ## Partial Modifications
 
@@ -87,21 +113,6 @@ modifyconstraint!(model, c, ScalarAffineFunction([v1,v2],[1.0,2.0],5.0))
 modifyconstraint!(model, c, SingleVariable(v1)) # Error
 ```
 
-## Modify Set
-
-    modifyconstraint!(model::ModelLike, c::ConstraintIndex{F,S}, set::S)
-
-Change the set of constraint `c` to the new set `set` which should be of the same type as the original set.
-
-### Examples
-
-If `c` is a `ConstraintIndex{F,Interval}`
-
-```julia
-modifyconstraint!(model, c, Interval(0, 5))
-modifyconstraint!(model, c, NonPositives) # Error
-```
-
 ## Partial Modifications
 
     modifyconstraint!(model::ModelLike, c::ConstraintIndex, change::AbstractFunctionModification)

test/cachingoptimizer.jl

@@ -62,16 +62,16 @@
     @test MOI.canaddconstraint(m.optimizer, MOI.SingleVariable, MOI.LessThan{Float64})
     @test MOI.canaddconstraint(m, MOI.SingleVariable, MOI.LessThan{Float64})
     lb = MOI.addconstraint!(m, MOI.SingleVariable(v), MOI.LessThan(10.0))
-    @test MOI.canmodifyconstraint(m, lb, MOI.LessThan{Float64})
-    MOI.modifyconstraint!(m, lb, MOI.LessThan(11.0))
+    @test MOI.canset(m, MOI.ConstraintSet(), lb, MOI.LessThan{Float64})
+    MOI.set!(m, MOI.ConstraintSet(), lb, MOI.LessThan(11.0))
     @test MOI.get(m, MOI.ConstraintSet(), lb) == MOI.LessThan(11.0)
     @test MOI.get(m, MOI.ConstraintFunction(), lb) == MOI.SingleVariable(v)
 
     MOIU.dropoptimizer!(m)
     @test MOIU.state(m) == MOIU.NoOptimizer
 
-    @test MOI.canmodifyconstraint(m, lb, MOI.LessThan{Float64})
-    MOI.modifyconstraint!(m, lb, MOI.LessThan(12.0))
+    @test MOI.canset(m, MOI.ConstraintSet(), lb, MOI.LessThan{Float64})
+    MOI.set!(m, MOI.ConstraintSet(), lb, MOI.LessThan(12.0))
     @test MOI.get(m, MOI.ConstraintSet(), lb) == MOI.LessThan(12.0)
 
     @test MOI.candelete(m, x[2])