Changeset 788 for trunk/sources/HeuristicLab.Operators

Timestamp:

11/20/08 11:27:51 (15 years ago)

Author:

vdorfer

Message:

Fixed bug of ticket #375

File:

• trunk/sources/HeuristicLab.Operators/SubScopesMixer.cs (modified) (2 diffs)

trunk/sources/HeuristicLab.Operators/SubScopesMixer.cs

@@ -27 +27 @@
 
 namespace HeuristicLab.Operators {
+  /// <summary>
+  /// Mixes the sub scopes of a specified scope according to a specified number of partitions.
+  /// </summary>
   public class SubScopesMixer : OperatorBase {
+    /// <inheritdoc select="summary"/>
     public override string Description {
       get { return @"TODO\r\nOperator description still missing ..."; }
     }
-
+    /// <summary>
+    /// Initializes a new instance of <see cref="SubScopesMixer"/> with one variable infos 
+    /// (<c>Partitions</c>) and the <c>Local</c> flag set to <c>true</c>.
+    /// </summary>
     public SubScopesMixer()
       : base() {
@@ -39 +46 @@
     }
 
+    /// <summary>
+    /// Mixes the subscopes of the given <paramref name="scope"/>.
+    /// </summary>
+    /// <remarks>Calls <see cref="IScope.ReorderSubScopes"/>.<br/>
+    /// Mixing of sub scopes is based on the number of partitions.
+    /// <example>12 sub scopes and 3 partitions:<br/>
+    /// Partition 1 contains sub scopes 1-4, partition 2 sub scopes 5-8 and partition 3 sub scopes 9-12. <br/>
+    /// Mixing is realized by selecting at the beginning the first sub scope from partition one, then the 
+    /// first sub scope from partition 2, afterwards first sub scope from partition 3, 
+    /// then the second sub scope from the first partition and so on. <br/>
+    /// In the end the new sorting of the sub scopes is 1-5-9-2-6-10-3-7-11-4-8-12. 
+    /// </example>
+    /// </remarks>
+    /// <param name="scope">The scope whose sub scopes should be mixed.</param>
+    /// <returns><c>null</c>.</returns>
     public override IOperation Apply(IScope scope) {
       int partitions = GetVariableValue<IntData>("Partitions", scope, true).Data;
       int[] sequence = new int[scope.SubScopes.Count];
+      if ((sequence.Length % partitions) != 0)
+        throw new ArgumentException("The number of subScopes is not divisible by the number of partitions without remainder.");
       int partitionSize = sequence.Length / partitions;