Various refactoring annd tidying of HeuristicCallback and UserCutCallback (#317)

Author: odow

src/MOI_wrapper.jl

@@ -476,6 +476,6 @@ include(joinpath("MOI_wrapper", "nonlinear_constraints.jl"))
 include(joinpath("MOI_wrapper", "objective.jl"))
 include(joinpath("MOI_wrapper", "results.jl"))
 include(joinpath("MOI_wrapper", "conshdlr.jl"))
-include(joinpath("MOI_wrapper", "sepa.jl"))
-include(joinpath("MOI_wrapper", "heuristic.jl"))
+include(joinpath("MOI_wrapper", "UserCutCallback.jl"))
+include(joinpath("MOI_wrapper", "HeuristicCallback.jl"))
 include(joinpath("MOI_wrapper", "conflict.jl"))

src/MOI_wrapper/heuristic.jl renamed to src/MOI_wrapper/HeuristicCallback.jl

@@ -3,32 +3,12 @@
 # Use of this source code is governed by an MIT-style license that can be found
 # in the LICENSE.md file or at https://opensource.org/licenses/MIT.
 
-function include_heuristic(
-    o::Optimizer,
-    heuristic::HT;
-    name="",
-    description="",
-    dispchar='_',
-    priority=10000,
-    frequency=1,
-    frequency_offset=0,
-    maximum_depth=-1,
-    timing_mask=SCIP_HEURTIMING_BEFORENODE,
-    usessubscip=false,
-) where {HT}
+function include_heuristic(o::Optimizer, heuristic; kwargs...)
     return include_heuristic(
         o.inner.scip[],
         heuristic,
         o.inner.heuristic_storage;
-        name=name,
-        description=description,
-        dispchar=dispchar,
-        priority=priority,
-        frequency=frequency,
-        frequency_offset=frequency_offset,
-        maximum_depth=maximum_depth,
-        timing_mask=timing_mask,
-        usessubscip=usessubscip,
+        kwargs...,
     )
 end
 
@@ -65,9 +45,7 @@ function find_primal_solution(
     return SCIP_OKAY, result
 end
 
-#
 # MOI Interface for heuristic callbacks
-#
 
 function MOI.get(
     o::Optimizer,
@@ -77,6 +55,8 @@ function MOI.get(
     return [SCIPgetSolVal(o, C_NULL, var(o, vi)) for vi in vs]
 end
 
+MOI.supports(::Optimizer, ::MOI.HeuristicCallback) = true
+
 function MOI.set(o::Optimizer, ::MOI.HeuristicCallback, cb::Function)
     if o.moi_heuristic === nothing
         o.moi_heuristic = HeuristicCb(o.inner, cb)
@@ -91,7 +71,8 @@ function MOI.set(o::Optimizer, ::MOI.HeuristicCallback, cb::Function)
     end
     return nothing
 end
-MOI.supports(::Optimizer, ::MOI.HeuristicCallback) = true
+
+MOI.supports(::Optimizer, ::MOI.HeuristicSolution{HeuristicCbData}) = true
 
 function MOI.submit(
     o::Optimizer,
@@ -102,7 +83,6 @@ function MOI.submit(
     callback_data = cb.callback_data
     heuristic = callback_data.heur
     heur_ = o.inner.heuristic_storage[heuristic]
-
     sol = create_empty_scipsol(o.inner.scip[], heur_)
     for idx in eachindex(x)
         SCIP.@SCIP_CALL SCIP.SCIPsetSolVal(
@@ -126,5 +106,5 @@ function MOI.submit(
     if stored[] == SCIP.TRUE
         callback_data.submit_called = true
     end
+    return
 end
-MOI.supports(::Optimizer, ::MOI.HeuristicSolution{HeuristicCbData}) = true

src/MOI_wrapper/sepa.jl renamed to src/MOI_wrapper/UserCutCallback.jl

@@ -3,10 +3,6 @@
 # Use of this source code is governed by an MIT-style license that can be found
 # in the LICENSE.md file or at https://opensource.org/licenses/MIT.
 
-#
-# Adding separators to SCIP.Optimizer.
-#
-
 """
     include_sepa(
         o::Optimizer,
@@ -24,34 +20,11 @@ Include a user defined separator `sepa` to the SCIP optimizer instance `o`.
 
 All parameters have default values, that can be set as keyword arguments.
 """
-function include_sepa(
-    o::Optimizer,
-    sepa::SEPA;
-    name="",
-    description="",
-    priority=0,
-    freq=1,
-    maxbounddist=0.0,
-    usessubscip=false,
-    delay=false,
-) where {SEPA<:AbstractSeparator}
-    include_sepa(
-        o.inner.scip[],
-        o.inner.sepas,
-        sepa;
-        name=name,
-        description=description,
-        priority=priority,
-        freq=freq,
-        maxbounddist=maxbounddist,
-        usessubscip=usessubscip,
-        delay=delay,
-    )
+function include_sepa(o::Optimizer, sepa::AbstractSeparator; kwargs...)
+    return include_sepa(o.inner.scip[], o.inner.sepas, sepa; kwargs...)
 end
 
-#
 # Separator for cutcallbacks.
-#
 
 mutable struct CutCbSeparator <: AbstractSeparator
     scipd::SCIPData
@@ -77,47 +50,44 @@ function exec_lp(sepa::CutCbSeparator)
     return cb_data.submit_called ? SCIP_SEPARATED : SCIP_DIDNOTFIND
 end
 
-#
 # MOI Interface for cutcallbacks
-#
 
 function MOI.get(o::Optimizer, ::MOI.CallbackVariablePrimal{CutCbData}, vi)
     return SCIPgetSolVal(o, C_NULL, var(o, vi))
 end
 
+MOI.supports(::Optimizer, ::MOI.UserCutCallback) = true
+
 function MOI.set(o::Optimizer, ::MOI.UserCutCallback, cb::Function)
     if o.moi_separator === nothing
         o.moi_separator = CutCbSeparator(o.inner, cb)
         include_sepa(o, o.moi_separator)
     else
         o.moi_separator.cutcallback = cb
     end
+    return
 end
-MOI.supports(::Optimizer, ::MOI.UserCutCallback) = true
+
+MOI.supports(::Optimizer, ::MOI.UserCut{CutCbData}) = true
 
 function MOI.submit(
     o::Optimizer,
     cb_data::MOI.UserCut{CutCbData},
     func::MOI.ScalarAffineFunction{Float64},
-    set::S,
-) where {S<:BOUNDS}
-    varrefs = [VarRef(t.variable.value) for t in func.terms]
-    coefs = [t.coefficient for t in func.terms]
-
+    set::BOUNDS,
+)
     lhs, rhs = bounds(set)
-    lhs = lhs === nothing ? -SCIPinfinity(o) : lhs
-    rhs = rhs === nothing ? SCIPinfinity(o) : rhs
-
+    inf = SCIPinfinity(o)
     add_cut_sepa(
         o.inner.scip[],
         o.inner.vars,
         o.inner.sepas,
         cb_data.callback_data.sepa,
-        varrefs,
-        coefs,
-        lhs,
-        rhs,
+        [VarRef(t.variable.value) for t in func.terms],
+        [t.coefficient for t in func.terms],
+        something(lhs, -inf),
+        something(rhs, inf),
     )
     cb_data.callback_data.submit_called = true
+    return
 end
-MOI.supports(::Optimizer, ::MOI.UserCut{CutCbData}) = true

src/MOI_wrapper/conshdlr.jl

@@ -3,10 +3,6 @@
 # Use of this source code is governed by an MIT-style license that can be found
 # in the LICENSE.md file or at https://opensource.org/licenses/MIT.
 
-#
-# Adding constraint handlers, constraints, and cut selectors to SCIP.Optimizer.
-#
-
 """
     include_conshdlr(
         o::Optimizer,
@@ -31,25 +27,10 @@ In particular, note the boolean `needs_constraints`:
 """
 function include_conshdlr(
     o::Optimizer,
-    ch::CH;
-    name="",
-    description="",
-    enforce_priority=-15,
-    check_priority=-7000000,
-    eager_frequency=100,
-    needs_constraints=true,
-) where {CH<:AbstractConstraintHandler}
-    include_conshdlr(
-        o.inner.scip[],
-        o.inner.conshdlrs,
-        ch;
-        name=name,
-        description=description,
-        enforce_priority=enforce_priority,
-        check_priority=check_priority,
-        eager_frequency=eager_frequency,
-        needs_constraints=needs_constraints,
-    )
+    ch::AbstractConstraintHandler;
+    kwargs...,
+)
+    return include_conshdlr(o.inner.scip[], o.inner.conshdlrs, ch; kwargs...)
 end
 
 """
@@ -78,65 +59,30 @@ All keyword arguments are passed to the `SCIPcreateCons` call.
 function add_constraint(
     o::Optimizer,
     ch::CH,
-    c::C;
-    initial=true,
-    separate=true,
-    enforce=true,
-    check=true,
-    propagate=true,
-    _local=false,
-    modifiable=false,
-    dynamic=false,
-    removable=false,
-    stickingatnode=false,
-) where {CH<:AbstractConstraintHandler,C<:AbstractConstraint{CH}}
-    return add_constraint(
-        o.inner,
-        ch,
-        c;
-        initial=initial,
-        separate=separate,
-        enforce=enforce,
-        check=check,
-        propagate=propagate,
-        _local=_local,
-        modifiable=modifiable,
-        dynamic=dynamic,
-        removable=removable,
-        stickingatnode=stickingatnode,
-    )
+    c::AbstractConstraint{CH};
+    kwargs...,
+) where {CH<:AbstractConstraintHandler}
+    return add_constraint(o.inner, ch, c; kwargs...)
 end
 
-function include_cutsel(
-    o::Optimizer,
-    cutsel::CS;
-    name="",
-    description="",
-    priority=10000,
-) where {CS<:AbstractCutSelector}
+function include_cutsel(o::Optimizer, cutsel::AbstractCutSelector; kwargs...)
     return include_cutsel(
         o.inner.scip[],
         cutsel,
         o.inner.cutsel_storage;
-        name=name,
-        description=description,
-        priority=priority,
+        kwargs...,
     )
 end
 
 function include_branchrule(
     o::Optimizer,
-    branchrule::BR;
-    name="",
-    description="",
-    priority=10000,
-) where {BR<:AbstractBranchingRule}
+    branchrule::AbstractBranchingRule;
+    kwargs...,
+)
     return include_branchrule(
         o.inner.scip[],
         branchrule,
         o.inner.branchrule_storage;
-        name=name,
-        description=description,
-        priority=priority,
+        kwargs...,
     )
 end