Changeset 17747 for branches/2521_ProblemRefactoring/HeuristicLab.Analysis

Timestamp:

09/15/20 17:09:10 (4 years ago)

Author:

abeham

Message:

#2521: worked on refactoring

• add results to problem base classes
• fix external evaluation problem
• Add result descriptions

Location:

branches/2521_ProblemRefactoring/HeuristicLab.Analysis/3.3

Files:

• AlleleFrequencyAnalysis/AlleleFrequencyAnalyzer.cs (modified) (9 diffs)
• BestScopeSolutionAnalyzer.cs (modified) (1 diff)
• MultiObjective/RankBasedParetoFrontAnalyzer.cs (modified) (3 diffs)

branches/2521_ProblemRefactoring/HeuristicLab.Analysis/3.3/AlleleFrequencyAnalysis/AlleleFrequencyAnalyzer.cs

@@ -23 +23 @@
 using System.Collections.Generic;
 using System.Linq;
+using HEAL.Attic;
 using HeuristicLab.Common;
 using HeuristicLab.Core;
@@ -29 +30 @@
 using HeuristicLab.Optimization;
 using HeuristicLab.Parameters;
-using HEAL.Attic;
 
 namespace HeuristicLab.Analysis {
@@ -165 +165 @@
         if (!ResultsParameter.ActualValue.ContainsKey(Name + " Results")) {
           results = new ResultCollection();
-          ResultsParameter.ActualValue.Add(new Result(Name + " Results", results));
+          ResultsParameter.ActualValue.Add(new Result(Name + " Results", "Collection of allele frequency analysis results", results));
         } else {
           results = (ResultCollection)ResultsParameter.ActualValue[Name + " Results"].Value;
@@ -173 +173 @@
         AlleleFrequencyCollection frequenciesCollection = new AlleleFrequencyCollection(frequencies);
         if (!results.ContainsKey("Allele Frequencies"))
-          results.Add(new Result("Allele Frequencies", frequenciesCollection));
+          results.Add(new Result("Allele Frequencies", "Displays for all alleles in the population the frequencies with which these occur.", frequenciesCollection));
         else
           results["Allele Frequencies"].Value = frequenciesCollection;
@@ -182 +182 @@
             AlleleFrequencyCollectionHistory history = new AlleleFrequencyCollectionHistory();
             history.Add(frequenciesCollection);
-            results.Add(new Result("Allele Frequencies History", history));
+            results.Add(new Result("Allele Frequencies History", "Snapshots of the allele frequency of each generation.", history));
           } else {
             ((AlleleFrequencyCollectionHistory)results["Allele Frequencies History"].Value).Add(frequenciesCollection);
@@ -215 +215 @@
           allelesTable.Rows["Lost Alleles of Best Known Solution"].VisualProperties.StartIndexZero = true;
 
-          results.Add(new Result("Alleles", allelesTable));
+          results.Add(new Result("Alleles", "Tabular summary of the allele frequency analysis", allelesTable));
         } else {
           allelesTable = (DataTable)results["Alleles"].Value;
@@ -234 +234 @@
         // store alleles values
         if (!results.ContainsKey("Unique Alleles"))
-          results.Add(new Result("Unique Alleles", new DoubleValue(frequenciesCollection.Count)));
+          results.Add(new Result("Unique Alleles", "The number of unique alleles currently in the population.", new DoubleValue(frequenciesCollection.Count)));
         else
           ((DoubleValue)results["Unique Alleles"].Value).Value = frequenciesCollection.Count;
 
         if (!results.ContainsKey("Unique Alleles of Best Known Solution"))
-          results.Add(new Result("Unique Alleles of Best Known Solution", new DoubleValue(uniqueRelevantAllelesCount)));
+          results.Add(new Result("Unique Alleles of Best Known Solution", "The number of alleles from the best-known solution that are currently present in the population.", new DoubleValue(uniqueRelevantAllelesCount)));
         else
           ((DoubleValue)results["Unique Alleles of Best Known Solution"].Value).Value = uniqueRelevantAllelesCount;
 
         if (!results.ContainsKey("Fixed Alleles"))
-          results.Add(new Result("Fixed Alleles", new DoubleValue(fixedAllelesCount)));
+          results.Add(new Result("Fixed Alleles", "The number of alleles, that are present in every individual of the population.", new DoubleValue(fixedAllelesCount)));
         else
           ((DoubleValue)results["Fixed Alleles"].Value).Value = fixedAllelesCount;
 
         if (!results.ContainsKey("Fixed Alleles of Best Known Solution"))
-          results.Add(new Result("Fixed Alleles of Best Known Solution", new DoubleValue(fixedRelevantAllelesCount)));
+          results.Add(new Result("Fixed Alleles of Best Known Solution", "The number of alles from the best-known solution that are present in every individual of the population.", new DoubleValue(fixedRelevantAllelesCount)));
         else
           ((DoubleValue)results["Fixed Alleles of Best Known Solution"].Value).Value = fixedRelevantAllelesCount;
 
         if (!results.ContainsKey("Lost Alleles of Best Known Solution"))
-          results.Add(new Result("Lost Alleles of Best Known Solution", new DoubleValue(lostRelevantAllelesCount)));
+          results.Add(new Result("Lost Alleles of Best Known Solution", "The number of alles from the best-known solution that are currently not present in the population.", new DoubleValue(lostRelevantAllelesCount)));
         else
           ((DoubleValue)results["Lost Alleles of Best Known Solution"].Value).Value = lostRelevantAllelesCount;
@@ -282 +282 @@
 
           if (!results.ContainsKey("Scatter Plot"))
-            results.Add(new Result("Scatter Plot", plot));
+            results.Add(new Result("Scatter Plot", "A plot that shows the correlation between number of unique alleles that an individual shares with the best-known solution and its relative quality.", plot));
           else
             results["Scatter Plot"].Value = plot;
           if (storeHistory) {
             if (!results.ContainsKey("Scatter Plot History")) {
-              results.Add(new Result("Scatter Plot History", new ScatterPlotHistory()));
+              results.Add(new Result("Scatter Plot History", "Snapshots of the scatter plot that show correlation between shared alleles with best-known solution and relative solution quality.", new ScatterPlotHistory()));
             }
             ((ScatterPlotHistory)results["Scatter Plot History"].Value).Add(plot);
@@ -300 +300 @@
 
           if (!results.ContainsKey("Average Contained Alleles of Best Known Solution"))
-            results.Add(new Result("Average Contained Alleles of Best Known Solution", new DoubleValue(avgContainedReleventAlleles)));
+            results.Add(new Result("Average Contained Alleles of Best Known Solution", "Average number of alleles that individuals share with the best-known solution.", new DoubleValue(avgContainedReleventAlleles)));
           else
             ((DoubleValue)results["Average Contained Alleles of Best Known Solution"].Value).Value = avgContainedReleventAlleles;

branches/2521_ProblemRefactoring/HeuristicLab.Analysis/3.3/BestScopeSolutionAnalyzer.cs

@@ -124 +124 @@
         var solution = cloner.Clone(currentBestScope);
 
-        results.Add(new Result(BestSolutionResultName, solution));
+        results.Add(new Result(BestSolutionResultName, "The best solution found so far.", solution));
       } else {
         var bestSolution = (IScope)results[BestSolutionResultName].Value;

branches/2521_ProblemRefactoring/HeuristicLab.Analysis/3.3/MultiObjective/RankBasedParetoFrontAnalyzer.cs

@@ -22 +22 @@
 using System.Collections.Generic;
 using System.Linq;
+using HEAL.Attic;
 using HeuristicLab.Common;
 using HeuristicLab.Core;
@@ -27 +28 @@
 using HeuristicLab.Optimization;
 using HeuristicLab.Parameters;
-using HEAL.Attic;
 
 namespace HeuristicLab.Analysis {
@@ -72 +72 @@
       if (results.ContainsKey("Pareto Front"))
         results["Pareto Front"].Value = front;
-      else results.Add(new Result("Pareto Front", front));
+      else results.Add(new Result("Pareto Front", "A tabular presentation of the current Pareto front.", front));
 
       if (populationLevel) {
         if (results.ContainsKey("Pareto Archive"))
           results["Pareto Archive"].Value = paretoArchive;
-        else results.Add(new Result("Pareto Archive", paretoArchive));
+        else results.Add(new Result("Pareto Archive", "The individual solutions on the Pareto front.", paretoArchive));
       }
     }