supports_constrained_variable -> supports_add_constrained_variable

Author: blegat

docs/src/apimanual.md

@@ -1052,7 +1052,7 @@ The `Bridges.Variable.Vectorize` is the bridge optimizer that applies the
 the optimizer
 ```jldoctest; setup=:(optimizer = MOI.Utilities.Model{Float64}())
 bridged_optimizer = MOI.Bridges.Variable.Vectorize{Float64}(optimizer)
-MOI.supports_constrained_variable(bridged_optimizer, MOI.GreaterThan{Float64})
+MOI.supports_add_constrained_variable(bridged_optimizer, MOI.GreaterThan{Float64})
 
 # output
 
@@ -1143,9 +1143,9 @@ if `model` supports creating free variables. However, if `model` does not
 support creating free variables, then it should only implement
 [`add_constrained_variable`](@ref) and not [`add_variable`](@ref) nor
 [`add_constraint`](@ref) for [`SingleVariable`](@ref)-in-`typeof(set)`.
-In addition, it should implement `supports_constrained_variables(::Optimizer,
+In addition, it should implement `supports_add_constrained_variables(::Optimizer,
 ::Type{Reals})` and return `false` so that free variables are bridged,
-see [`supports_constrained_variables`](@ref).
+see [`supports_add_constrained_variables`](@ref).
 
 ### Handling duplicate coefficients
 

docs/src/apireference.md

@@ -224,8 +224,8 @@ add_variable
 add_variables
 add_constrained_variable
 add_constrained_variables
-supports_constrained_variable
-supports_constrained_variables
+supports_add_constrained_variable
+supports_add_constrained_variables
 ```
 
 List of attributes associated with variables. [category AbstractVariableAttribute]
@@ -816,7 +816,7 @@ Bridges.added_constraint_types
 ```
 Additionally, variable bridges should implement:
 ```@docs
-Bridges.Variable.supports_constrained_variable
+Bridges.Variable.supports_add_constrained_variable
 Bridges.Variable.concrete_bridge_type
 Bridges.Variable.bridge_constrained_variable
 ```

src/Test/contconic.jl

@@ -103,7 +103,7 @@ function _lin2test(model::MOI.ModelLike, config::TestConfig, vecofvars::Bool)
     @test MOI.supports(model, MOI.ObjectiveSense())
     if vecofvars
         @test MOI.supports_constraint(model, MOI.VectorOfVariables, MOI.Nonnegatives)
-        @test MOI.supports_constrained_variables(model, MOI.Nonpositives)
+        @test MOI.supports_add_constrained_variables(model, MOI.Nonpositives)
         @test MOI.supports_constraint(model, MOI.VectorOfVariables, MOI.Zeros)
     else
         @test MOI.supports_constraint(model, MOI.VectorAffineFunction{Float64}, MOI.Nonnegatives)
@@ -258,7 +258,7 @@ function lin4test(model::MOI.ModelLike, config::TestConfig)
     @test MOI.supports(model, MOI.ObjectiveFunction{MOI.ScalarAffineFunction{Float64}}())
     @test MOI.supports(model, MOI.ObjectiveSense())
     @test MOI.supports_constraint(model, MOI.VectorAffineFunction{Float64}, MOI.Nonnegatives)
-    @test MOI.supports_constrained_variables(model, MOI.Nonpositives)
+    @test MOI.supports_add_constrained_variables(model, MOI.Nonpositives)
 
     MOI.empty!(model)
     @test MOI.is_empty(model)
@@ -586,7 +586,7 @@ function _soc1test(model::MOI.ModelLike, config::TestConfig, vecofvars::Bool)
     @test MOI.supports(model, MOI.ObjectiveFunction{MOI.ScalarAffineFunction{Float64}}())
     @test MOI.supports(model, MOI.ObjectiveSense())
     if vecofvars
-        @test MOI.supports_constrained_variables(model, MOI.SecondOrderCone)
+        @test MOI.supports_add_constrained_variables(model, MOI.SecondOrderCone)
     else
         @test MOI.supports_constraint(model, MOI.VectorAffineFunction{Float64}, MOI.SecondOrderCone)
     end
@@ -875,7 +875,7 @@ function _rotatedsoc1test(model::MOI.ModelLike, config::TestConfig, abvars::Bool
     @test MOI.supports(model, MOI.ObjectiveSense())
     if abvars
         @test MOI.supports_constraint(model, MOI.SingleVariable, MOI.EqualTo{Float64})
-        @test MOI.supports_constrained_variables(model, MOI.RotatedSecondOrderCone)
+        @test MOI.supports_add_constrained_variables(model, MOI.RotatedSecondOrderCone)
     else
         @test MOI.supports_constraint(model, MOI.VectorAffineFunction{Float64}, MOI.RotatedSecondOrderCone)
     end
@@ -977,7 +977,7 @@ function rotatedsoc2test(model::MOI.ModelLike, config::TestConfig)
     @test MOI.supports_constraint(model, MOI.SingleVariable,MOI.EqualTo{Float64})
     @test MOI.supports_constraint(model, MOI.SingleVariable,MOI.LessThan{Float64})
     @test MOI.supports_constraint(model, MOI.SingleVariable,MOI.GreaterThan{Float64})
-    @test MOI.supports_constrained_variables(model, MOI.RotatedSecondOrderCone)
+    @test MOI.supports_add_constrained_variables(model, MOI.RotatedSecondOrderCone)
 
     MOI.empty!(model)
     @test MOI.is_empty(model)
@@ -1045,7 +1045,7 @@ function rotatedsoc3test(model::MOI.ModelLike, config::TestConfig; n=2, ub=3.0)
     @test MOI.supports(model, MOI.ObjectiveFunction{MOI.ScalarAffineFunction{Float64}}())
     @test MOI.supports(model, MOI.ObjectiveSense())
     @test MOI.supports_constraint(model, MOI.SingleVariable, MOI.EqualTo{Float64})
-    @test MOI.supports_constrained_variables(model, MOI.Nonnegatives)
+    @test MOI.supports_add_constrained_variables(model, MOI.Nonnegatives)
     @test MOI.supports_constraint(model, MOI.SingleVariable, MOI.GreaterThan{Float64})
     @test MOI.supports_constraint(model, MOI.SingleVariable, MOI.LessThan{Float64})
     @test MOI.supports_constraint(model, MOI.VectorAffineFunction{Float64}, MOI.RotatedSecondOrderCone)
@@ -1152,7 +1152,7 @@ function rotatedsoc4test(model::MOI.ModelLike, config::TestConfig; n=2, ub=3.0)
     @test MOI.supports(model, MOI.ObjectiveFunction{MOI.ScalarAffineFunction{Float64}}())
     @test MOI.supports(model, MOI.ObjectiveSense())
     @test MOI.supports_constraint(model, MOI.ScalarAffineFunction{Float64}, MOI.LessThan{Float64})
-    @test MOI.supports_constrained_variables(model, MOI.RotatedSecondOrderCone)
+    @test MOI.supports_add_constrained_variables(model, MOI.RotatedSecondOrderCone)
 
     MOI.empty!(model)
     @test MOI.is_empty(model)

src/constraints.jl

@@ -29,11 +29,11 @@ sum of a nonnegative and a nonpositive variables.
 """ # Implemented as only one method to avoid ambiguity
 function supports_constraint(model::ModelLike, F::Type{<:AbstractFunction},
                              S::Type{<:AbstractSet})
-    # TODO removed this condition, as `supports_constrained_variables(model, Reals)`
+    # TODO removed this condition, as `supports_add_constrained_variables(model, Reals)`
     # should be called instead of
     # `supports_constraint(model, ::VectorOfVariables, ::Reals)
     if F === VectorOfVariables && S === Reals
-        return supports_constrained_variables(model, Reals)
+        return supports_add_constrained_variables(model, Reals)
     else
         return false
     end

src/variables.jl

@@ -35,7 +35,7 @@ done in the current state of the model `model`.
 add_variable(model::ModelLike) = throw(AddVariableNotAllowed())
 
 """
-    supports_constrained_variable(
+    supports_add_constrained_variable(
         model::ModelLike,
         S::Type{<:AbstractScalarSet}
     )::Bool
@@ -46,7 +46,7 @@ to belong to a set of type `S` either on creation of the variable with
 [`add_constraint`](@ref).
 
 By default, this function falls back to
-`supports_constrained_variables(model, Reals) &&
+`supports_add_constrained_variables(model, Reals) &&
 supports_constraint(model, MOI.SingleVariable, S)` which is the correct
 definition for most models.
 
@@ -61,9 +61,9 @@ lower bound on the same variable. Moreover, if the user adds a
 `SingleVariable`-in-`GreaterThan` constraint, it will transparently be bridged
 into a supported constraint.
 """
-function supports_constrained_variable(model::ModelLike,
+function supports_add_constrained_variable(model::ModelLike,
                                        S::Type{<:AbstractScalarSet})
-    return supports_constrained_variables(model, Reals) &&
+    return supports_add_constrained_variables(model, Reals) &&
         supports_constraint(model, SingleVariable, S)
 end
 
@@ -89,7 +89,7 @@ function add_constrained_variable(model::ModelLike, set::AbstractScalarSet)
 end
 
 """
-    supports_constrained_variables(
+    supports_add_constrained_variables(
         model::ModelLike,
         S::Type{<:AbstractScalarSet}
     )::Bool
@@ -100,7 +100,7 @@ variables with [`add_constrained_variables`](@ref) or after the variable is
 created with [`add_constraint`](@ref).
 
 By default, if `S` is `Reals` then this function returns `true` and otherwise,
-it falls back to `supports_constrained_variables(model, Reals) &&
+it falls back to `supports_add_constrained_variables(model, Reals) &&
 supports_constraint(model, MOI.VectorOfVariables, S)` which is the correct
 definition for most models.
 
@@ -109,10 +109,10 @@ definition for most models.
 In the standard conic form, the variables are grouped into several cones
 and the constraints are affine equality constraints.
 If `Reals` is not one of the cones supported by the solvers then it needs
-to implement `supports_constrained_variables(::Optimizer, ::Type{Reals}) = false`
+to implement `supports_add_constrained_variables(::Optimizer, ::Type{Reals}) = false`
 as free variables are not supported.
 The solvers should then implement
-`supports_constrained_variables(::Optimizer, ::Type{<:SupportedCones}) = true`
+`supports_add_constrained_variables(::Optimizer, ::Type{<:SupportedCones}) = true`
 where `SupportedCones` is the union of all cone types that are supported
 but it should not implement
 `supports_constraint(::Type{VectorOfVariables}, Type{<:SupportedCones})`
@@ -123,13 +123,23 @@ have already been created so they already belong to given cones.
 The constraint will therefore be bridged by adding slack variables in `S`
 and equality constraints ensuring that the slack variables are equal to the
 corresponding variables of the given constraint function.
-"""
-function supports_constrained_variables(model::ModelLike,
-                                        S::Type{<:AbstractVectorSet})
-    return supports_constrained_variables(model, Reals) &&
+
+Note that there may also be sets for which
+`!supports_add_constrained_variables(model, S)` and
+`supports_constraint(model, MOI.VectorOfVariables, S)`.
+For instance, suppose a solver supports positive semidefinite variable
+constraints and two types of variables: binary variables and nonnegative
+variables. Then the solver should support adding
+`VectorOfVariables`-in-`PositiveSemidefiniteConeTriangle` constraints but it
+should not support creating variables constrained to belong to the
+`PositiveSemidefiniteConeTriangle` as free variables are not supported.
+"""
+function supports_add_constrained_variables(
+    model::ModelLike, S::Type{<:AbstractVectorSet})
+    return supports_add_constrained_variables(model, Reals) &&
         supports_constraint(model, VectorOfVariables, S)
 end
-supports_constrained_variables(::ModelLike, ::Type{Reals}) = true
+supports_add_constrained_variables(::ModelLike, ::Type{Reals}) = true
 
 """
     add_constrained_variables(

test/Utilities/model.jl

@@ -61,18 +61,18 @@ struct DummySet <: MOI.AbstractScalarSet end
     @testset "`SingleVariable`-in-`S`" begin
         @test !MOI.supports_constraint(model, DummyFunction, DummySet)
         @test !MOI.supports_constraint(model, MOI.SingleVariable, DummySet)
-        @test !MOI.supports_constrained_variable(model, DummySet)
+        @test !MOI.supports_add_constrained_variable(model, DummySet)
         for S in [MOI.EqualTo{T}, MOI.GreaterThan{T}, MOI.LessThan{T},
                   MOI.Interval{T}, MOI.Integer, MOI.ZeroOne,
                   MOI.Semicontinuous{T}, MOI.Semiinteger{T}]
             @test MOI.supports_constraint(model, MOI.SingleVariable, S)
-            @test MOI.supports_constrained_variable(model, S)
+            @test MOI.supports_add_constrained_variable(model, S)
         end
         U = Float32
         for S in [MOI.EqualTo{U}, MOI.GreaterThan{U}, MOI.LessThan{U},
                   MOI.Interval{U}, MOI.Semicontinuous{U}, MOI.Semiinteger{U}]
             @test !MOI.supports_constraint(model, MOI.SingleVariable, S)
-            @test !MOI.supports_constrained_variable(model, S)
+            @test !MOI.supports_add_constrained_variable(model, S)
         end
     end
 end