VolumePacker::findBestOrientation() - Code Metrics - Inspection of "Hoist special-casing to before packing loop as we..." - dvdoug/BoxPacker - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( e77b1c...2d8cf3 )

by Doug

created 2016-09-22 13:43 UTC

VolumePacker::findBestOrientation() D

↳ Parent: VolumePacker

Complexity

Conditions	9
Paths	8

Size

Total Lines	36
Code Lines	21

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	21
CRAP Score	9.0076

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	36
ccs	21
cts	22
cp	0.9545
rs	4.909
cc	9
eloc	21
nc	8
nop	6
crap	9.0076

<?php
/**
 * Box packing (3D bin packing, knapsack problem)
 * @package BoxPacker
 * @author Doug Wright
 */
namespace DVDoug\BoxPacker;

use Psr\Log\LoggerAwareInterface;
use Psr\Log\LoggerAwareTrait;
use Psr\Log\NullLogger;

/**
 * Actual packer
 * @author Doug Wright
 * @package BoxPacker
 */
class VolumePacker implements LoggerAwareInterface
{
    use LoggerAwareTrait;

    /**
     * Box to pack items into
     * @var Box
     */
    protected $box;

    /**
     * List of items to be packed
     * @var ItemList
     */
    protected $items;

    /**
     * Constructor
     */
    public function __construct(Box $box, ItemList $items)
    {
        $this->box = $box;
        $this->items = $items;
        $this->logger = new NullLogger();
    }

    /**
     * Pack as many items as possible into specific given box
     * @return PackedBox packed box
     */
    public function pack()
    {
        $this->logger->debug("[EVALUATING BOX] {$this->box->getReference()}");

        $packedItems = new ItemList;
        $depthLeft = $this->box->getInnerDepth();
        $remainingWeight = $this->box->getMaxWeight() - $this->box->getEmptyWeight();
        $widthLeft = $this->box->getInnerWidth();
        $lengthLeft = $this->box->getInnerLength();

        $layerWidth = $layerLength = $layerDepth = 0;

        $prevItem = null;

        while (!$this->items->isEmpty()) {

            $itemToPack = $this->items->extract();

            //skip items that are simply too heavy
            if ($itemToPack->getWeight() > $remainingWeight) {
                continue;
            }

            $this->logger->debug("evaluating item {$itemToPack->getDescription()}");
            $this->logger->debug("remaining width: {$widthLeft}, length: {$lengthLeft}, depth: {$depthLeft}");
            $this->logger->debug("layerWidth: {$layerWidth}, layerLength: {$layerLength}, layerDepth: {$layerDepth}");

            $nextItem = !$this->items->isEmpty() ? $this->items->top() : null;
            $orientatedItem = $this->findBestOrientation($itemToPack, $prevItem, $nextItem, $widthLeft, $lengthLeft, $depthLeft);

            if ($orientatedItem) {

                $packedItems->insert($orientatedItem->getItem());
                $remainingWeight -= $itemToPack->getWeight();

                $lengthLeft -= $orientatedItem->getLength();
                $layerLength += $orientatedItem->getLength();
                $layerWidth = max($orientatedItem->getWidth(), $layerWidth);

                $layerDepth = max($layerDepth, $orientatedItem->getDepth()); //greater than 0, items will always be less deep

                //allow items to be stacked in place within the same footprint up to current layerdepth
                $maxStackDepth = $layerDepth - $orientatedItem->getDepth();
                while (!$this->items->isEmpty() && $this->canStackItemInLayer($itemToPack, $this->items->top(), $maxStackDepth, $remainingWeight)) {
                    $remainingWeight -= $this->items->top()->getWeight();
                    $maxStackDepth -= $this->items->top()->getDepth(); // XXX no attempt at best fit
                    $packedItems->insert($this->items->extract());
                }

                $prevItem = $orientatedItem;
            } else {

                $prevItem = null;

                if ($widthLeft >= min($itemToPack->getWidth(), $itemToPack->getLength()) && $this->isLayerStarted($layerWidth, $layerLength, $layerDepth)) {
                    $this->logger->debug("No more fit in lengthwise, resetting for new row");
                    $lengthLeft += $layerLength;
                    $widthLeft -= $layerWidth;
                    $layerWidth = $layerLength = 0;
                    $this->items->insert($itemToPack);
                    continue;
                } elseif ($lengthLeft < min($itemToPack->getWidth(), $itemToPack->getLength()) || $layerDepth == 0) {
                    $this->logger->debug("doesn't fit on layer even when empty");
                    continue;
                }

                $widthLeft = $layerWidth ? min(floor($layerWidth * 1.1), $this->box->getInnerWidth()) : $this->box->getInnerWidth();
                $lengthLeft = $layerLength ? min(floor($layerLength * 1.1), $this->box->getInnerLength()) : $this->box->getInnerLength();
                $depthLeft -= $layerDepth;

                $layerWidth = $layerLength = $layerDepth = 0;
                $this->logger->debug("doesn't fit, so starting next vertical layer");
                $this->items->insert($itemToPack);
            }
        }
        $this->logger->debug("done with this box");
        return new PackedBox($this->box, $packedItems, $widthLeft, $lengthLeft, $depthLeft, $remainingWeight);
    }

