source: branches/2817-BinPackingSpeedup/HeuristicLab.Problems.BinPacking/3.3/2D/BinPacking2D.cs @ 16147

#region License Information
/* HeuristicLab
 * Copyright (C) 2002-2018 Joseph Helm and Heuristic and Evolutionary Algorithms Laboratory (HEAL)
 *
 * This file is part of HeuristicLab.
 *
 * HeuristicLab is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * HeuristicLab is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with HeuristicLab. If not, see <http://www.gnu.org/licenses/>.
 */
#endregion

using System;
using System.Collections.Generic;
using System.Linq;
using HeuristicLab.Persistence.Default.CompositeSerializers.Storable;
using HeuristicLab.Core;
using HeuristicLab.Common;

namespace HeuristicLab.Problems.BinPacking2D {
  [Item("BinPacking2D", "Represents a single-bin packing for a 2D bin-packing problem.")]
  [StorableClass]
  public class BinPacking2D : BinPacking.BinPacking<PackingPosition, PackingShape, PackingItem> {
    [Storable]
    public SortedSet<PackingPosition> ExtremePoints { get; protected set; }

    public BinPacking2D(PackingShape binShape)
      : base(binShape) {
      ExtremePoints = new SortedSet<PackingPosition>();
      OccupationLayers = new Dictionary<int, List<int>>();
      ExtremePoints.Add(binShape.Origin);
      InitializeOccupationLayers();
    }

    [StorableConstructor]
    protected BinPacking2D(bool deserializing) : base(deserializing) { }
    protected BinPacking2D(BinPacking2D original, Cloner cloner) : base(original, cloner) {
      this.OccupationLayers = new Dictionary<int, List<int>>();
      foreach (var kvp in original.OccupationLayers) {
        OccupationLayers.Add(kvp.Key, new List<int>(kvp.Value));
      }

      this.ExtremePoints = new SortedSet<PackingPosition>(original.ExtremePoints.Select(p => cloner.Clone(p)));
    }
    public override IDeepCloneable Clone(Cloner cloner) {
      return new BinPacking2D(this, cloner);
    }

    [Storable]
    protected Dictionary<int, List<int>> OccupationLayers { get; set; }

    protected override void GenerateNewExtremePointsForNewItem(PackingItem newItem, PackingPosition position) {

      int newWidth = position.Rotated ? newItem.Height : newItem.Width;
      int newHeight = position.Rotated ? newItem.Width : newItem.Height;

      //Find ExtremePoints beginning from sourcepointX
      var sourcePointX = new PackingPosition(0, position.X + newWidth, position.Y);
      if (sourcePointX.X < BinShape.Width && sourcePointX.Y < BinShape.Height) {
        //Traversing down the y-axis        
        var newPoint = new PackingPosition(0, sourcePointX.X, sourcePointX.Y - 1);
        while (sourcePointX.Y > 0 && !IsPointOccupied(newPoint)) {
          sourcePointX = newPoint;
          newPoint = new PackingPosition(0, sourcePointX.X, sourcePointX.Y - 1);
        }
        ExtremePoints.Add(new PackingPosition(0, sourcePointX.X, sourcePointX.Y));
      }

      //Find ExtremePoints beginning from sourcepointY
      var sourcePointY = new PackingPosition(0, position.X, position.Y + newHeight);
      if (sourcePointY.X < BinShape.Width && sourcePointY.Y < BinShape.Height) {
        //Traversing down the x-axis  
        var newPoint = new PackingPosition(0, sourcePointY.X - 1, sourcePointY.Y);
        while (sourcePointY.X > 0 && !IsPointOccupied(newPoint)) {
          sourcePointY = newPoint;
          newPoint = new PackingPosition(0, sourcePointY.X - 1, sourcePointY.Y);
        }
        ExtremePoints.Add(new PackingPosition(0, sourcePointY.X, sourcePointY.Y));
      }
    }

    public PackingPosition FindExtremePointForItem(PackingItem item, bool rotated, bool stackingConstraints) {
      PackingItem rotatedItem = new PackingItem(
        rotated ? item.Height : item.Width,
        rotated ? item.Width : item.Height,
        item.TargetBin) {
        Layer = item.Layer,
        Weight = item.Weight
      };

      var ep = ExtremePoints.Where(x => IsPositionFeasible(rotatedItem, x, stackingConstraints)).FirstOrDefault();
      if (ep != null) {
        var result = new PackingPosition(ep.AssignedBin, ep.X, ep.Y, rotated);
        return result;
      }
      return null;
    }

    public override void PackItem(int itemID, PackingItem item, PackingPosition position) {
      Items[itemID] = item;
      Positions[itemID] = position;
      ExtremePoints.Remove(position);
      GenerateNewExtremePointsForNewItem(item, position);

      AddNewItemToOccupationLayers(itemID, item, position);
    }

    public bool PackItemIfFeasible(int itemID, PackingItem item, PackingPosition position, bool stackingConstraints) {
      if (IsPositionFeasible(item, position, stackingConstraints)) {
        PackItem(itemID, item, position);
        return true;
      }
      return false;
    }

    /// <summary>
    /// 
    /// </summary>
    /// <param name="item"></param>
    /// <param name="position"></param>
    /// <param name="stackingConstraints"></param>
    /// <returns></returns>
    public override bool IsPositionFeasible(PackingItem item, PackingPosition position, bool stackingConstraints) {
      //In this case feasability is defined as following: 
      //1. the item fits into the bin-borders; 
      //2. the point is supported by something; 
      //3. the item does not collide with another already packed item
      if (!BinShape.Encloses(position, item))
        return false;

      foreach (var id in GetLayerItemIDs(item, position)) {
        if (Items[id].Overlaps(Positions[id], position, item))
          return false;
      }

      return true;
    }


