Changeset 16582 for branches/2931_OR-Tools_LP_MIP/HeuristicLab.MathematicalOptimization/3.3/LinearProgramming/Problems/ProgrammableLinearProblemDefinition.cs

Timestamp:

01/29/19 17:45:06 (5 years ago)

Author:

ddorfmei

Message:

#2931: solved the issues found during the review

File:

• branches/2931_OR-Tools_LP_MIP/HeuristicLab.MathematicalOptimization/3.3/LinearProgramming/Problems/ProgrammableLinearProblemDefinition.cs (moved) (moved from branches/2931_OR-Tools_LP_MIP/HeuristicLab.MathematicalOptimization/3.3/LinearProgramming/Problems/ProgrammableLinearProgrammingProblemDefinition.cs) (8 diffs)

branches/2931_OR-Tools_LP_MIP/HeuristicLab.MathematicalOptimization/3.3/LinearProgramming/Problems/ProgrammableLinearProblemDefinition.cs

@@ -26 +26 @@
 using HeuristicLab.Common;
 using HeuristicLab.Core;
+using HeuristicLab.ExactOptimization.LinearProgramming.Templates;
 using HeuristicLab.Optimization;
 using HeuristicLab.Persistence.Default.CompositeSerializers.Storable;
@@ -31 +32 @@
 using HeuristicLab.Scripting;
 
-namespace HeuristicLab.MathematicalOptimization.LinearProgramming {
+namespace HeuristicLab.ExactOptimization.LinearProgramming {
 
-  [Item("Programmable Linear/Mixed Integer Programming Problem Definition",
-    "Script that defines the model and evaluates the solution for a linear/mixed integer programming problem.")]
+  [Item("Programmable Linear Problem Definition (LP, MIP)",
+    "Script that defines the model for a linear/mixed integer programming problem.")]
   [StorableClass]
-  public sealed class ProgrammableLinearProgrammingProblemDefinition : Script, ILinearProgrammingProblemDefinition,
+  public sealed class ProgrammableLinearProblemDefinition : Script, ILinearProblemDefinition,
     IStorableContent {
     private readonly object compileLock = new object();
 
-    [Storable] private readonly VariableStore variableStore;
+    [Storable]
+    private readonly VariableStore variableStore;
 
-    [Storable] private bool codeChanged;
+    [Storable]
+    private bool codeChanged;
 
-    private volatile ILinearProgrammingProblemDefinition compiledProblemDefinition;
+    private volatile ILinearProblemDefinition compiledProblemDefinition;
 
-    public ProgrammableLinearProgrammingProblemDefinition()
-      : base(ScriptTemplates.CompiledLinearProgrammingProblemDefinition) {
-      Name = "Programmable Linear/Mixed Integer Programming Problem Definition";
+    public ProgrammableLinearProblemDefinition()
+      : base(ScriptTemplates.CompiledLinearProblemDefinition) {
+      Name = "Programmable Linear Problem Definition";
       variableStore = new VariableStore();
     }
 
     [StorableConstructor]
-    private ProgrammableLinearProgrammingProblemDefinition(bool deserializing) : base(deserializing) {
+    private ProgrammableLinearProblemDefinition(bool deserializing) : base(deserializing) {
     }
 
-    private ProgrammableLinearProgrammingProblemDefinition(ProgrammableLinearProgrammingProblemDefinition original,
+    private ProgrammableLinearProblemDefinition(ProgrammableLinearProblemDefinition original,
       Cloner cloner) : base(original, cloner) {
       variableStore = cloner.Clone(original.variableStore);
@@ -68 +71 @@
     public VariableStore VariableStore => variableStore;
 
-    private ILinearProgrammingProblemDefinition CompiledProblemDefinition {
+    private ILinearProblemDefinition CompiledProblemDefinition {
       get {
         // double checked locking pattern
@@ -85 +88 @@
     }
 
-    private bool SuppressEvents { get; set; }
-
     public void Analyze(Solver solver, ResultCollection results) => CompiledProblemDefinition.Analyze(solver, results);
 
@@ -92 +93 @@
 
     public override IDeepCloneable Clone(Cloner cloner) {
-      return new ProgrammableLinearProgrammingProblemDefinition(this, cloner);
+      return new ProgrammableLinearProblemDefinition(this, cloner);
     }
 
@@ -108 +109 @@
       if (!types.Any(x => typeof(CompiledProblemDefinition).IsAssignableFrom(x)))
         throw new ProblemDefinitionScriptException("The compiled code doesn't contain a problem definition." + Environment.NewLine +
-                                                   "The problem definition must be a subclass of CompiledProblemDefinition.");
+                                                   $"The problem definition must be a subclass of {nameof(CompiledProblemDefinition)} and implement {nameof(ILinearProblemDefinition)}.");
       if (types.Count(x => typeof(CompiledProblemDefinition).IsAssignableFrom(x)) > 1)
         throw new ProblemDefinitionScriptException("The compiled code contains multiple problem definitions." + Environment.NewLine +
-                                                   "Only one subclass of CompiledProblemDefinition is allowed.");
+                                                   $"Only one subclass of {nameof(CompiledProblemDefinition)} is allowed.");
 
       CompiledProblemDefinition inst;
@@ -133 +134 @@
 
       try {
-        compiledProblemDefinition = (ILinearProgrammingProblemDefinition)inst;
+        compiledProblemDefinition = (ILinearProblemDefinition)inst;
         if (fireChanged) OnProblemDefinitionChanged();
       } catch (Exception e) {
@@ -139 +140 @@
         throw new ProblemDefinitionScriptException(
           "Using the problem definition in the problem failed." + Environment.NewLine +
-          "Examine this error message carefully (often there is an issue with the defined encoding).", e);
+          "Examine this error message carefully.", e);
       }