    /**
     * Get the best orientation for an item
     * @param Item $item
     * @param OrientatedItem|null $prevItem
     * @param Item|null $nextItem
     * @param int $widthLeft
     * @param int $lengthLeft
     * @param int $depthLeft
     * @return OrientatedItem|false
     */
    protected function findBestOrientation(Item $item, OrientatedItem $prevItem = null, Item $nextItem = null, $widthLeft, $lengthLeft, $depthLeft) {

        $orientations = $this->findPossibleOrientations($item, $prevItem, $widthLeft, $lengthLeft, $depthLeft);

        if (empty($orientations)) {
            return false;
        }

        // special casing based on next item
        if (isset($orientations[0]) && $nextItem == $item && $lengthLeft >= 2 * $item->getLength()) {
            $this->logger->debug("not rotating based on next item");
            return $orientations[0]; // XXX this is tied to the ordering from ->findPossibleOrientations()
        }

        $orientationFits = [];

        /** @var OrientatedItem $orientation */
        foreach ($orientations as $o => $orientation) {
            $orientationFit = min($widthLeft   - $orientation->getWidth(),
                                  $lengthLeft  - $orientation->getLength());

            if ($orientationFit >= 0 && $depthLeft - $orientation->getDepth() >= 0) {
                $orientationFits[$o] = $orientationFit;
            }
        }

        if ($orientationFits) {

            asort($orientationFits);
            reset($orientationFits);
            $bestFit = key($orientationFits);
            $this->logger->debug("Using orientation #{$bestFit}");
            return $orientations[$bestFit];
        } else {
            return false;
        }
    }

    /**
     * Find all possible orientations for an item
     * @param Item $item
     * @param OrientatedItem|null $prevItem
     * @param int $widthLeft
     * @param int $lengthLeft
     * @param int $depthLeft
     * @return OrientatedItem[]
     */
    protected function findPossibleOrientations(Item $item, OrientatedItem $prevItem = null, $widthLeft, $lengthLeft, $depthLeft) {

        $orientations = [];

        //Special case items that are the same as what we just packed - keep orientation
        if ($prevItem && $prevItem->getItem() == $item) {
            $orientations[] = new OrientatedItem($item, $prevItem->getWidth(), $prevItem->getLength(), $prevItem->getDepth());
        } else {

            //simple 2D rotation
            $orientations[] = new OrientatedItem($item, $item->getWidth(), $item->getLength(), $item->getDepth());
            $orientations[] = new OrientatedItem($item, $item->getLength(), $item->getWidth(), $item->getDepth());

            //add 3D rotation if we're allowed
            if (!$item->getKeepFlat()) {
                $orientations[] = new OrientatedItem($item, $item->getWidth(), $item->getDepth(), $item->getLength());
                $orientations[] = new OrientatedItem($item, $item->getLength(), $item->getDepth(), $item->getWidth());
                $orientations[] = new OrientatedItem($item, $item->getDepth(), $item->getWidth(), $item->getLength());
                $orientations[] = new OrientatedItem($item, $item->getDepth(), $item->getLength(), $item->getWidth());
            }
        }

        //remove any that simply don't fit
        return array_filter($orientations, function (OrientatedItem $i) use ($widthLeft, $lengthLeft, $depthLeft) {
            return $i->getWidth() <= $widthLeft && $i->getLength() <= $lengthLeft && $i->getDepth() <= $depthLeft;
        });

    }

