Changeset 2834 for trunk/sources/HeuristicLab.Core/3.3

Timestamp:

02/19/10 06:19:16 (15 years ago)

Author:

swagner

Message:

Operator architecture refactoring (#95)

• worked on operators, engines, and optimization

Location:

trunk/sources/HeuristicLab.Core/3.3

Files:

• Engine.cs (modified) (7 diffs)
• ExecutionContext.cs (modified) (3 diffs)
• HeuristicLab.Core-3.3.csproj (modified) (3 diffs)
• Interfaces/IAtomicOperation.cs (added)
• Interfaces/IEngine.cs (modified) (3 diffs)
• Interfaces/IExecutionContext.cs (added)
• Interfaces/IOperation.cs (moved) (moved from trunk/sources/HeuristicLab.Core/3.3/Interfaces/IExecutionSequence.cs) (1 diff)
• Interfaces/IOperator.cs (modified) (3 diffs)
• Interfaces/IParameter.cs (modified) (2 diffs)
• Interfaces/IParameterizedItem.cs (added)
• NamedItemCollection.cs (modified) (1 diff)
• OperationCollection.cs (moved) (moved from trunk/sources/HeuristicLab.Core/3.3/ExecutionContextCollection.cs) (3 diffs)

trunk/sources/HeuristicLab.Core/3.3/Engine.cs

@@ -71 +71 @@
 
     [Storable]
-    private IProblem problem;
-    /// <summary>
-    /// Gets or sets the current problem.
-    /// </summary>
-    public IProblem Problem {
-      get { return problem; }
-      set {
-        if (value == null) throw new ArgumentNullException();
-        if (value != problem) {
-          problem = value;
-          OnProblemChanged();
-          Prepare();
-        }
-      }
-    }
-
-    [Storable]
     private TimeSpan executionTime;
     /// <summary>
@@ -105 +88 @@
     /// </summary>
     [Storable]
-    private Stack<IExecutionSequence> executionStack;
+    private Stack<IOperation> executionStack;
     /// <summary>
     /// Gets the current execution stack.
     /// </summary>
-    protected Stack<IExecutionSequence> ExecutionStack {
+    protected Stack<IOperation> ExecutionStack {
       get { return executionStack; }
     }
@@ -146 +129 @@
     protected Engine() {
       globalScope = new Scope("Global");
-      problem = null;
-      executionStack = new Stack<IExecutionSequence>();
+      executionStack = new Stack<IOperation>();
       OperatorGraph = new OperatorGraph();
     }
@@ -162 +144 @@
       clone.OperatorGraph = (OperatorGraph)cloner.Clone(operatorGraph);
       clone.globalScope = (Scope)cloner.Clone(globalScope);
-      clone.problem = (IProblem)cloner.Clone(problem);
       clone.executionTime = executionTime;
-      IExecutionSequence[] contexts = executionStack.ToArray();
+      IOperation[] contexts = executionStack.ToArray();
       for (int i = contexts.Length - 1; i >= 0; i--)
-        clone.executionStack.Push((IExecutionSequence)cloner.Clone(contexts[i]));
+        clone.executionStack.Push((IOperation)cloner.Clone(contexts[i]));
       clone.running = running;
       clone.canceled = canceled;
@@ -172 +153 @@
     }
 
+    public void Prepare(IOperation initialOperation) {
+      canceled = false;
+      running = false;
+      globalScope.Clear();
+      ExecutionTime = new TimeSpan();
+      executionStack.Clear();
+      if (initialOperation != null)
+        executionStack.Push(initialOperation);
+      OnPrepared();
+    }
     /// <inheritdoc/>
     /// <remarks>Sets <c>myCanceled</c> and <c>myRunning</c> to <c>false</c>. The global scope is cleared,
@@ -178 +169 @@
     /// Calls <see cref="OnPrepared"/>.</remarks>
     public void Prepare() {
-      canceled = false;
-      running = false;
-      globalScope.Clear();
-      ExecutionTime = new TimeSpan();
-      executionStack.Clear();
-      if ((OperatorGraph.InitialOperator != null) && (Problem != null))
-        executionStack.Push(new ExecutionContext(null, OperatorGraph.InitialOperator, GlobalScope, Problem));
-      OnPrepared();
+      if (OperatorGraph.InitialOperator != null)
+        Prepare(new ExecutionContext(null, OperatorGraph.InitialOperator, GlobalScope));
     }
     /// <inheritdoc/>
@@ -254 +239 @@
     }
     /// <summary>
