Changeset 15471 for branches/2817-BinPackingSpeedup/HeuristicLab.Problems.BinPacking/3.3/3D/BinPacking3D.cs

Timestamp:

11/14/17 15:31:22 (6 years ago)

Author:

rhanghof

Message:

#2817

• Added some unit tests
• Enhanced the documentation

File:

• branches/2817-BinPackingSpeedup/HeuristicLab.Problems.BinPacking/3.3/3D/BinPacking3D.cs (modified) (7 diffs)

branches/2817-BinPackingSpeedup/HeuristicLab.Problems.BinPacking/3.3/3D/BinPacking3D.cs

@@ -67 +67 @@
     #region New methods for bin packer class
 
+    /// <summary>
+    /// Puts a given item into the bin packing at the given position.
+    /// </summary>
+    /// <param name="itemID">Offset in the internal item array</param>
+    /// <param name="item">Item</param>
+    /// <param name="position">Position of the item in the bin packing</param>
     public override void PackItem(int itemID, PackingItem item, PackingPosition position) {
       Items[itemID] = item;
@@ -107 +113 @@
       AddExtremePoint(ep2);
       AddExtremePoint(ep3);
-
-      /*
-      ExtremePoints.Add(ep1);
-      ExtremePoints.Add(ep2);
-      ExtremePoints.Add(ep3);
-
-      var rs1 = CalculateResidualSpace(CreateRs(ep1));
-      var rs2 = CalculateResidualSpace(CreateRs(ep2));
-      var rs3 = CalculateResidualSpace(CreateRs(ep3));
-      ResidualSpace.Add(ep1, rs1);
-      ResidualSpace.Add(ep2, rs2);
-      ResidualSpace.Add(ep3, rs3);*/
-    }
-
-
-    /*private bool AddExtremePoint(PackingPosition position) {
-      if ()
-
-      return true;
-    }
-
-    
-    private bool AddExtremePoint(PackingPosition pos) {
-      if (ExtremePoints.Add(pos)) {
-        var rs = CalculateResidualSpace(new Vector3D(pos));
-        ResidualSpace.Add(pos, rs);
-        // Check if existing extreme points are shadowed by the new point
-        // That is, their residual space fit entirely into the residual space of the new point
-        foreach (var ep in ExtremePoints.Where(x => x != pos && new Vector3D(x).IsInside(pos, rs)).ToList()) {
-          if (IsWithinResidualSpaceOfAnotherExtremePoint(new Vector3D(ep), ResidualSpace[ep], pos, rs)) {
-            ExtremePoints.Remove(ep);
-            ResidualSpace.Remove(ep);
-          }
-        }
-        return true;
-      }
-      return false;
-    }*/
-
-
+    }
+        
     private Tuple<int, int, int> CalculateResidualSpace(Vector3D pos) {
       var itemPos = Items.Select(x => new { Item = x.Value, Position = Positions[x.Key] });
@@ -164 +132 @@
         }
       }
-
-      
       
       if (limit.X - pos.X <= 0 || limit.Y - pos.Y <= 0  || limit.Z - pos.Z <= 0) {
         return Tuple.Create(0, 0, 0);
-      }
-
-
+      }      
       return Tuple.Create(limit.X - pos.X, limit.Y - pos.Y, limit.Z - pos.Z);
     }
@@ -491 +455 @@
     }
 
+    /// <summary>
+    /// Returns true if all values of a given tuple are not zero
+    /// </summary>
+    /// <param name="rs">Tuple with three integer values which represents a residual space</param>
+    /// <returns></returns>
     private bool IsNonZero(Tuple<int, int, int> rs) {
       return rs.Item1 > 0 && rs.Item2 > 0 && rs.Item3 > 0;
     }
 
+    /// <summary>
+    /// 
+    /// </summary>
+    /// <param name="pos"></param>
+    /// <param name="residualSpace"></param>
+    /// <returns></returns>
     private bool IsWithinResidualSpaceOfAnotherExtremePoint(Vector3D pos, Tuple<int, int, int> residualSpace) {
       var eps = ExtremePoints.Where(x => !pos.Equals(x) && pos.IsInside(x, ResidualSpace[x]));
@@ -505 +480 @@
     }
 
+    /// <summary>
+    /// Adds an extrem point to the extreme point collection of the bin packing.
+    /// </summary>
+    /// <param name="pos">Position of the new extreme point</param>
+    /// <returns>Retruns true if the extreme point could be added</returns>
     private bool AddExtremePoint(PackingPosition pos) {
       if (ExtremePoints.Add(pos)) {
         var rs = CalculateResidualSpace(new Vector3D(pos));
         ResidualSpace.Add(pos, rs);
-        // Check if existing extreme points are shadowed by the new point
-        // That is, their residual space fit entirely into the residual space of the new point
+        // Check if the existing extreme points are shadowed by the new point
+        // This is, their residual space fit entirely into the residual space of the new point
         foreach (var ep in ExtremePoints.Where(x => x != pos && new Vector3D(x).IsInside(pos, rs)).ToList()) {
           if (IsWithinResidualSpaceOfAnotherExtremePoint(new Vector3D(ep), ResidualSpace[ep], pos, rs)) {
@@ -521 +501 @@
       return false;
     }
-
-    private Tuple<int, int, int> CalculateResidualSpace1(Vector3D pos) {
-      var itemPos = Items.Select(x => new { Item = x.Value, Position = Positions[x.Key] });
-      var rightLimit = ProjectRight(pos);
-      var upLimit = ProjectUp(pos);
-      var forwardLimit = ProjectForward(pos);
-      return Tuple.Create(rightLimit.X - pos.X, upLimit.Y - pos.Y, forwardLimit.Z - pos.Z);
-    }
-
+        
     #region Projections
 
@@ -719 +691 @@
 
 
+    /// <summary>
+    /// Updates the resiual space for a packing item.
+    /// </summary>
+    /// <param name="item"></param>
+    /// <param name="pos"></param>
     public void UpdateResidualSpace(PackingItem item, PackingPosition pos) {
       foreach (var ep in ExtremePoints.ToList()) {