Fix MOI wrapper (#6)

* Fix MOI wrapper

* Add sudoku example

* Add test/Project.toml

* Fix

Author: blegat

README.md

@@ -8,12 +8,19 @@ JaCoP.jl only proposes an implementation of the interface defined by
 [ConstraintProgrammingExtensions.jl](https://github.com/dourouc05/ConstraintProgrammingExtensions.jl).
 It does not provide access to the low-level Java API.
 
-*Note: This wrapper is maintained by the community and is not officially
+## Affiliation
+
+This wrapper is maintained by the community and is not officially
 supported by the JaCoP project. If you are interested in official support for
-JaCoP in Julia, let them know!*
+JaCoP in Julia, let them know!
+
+## Installation
 
-Unlike the other packages for constraint programming in Julia, JaCoP.jl
-requires Julia 1.6 (due to the `Downloads.jl` standard package).
+Install JaCoP as follows:
+```julia
+import Pkg
+Pkg.add("JaCoP")
+```
 
 The JaCoP library is automatically downloaded when building this package in a
 version that it supports. However, as JaCoP is a Java library, you will need
@@ -22,3 +29,17 @@ a working JVM on your machine that is compatible with
 reduces to having access to a JVM in your `PATH` or `JAVA_HOME`
 environment variables. (If you want to use your own JaCoP binary, you can 
 tweak the `deps/deps.jl` that is generated while building the package.)
+
+> [!WARNING]
+> JaCoP uses [JavaCall](https://github.com/JuliaInterop/JavaCall.jl) which requires
+> launching Julia with [`JULIA_NUM_THREADS=1 JULIA_COPY_STACKS=1 julia`](https://github.com/JuliaInterop/JavaCall.jl?tab=readme-ov-file#macos-and-linux)
+> on MaxOS and Linux. See [here](https://github.com/JuliaInterop/JavaCall.jl?tab=readme-ov-file#windows) for Windows.
+
+## Use with JuMP
+
+To use JaCoP with JuMP, use `JaCoP.Optimizer`:
+
+```julia
+using JuMP, JaCoP
+model = Model(JaCoP.Optimizer)
+```

src/MOI/parse.jl

@@ -1,7 +1,4 @@
-function _parse_to_vars(
-    model::Optimizer,
-    f::MOI.VectorOfVariables,
-)
+function _parse_to_vars(model::Optimizer, f::MOI.VectorOfVariables)
     return [_info(model, v).variable for v in f.variables]
 end
 

src/MOI/wrapper.jl

@@ -23,14 +23,7 @@ mutable struct VariableInfo
 end
 
 function VariableInfo(index::MOI.VariableIndex, variable::Variable)
-    return VariableInfo(
-        index,
-        variable,
-        "",
-        INTEGER,
-        nothing,
-        nothing,
-    )
+    return VariableInfo(index, variable, "", INTEGER, nothing, nothing)
 end
 
 mutable struct ConstraintInfo
@@ -113,8 +106,6 @@ mutable struct Optimizer <: MOI.AbstractOptimizer
     end
 end
 
-Base.show(io::IO, model::Optimizer) = show(io, model.inner)
-
 function MOI.empty!(model::Optimizer)
     model.inner = Store()
     model.name = ""
@@ -140,12 +131,7 @@ MOI.get(::Optimizer, ::MOI.SolverName) = "JaCoP"
 function MOI.supports(
     ::Optimizer,
     ::MOI.ObjectiveFunction{F},
-) where {
-    F <: Union{
-        MOI.VariableIndex,
-        MOI.ScalarAffineFunction{Float64},
-    },
-}
+) where {F <: Union{MOI.VariableIndex, MOI.ScalarAffineFunction{Float64}}}
     return true
 end
 
@@ -155,12 +141,8 @@ function MOI.supports_constraint(
     ::Type{F},
 ) where {
     T <: Union{Int32, Float64},
-    F <: Union{
-        MOI.EqualTo{T},
-        MOI.LessThan{T},
-        MOI.GreaterThan{T},
-        MOI.Interval{T},
-    },
+    F <:
+    Union{MOI.EqualTo{T}, MOI.LessThan{T}, MOI.GreaterThan{T}, MOI.Interval{T}},
 }
     return true
 end
@@ -171,56 +153,36 @@ function MOI.supports_constraint(
     ::Type{F},
 ) where {
     T <: Union{Int32, Float64},
-    F <:
-    Union{MOI.EqualTo{T}, MOI.LessThan{T}, MOI.GreaterThan{T}},
+    F <: Union{MOI.EqualTo{T}, MOI.LessThan{T}, MOI.GreaterThan{T}},
     # No interval!
 }
     return true
 end
 
-MOI.supports(::Optimizer, ::MOI.VariableName, ::Type{MOI.VariableIndex}) = true
-function MOI.supports(
-    ::Optimizer,
-    ::MOI.ConstraintName,
-    ::Type{<:MOI.ConstraintIndex},
-)
-    return true
-end
-
-MOI.supports(::Optimizer, ::MOI.Name) = true
 # MOI.supports(::Optimizer, ::MOI.NumberOfThreads) = true
 # MOI.supports(::Optimizer, ::MOI.TimeLimitSec) = true
 # MOI.supports(::Optimizer, ::MOI.ObjectiveSense) = true
 # MOI.supports(::Optimizer, ::MOI.RawOptimizerAttribute) = true
 
+MOI.supports_incremental_interface(::Optimizer) = true
+
 function MOI.copy_to(dest::Optimizer, src::MOI.ModelLike)
     return MOI.Utilities.default_copy_to(dest, src)
 end
 
-function MOI.get(::Optimizer, ::MOI.ListOfVariableAttributesSet)
-    return MOI.AbstractVariableAttribute[MOI.VariableName()]
-end
-
 function MOI.get(model::Optimizer, ::MOI.ListOfModelAttributesSet)
     attributes = Any[MOI.ObjectiveSense()]
     typ = MOI.get(model, MOI.ObjectiveFunctionType())
     if typ !== nothing
         push!(attributes, MOI.ObjectiveFunction{typ}())
     end
-    if MOI.get(model, MOI.Name()) != ""
-        push!(attributes, MOI.Name())
-    end
     return attributes
 end
 
-function MOI.get(::Optimizer, ::MOI.ListOfConstraintAttributesSet)
-    return MOI.AbstractConstraintAttribute[MOI.ConstraintName()]
-end
-
 function MOI.optimize!(model::Optimizer)
     int_vars = IntVar[
-        info.variable for info in values(model.variable_info)
-        if info.variable isa IntVar
+        info.variable for
+        info in values(model.variable_info) if info.variable isa IntVar
     ]
     if isempty(int_vars)
         model.termination_status = MOI.OPTIMAL
@@ -231,11 +193,17 @@ function MOI.optimize!(model::Optimizer)
     indomain = IndomainMin(())
     select = InputOrderSelect(
         (Store, Vector{Var}, Indomain),
-        model.inner, int_vars, indomain,
+        model.inner,
+        int_vars,
+        indomain,
     )
     result = jcall(
-        search, "labeling", jboolean, (Store, SelectChoicePoint),
-        model.inner, select,
+        search,
+        "labeling",
+        jboolean,
+        (Store, SelectChoicePoint),
+        model.inner,
+        select,
     )
     if result != 0
         model.termination_status = MOI.OPTIMAL

src/MOI/wrapper_constraints_cp.jl

@@ -6,10 +6,7 @@ function MOI.supports_constraint(
     ::Optimizer,
     ::Type{F},
     ::Type{S},
-) where {
-    F <: MOI.VectorOfVariables,
-    S <: MOI.AllDifferent,
-}
+) where {F <: MOI.VectorOfVariables, S <: MOI.AllDifferent}
     return true
 end
 

src/MOI/wrapper_constraints_mo.jl

@@ -8,7 +8,11 @@ function _build_constraint(
     coeffs, vars, constant = _parse_to_coeffs_vars(model, f)
     return LinearInt(
         (Store, Vector{jint}, Vector{IntVar}, JString, jint),
-        model.inner, coeffs, vars, ">=", Int32(s.constant - constant),
+        model.inner,
+        coeffs,
+        vars,
+        ">=",
+        Int32(s.constant - constant),
     )
 end
 
@@ -20,7 +24,11 @@ function _build_constraint(
     coeffs, vars, constant = _parse_to_coeffs_vars(model, f)
     return LinearInt(
         (Store, Vector{jint}, Vector{IntVar}, JString, jint),
-        model.inner, coeffs, vars, "<=", Int32(s.constant - constant),
+        model.inner,
+        coeffs,
+        vars,
+        "<=",
+        Int32(s.constant - constant),
     )
 end
 
@@ -32,7 +40,11 @@ function _build_constraint(
     coeffs, vars, constant = _parse_to_coeffs_vars(model, f)
     return LinearInt(
         (Store, Vector{jint}, Vector{IntVar}, JString, jint),
-        model.inner, coeffs, vars, "==", Int32(s.constant - constant),
+        model.inner,
+        coeffs,
+        vars,
+        "==",
+        Int32(s.constant - constant),
     )
 end
 

src/MOI/wrapper_constraints_singlevar.jl

@@ -44,7 +44,7 @@ function MOI.add_constraint(
     model::Optimizer,
     f::MOI.VariableIndex,
     s::MOI.EqualTo{T},
-) where {T <: Integer}
+) where {T <: Real}
     v = _info(model, f).variable
     constr = XeqC((IntVar, jint), v, Int32(s.value))
     jacop_add_constraint_to_store(model.inner, constr)
@@ -59,7 +59,7 @@ function MOI.add_constraint(
     model::Optimizer,
     f::MOI.VariableIndex,
     s::MOI.LessThan{T},
-) where {T <: Integer}
+) where {T <: Real}
     v = _info(model, f).variable
     constr = XlteqC((IntVar, jint), v, Int32(s.upper))
     jacop_add_constraint_to_store(model.inner, constr)
@@ -73,7 +73,7 @@ function MOI.add_constraint(
     model::Optimizer,
     f::MOI.VariableIndex,
     s::MOI.GreaterThan{T},
-) where {T <: Integer}
+) where {T <: Real}
     v = _info(model, f).variable
     constr = XgteqC((IntVar, jint), v, Int32(s.lower))
     jacop_add_constraint_to_store(model.inner, constr)
@@ -87,7 +87,7 @@ function MOI.add_constraint(
     model::Optimizer,
     f::MOI.VariableIndex,
     s::MOI.Interval{T},
-) where {T <: Integer}
+) where {T <: Real}
     v = _info(model, f).variable
     lb_constr = XgteqC((IntVar, jint), v, Int32(s.lower))
     ub_constr = XlteqC((IntVar, jint), v, Int32(s.upper))

src/MOI/wrapper_variables.jl

@@ -58,18 +58,10 @@ function _make_floatvar(
     ub::Union{Nothing, Float64}=nothing,
 )
     v = if lb === nothing && ub === nothing
-        FloatVar(
-            (Store,),
-            model.inner,
-        )
+        FloatVar((Store,), model.inner)
     else
         lb_, ub_ = _sanitise_bounds(lb, ub, Float64)
-        FloatVar(
-            (Store, jdouble, jdouble),
-            model.inner,
-            lb_,
-            ub_,
-        )
+        FloatVar((Store, jdouble, jdouble), model.inner, lb_, ub_)
     end
 
     vindex, cindex = _make_var(model, v, set)
@@ -86,18 +78,10 @@ function _make_intvar(
     ub::Int32=typemax(Int32),
 )
     v = if lb === nothing && ub === nothing
-        FloatVar(
-            (Store,),
-            model.inner,
-        )
+        FloatVar((Store,), model.inner)
     else
         lb_, ub_ = _sanitise_bounds(lb, ub, Int32)
-        IntVar(
-            (Store, jint, jint),
-            model.inner,
-            lb_,
-            ub_,
-        )
+        IntVar((Store, jint, jint), model.inner, lb_, ub_)
     end
 
     vindex, cindex = _make_var(model, v, set)
@@ -113,7 +97,7 @@ function _make_boolvar(model::Optimizer, set::MOI.AbstractScalarSet)
     return vindex, cindex
 end
 
-function supports_add_constrained_variable(
+function MOI.supports_add_constrained_variable(
     ::Optimizer,
     ::Type{F},
 ) where {
@@ -142,7 +126,6 @@ function MOI.add_variable(model::Optimizer)
     return vindex
 end
 
-
 function MOI.add_constrained_variable(
     model::Optimizer,
     set::MOI.GreaterThan{T},

test/Project.toml

@@ -0,0 +1,9 @@
+[deps]
+ConstraintProgrammingExtensions = "b65d079e-ed98-51d9-b0db-edee61a5c5f8"
+JaCoP = "02462d8f-a5b3-44fd-8fd4-3169fe7a24c5"
+JuMP = "4076af6c-e467-56ae-b986-b466b2749572"
+MathOptInterface = "b8f27783-ece8-5eb3-8dc8-9495eed66fee"
+Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
+
+[sources]
+JaCoP = {path = ".."}

test/runtests.jl

@@ -12,4 +12,5 @@ const COIT = CP.Test
 
 @testset "JaCoP" begin
     include("MOI.jl")
+    include("sudoku.jl")
 end