    /**
     * Figure out if we can stack the next item vertically on top of this rather than side by side
     * Used when we've packed a tall item, and have just put a shorter one next to it
     * @param Item $item
     * @param Item $nextItem
     * @param $maxStackDepth
     * @param $remainingWeight
     * @return bool
     */
    protected function canStackItemInLayer(Item $item, Item $nextItem, $maxStackDepth, $remainingWeight)
    {
        return $nextItem->getDepth() <= $maxStackDepth &&
               $nextItem->getWeight() <= $remainingWeight &&
               $nextItem->getWidth() <= $item->getWidth() &&
               $nextItem->getLength() <= $item->getLength();
    }

    /**
     * @param $layerWidth
     * @param $layerLength
     * @param $layerDepth
     * @return bool
     */
    protected function isLayerStarted($layerWidth, $layerLength, $layerDepth) {
        return $layerWidth > 0 && $layerLength > 0 && $layerDepth > 0;
    }
}


1		<?php
2		/**
3		* Box packing (3D bin packing, knapsack problem)
4		* @package BoxPacker
5		* @author Doug Wright
6		*/
7		namespace DVDoug\BoxPacker;
8
9		use Psr\Log\LoggerAwareInterface;
10		use Psr\Log\LoggerAwareTrait;
11		use Psr\Log\NullLogger;
12
13		/**
14		* Actual packer
15		* @author Doug Wright
16		* @package BoxPacker
17		*/
18		class VolumePacker implements LoggerAwareInterface
19		{
20		use LoggerAwareTrait;
21
22		/**
23		* Box to pack items into
24		* @var Box
25		*/
26		protected $box;
27
28		/**
29		* List of items to be packed
30		* @var ItemList
31		*/
32		protected $items;
33
34		/**
35		* Constructor
36		*/
37	26	public function __construct(Box $box, ItemList $items)
38		{
39	26	$this->box = $box;
40	26	$this->items = $items;
41	26	$this->logger = new NullLogger();
42	26	}
43
44		/**
45		* Pack as many items as possible into specific given box
46		* @return PackedBox packed box
47		*/
48	26	public function pack()
49		{
50	26	$this->logger->debug("[EVALUATING BOX] {$this->box->getReference()}");
51
52	26	$packedItems = new ItemList;
53	26	$depthLeft = $this->box->getInnerDepth();
54	26	$remainingWeight = $this->box->getMaxWeight() - $this->box->getEmptyWeight();
55	26	$widthLeft = $this->box->getInnerWidth();
56	26	$lengthLeft = $this->box->getInnerLength();
57
58	26	$layerWidth = $layerLength = $layerDepth = 0;
59
60	26	$prevItem = null;
61
62	26	while (!$this->items->isEmpty()) {
63
64	26	$itemToPack = $this->items->extract();
65
66		//skip items that are simply too heavy
67	26	if ($itemToPack->getWeight() > $remainingWeight) {
68	4	continue;
69		}
70
71	26	$this->logger->debug("evaluating item {$itemToPack->getDescription()}");
72	26	$this->logger->debug("remaining width: {$widthLeft}, length: {$lengthLeft}, depth: {$depthLeft}");
73	26	$this->logger->debug("layerWidth: {$layerWidth}, layerLength: {$layerLength}, layerDepth: {$layerDepth}");
74
75	26	$nextItem = !$this->items->isEmpty() ? $this->items->top() : null;
76	26	$orientatedItem = $this->findBestOrientation($itemToPack, $prevItem, $nextItem, $widthLeft, $lengthLeft, $depthLeft);
77
78	26	if ($orientatedItem) {
79
80	26	$packedItems->insert($orientatedItem->getItem());
81	26	$remainingWeight -= $itemToPack->getWeight();
82
83	26	$lengthLeft -= $orientatedItem->getLength();
84	26	$layerLength += $orientatedItem->getLength();
85	26	$layerWidth = max($orientatedItem->getWidth(), $layerWidth);
86
87	26	$layerDepth = max($layerDepth, $orientatedItem->getDepth()); //greater than 0, items will always be less deep
88
89		//allow items to be stacked in place within the same footprint up to current layerdepth
90	26	$maxStackDepth = $layerDepth - $orientatedItem->getDepth();
91	26	while (!$this->items->isEmpty() && $this->canStackItemInLayer($itemToPack, $this->items->top(), $maxStackDepth, $remainingWeight)) {
92	1	$remainingWeight -= $this->items->top()->getWeight();
93	1	$maxStackDepth -= $this->items->top()->getDepth(); // XXX no attempt at best fit
94	1	$packedItems->insert($this->items->extract());
95	1	}
96
97	26	$prevItem = $orientatedItem;
98	26	} else {
99
100	23	$prevItem = null;
101
102	23	if ($widthLeft >= min($itemToPack->getWidth(), $itemToPack->getLength()) && $this->isLayerStarted($layerWidth, $layerLength, $layerDepth)) {
103	22	$this->logger->debug("No more fit in lengthwise, resetting for new row");
104	22	$lengthLeft += $layerLength;
105	22	$widthLeft -= $layerWidth;
106	22	$layerWidth = $layerLength = 0;
107	22	$this->items->insert($itemToPack);
108	22	continue;
109	18	} elseif ($lengthLeft < min($itemToPack->getWidth(), $itemToPack->getLength()) \|\| $layerDepth == 0) {
110	7	$this->logger->debug("doesn't fit on layer even when empty");
111	7	continue;
112		}
113
114	17	$widthLeft = $layerWidth ? min(floor($layerWidth * 1.1), $this->box->getInnerWidth()) : $this->box->getInnerWidth();
115	17	$lengthLeft = $layerLength ? min(floor($layerLength * 1.1), $this->box->getInnerLength()) : $this->box->getInnerLength();
116	17	$depthLeft -= $layerDepth;
117
118	17	$layerWidth = $layerLength = $layerDepth = 0;
119	17	$this->logger->debug("doesn't fit, so starting next vertical layer");
120	17	$this->items->insert($itemToPack);
121		}
122	26	}
123	26	$this->logger->debug("done with this box");
124	26	return new PackedBox($this->box, $packedItems, $widthLeft, $lengthLeft, $depthLeft, $remainingWeight);
125		}
126
127		/**
128		* Get the best orientation for an item
129		* @param Item $item
130		* @param OrientatedItem\|null $prevItem
131		* @param Item\|null $nextItem
132		* @param int $widthLeft
133		* @param int $lengthLeft
134		* @param int $depthLeft
135		* @return OrientatedItem\|false
136		*/
137	26	protected function findBestOrientation(Item $item, OrientatedItem $prevItem = null, Item $nextItem = null, $widthLeft, $lengthLeft, $depthLeft) {
138
139	26	$orientations = $this->findPossibleOrientations($item, $prevItem, $widthLeft, $lengthLeft, $depthLeft);
140
141	26	if (empty($orientations)) {
142	23	return false;
143		}
144
145		// special casing based on next item
146	26	if (isset($orientations[0]) && $nextItem == $item && $lengthLeft >= 2 * $item->getLength()) {
147	5	$this->logger->debug("not rotating based on next item");
148	5	return $orientations[0]; // XXX this is tied to the ordering from ->findPossibleOrientations()
149		}
150
151	26	$orientationFits = [];
152
153		/** @var OrientatedItem $orientation */
154	26	foreach ($orientations as $o => $orientation) {
155	26	$orientationFit = min($widthLeft - $orientation->getWidth(),
156	26	$lengthLeft - $orientation->getLength());
157
158	26	if ($orientationFit >= 0 && $depthLeft - $orientation->getDepth() >= 0) {
159	26	$orientationFits[$o] = $orientationFit;
160	26	}
161	26	}
162
163	26	if ($orientationFits) {
		0 ignored issues – show Bug Best Practice introduced 2016-06-16 21:08 UTC by Report Bug Copy Issue Report The expression `$orientationFits` of type `array` is implicitly converted to a boolean; are you sure this is intended? If so, consider using `! empty($expr)` instead to make it clear that you intend to check for an array without elements. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
164	26	asort($orientationFits);
165	26	reset($orientationFits);
166	26	$bestFit = key($orientationFits);
167	26	$this->logger->debug("Using orientation #{$bestFit}");
168	26	return $orientations[$bestFit];
169		} else {
170		return false;
171		}
172		}
173
174		/**
175		* Find all possible orientations for an item
176		* @param Item $item
177		* @param OrientatedItem\|null $prevItem
178		* @param int $widthLeft
179		* @param int $lengthLeft
180		* @param int $depthLeft
181		* @return OrientatedItem[]
182		*/
183	26	protected function findPossibleOrientations(Item $item, OrientatedItem $prevItem = null, $widthLeft, $lengthLeft, $depthLeft) {
184
185	26	$orientations = [];
186
187		//Special case items that are the same as what we just packed - keep orientation
188	26	if ($prevItem && $prevItem->getItem() == $item) {
189	9	$orientations[] = new OrientatedItem($item, $prevItem->getWidth(), $prevItem->getLength(), $prevItem->getDepth());
190	9	} else {
191
192		//simple 2D rotation
193	26	$orientations[] = new OrientatedItem($item, $item->getWidth(), $item->getLength(), $item->getDepth());
194	26	$orientations[] = new OrientatedItem($item, $item->getLength(), $item->getWidth(), $item->getDepth());
195
196		//add 3D rotation if we're allowed
197	26	if (!$item->getKeepFlat()) {
198	10	$orientations[] = new OrientatedItem($item, $item->getWidth(), $item->getDepth(), $item->getLength());
199	10	$orientations[] = new OrientatedItem($item, $item->getLength(), $item->getDepth(), $item->getWidth());
200	10	$orientations[] = new OrientatedItem($item, $item->getDepth(), $item->getWidth(), $item->getLength());
201	10	$orientations[] = new OrientatedItem($item, $item->getDepth(), $item->getLength(), $item->getWidth());
202	10	}
203		}
204
205		//remove any that simply don't fit
206	26	return array_filter($orientations, function (OrientatedItem $i) use ($widthLeft, $lengthLeft, $depthLeft) {
207	26	return $i->getWidth() <= $widthLeft && $i->getLength() <= $lengthLeft && $i->getDepth() <= $depthLeft;
208	26	});
209
210		}
211
212		/**
213		* Figure out if we can stack the next item vertically on top of this rather than side by side
214		* Used when we've packed a tall item, and have just put a shorter one next to it
215		* @param Item $item
216		* @param Item $nextItem
217		* @param $maxStackDepth
218		* @param $remainingWeight
219		* @return bool
220		*/
221	24	protected function canStackItemInLayer(Item $item, Item $nextItem, $maxStackDepth, $remainingWeight)
222		{
223	24	return $nextItem->getDepth() <= $maxStackDepth &&
224	24	$nextItem->getWeight() <= $remainingWeight &&
225	24	$nextItem->getWidth() <= $item->getWidth() &&
226	24	$nextItem->getLength() <= $item->getLength();
227		}
228
229		/**
230		* @param $layerWidth
231		* @param $layerLength
232		* @param $layerDepth
233		* @return bool
234		*/
235	23	protected function isLayerStarted($layerWidth, $layerLength, $layerDepth) {
236	23	return $layerWidth > 0 && $layerLength > 0 && $layerDepth > 0;
237		}
238		}
239

dvdoug / BoxPacker

Push — master ( e77b1c...2d8cf3 )

VolumePacker::findBestOrientation() D

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like