    public PackingPosition FindPositionBySliding(PackingItem item, bool rotated, bool stackingConstraints) {
      PackingPosition currentPosition = new PackingPosition(0,
        BinShape.Width - (rotated ? item.Height : item.Width),
        BinShape.Height - (rotated ? item.Width : item.Height), rotated);
      //Slide the item as far as possible to the left
      while (IsPositionFeasible(item, PackingPosition.MoveLeft(currentPosition), stackingConstraints)
        || IsPositionFeasible(item, PackingPosition.MoveDown(currentPosition), stackingConstraints)) {
        //Slide the item as far as possible to the bottom
        while (IsPositionFeasible(item, PackingPosition.MoveDown(currentPosition), stackingConstraints)) {
          currentPosition = PackingPosition.MoveDown(currentPosition);
        }
        if (IsPositionFeasible(item, PackingPosition.MoveLeft(currentPosition), stackingConstraints))
          currentPosition = PackingPosition.MoveLeft(currentPosition);
      }

      return IsPositionFeasible(item, currentPosition, stackingConstraints) ? currentPosition : null;
    }

    public void SlidingBasedPacking(ref IList<int> sequence, IList<PackingItem> items, bool stackingConstraints) {
      var temp = new List<int>(sequence);
      for (int i = 0; i < temp.Count; i++) {
        var item = items[temp[i]];
        var position = FindPositionBySliding(item, false, stackingConstraints);
        if (position != null) {
          PackItem(temp[i], item, position);
          sequence.Remove(temp[i]);
        }
      }
    }
    public void SlidingBasedPacking(ref IList<int> sequence, IList<PackingItem> items, Dictionary<int, bool> rotationArray, bool stackingConstraints) {
      var temp = new List<int>(sequence);
      for (int i = 0; i < temp.Count; i++) {
        var item = items[temp[i]];
        var position = FindPositionBySliding(item, rotationArray[temp[i]], stackingConstraints);
        if (position != null) {
          PackItem(temp[i], item, position);
          sequence.Remove(temp[i]);
        }
      }
    }
    public void ExtremePointBasedPacking(ref IList<int> sequence, IList<PackingItem> items, bool stackingConstraints) {
      var temp = new List<int>(sequence);
      foreach (int itemID in temp) {
        var item = items[itemID];
        var positionFound = FindExtremePointForItem(item, false, false);
        if (positionFound != null) {
          PackItem(itemID, item, positionFound);
          sequence.Remove(itemID);
        }
      }
    }
    
    public void ExtremePointBasedPacking(ref IList<int> sequence, IList<PackingItem> items, bool stackingConstraints, Dictionary<int, bool> rotationArray) {
      var temp = new List<int>(sequence);
      foreach (int itemID in temp) {
        var item = items[itemID];
        var positionFound = FindExtremePointForItem(item, rotationArray[itemID], false);
        if (positionFound != null) {
          PackItem(itemID, item, positionFound);
          sequence.Remove(itemID);
        }
      }
    }

    public int ShortestPossibleSideFromPoint(PackingPosition position) {
      int shortestSide = int.MaxValue;
      int width = BinShape.Width;
      int height = BinShape.Height;

      if (position.X >= width || position.Y >= height)
        return shortestSide;

      PackingPosition current = new PackingPosition(0, position.X, position.Y);
      while (current.X < width && IsPointOccupied(current)) { current = PackingPosition.MoveRight(current); }
      if (current.X - position.X < shortestSide)
        shortestSide = current.X - position.X;


      current = new PackingPosition(0, position.X, position.Y);
      while (current.Y < height && IsPointOccupied(current)) { current = PackingPosition.MoveUp(current); }
      if (current.Y - position.Y < shortestSide)
        shortestSide = current.Y - position.Y;

      return shortestSide;
    }
    public override bool IsStaticStable(PackingItem item, PackingPosition position) {
      throw new NotSupportedException();
    }
    protected void InitializeOccupationLayers() {
      for (int i = 0; i * 10 <= BinShape.Width; i += 1) {
        OccupationLayers[i] = new List<int>();
      }
    }

    protected void AddNewItemToOccupationLayers(int itemID, PackingItem item, PackingPosition position) {
      int x1 = position.X / 10;
      int x2 = (position.X + (position.Rotated ? item.Height : item.Width)) / 10;

      for (int i = x1; i <= x2; i++)
        OccupationLayers[i].Add(itemID);
    }
    protected List<int> GetLayerItemIDs(PackingPosition position) {
      return OccupationLayers[position.X / 10];
    }
    protected List<int> GetLayerItemIDs(PackingItem item, PackingPosition position) {
      List<int> result = new List<int>();
      int x1 = position.X / 10;
      int x2 = (position.X + (position.Rotated ? item.Height : item.Width)) / 10;

      for (int i = x1; i <= x2; i++)
        result.AddRange(OccupationLayers[i]);

      return result;
    }
    

    public int PointOccupation(PackingPosition position) {
      foreach (var id in GetLayerItemIDs(position)) {
        if (Items[id].EnclosesPoint(Positions[id], position))
          return id;
      }
      return -1;
    }

    public bool IsPointOccupied(PackingPosition position) {
      foreach (var id in GetLayerItemIDs(position)) {
        if (Items[id].EnclosesPoint(Positions[id], position))
          return true;
      }
      return false;
    }
  }
}