[bridges] unify IndexInVector

src/Bridges/Constraint/bridge.jl

@@ -6,16 +6,6 @@ bridges.
 """
 abstract type AbstractBridge <: MOIB.AbstractBridge end
 
-# TODO [breaking] merge with `Bridges.Variable.IndexInVector` into `Bridges.IndexInVector`
-"""
-    IndexInVector
-
-Index of variable in vector of variables.
-"""
-struct IndexInVector
-    value::Int
-end
-
 """
     bridge_constraint(
         BT::Type{<:AbstractBridge},

src/Bridges/Constraint/flip_sign.jl

@@ -32,7 +32,7 @@ end
 function MOI.delete(
     model::MOI.ModelLike,
     bridge::FlipSignBridge,
-    i::IndexInVector,
+    i::MOIB.IndexInVector,
 )
     func = MOI.get(model, MOI.ConstraintFunction(), bridge.constraint)
     idx = setdiff(1:MOI.output_dimension(func), i.value)

src/Bridges/Constraint/functionize.jl

@@ -171,7 +171,7 @@ end
 function MOI.delete(
     model::MOI.ModelLike,
     bridge::VectorFunctionizeBridge,
-    i::IndexInVector,
+    i::MOIB.IndexInVector,
 )
     func = MOI.get(model, MOI.ConstraintFunction(), bridge.constraint)
     idx = setdiff(1:MOI.output_dimension(func), i.value)

src/Bridges/Constraint/scalarize.jl

@@ -79,7 +79,7 @@ end
 function MOI.delete(
     model::MOI.ModelLike,
     bridge::ScalarizeBridge,
-    i::IndexInVector,
+    i::MOIB.IndexInVector,
 )
     MOI.delete(model, bridge.scalar_constraints[i.value])
     deleteat!(bridge.scalar_constraints, i.value)

src/Bridges/Variable/bridge.jl

@@ -6,15 +6,6 @@ bridges.
 """
 abstract type AbstractBridge <: MOIB.AbstractBridge end
 
-"""
-    IndexInVector
-
-Index of variable in vector of variables.
-"""
-struct IndexInVector
-    value::Int
-end
-
 """
     bridge_constrained_variable(
         BT::Type{<:AbstractBridge},
@@ -56,7 +47,7 @@ end
         model::MOI.ModelLike,
         attr::MOI.AbstractVariableAttribute,
         bridge::AbstractBridge,
-        i::IndexInVector,
+        i::MOIB.IndexInVector,
     )
 
 Return the value of the attribute `attr` of the model `model` for the variable
@@ -66,7 +57,7 @@ function MOI.get(
     ::MOI.ModelLike,
     attr::MOI.AbstractVariableAttribute,
     bridge::AbstractBridge,
-    ::IndexInVector,
+    ::MOIB.IndexInVector,
 )
     return throw(
         ArgumentError(
@@ -98,7 +89,7 @@ end
         attr::MOI.AbstractVariableAttribute,
         bridge::AbstractBridge,
         value[,
-        ::IndexInVector],
+        ::MOIB.IndexInVector],
     )
 
 Return the value of the attribute `attr` of the model `model` for the variable
@@ -109,7 +100,7 @@ function MOI.set(
     attr::MOI.AbstractVariableAttribute,
     bridge::AbstractBridge,
     value,
-    ::IndexInVector...,
+    ::MOIB.IndexInVector...,
 )
     if MOI.is_copyable(attr) && !MOI.supports(model, attr, typeof(bridge))
         throw(MOI.UnsupportedAttribute(attr))
@@ -271,7 +262,7 @@ the following method for every variable of `vis`.
     unbridged_map(
         bridge::MOI.Bridges.Variable.AbstractBridge,
         vi::MOI.VariableIndex,
-        i::IndexInVector,
+        i::MOIB.IndexInVector,
     )
 
 For a bridged variable in a vector set, return a tuple of pairs mapping the
@@ -287,7 +278,7 @@ function unbridged_map end
 function unbridged_map(bridge::AbstractBridge, vis::Vector{MOI.VariableIndex})
     mappings = Pair{MOI.VariableIndex,MOI.AbstractScalarFunction}[]
     for (i, vi) in enumerate(vis)
-        vi_mappings = unbridged_map(bridge, vi, IndexInVector(i))
+        vi_mappings = unbridged_map(bridge, vi, MOIB.IndexInVector(i))
         if vi_mappings === nothing
             return
         end

src/Bridges/Variable/flip_sign.jl

@@ -58,7 +58,7 @@ end
 function MOI.delete(
     model::MOI.ModelLike,
     bridge::FlipSignBridge,
-    i::IndexInVector,
+    i::MOIB.IndexInVector,
 )
     MOI.delete(model, bridge.flipped_variables[i.value])
     deleteat!(bridge.flipped_variables, i.value)
@@ -86,14 +86,14 @@ function MOI.get(
     model::MOI.ModelLike,
     attr::Union{MOI.VariablePrimal,MOI.VariablePrimalStart},
     bridge::FlipSignBridge,
-    i::IndexInVector,
+    i::MOIB.IndexInVector,
 )
     return -MOI.get(model, attr, bridge.flipped_variables[i.value])
 end
 
 function MOIB.bridged_function(
     bridge::FlipSignBridge{T},
-    i::IndexInVector,
+    i::MOIB.IndexInVector,
 ) where {T}
     func = MOI.SingleVariable(bridge.flipped_variables[i.value])
     return MOIU.operate(-, T, func)
@@ -102,7 +102,7 @@ end
 function unbridged_map(
     bridge::FlipSignBridge{T},
     vi::MOI.VariableIndex,
-    i::IndexInVector,
+    i::MOIB.IndexInVector,
 ) where {T}
     func = MOIU.operate(-, T, MOI.SingleVariable(vi))
     return (bridge.flipped_variables[i.value] => func,)
@@ -121,7 +121,7 @@ function MOI.set(
     attr::MOI.VariablePrimalStart,
     bridge::FlipSignBridge,
     value,
-    i::IndexInVector,
+    i::MOIB.IndexInVector,
 )
     MOI.set(model, attr, bridge.flipped_variables[i.value], -value)
     return

src/Bridges/Variable/free.jl

@@ -62,7 +62,11 @@ function MOI.delete(model::MOI.ModelLike, bridge::FreeBridge)
     return
 end
 
-function MOI.delete(model::MOI.ModelLike, bridge::FreeBridge, i::IndexInVector)
+function MOI.delete(
+    model::MOI.ModelLike,
+    bridge::FreeBridge,
+    i::MOIB.IndexInVector,
+)
     n = div(length(bridge.variables), 2)
     MOI.delete(model, bridge.variables[i.value])
     MOI.delete(model, bridge.variables[n+i.value])
@@ -101,7 +105,7 @@ function MOI.get(
     model::MOI.ModelLike,
     attr::Union{MOI.VariablePrimal,MOI.VariablePrimalStart},
     bridge::FreeBridge{T},
-    i::IndexInVector,
+    i::MOIB.IndexInVector,
 ) where {T}
     n = div(length(bridge.variables), 2)
     return MOI.get(model, attr, bridge.variables[i.value]) -
@@ -110,7 +114,7 @@ end
 
 function MOIB.bridged_function(
     bridge::FreeBridge{T},
-    i::IndexInVector,
+    i::MOIB.IndexInVector,
 ) where {T}
     n = div(length(bridge.variables), 2)
     return MOIU.operate(
@@ -126,7 +130,7 @@ end
 function unbridged_map(
     bridge::FreeBridge{T},
     vi::MOI.VariableIndex,
-    i::IndexInVector,
+    i::MOIB.IndexInVector,
 ) where {T}
     sv = MOI.SingleVariable(vi)
     # `unbridged_map` is required to return a `MOI.ScalarAffineFunction`.
@@ -149,7 +153,7 @@ function MOI.set(
     attr::MOI.VariablePrimalStart,
     bridge::FreeBridge,
     value,
-    i::IndexInVector,
+    i::MOIB.IndexInVector,
 )
     if value < 0
         nonneg = zero(value)

src/Bridges/Variable/map.jl

@@ -261,12 +261,12 @@ function length_of_vector_of_variables(map::Map, vi::MOI.VariableIndex)
 end
 
 """
-    index_in_vector_of_variables(map::Map, vi::MOI.VariableIndex)::IndexInVector
+    index_in_vector_of_variables(map::Map, vi::MOI.VariableIndex)::MOIB.IndexInVector
 
 Return the index of `vi` in the vector of variables in which it was bridged.
 """
 function index_in_vector_of_variables(map::Map, vi::MOI.VariableIndex)
-    return IndexInVector(map.index_in_vector[-vi.value])
+    return MOIB.IndexInVector(map.index_in_vector[-vi.value])
 end
 
 """

src/Bridges/Variable/rsoc_to_psd.jl

@@ -169,7 +169,7 @@ function trimap(i::Integer, j::Integer)
     end
 end
 
-function _variable_map(bridge::RSOCtoPSDBridge, i::IndexInVector)
+function _variable_map(bridge::RSOCtoPSDBridge, i::MOIB.IndexInVector)
     if bridge.psd isa
        MOI.ConstraintIndex{MOI.VectorOfVariables,MOI.Nonnegatives}
         return i.value
@@ -182,7 +182,7 @@ function _variable_map(bridge::RSOCtoPSDBridge, i::IndexInVector)
     end
 end
 
-function _variable(bridge::RSOCtoPSDBridge, i::IndexInVector)
+function _variable(bridge::RSOCtoPSDBridge, i::MOIB.IndexInVector)
     return bridge.variables[_variable_map(bridge, i)]
 end
 
@@ -193,7 +193,7 @@ function MOI.get(
 )
     values = MOI.get(model, attr, bridge.psd)
     n = MOI.dimension(MOI.get(model, MOI.ConstraintSet(), bridge))
-    mapped = [values[_variable_map(bridge, IndexInVector(i))] for i in 1:n]
+    mapped = [values[_variable_map(bridge, MOIB.IndexInVector(i))] for i in 1:n]
     if length(mapped) >= 2
         mapped[2] /= 2
     end
@@ -207,7 +207,7 @@ function MOI.get(
 )
     dual = MOI.get(model, attr, bridge.psd)
     n = MOI.dimension(MOI.get(model, MOI.ConstraintSet(), bridge))
-    mapped = [dual[_variable_map(bridge, IndexInVector(i))] for i in 1:n]
+    mapped = [dual[_variable_map(bridge, MOIB.IndexInVector(i))] for i in 1:n]
     for ci in bridge.diag
         mapped[2] += MOI.get(model, attr, ci)
     end
@@ -224,7 +224,7 @@ function MOI.get(
     model::MOI.ModelLike,
     attr::MOI.VariablePrimal,
     bridge::RSOCtoPSDBridge,
-    i::IndexInVector,
+    i::MOIB.IndexInVector,
 )
     value = MOI.get(model, attr, _variable(bridge, i))
     if i.value == 2
@@ -236,7 +236,7 @@ end
 
 function MOIB.bridged_function(
     bridge::RSOCtoPSDBridge{T},
-    i::IndexInVector,
+    i::MOIB.IndexInVector,
 ) where {T}
     func = MOI.SingleVariable(_variable(bridge, i))
     if i.value == 2
@@ -249,7 +249,7 @@ end
 function unbridged_map(
     bridge::RSOCtoPSDBridge{T},
     vi::MOI.VariableIndex,
-    i::IndexInVector,
+    i::MOIB.IndexInVector,
 ) where {T}
     sv = MOI.SingleVariable(vi)
     if i.value == 2

src/Bridges/Variable/rsoc_to_soc.jl

@@ -13,7 +13,7 @@ function rotate_result(
     model,
     attr::MOI.VariablePrimal,
     variables,
-    i::IndexInVector,
+    i::MOIB.IndexInVector,
 )
     if i.value == 1 || i.value == 2
         t, u = MOI.get(model, attr, variables[1:2])
@@ -29,7 +29,7 @@ function rotate_result(
     end
 end
 
-function rotate_bridged_function(T::Type, variables, i::IndexInVector)
+function rotate_bridged_function(T::Type, variables, i::MOIB.IndexInVector)
     s2 = √T(2)
     if i.value == 1 || i.value == 2
         t = MOIU.operate(/, T, MOI.SingleVariable(variables[1]), s2)
@@ -154,14 +154,14 @@ function MOI.get(
     model::MOI.ModelLike,
     attr::MOI.VariablePrimal,
     bridge::RSOCtoSOCBridge,
-    i::IndexInVector,
+    i::MOIB.IndexInVector,
 )
     return rotate_result(model, attr, bridge.variables, i)
 end
 
 function MOIB.bridged_function(
     bridge::RSOCtoSOCBridge{T},
-    i::IndexInVector,
+    i::MOIB.IndexInVector,
 ) where {T}
     return rotate_bridged_function(T, bridge.variables, i)
 end

src/Bridges/Variable/soc_to_rsoc.jl

@@ -92,14 +92,14 @@ function MOI.get(
     model::MOI.ModelLike,
     attr::MOI.VariablePrimal,
     bridge::SOCtoRSOCBridge,
-    i::IndexInVector,
+    i::MOIB.IndexInVector,
 )
     return rotate_result(model, attr, bridge.variables, i)
 end
 
 function MOIB.bridged_function(
     bridge::SOCtoRSOCBridge{T},
-    i::IndexInVector,
+    i::MOIB.IndexInVector,
 ) where {T}
     return rotate_bridged_function(T, bridge.variables, i)
 end

src/Bridges/Variable/zeros.jl

@@ -67,13 +67,15 @@ function MOI.get(
     ::MOI.ModelLike,
     ::MOI.VariablePrimal,
     ::ZerosBridge{T},
-    ::IndexInVector,
+    ::MOIB.IndexInVector,
 ) where {T}
     return zero(T)
 end
 
-function MOIB.bridged_function(::ZerosBridge{T}, ::IndexInVector) where {T}
+function MOIB.bridged_function(::ZerosBridge{T}, ::MOIB.IndexInVector) where {T}
     return zero(MOI.ScalarAffineFunction{T})
 end
 
-unbridged_map(::ZerosBridge, ::MOI.VariableIndex, ::IndexInVector) = nothing
+function unbridged_map(::ZerosBridge, ::MOI.VariableIndex, ::MOIB.IndexInVector)
+    return nothing
+end

src/Bridges/bridge.jl

@@ -19,6 +19,15 @@ the bridge so they should be implemented by the bridge.
 """
 abstract type AbstractBridge end
 
+"""
+    IndexInVector
+
+Index of variable in vector of variables.
+"""
+struct IndexInVector
+    value::Int
+end
+
 """
     MOI.get(b::AbstractBridge, ::MOI.NumberOfConstraints{F, S}) where {F, S}
 

src/Bridges/bridge_optimizer.jl

@@ -439,8 +439,7 @@ function _delete_variables_in_vector_of_variables_constraint(
                     call_in_context(
                         b,
                         ci,
-                        bridge ->
-                            MOI.delete(b, bridge, Constraint.IndexInVector(i)),
+                        bridge -> MOI.delete(b, bridge, IndexInVector(i)),
                     )
                 else
                     MOIU.throw_delete_variable_in_vov(vi)

test/Bridges/Variable/bridge.jl

@@ -13,7 +13,7 @@ struct DummyVariableBridge <: MOIB.Variable.AbstractBridge end
     bridge = DummyVariableBridge()
     attr = MOI.VariablePrimalStart()
     @test !MOI.supports(model, attr, typeof(bridge))
-    i = MOIB.Variable.IndexInVector(1)
+    i = MOIB.IndexInVector(1)
     @test_throws MOI.UnsupportedAttribute(attr) MOI.set(
         model,
         attr,