Changeset 2526 for trunk/sources/HeuristicLab.Core

Timestamp:

11/23/09 16:43:34 (15 years ago)

Author:

swagner

Message:

Refactored cloning (#806)

Location:

trunk/sources/HeuristicLab.Core/3.3

Files:

• AtomicOperation.cs (modified) (1 diff)
• Auxiliary.cs (deleted)
• Cloner.cs (added)
• CompositeOperation.cs (modified) (1 diff)
• EngineBase.cs (modified) (1 diff)
• HeuristicLab.Core-3.3.csproj (modified) (2 diffs)
• Interfaces/ICloner.cs (added)
• Interfaces/IItem.cs (modified) (1 diff)
• Interfaces/IOperatorGraph.cs (modified) (1 diff)
• Interfaces/IOperatorGroup.cs (modified) (1 diff)
• Interfaces/IScope.cs (modified) (1 diff)
• Interfaces/IStorable.cs (deleted)
• ItemBase.cs (modified) (1 diff)
• OperatorBase.cs (modified) (1 diff)
• OperatorGraph.cs (modified) (6 diffs)
• OperatorGroup.cs (modified) (2 diffs)
• OperatorLibrary.cs (modified) (1 diff)
• PersistenceManager.cs (modified) (4 diffs)
• Scope.cs (modified) (2 diffs)
• StorableBase.cs (deleted)
• Variable.cs (modified) (1 diff)
• VariableInfo.cs (modified) (1 diff)

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

@@ -69 +69 @@
     /// </summary>
     /// <remarks>The operator and the scope objects are cloned with the 
-    /// <see cref="HeuristicLab.Core.Auxiliary.Clone"/> method of the <see cref="Auxiliary"/> class.</remarks>
+    /// <see cref="HeuristicLab.Core.cloner.Clone"/> method of the <see cref="Auxiliary"/> class.</remarks>
     /// <param name="clonedObjects">All already cloned objects. (Needed to avoid cycles.)</param>
     /// <returns>The cloned object as <see cref="AtomicOperation"/>.</returns>
-    public override object Clone(IDictionary<Guid, object> clonedObjects) {
+    public override IItem Clone(ICloner cloner) {
       AtomicOperation clone = new AtomicOperation();
-      clonedObjects.Add(Guid, clone);
-      clone.myOperator = (IOperator)Auxiliary.Clone(Operator, clonedObjects);
-      clone.myScope = (IScope)Auxiliary.Clone(Scope, clonedObjects);
+      cloner.RegisterClonedObject(this, clone);
+      clone.myOperator = (IOperator)cloner.Clone(Operator);
+      clone.myScope = (IScope)cloner.Clone(Scope);
       return clone;
     }

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

@@ -81 +81 @@
     /// </summary>
     /// <remarks>All operations of the current instance are cloned, too (deep clone), with the 
-    /// <see cref="HeuristicLab.Core.Auxiliary.Clone"/> method of the class <see cref="Auxiliary"/>.</remarks>
+    /// <see cref="HeuristicLab.Core.cloner.Clone"/> method of the class <see cref="Auxiliary"/>.</remarks>
     /// <param name="clonedObjects">A dictionary of all already cloned objects. (Needed to avoid cycles.)</param>
     /// <returns>The cloned operation as <see cref="CompositeOperation"/>.</returns>
-    public override object Clone(IDictionary<Guid, object> clonedObjects) {
+    public override IItem Clone(ICloner cloner) {
       CompositeOperation clone = new CompositeOperation();
-      clonedObjects.Add(Guid, clone);
+      cloner.RegisterClonedObject(this, clone);
       clone.myExecuteInParallel = ExecuteInParallel;
       for (int i = 0; i < Operations.Count; i++)
-        clone.AddOperation((IOperation)Auxiliary.Clone(Operations[i], clonedObjects));
+        clone.AddOperation((IOperation)cloner.Clone(Operations[i]));
       return clone;
     }

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

@@ -127 +127 @@
     /// Clones the current instance (deep clone).
     /// </summary>
-    /// <remarks>Deep clone through <see cref="Auxiliary.Clone"/> method of helper class 
+    /// <remarks>Deep clone through <see cref="cloner.Clone"/> method of helper class 
     /// <see cref="Auxiliary"/>.</remarks>
     /// <param name="clonedObjects">Dictionary of all already clone objects. (Needed to avoid cycles.)</param>
     /// <returns>The cloned object as <see cref="EngineBase"/>.</returns>
-    public override object Clone(IDictionary<Guid, object> clonedObjects) {
-      EngineBase clone = (EngineBase)base.Clone(clonedObjects);
-      clone.myOperatorGraph = (IOperatorGraph)Auxiliary.Clone(OperatorGraph, clonedObjects);
-      clone.myGlobalScope = (IScope)Auxiliary.Clone(GlobalScope, clonedObjects);
+    public override IItem Clone(ICloner cloner) {
+      EngineBase clone = (EngineBase)base.Clone(cloner);
+      clone.myOperatorGraph = (IOperatorGraph)cloner.Clone(OperatorGraph);
+      clone.myGlobalScope = (IScope)cloner.Clone(GlobalScope);
       clone.myExecutionTime = ExecutionTime;
       IOperation[] operations = new IOperation[ExecutionStack.Count];
       ExecutionStack.CopyTo(operations, 0);
       for (int i = operations.Length - 1; i >= 0; i--)
-        clone.myExecutionStack.Push((IOperation)Auxiliary.Clone(operations[i], clonedObjects));
+        clone.myExecutionStack.Push((IOperation)cloner.Clone(operations[i]));
       clone.myRunning = Running;
       clone.myCanceled = Canceled;

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

@@ -98 +98 @@
   </ItemGroup>
   <ItemGroup>
-    <Compile Include="Auxiliary.cs" />
     <Compile Include="AtomicOperation.cs" />
     <Compile Include="CompositeOperation.cs" />
+    <Compile Include="Cloner.cs" />
+    <Compile Include="Interfaces\ICloner.cs" />
     <Compile Include="Interfaces\IEditable.cs" />
     <Compile Include="Interfaces\IOperation.cs" />
@@ -119 +120 @@
     <Compile Include="Interfaces\IRandom.cs" />
     <Compile Include="OperatorGraph.cs" />
-    <Compile Include="StorableBase.cs" />
     <Compile Include="Scope.cs" />
     <Compile Include="EngineBase.cs" />
     <Compile Include="Interfaces\IEngine.cs" />
     <Compile Include="Interfaces\IOperator.cs" />
-    <Compile Include="Interfaces\IStorable.cs" />
     <Compile Include="PersistenceManager.cs" />
     <Compile Include="HeuristicLabCorePlugin.cs" />

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

@@ -28 +28 @@
   /// Interface to represent (almost) every HeuristicLab object (an object, an operator,...).
   /// </summary>
-  public interface IItem : IStorable {
+  public interface IItem : ICloneable {
+    /// <summary>
+    /// Creates a deep clone of this item.
+    /// </summary>
+    /// <param name="cloner">The cloner which is responsible for keeping track of all already
+    /// cloned objects.</param>
+    /// <returns>A clone of this instance.</returns>
+    IItem Clone(ICloner cloner);
+
     /// <summary>
     /// Fires a new <c>Changed</c> event.

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

@@ -49 +49 @@
     /// </summary>
     /// <param name="guid">The unique id of the operator to remove.</param>
-    void RemoveOperator(Guid guid);
-    /// <summary>
-    /// Gets the operator with the specified <paramref name="guid"/>.
-    /// </summary>
-    /// <param name="guid">The unique id of the operator.</param>
-    /// <returns>The searched operator.</returns>
-    IOperator GetOperator(Guid guid);
+    void RemoveOperator(IOperator op);
     /// <summary>
     /// Clears the current instance.

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

@@ -29 +29 @@
   /// Interface to represent a group of operators.
   /// </summary>
-  public interface IOperatorGroup : IStorable {
+  public interface IOperatorGroup : IItem {
     /// <summary>
     /// Gets or sets the name of the current instance.

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

@@ -130 +130 @@
     void ReorderSubScopes(int[] sequence);
     /// <summary>
-    /// Gets the sub scope with the given <paramref name="guid"/>.
-    /// </summary>
-    /// <param name="guid">The unique identifier of the sub scope.</param>
-    /// <returns>The sub scope with the given <paramref name="guid"/>.</returns>
-    IScope GetScope(Guid guid);
-    /// <summary>
     /// Gets the sub scope with the given <paramref name="name"/>.
     /// </summary>

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

@@ -31 +31 @@
   /// </summary>
   [EmptyStorableClass]
-  public abstract class ItemBase : StorableBase, IItem {
+  public abstract class ItemBase : IItem {
+    /// <summary>
+    /// Creates a deep clone of this instance.
+    /// </summary>
+    /// <remarks>
+    /// This method is the entry point for creating a deep clone of a whole object graph.
+    /// </remarks>
+    /// <returns>A clone of this instance.</returns>
+    public object Clone() {
+      return Clone(new Cloner());
+    }
+
+    /// <summary>
+    /// Creates a deep clone of this instance.
+    /// </summary>
+    /// <remarks>This method should not be called directly. It is used for creating clones of
+    /// objects which are contained in the object that is currently cloned.</remarks>
+    /// <param name="cloner">The cloner which is responsible for keeping track of all already
+    /// cloned objects.</param>
+    /// <returns>A clone of this instance.</returns>
+    public virtual IItem Clone(ICloner cloner) {
+      ItemBase clone = (ItemBase)Activator.CreateInstance(this.GetType());
+      cloner.RegisterClonedObject(this, clone);
+      return clone;
+    }
+
     /// <summary>
     /// Gets the string representation of the current instance.

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

@@ -131 +131 @@
     /// <param name="clonedObjects">Dictionary of all already cloned objects. (Needed to avoid cycles.)</param>
     /// <returns>The cloned object as <see cref="OperatorBase"/>.</returns>
-    public override object Clone(IDictionary<Guid, object> clonedObjects) {
-      OperatorBase clone = (OperatorBase)base.Clone(clonedObjects);
+    public override IItem Clone(ICloner cloner) {
+      OperatorBase clone = (OperatorBase)base.Clone(cloner);
       clone.myName = Name;
       clone.mySubOperators.Clear();
       for (int i = 0; i < SubOperators.Count; i++)
-        clone.AddSubOperator((IOperator)Auxiliary.Clone(SubOperators[i], clonedObjects));
+        clone.AddSubOperator((IOperator)cloner.Clone(SubOperators[i]));
       clone.myVariableInfos.Clear();
       foreach (IVariableInfo variableInfo in myVariableInfos.Values)
-        clone.AddVariableInfo((IVariableInfo)Auxiliary.Clone(variableInfo, clonedObjects));
+        clone.AddVariableInfo((IVariableInfo)cloner.Clone(variableInfo));
       clone.myVariables.Clear();
       foreach (IVariable variable in myVariables.Values)
-        clone.AddVariable((IVariable)Auxiliary.Clone(variable, clonedObjects));
+        clone.AddVariable((IVariable)cloner.Clone(variable));
       return clone;
     }

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

@@ -34 +34 @@
 
     [Storable]
-    private IDictionary<Guid, IOperator> myOperators;
+    private IDictionary<IOperator, IOperator> myOperators;
     /// <summary>
     /// Gets all operators of the current instance.
@@ -62 +62 @@
     /// </summary>
     public OperatorGraph() {
-      myOperators = new Dictionary<Guid, IOperator>();
+      myOperators = new Dictionary<IOperator, IOperator>();
     }
 
@@ -68 +68 @@
     /// Clones the current instance (deep clone).
     /// </summary>
-    /// <remarks>Deep clone through <see cref="Auxiliary.Clone"/> method of helper class 
+    /// <remarks>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="OperatorGraph"/>.</returns>
-    public override object Clone(IDictionary<Guid, object> clonedObjects) {
+    public override IItem Clone(ICloner cloner) {
       OperatorGraph clone = new OperatorGraph();
-      clonedObjects.Add(Guid, clone);
+      cloner.RegisterClonedObject(this, clone);
       foreach (IOperator op in Operators)
-        clone.AddOperator((IOperator)Auxiliary.Clone(op, clonedObjects));
+        clone.AddOperator((IOperator)cloner.Clone(op));
       if (InitialOperator != null)
-        clone.myInitialOperator = (IOperator)Auxiliary.Clone(InitialOperator, clonedObjects);
+        clone.myInitialOperator = (IOperator)cloner.Clone(InitialOperator);
       return clone;
     }
@@ -85 +85 @@
     /// <remarks>Calls <see cref="OnOperatorAdded"/>.</remarks>
     public void AddOperator(IOperator op) {
-      if (!myOperators.ContainsKey(op.Guid)) {
-        myOperators.Add(op.Guid, op);
+      if (!myOperators.ContainsKey(op)) {
+        myOperators.Add(op, op);
         OnOperatorAdded(op);
 
@@ -95 +95 @@
     /// <inheritdoc/>
     /// <remarks>Calls <see cref="OnOperatorRemoved"/>.</remarks>
-    public void RemoveOperator(Guid guid) {
-      IOperator op = GetOperator(guid);
-      if (op != null) {
+    public void RemoveOperator(IOperator op) {
+      if (myOperators.ContainsKey(op)) {
         foreach (IOperator o in Operators) {
           int i = 0;
@@ -109 +108 @@
         if (InitialOperator == op)
           InitialOperator = null;
-        myOperators.Remove(op.Guid);
+        myOperators.Remove(op);
         OnOperatorRemoved(op);
       }
     }
     /// <inheritdoc/>
-    public IOperator GetOperator(Guid guid) {
-      IOperator op;
-      if (myOperators.TryGetValue(guid, out op))
-        return op;
-      else
-        return null;
-    }
-    /// <inheritdoc/>
     public void Clear() {
-      Guid[] guids = new Guid[Operators.Count];
+      IOperator[] ops = new IOperator[Operators.Count];
       int i = 0;
       foreach (IOperator op in Operators) {
-        guids[i] = op.Guid;
+        ops[i] = op;
         i++;
       }
-      for (int j = 0; j < guids.Length; j++)
-        RemoveOperator(guids[j]);
+      for (int j = 0; j < ops.Length; j++)
+        RemoveOperator(ops[j]);
     }
 

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

@@ -30 +30 @@
   /// Representation of a group of operators (can also include subgroups).
   /// </summary>
-  public class OperatorGroup : StorableBase, IOperatorGroup {
+  public class OperatorGroup : ItemBase, IOperatorGroup {
 
     [Storable]
@@ -80 +80 @@
     /// Clones the current instance (deep clone).
     /// </summary>
-    /// <remarks>Deep clone with <see cref="Auxiliary.Clone"/> method of helper class 
+    /// <remarks>Deep clone with <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="OperatorGroup"/>.</returns>
-    public override object Clone(IDictionary<Guid, object> clonedObjects) {
-      OperatorGroup clone = (OperatorGroup)base.Clone(clonedObjects);
+    public override IItem Clone(ICloner cloner) {
+      OperatorGroup clone = (OperatorGroup)base.Clone(cloner);
       clone.myName = Name;
       foreach (IOperatorGroup group in SubGroups)
-        clone.AddSubGroup((IOperatorGroup)Auxiliary.Clone(group, clonedObjects));
+        clone.AddSubGroup((IOperatorGroup)cloner.Clone(group));
       foreach (IOperator op in Operators)
-        clone.AddOperator((IOperator)Auxiliary.Clone(op, clonedObjects));
+        clone.AddOperator((IOperator)cloner.Clone(op));
       return clone;
     }

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

@@ -51 +51 @@
     /// Clones the current instance (deep clone).
     /// </summary>
-    /// <remarks>Deep clone through <see cref="Auxiliary.Clone"/> method of helper class 
+    /// <remarks>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="OperatorLibrary"/>.</returns>
-    public override object Clone(IDictionary<Guid, object> clonedObjects) {
+    public override IItem Clone(ICloner cloner) {
       OperatorLibrary clone = new OperatorLibrary();
-      clonedObjects.Add(Guid, clone);
-      clone.myGroup = (IOperatorGroup)Auxiliary.Clone(Group, clonedObjects);
+      cloner.RegisterClonedObject(this, clone);
+      clone.myGroup = (IOperatorGroup)cloner.Clone(Group);
       return clone;
     }

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

@@ -41 +41 @@
     /// <param name="instance">The object that should be saved.</param>
     /// <param name="filename">The name of the file where the <paramref name="object"/> should be saved.</param>
-    public static void Save(IStorable instance, string filename) {
+    public static void Save(IItem instance, string filename) {
       XmlGenerator.Serialize(instance, filename, 0);
     }
 
-    public static void SaveCompressed(IStorable instance, string filename) {
+    public static void SaveCompressed(IItem instance, string filename) {
       XmlGenerator.Serialize(instance, filename, 9);
     }
@@ -55 +55 @@
     /// <param name="instance">The object that should be saved.</param>
     /// <param name="stream">The (file) stream where the object should be saved.</param>
-    public static void Save(IStorable instance, Stream stream) {
+    public static void Save(IItem instance, Stream stream) {
       XmlGenerator.Serialize(instance, stream, ConfigurationService.Instance.GetConfiguration(new XmlFormat()));      
     }
@@ -65 +65 @@
     /// <param name="filename">The filename of the file where the data is saved.</param>
     /// <returns>The loaded object.</returns>
-    public static IStorable Load(string filename) {
-      return (IStorable)XmlParser.Deserialize(filename);
+    public static IItem Load(string filename) {
+      return (IItem)XmlParser.Deserialize(filename);
     }
     /// <summary>
@@ -75 +75 @@
     /// <param name="stream">The stream from where to load the data.</param>
     /// <returns>The loaded object.</returns>
-    public static IStorable Load(Stream stream) {
-      return (IStorable)XmlParser.Deserialize(stream);
+    public static IItem Load(Stream stream) {
+      return (IItem)XmlParser.Deserialize(stream);
     }
 

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

@@ -217 +217 @@
     }
     /// <inheritdoc/>
-    public IScope GetScope(Guid guid) {
-      if (Guid == guid) return this;
-      else {
-        for (int i = 0; i < mySubScopes.Count; i++) {
-          IScope s = mySubScopes[i].GetScope(guid);
-          if (s != null) return s;
-        }
-      }
-      return null;
-    }
-    /// <inheritdoc/>
     public IScope GetScope(string name) {
       if (Name == name) return this;
@@ -260 +249 @@
 
     /// <inheritdoc/>
-    public override object Clone(IDictionary<Guid, object> clonedObjects) {
-      Scope clone = (Scope)base.Clone(clonedObjects);
+    public override IItem Clone(ICloner cloner) {
+      Scope clone = (Scope)base.Clone(cloner);
       clone.myName = Name;
 
       foreach (IVariable variable in myVariables.Values)
-        clone.AddVariable((IVariable)Auxiliary.Clone(variable, clonedObjects));
+        clone.AddVariable((IVariable)cloner.Clone(variable));
       foreach (KeyValuePair<string, string> alias in myAliases)
         clone.AddAlias(alias.Key, alias.Value);
       for (int i = 0; i < SubScopes.Count; i++)
-        clone.AddSubScope((IScope)Auxiliary.Clone(SubScopes[i], clonedObjects));
+        clone.AddSubScope((IScope)cloner.Clone(SubScopes[i]));
 
       return clone;

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

@@ -95 +95 @@
     /// <param name="clonedObjects">Dictionary of all already cloned objects. (Needed to avoid cycles.)</param>
     /// <returns>The cloned object as <see cref="Variable"/>.</returns>
-    public override object Clone(IDictionary<Guid, object> clonedObjects) {
+    public override IItem Clone(ICloner cloner) {
       Variable clone = new Variable();
-      clonedObjects.Add(Guid, clone);
+      cloner.RegisterClonedObject(this, clone);
       clone.myName = Name;
       if (Value != null)
-        clone.myValue = (IItem)Auxiliary.Clone(Value, clonedObjects);
+        clone.myValue = (IItem)cloner.Clone(Value);
       return clone;
     }

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

@@ -136 +136 @@
     /// <param name="clonedObjects">Dictionary of all already cloned objects. (Needed to avoid cycles.)</param>
     /// <returns>The cloned object as <see cref="VariableInfo"/>.</returns>
-    public override object Clone(IDictionary<Guid, object> clonedObjects) {
+    public override IItem Clone(ICloner cloner) {
       VariableInfo clone = new VariableInfo();
-      clonedObjects.Add(Guid, clone);
+      cloner.RegisterClonedObject(this, clone);
       clone.myActualName = ActualName;
       clone.myFormalName = FormalName;