Changeset 2684 for trunk/sources/HeuristicLab.Operators

Timestamp:

01/26/10 05:14:51 (15 years ago)

Author:

swagner

Message:

Operator architecture refactoring (#95)

• continued work on adapting and refactoring HeuristicLab.Data according to the changes in HeuristicLab.Core
• started work on adapting and refactoring HeuristicLab.Operators according to changes in HeuristicLab.Core

Location:

trunk/sources/HeuristicLab.Operators/3.3

Files:

• CombinedOperator.cs (modified) (2 diffs)
• CombinedOperatorView.Designer.cs (deleted)
• CombinedOperatorView.cs (deleted)
• CombinedOperatorView.resx (deleted)
• Counter.cs (modified) (1 diff)
• EmptyOperator.cs (modified) (1 diff)
• HeuristicLab.Operators-3.3.csproj (modified) (2 diffs)
• Operator.cs (modified) (1 diff)
• SequentialProcessor.cs (modified) (1 diff)
• StandardOperator.cs (modified) (2 diffs)

trunk/sources/HeuristicLab.Operators/3.3/CombinedOperator.cs

@@ -22 +22 @@
 using System;
 using System.Collections.Generic;
+using System.Drawing;
 using System.Text;
 using System.Xml;
+using HeuristicLab.Collections;
 using HeuristicLab.Core;
 using HeuristicLab.Data;
@@ -30 +32 @@
 namespace HeuristicLab.Operators {
   /// <summary>
-  /// Contains an operator graph and automatically injects its sub-operators into the scope it is 
-  /// applied on (useful for modularization to assemble complex operators out of simpler ones).
+  /// Operator which contains an operator graph.
   /// </summary>
-  public class CombinedOperator : DelegatingOperator {
-
+  [Item("CombinedOperator", "An operator which contains an operator graph.")]
+  [Creatable("Test")]
+  public sealed class CombinedOperator : StandardOperator, IOperator {
+    public override Image ItemImage {
+      get { return HeuristicLab.Common.Resources.VS2008ImageLibrary.Module; }
+    }
     [Storable]
-    private string myDescription;
-    /// <summary>
-    /// Gets the description of the current instance.
-    /// </summary>
-    public override string Description {
-      get { return myDescription; }
+    private OperatorGraph operatorGraph;
+    public OperatorGraph OperatorGraph {
+      get { return operatorGraph; }
+    }
+    public new ParameterCollection Parameters {
+      get {
+        return base.Parameters;
+      }
+    }
+    IObservableKeyedCollection<string, IParameter> IOperator.Parameters {
+      get { return Parameters; }
+    }
+    public override bool CanChangeDescription {
+      get { return true; }
     }
 
-    [Storable]
-    private IOperatorGraph myOperatorGraph;
-    /// <summary>
-    /// Gets the operator graph of the current instance.
-    /// </summary>
-    public IOperatorGraph OperatorGraph {
-      get { return myOperatorGraph; }
+    public CombinedOperator()
+      : base() {
+      operatorGraph = new OperatorGraph();
     }
 
-    /// <summary>
-    /// Initializes a new instance of <see cref="CombinedOperator"/>.
-    /// </summary>
-    public CombinedOperator()
-      : base() {
-      myDescription =
-        @"A combined operator contains a whole operator graph. It is useful for modularization to assemble complex operators out of simpler ones.
-
-A combined operator automatically inject its sub-operators into the scope it is applied on. Thereby the names of the sub-operators are used as variable names. Those operators can be extracted again in the contained operator graph by using an OperatorExtractor. So it is possible to parameterize a combined operator with custom operators.";
-      myOperatorGraph = new OperatorGraph();
+    public override IDeepCloneable Clone(Cloner cloner) {
+      CombinedOperator clone = (CombinedOperator)base.Clone(cloner);
+      clone.operatorGraph = (OperatorGraph)cloner.Clone(operatorGraph);
+      return base.Clone(cloner);
     }
 
-    /// <summary>
-    /// Sets the description of the current instance.
-    /// </summary>
-    /// <remarks>Calls <see cref="OnDescriptionChanged"/>.</remarks>
-    /// <exception cref="NullReferenceException">Thrown when <paramref name="description"/> is <c>null</c>.</exception>
-    /// <param name="description">The description to set.</param>
-    public void SetDescription(string description) {
-      if (description == null)
-        throw new NullReferenceException("description must not be null");
-
-      if (description != myDescription) {
-        myDescription = description;
-        OnDescriptionChanged();
-      }
-    }
-
-    /// <summary>
-    /// Clones the current instance (deep clone).
-    /// </summary>
-    /// <remarks>Calls <see cref="OperatorBase.Clone
-    /// (System.Collections.Generic.IDictionary&lt;System.Guid, object&gt;)"/> 
-    /// of base class <see cref="DelegatingOperator"/>.<br/>
-    /// Deep clone through <see cref="cloner.Clone"/> method of helper class 
-    /// <see cref="Auxiliary"/>.</remarks>
-    /// <param name="clonedObjects">Dictionary of all already cloned objects. (Needed to avoid cycles.)</param>
-    /// <returns>The cloned object as <see cref="CombinedOperator"/>.</returns>
-    public override IItem Clone(ICloner cloner) {
-      CombinedOperator clone = (CombinedOperator)base.Clone(cloner);
-      clone.myDescription = Description;
-      clone.myOperatorGraph = (IOperatorGraph)cloner.Clone(OperatorGraph);
-      return clone;
-    }
-
-    /// <summary>
-    /// Adds all sub operators to the specified <paramref name="scope"/>.
-    /// </summary>
-    /// <param name="scope">The scope where to inject the sub operators.</param>
-    /// <returns><c>null</c> if the initial operator is <c>nulll</c>, else a new 
-    /// <see cref="AtomicOperation"/> with the initial operator and the given <paramref name="scope"/>.</returns>
-    public override IOperation Apply(IScope scope) {
-      if (OperatorGraph.InitialOperator != null) {
-        for (int i = 0; i < SubOperators.Count; i++) {
-          if (scope.GetVariable(SubOperators[i].Name) != null)
-            scope.RemoveVariable(SubOperators[i].Name);
-          scope.AddVariable(new Variable(SubOperators[i].Name, SubOperators[i]));
-        }
-        return new AtomicOperation(OperatorGraph.InitialOperator, scope);
-      } else {
-        return null;
-      }
-    }
-
-    /// <summary>
-    /// Occurs when the description of the current instance has been changed.
-    /// </summary>
-    public event EventHandler DescriptionChanged;
-    /// <summary>
-    /// Fires a new <c>DescriptionChanged</c> event.
-    /// </summary>
-    protected virtual void OnDescriptionChanged() {
-      if (DescriptionChanged != null)
-        DescriptionChanged(this, new EventArgs());
+    public override ExecutionContextCollection Apply(ExecutionContext context) {
+      ExecutionContextCollection next = base.Apply(context);
+      if (operatorGraph.InitialOperator != null)
+        next.Insert(0, new ExecutionContext(context, operatorGraph.InitialOperator, context.Scope));
+      return next;
     }
   }

trunk/sources/HeuristicLab.Operators/3.3/Counter.cs

@@ -25 +25 @@
 using HeuristicLab.Core;
 using HeuristicLab.Data;
+using HeuristicLab.Persistence.Default.CompositeSerializers.Storable;
 
 namespace HeuristicLab.Operators {
   /// <summary>
-  /// Class to increment an int variable by 1.
+  /// Operator which increments an integer variable.
   /// </summary>
-  public class Counter : OperatorBase {
-    /// <summary>
-    /// Gets the description of the current instance.
-    /// </summary>
-    public override string Description {
-      get { return @"TODO\r\nOperator description still missing ..."; }
+  [Item("Counter", "An operator which increments an integer variable.")]
+  [EmptyStorableClass]
+  [Creatable("Test")]
+  public sealed class Counter : StandardOperator {
+    public ItemParameter<IntData> Value {
+      get { return (ItemParameter<IntData>)Parameters["Value"]; }
+    }
+    public ItemParameter<IntData> Increment {
+      get { return (ItemParameter<IntData>)Parameters["Increment"]; }
     }
 
-    /// <summary>
-    /// Initializes a new instance of <see cref="Counter"/> with one variable info (<c>Value</c>).
-    /// </summary>
     public Counter()
       : base() {
-      AddVariableInfo(new VariableInfo("Value", "Counter value", typeof(IntData), VariableKind.In | VariableKind.Out));
+      Parameters.Add(new ItemParameter<IntData>("Value", "The value which should be incremented."));
+      Parameters.Add(new ItemParameter<IntData>("Increment", "The increment which is added to the value.", new IntData(1)));
     }
 
-    /// <summary>
-    /// Increments an int value of the specified <paramref name="scope"/> by one.
-    /// </summary>
-    /// <param name="scope">The scope whose variable should be incremented.</param>
-    /// <returns><c>null</c>.</returns>
-    public override IOperation Apply(IScope scope) {
-      IntData value = GetVariableValue<IntData>("Value", scope, true);
-      value.Data++;
-      return null;
+    public override ExecutionContextCollection Apply(ExecutionContext context) {
+      IntData value = Value.GetValue(context);
+      IntData increment = Increment.GetValue(context);
+      value.Value += increment.Value;
+      return base.Apply(context);
     }
   }

trunk/sources/HeuristicLab.Operators/3.3/EmptyOperator.cs

@@ -31 +31 @@
   /// An operator which represents an empty statement.
   /// </summary>
-  [Item("Empty Operator", "An operator which represents an empty statement.")]
+  [Item("EmptyOperator", "An operator which represents an empty statement.")]
   [Creatable("Test")]
   [EmptyStorableClass]

trunk/sources/HeuristicLab.Operators/3.3/HeuristicLab.Operators-3.3.csproj

@@ -85 +85 @@
   </ItemGroup>
   <ItemGroup>
+    <Compile Include="CombinedOperator.cs" />
+    <Compile Include="Counter.cs" />
     <Compile Include="EmptyOperator.cs">
       <SubType>Code</SubType>
@@ -91 +93 @@
     <Compile Include="Operator.cs" />
     <Compile Include="Properties\AssemblyInfo.cs" />
+    <Compile Include="SequentialProcessor.cs" />
     <Compile Include="StandardOperator.cs" />
   </ItemGroup>

trunk/sources/HeuristicLab.Operators/3.3/Operator.cs

@@ -37 +37 @@
     public override Image ItemImage {
       get { return HeuristicLab.Common.Resources.VS2008ImageLibrary.Method; }
+    }
+    public override bool CanChangeDescription {
+      get { return false; }
     }
 

trunk/sources/HeuristicLab.Operators/3.3/SequentialProcessor.cs

@@ -23 +23 @@
 using System.Collections.Generic;
 using System.Text;
+using System.Xml;
+using HeuristicLab.Collections;
 using HeuristicLab.Core;
 using HeuristicLab.Data;
+using HeuristicLab.Persistence.Default.CompositeSerializers.Storable;
 
 namespace HeuristicLab.Operators {
   /// <summary>
-  /// Performs <c>n</c> operators on the given scope sequentially.
+  /// Operator which executes multiple operators sequentially.
   /// </summary>
-  public class SequentialProcessor : OperatorBase {
-    /// <inheritdoc select="summary"/>
-    public override string Description {
-      get { return @"TODO\r\nOperator description still missing ..."; }
+  [Item("SequentialProcessor", "An operator which executes multiple operators sequentially.")]
+  [Creatable("Test")]
+  [EmptyStorableClass]
+  public sealed class SequentialProcessor : Operator, IOperator {
+    public new ParameterCollection Parameters {
+      get {
+        return base.Parameters;
+      }
+    }
+    IObservableKeyedCollection<string, IParameter> IOperator.Parameters {
+      get { return Parameters; }
     }
 
-    /// <summary>
-    /// Applies <c>n</c> operators on the given <paramref name="scope"/>.
-    /// </summary>
-    /// <param name="scope">The scope to apply the operators on.</param>
-    /// <returns>A new <see cref="CompositeOperation"/> with the <c>n</c> operators applied 
-    /// to the given <paramref name="scope"/>.</returns>
-    public override IOperation Apply(IScope scope) {
-      CompositeOperation next = new CompositeOperation();
-      for (int i = 0; i < SubOperators.Count; i++)
-        next.AddOperation(new AtomicOperation(SubOperators[i], scope));
+    public SequentialProcessor()
+      : base() {
+    }
+
+    public override ExecutionContextCollection Apply(ExecutionContext context) {
+      ExecutionContextCollection next = new ExecutionContextCollection();
+      foreach (IParameter param in Parameters) {
+        IOperatorParameter opParam = param as IOperatorParameter;
+        if (opParam != null) {
+          IOperator op = (IOperator)opParam.GetValue(context);
+          if (op != null) next.Add(new ExecutionContext(context.Parent, op, context.Scope));
+        }
+      }
       return next;
     }

trunk/sources/HeuristicLab.Operators/3.3/StandardOperator.cs

@@ -31 +31 @@
   /// A base class for operators which have only one successor.
   /// </summary>
-  [Item("Standard Operator", "A base class for operators which have only one successor.")]
+  [Item("StandardOperator", "A base class for operators which have only one successor.")]
   [Creatable("Test")]
   [EmptyStorableClass]
@@ -45 +45 @@
 
     public override ExecutionContextCollection Apply(ExecutionContext context) {
-      IOperator successor = Successor.GetValue(context);
+      IOperator successor = Successor.GetValue(context, false);
       if (successor != null)
         return new ExecutionContextCollection(new ExecutionContext(context.Parent, successor, context.Scope));