-    /// Occurs when the problem was changed.
-    /// </summary>
-    public event EventHandler ProblemChanged;
-    /// <summary>
-    /// Fires a new <c>ProblemChanged</c> event.
-    /// </summary>
-    protected virtual void OnProblemChanged() {
-      if (ProblemChanged != null)
-        ProblemChanged(this, EventArgs.Empty);
-    }
-    /// <summary>
     /// Occurs when the execution time changed.
     /// </summary>

trunk/sources/HeuristicLab.Core/3.3/ExecutionContext.cs

@@ -21 +21 @@
 
 using System;
-using System.Collections.Generic;
-using System.Text;
+using HeuristicLab.Collections;
 using HeuristicLab.Persistence.Default.CompositeSerializers.Storable;
 
 namespace HeuristicLab.Core {
-  public class ExecutionContext : DeepCloneable, IExecutionSequence {
+  public class ExecutionContext : DeepCloneable, IExecutionContext, IAtomicOperation {
     [Storable]
-    private ExecutionContext parent;
-    public ExecutionContext Parent {
+    private IParameterizedItem parameterizedItem;
+
+    [Storable]
+    private IExecutionContext parent;
+    public IExecutionContext Parent {
       get { return parent; }
     }
 
-    [Storable]
-    private IOperator op;
+    public IObservableKeyedCollection<string, IParameter> Parameters {
+      get { return parameterizedItem.Parameters; }
+    }
+
     public IOperator Operator {
-      get { return op; }
+      get { return parameterizedItem as IOperator; }
     }
 
@@ -45 +49 @@
     }
 
-    [Storable]
-    private IProblem problem;
-    public IProblem Problem {
-      get { return problem; }
-    }
-
     private ExecutionContext() {
       parent = null;
-      op = null;
+      parameterizedItem = null;
       scope = null;
-      problem = null;
     }
-    public ExecutionContext(ExecutionContext parent, IOperator op, IScope scope, IProblem problem) {
-      if ((op == null) || (scope == null) || (problem == null)) throw new ArgumentNullException();
+    public ExecutionContext(IExecutionContext parent, IParameterizedItem parameterizedItem, IScope scope) {
+      if ((parameterizedItem == null) || (scope == null)) throw new ArgumentNullException();
       this.parent = parent;
-      this.op = op;
+      this.parameterizedItem = parameterizedItem;
       this.scope = scope;
-      this.problem = problem;
     }
 
@@ -68 +64 @@
       ExecutionContext clone = new ExecutionContext();
       cloner.RegisterClonedObject(this, clone);
-      clone.parent = (ExecutionContext)cloner.Clone(parent);
-      clone.op = (IOperator)cloner.Clone(op);
+      clone.parent = (IExecutionContext)cloner.Clone(parent);
+      clone.parameterizedItem = (IParameterizedItem)cloner.Clone(parameterizedItem);
       clone.scope = (IScope)cloner.Clone(scope);
-      clone.problem = (IProblem)cloner.Clone(problem);
       return clone;
     }
 
-    public ExecutionContext CreateContext(IOperator op) {
-      return new ExecutionContext(parent, op, scope, problem);
+    public IAtomicOperation CreateOperation(IOperator op) {
+      return new ExecutionContext(parent, op, scope);
     }
-    public ExecutionContext CreateContext(IOperator op, IScope scope) {
-      return new ExecutionContext(parent, op, scope, problem);
+    public IAtomicOperation CreateOperation(IOperator op, IScope scope) {
+      return new ExecutionContext(parent, op, scope);
     }
-    public ExecutionContext CreateChildContext(IOperator op) {
-      return new ExecutionContext(this, op, scope, problem);
+    public IAtomicOperation CreateChildOperation(IOperator op) {
+      return new ExecutionContext(this, op, scope);
     }
-    public ExecutionContext CreateChildContext(IOperator op, IScope scope) {
-      return new ExecutionContext(this, op, scope, problem);
+    public IAtomicOperation CreateChildOperation(IOperator op, IScope scope) {
+      return new ExecutionContext(this, op, scope);
     }
   }

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

@@ -104 +104 @@
     <Compile Include="ChangedEventArgs.cs" />
     <None Include="HeuristicLabCorePlugin.cs.frame" />
+    <Compile Include="Interfaces\IParameterizedItem.cs" />
+    <Compile Include="Interfaces\IAtomicOperation.cs" />
+    <Compile Include="Interfaces\IExecutionContext.cs" />
+    <Compile Include="Interfaces\IOperation.cs" />
+    <Compile Include="OperationCollection.cs" />
     <Compile Include="ValueParameterCollection.cs" />
-    <Compile Include="Interfaces\IProblem.cs" />
-    <Compile Include="Interfaces\IExecutionSequence.cs" />
     <Compile Include="Interfaces\IValueLookupParameter.cs" />
     <Compile Include="Interfaces\IValueParameter.cs" />
@@ -117 +120 @@
     <Compile Include="Item.cs" />
     <Compile Include="NamedItem.cs" />
-    <Compile Include="Problem.cs" />
     <Compile Include="OperatorGraph.cs" />
     <Compile Include="Interfaces\IParameter.cs" />
@@ -128 +130 @@
       <SubType>Code</SubType>
     </Compile>
-    <Compile Include="ExecutionContextCollection.cs" />
     <Compile Include="ExecutionContext.cs" />
     <Compile Include="OperatorList.cs" />

trunk/sources/HeuristicLab.Core/3.3/Interfaces/IEngine.cs

@@ -38 +38 @@
     /// </summary>
     IScope GlobalScope { get; }
-    /// <summary>
-    /// Gets the problem of the current instance.
-    /// </summary>
-    IProblem Problem { get; set; }
 
     /// <summary>
@@ -62 +58 @@
     void Prepare();
     /// <summary>
+    /// Prepares the engine with a given initial operation.
+    /// </summary>
+    void Prepare(IOperation initialOperation);
+    /// <summary>
     /// Executes the whole run.
     /// </summary>
@@ -78 +78 @@
     /// </summary>
     event EventHandler OperatorGraphChanged;
-    /// <summary>
-    /// Occurs when the problem was changed.
-    /// </summary>
-    event EventHandler ProblemChanged;
     /// <summary>
     /// Occurs when the execution time was changed.

trunk/sources/HeuristicLab.Core/3.3/Interfaces/IOperation.cs

@@ -20 +20 @@
 #endregion
 
-using System;
-using System.Collections.Generic;
-using System.ComponentModel;
-using System.Text;
-using System.Drawing;
-
 namespace HeuristicLab.Core {
   /// <summary>
-  /// Interface which represents an execution context.
+  /// Interface which represents an operation.
   /// </summary>
-  public interface IExecutionSequence : IDeepCloneable { }
+  public interface IOperation : IDeepCloneable { }
 }

trunk/sources/HeuristicLab.Core/3.3/Interfaces/IOperator.cs

@@ -21 +21 @@
 
 using System;
-using System.Collections.Generic;
-using System.Text;
-using HeuristicLab.Common;
-using HeuristicLab.Collections;
 
 namespace HeuristicLab.Core {
@@ -31 +27 @@
   /// a basic instruction of an algorithm.
   /// </summary>
-  public interface IOperator : INamedItem {
-    IObservableKeyedCollection<string, IParameter> Parameters { get; }
-
+  public interface IOperator : INamedItem, IParameterizedItem {
     /// <summary>
     /// Gets or sets a boolean value whether the engine should stop here during the run.
@@ -44 +38 @@
     /// <param name="scope">The scope where to execute the current instance.</param>
     /// <returns>The next operation.</returns>
-    IExecutionSequence Execute(ExecutionContext context);
+    IOperation Execute(IExecutionContext context);
     /// <summary>
     /// Aborts the current operator.

trunk/sources/HeuristicLab.Core/3.3/Interfaces/IParameter.cs

@@ -21 +21 @@
 
 using System;
-using System.Collections.Generic;
-using System.Text;
-using System.Xml;
-using HeuristicLab.Common;
 
 namespace HeuristicLab.Core {
@@ -30 +26 @@
     Type DataType { get; }
     IItem ActualValue { get; set; }
-    ExecutionContext ExecutionContext { get; set; }
+    IExecutionContext ExecutionContext { get; set; }
   }
 }

trunk/sources/HeuristicLab.Core/3.3/NamedItemCollection.cs

@@ -21 +21 @@
 
 using System;
-using System.Linq;
 using System.Collections.Generic;
 using System.Drawing;
+using System.Linq;
 using HeuristicLab.Collections;
 using HeuristicLab.Common;

trunk/sources/HeuristicLab.Core/3.3/OperationCollection.cs

@@ -20 +20 @@
 #endregion
 
-using System;
 using System.Collections.Generic;
 using System.Linq;
-using System.Text;
-using System.Xml;
 using HeuristicLab.Persistence.Default.CompositeSerializers.Storable;
 
 namespace HeuristicLab.Core {
-  public class ExecutionContextCollection : DeepCloneable, IList<IExecutionSequence>, IExecutionSequence {
+  public class OperationCollection : DeepCloneable, IList<IOperation>, IOperation {
     [Storable]
-    private IList<IExecutionSequence> contexts;
+    private IList<IOperation> operations;
 
     [Storable]
@@ -39 +36 @@
     }
 
-    public ExecutionContextCollection() {
-      contexts = new List<IExecutionSequence>();
+    public OperationCollection() {
+      operations = new List<IOperation>();
       parallel = false;
     }
-    public ExecutionContextCollection(IEnumerable<IExecutionSequence> collection) {
-      contexts = new List<IExecutionSequence>(collection.Where(e => e != null));
+    public OperationCollection(IEnumerable<IOperation> collection) {
+      operations = new List<IOperation>(collection.Where(e => e != null));
       parallel = false;
     }
-    public ExecutionContextCollection(params IExecutionSequence[] list) {
-      contexts = new List<IExecutionSequence>(list.Where(e => e != null));
+    public OperationCollection(params IOperation[] list) {
+      operations = new List<IOperation>(list.Where(e => e != null));
       parallel = false;
     }
 
     public override IDeepCloneable Clone(Cloner cloner) {
-      ExecutionContextCollection clone = new ExecutionContextCollection();
+      OperationCollection clone = new OperationCollection(this.Select(x => (IOperation)cloner.Clone(x)));
       cloner.RegisterClonedObject(this, clone);
       clone.parallel = parallel;
-      for (int i = 0; i < contexts.Count; i++)
-        clone.contexts.Add((IExecutionSequence)cloner.Clone(contexts[i]));
       return clone;
     }
 
-    #region IList<IExecutionContext> Members
-    public int IndexOf(IExecutionSequence item) {
-      return contexts.IndexOf(item);
+    #region IList<IOperation> Members
+    public int IndexOf(IOperation item) {
+      return operations.IndexOf(item);
     }
-    public void Insert(int index, IExecutionSequence item) {
-      if (item != null) contexts.Insert(index, item);
+    public void Insert(int index, IOperation item) {
+      if (item != null) operations.Insert(index, item);
     }
     public void RemoveAt(int index) {
-      contexts.RemoveAt(index);
+      operations.RemoveAt(index);
     }
-    public IExecutionSequence this[int index] {
-      get { return contexts[index]; }
-      set { if (value != null) contexts[index] = value; }
+    public IOperation this[int index] {
+      get { return operations[index]; }
+      set { if (value != null) operations[index] = value; }
     }
     #endregion
 
-    #region ICollection<IExecutionContext> Members
-    public void Add(IExecutionSequence item) {
-      if (item != null) contexts.Add(item);
+    #region ICollection<IOperation> Members
+    public void Add(IOperation item) {
+      if (item != null) operations.Add(item);
     }
     public void Clear() {
-      contexts.Clear();
+      operations.Clear();
     }
-    public bool Contains(IExecutionSequence item) {
-      return contexts.Contains(item);
+    public bool Contains(IOperation item) {
+      return operations.Contains(item);
     }
-    public void CopyTo(IExecutionSequence[] array, int arrayIndex) {
-      contexts.CopyTo(array, arrayIndex);
+    public void CopyTo(IOperation[] array, int arrayIndex) {
+      operations.CopyTo(array, arrayIndex);
     }
     public int Count {
-      get { return contexts.Count; }
+      get { return operations.Count; }
     }
     public bool IsReadOnly {
-      get { return contexts.IsReadOnly; }
+      get { return operations.IsReadOnly; }
     }
-    public bool Remove(IExecutionSequence item) {
-      return contexts.Remove(item);
+    public bool Remove(IOperation item) {
+      return operations.Remove(item);
     }
     #endregion
 
-    #region IEnumerable<IExecutionContext> Members
-    public IEnumerator<IExecutionSequence> GetEnumerator() {
-      return contexts.GetEnumerator();
+    #region IEnumerable<IOperation> Members
+    public IEnumerator<IOperation> GetEnumerator() {
+      return operations.GetEnumerator();
     }
     #endregion
@@ -109 +104 @@
     #region IEnumerable Members
     System.Collections.IEnumerator System.Collections.IEnumerable.GetEnumerator() {
-      return contexts.GetEnumerator();
+      return operations.GetEnumerator();
     }
     #endregion