Changeset 13109 for trunk/sources/HeuristicLab.Optimization.Operators

Timestamp:

11/03/15 15:17:13 (9 years ago)

Author:

pfleck

Message:

#2495

• Renamed ClockwiseMigrationDirection ClockwiseMigration.
• Removed access property.
• Updated documentation comments.

File:

• trunk/sources/HeuristicLab.Optimization.Operators/3.3/UnidirectionalRingMigrator.cs (modified) (5 diffs)

trunk/sources/HeuristicLab.Optimization.Operators/3.3/UnidirectionalRingMigrator.cs

@@ -35 +35 @@
   [StorableClass]
   public class UnidirectionalRingMigrator : SingleSuccessorOperator, IMigrator {
-    public IValueLookupParameter<BoolValue> ClockwiseMigrationDirectionParameter {
-      get { return (IValueLookupParameter<BoolValue>)Parameters["ClockwiseMigrationDirection"]; }
-    }
-
-    public BoolValue ClockwiseMigrationDirection
-    {
-      get { return ClockwiseMigrationDirectionParameter.Value; }
-      set { ClockwiseMigrationDirectionParameter.Value = value; }
+    public IValueLookupParameter<BoolValue> ClockwiseMigrationParameter {
+      get { return (IValueLookupParameter<BoolValue>)Parameters["ClockwiseMigration"]; }
     }
 
@@ -51 +45 @@
     public UnidirectionalRingMigrator()
       : base() {
-      Parameters.Add(new ValueLookupParameter<BoolValue>("ClockwiseMigrationDirection", "True to migrate individuals clockwise, otherwise migrate individuals counterclockwise.", new BoolValue(true)));
+      Parameters.Add(new ValueLookupParameter<BoolValue>("ClockwiseMigration", "True to migrate individuals clockwise, false to migrate individuals counterclockwise.", new BoolValue(true)));
     }
 
@@ -58 +52 @@
       // BackwardsCompatibility3.3
       #region Backwards compatible code (remove with 3.4)
-      if (!Parameters.ContainsKey("ClockwiseMigrationDirection")) {
-        Parameters.Add(new ValueLookupParameter<BoolValue>("ClockwiseMigrationDirection", "True to migrate individuals clockwise, otherwise migrate individuals counterclockwise.", new BoolValue(false)));
+      if (!Parameters.ContainsKey("ClockwiseMigration")) {
+        Parameters.Add(new ValueLookupParameter<BoolValue>("ClockwiseMigration", "True to migrate individuals clockwise, false to migrate individuals counterclockwise.", new BoolValue(false)));
       }
       #endregion
@@ -68 +62 @@
 
     /// <summary>
-    /// Migrates every first sub scope of each child to its left neighbour (like a ring).
-    /// <pre>                                                               
+    /// Migrates every first sub scope of each child to its right or left neighbour (like a ring).
+    /// If clockwise migration (default) is used the selected scopes A D G becomes G A D, contrary to counterclockwise where A D G becomes D G A.
+    /// <pre>
     ///          __ scope __              __ scope __
     ///         /     |     \            /     |     \
@@ -81 +76 @@
     /// <returns>The next operation.</returns>
     public override IOperation Apply() {
-      bool clockwise = ClockwiseMigrationDirectionParameter.ActualValue.Value;
+      bool clockwise = ClockwiseMigrationParameter.ActualValue.Value;
       IScope scope = ExecutionContext.Scope;
       List<IScope> emigrantsList = new List<IScope>();