source: branches/2817-BinPackingSpeedup/HeuristicLab.Problems.BinPacking/3.3/3D/Packer/BinPacker.cs @ 15554

Last change on this file since 15554 was 15554, checked in by rhanghof, 21 months ago

#2817:

  • Unittests
  • Bugfixes on the line projection based extreme point creation method
File size: 5.3 KB
Line 
1#region License Information
2/* HeuristicLab
3 * Copyright (C) 2002-2016 Joseph Helm and Heuristic and Evolutionary Algorithms Laboratory (HEAL)
4 *
5 * This file is part of HeuristicLab.
6 *
7 * HeuristicLab is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation, either version 3 of the License, or
10 * (at your option) any later version.
11 *
12 * HeuristicLab is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with HeuristicLab. If not, see <http://www.gnu.org/licenses/>.
19 */
20#endregion
21
22using HeuristicLab.Common;
23using HeuristicLab.Core;
24using HeuristicLab.Encodings.PermutationEncoding;
25using HeuristicLab.Persistence.Default.CompositeSerializers.Storable;
26using HeuristicLab.Problems.BinPacking3D;
27using HeuristicLab.Problems.BinPacking3D.ExtremePointCreation;
28using System;
29using System.Collections.Generic;
30using System.Linq;
31using System.Text;
32using System.Threading.Tasks;
33
34namespace HeuristicLab.Problems.BinPacking3D.Packer {
35  internal abstract class BinPacker : Item, IBinPacker {
36   
37    #region Constructors for HEAL
38
39   
40    [StorableConstructor]
41    protected BinPacker(bool deserializing) : base(deserializing) { }
42
43    protected BinPacker(BinPacker original, Cloner cloner) 
44      : base(original, cloner) {
45    }
46
47    #endregion
48
49    public BinPacker() { }
50
51    /// <summary>
52    /// Packs all items of the bin packer and returns a collection of BinPacking3D objects
53    /// </summary>
54    /// <param name="sortedItems">Permutation of items sorted by a sorting method. The value of each permutation index references to the index of the items list</param>
55    /// <param name="binShape">Bin for storing the items</param>
56    /// <param name="items">A list of packing items which should be assigned to a bin</param>
57    /// <param name="useStackingConstraints">Flag for using stacking constraints</param>
58    /// <returns>Returns a collection of bin packing 3d objects. Each object represents a bin and the packed items</returns>
59    public abstract IList<BinPacking3D> PackItems(Permutation sortedItems, PackingShape binShape, IList<PackingItem> items, ExtremePointCreationMethod epCreationMethod, bool useStackingConstraints);
60   
61    /// <summary>
62    /// Pack a given item into a given bin and updates the residual space and the extreme points
63    /// </summary>
64    /// <param name="packingBin"></param>
65    /// <param name="itemId"></param>
66    /// <param name="packingItem"></param>
67    /// <param name="position"></param>
68    protected virtual void PackItem(BinPacking3D packingBin, int itemId, PackingItem packingItem, PackingPosition position, IExtremePointCreator extremePointCreator, bool useStackingConstraints) {
69      if (!CheckItemDimensions(packingBin, packingItem, position)) {
70        throw new BinPacking3DException($"The dimensions of the given item exceeds the bin dimensions. " +
71          $"Bin: ({packingBin.BinShape.Width} {packingBin.BinShape.Depth} {packingBin.BinShape.Height})" +
72          $"Item: ({packingItem.Width} {packingItem.Depth} {packingItem.Height})");
73      }
74      packingBin.PackItem(itemId, packingItem, position);
75      extremePointCreator.UpdateBinPacking(packingBin, packingItem, position);
76    }
77       
78    /// <summary>
79    /// This method tries to find a valid packing position for an given item in a given packing bin
80    /// </summary>
81    /// <param name="packingBin"></param>
82    /// <param name="packingItem"></param>
83    /// <param name="useStackingConstraints"></param>
84    /// <param name="rotated"></param>
85    /// <returns>Returns the packing position for an given item. If there could not be found a valid position it returns null</returns>
86    protected PackingPosition FindPackingPositionForItem(BinPacking3D packingBin, PackingItem packingItem, bool useStackingConstraints, bool rotated) {
87      PackingItem newItem = new PackingItem(
88        rotated ? packingItem.Depth : packingItem.Width,
89        packingItem.Height,
90        rotated ? packingItem.Width : packingItem.Depth,
91        packingItem.TargetBin, packingItem.Weight, packingItem.Material);
92
93      // The extremepoints are sortet by Y / Z / X
94      var newPosition = packingBin.ExtremePoints.Where(x => packingBin.IsPositionFeasible(newItem, x.Key, useStackingConstraints)).FirstOrDefault();
95     
96      return newPosition.Key;
97    }
98
99    /// <summary>
100    /// Compares the dimensions of a given item and the current bin.
101    /// </summary>
102    /// <param name="item"></param>
103    /// <returns>Returns true if the dimensions of an given item are less or equal to the bin.</returns>
104    private bool CheckItemDimensions(BinPacking3D packingBin, PackingItem item, PackingPosition itemPosition) {
105      var width = itemPosition.Rotated ? item.Depth : item.Width;
106      var depth = itemPosition.Rotated ? item.Width : item.Depth;
107      return packingBin.BinShape.Width >= width && packingBin.BinShape.Height >= item.Height && packingBin.BinShape.Depth >= depth;
108    }
109  }
110}
Note: See TracBrowser for help on using the repository browser.