Changeset 15879 for branches/2906_Transformations/HeuristicLab.Problems.DataAnalysis

Timestamp:

03/30/18 15:46:05 (7 years ago)

Author:

pfleck

Message:

#2906 minor refactoring

Location:

branches/2906_Transformations/HeuristicLab.Problems.DataAnalysis/3.4

Files:

• Implementation/DataAnalysisProblemData.cs (modified) (2 diffs)
• Implementation/DataAnalysisTransformation.cs (modified) (3 diffs)
• Interfaces/ITransformation.cs (modified) (1 diff)

branches/2906_Transformations/HeuristicLab.Problems.DataAnalysis/3.4/Implementation/DataAnalysisProblemData.cs

@@ -245 +245 @@
       var newDataset = DataAnalysisTransformationModel.Transform(Dataset, Transformations);
 
-      var extendedInputs = ExtendInputVariables(AllowedInputVariables, Transformations);
+      var extendedInputs = DataAnalysisTransformationModel.ExtendInputVariables(AllowedInputVariables, Transformations);
       var checkedInputs = new CheckedItemList<StringValue>(newDataset.VariableNames.Select(x => new StringValue(x)));
       foreach (var input in checkedInputs) checkedInputs.SetItemCheckedState(input, extendedInputs.Contains(input.Value));
@@ -297 +297 @@
       return modifiableDataset;
     }
-
-    public static IEnumerable<string> ExtendInputVariables(IEnumerable<string> oldInputVariables, IEnumerable<IDataAnalysisTransformation> transformations) {
-      var inputs = new HashSet<string>(oldInputVariables);
-
-      foreach (var transformation in transformations) {
-        if (inputs.Contains(transformation.OriginalVariable))
-          inputs.Add(transformation.TransformedVariable);
-      }
-
-      return inputs;
-    }
-
-    public static IEnumerable<string> RemoveVirtualVariables(IEnumerable<string> variables, IEnumerable<IDataAnalysisTransformation> transformations) {
-      var remainingVariables = new HashSet<string>(variables);
-
-      var transformationsStack = new Stack<IDataAnalysisTransformation>(transformations);
-
-      while (transformationsStack.Any()) {
-        var transformation = transformationsStack.Pop();
-
-
-        bool transformedVariablePending = transformationsStack.Any(x => x.OriginalVariable == transformation.TransformedVariable);
-        if (!transformedVariablePending)
-          remainingVariables.Remove(transformation.TransformedVariable);
-      }
-
-      return remainingVariables;
-    }
   }
 }

branches/2906_Transformations/HeuristicLab.Problems.DataAnalysis/3.4/Implementation/DataAnalysisTransformation.cs

@@ -29 +29 @@
   [Item("Transformation", "A transformation applied to a DataAnalysisProblemData")]
   [StorableClass]
-  public class DataAnalysisTransformation : ParameterizedNamedItem, IDataAnalysisTransformation {
+  public sealed class DataAnalysisTransformation : ParameterizedNamedItem, IDataAnalysisTransformation {
     #region Parameter Properties
     private IFixedValueParameter<StringValue> OriginalVariableParameter {
@@ -66 +66 @@
     }
 
-    protected DataAnalysisTransformation(DataAnalysisTransformation original, Cloner cloner)
+    private DataAnalysisTransformation(DataAnalysisTransformation original, Cloner cloner)
       : base(original, cloner) {
     }
@@ -75 +75 @@
 
     [StorableConstructor]
-    protected DataAnalysisTransformation(bool deserializing)
+    private DataAnalysisTransformation(bool deserializing)
       : base(deserializing) { }
 

branches/2906_Transformations/HeuristicLab.Problems.DataAnalysis/3.4/Interfaces/ITransformation.cs

@@ -28 +28 @@
 
   public interface ITransformation<T> : ITransformation {
+    /// <summary>
+    /// Checks if the data is valid for the transformation.
+    /// Calling <code>Apply</code> or <code>Configure</code> on invalid data will throw an exception.
+    /// </summary>
+    /// <param name="data"></param>
+    /// <param name="errorMessage"></param>
+    /// <returns></returns>
     bool Check(IEnumerable<T> data, out string errorMessage);
 
+    /// <summary>
+    /// Configure the internal parameter of the transformation for the given data.
+    /// </summary>
+    /// <param name="data"></param>
     void Configure(IEnumerable<T> data);
 
+    /// <summary>
+    /// Transforms the given data based on the transformation's external and internal parameters.
+    /// </summary>
+    /// <param name="data"></param>
+    /// <returns></returns>
     IEnumerable<T> Apply(IEnumerable<T> data);
+    /// <summary>
+    /// Inverse-transforms the given data based on the transformation's external and internal parameters.
+    /// </summary>
+    /// <param name="data"></param>
+    /// <returns></returns>
+    /// <remarks>If the data cannot be inverse transformed, i.e. if the original data was not in the domain of the transformation, 
+    /// the returned values can contain invalid values or <code>InverseApply</code> might throw an exception.</remarks>
     IEnumerable<T> InverseApply(IEnumerable<T> data);
   }