docstring for restricted master heuristic (#543)

* docstring for restricted master heuristic * Update src/Algorithm/conquer.jl
atoptima · Jun 13, 2021 · fc9ba46 · fc9ba46
1 parent 0f405a6
commit fc9ba46
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 10 deletions.
diff --git a/src/Algorithm/Algorithm.jl b/src/Algorithm/Algorithm.jl
@@ -70,10 +70,12 @@ export getterminationstatus, setterminationstatus!,
 
 # Algorithm's types
 export AbstractOptimizationAlgorithm, TreeSearchAlgorithm, ColCutGenConquer, ColumnGeneration,
-       BendersConquer, BendersCutGeneration, SolveIpForm, MoiOptimize, UserOptimizer, 
+       BendersConquer, BendersCutGeneration, SolveIpForm, RestrictedMasterHeuristic,
        SolveLpForm, ExactBranchingPhase, OnlyRestrictedMasterBranchingPhase, PreprocessAlgorithm, 
-       RestrictedMasterIPHeuristic, OptimizationInput, OptimizationOutput, OptimizationState,
-       EmptyInput       
+       OptimizationInput, OptimizationOutput, OptimizationState, EmptyInput
+
+# Types of optimizers
+export MoiOptimize, UserOptimizer
 
 # Units 
 export PartialSolutionUnit, PreprocessingUnit

diff --git a/src/Algorithm/conquer.jl b/src/Algorithm/conquer.jl
@@ -69,8 +69,6 @@ end
 #                      ParameterisedHeuristic
 ####################################################################
 
-RestrictedMasterIPHeuristic() = SolveIpForm(moi_params = MoiOptimize(get_dual_bound = false))
-
 struct ParameterisedHeuristic
     algorithm::AbstractOptimizationAlgorithm
     root_priority::Float64
@@ -80,8 +78,16 @@ struct ParameterisedHeuristic
     name::String
 end
 
-DefaultRestrictedMasterHeuristic() = 
-    ParameterisedHeuristic(RestrictedMasterIPHeuristic(), 1.0, 1.0, 1, 1000, "Restricted Master IP")
+"""
+    Coluna.Algorithm.RestrictedMasterHeuristic()
+
+This algorithm enforces integrality of column variables in the master formulation and then solves the master formulation with its optimizer.
+"""
+RestrictedMasterHeuristic() = 
+    ParameterisedHeuristic(
+        SolveIpForm(moi_params = MoiOptimize(get_dual_bound = false)), 
+        1.0, 1.0, 1, 1000, "Restricted Master IP"
+    )
 
 
 ####################################################################
@@ -118,7 +124,7 @@ end
 """
     Coluna.Algorithm.ColCutGenConquer(
         stages::Vector{ColumnGeneration} = [ColumnGeneration()]
-        primal_heuristics::Vector{ParameterisedHeuristic} = [DefaultRestrictedMasterHeuristic()]
+        primal_heuristics::Vector{ParameterisedHeuristic} = [RestrictedMasterHeuristic()]
         preprocess = PreprocessAlgorithm()
         cutgen = CutCallbacks()
         run_preprocessing::Bool = false
@@ -133,7 +139,7 @@ several primal heuristics to more efficiently find feasible solutions.
 """
 @with_kw struct ColCutGenConquer <: AbstractConquerAlgorithm 
     stages::Vector{ColumnGeneration} = [ColumnGeneration()]
-    primal_heuristics::Vector{ParameterisedHeuristic} = [DefaultRestrictedMasterHeuristic()]
+    primal_heuristics::Vector{ParameterisedHeuristic} = [RestrictedMasterHeuristic()]
     preprocess = PreprocessAlgorithm()
     cutgen = CutCallbacks()
     max_nb_cut_rounds::Int = 3 # TODO : tailing-off ?

diff --git a/test/user_algorithms_tests.jl b/test/user_algorithms_tests.jl
@@ -9,7 +9,7 @@ end
 @with_kw struct ConsecutiveColGen <: AbstractOptimizationAlgorithm
     colgen = ColumnGeneration(smoothing_stabilization = 1.0)
     preprocess = PreprocessAlgorithm(preprocess_subproblems = true, printing = true)
-    rm_heur = RestrictedMasterIPHeuristic()
+    rm_heur = RestrictedMasterHeuristic()
     num_calls_to_col_gen = 3  
 end