Issues in VolumePacker.php - All Issues - Inspection of "Factor out orientation selection further" - dvdoug/BoxPacker - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — iterate_at_each_attempt ( 083b1f )

by Doug

created 2017-04-17 17:26 UTC

VolumePacker.php (2 issues)

Labels

Documentation 2

Severity

Informational 2

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

<?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;

    /**
     * Remaining width of the box to pack items into
     * @var int
     */
    protected $widthLeft;

    /**
     * Remaining length of the box to pack items into
     * @var int
     */
    protected $lengthLeft;

    /**
     * Remaining depth of the box to pack items into
     * @var int
     */
    protected $depthLeft;

    /**
     * Remaining weight capacity of the box
     * @var int
     */
    protected $remainingWeight;

    /**
     * Used width inside box for packing items
     * @var int
     */
    protected $usedWidth = 0;

    /**
     * Used length inside box for packing items
     * @var int
     */
    protected $usedLength = 0;

    /**
     * Used depth inside box for packing items
     * @var int
     */
    protected $usedDepth = 0;

    /**
     * @var int
     */
    protected $layerWidth = 0;

    /**
     * @var int
     */
    protected $layerLength = 0;

    /**
     * @var int
     */
    protected $layerDepth = 0;

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

        $this->box = $box;
        $this->items = $items;

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

    /**
     * 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;

        $this->layerWidth = $this->layerLength = $this->layerDepth = 0;

        $prevItem = null;

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

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

            //skip items that are simply too heavy
            if (!$this->checkNonDimensionalConstraints($itemToPack, $packedItems)) {
                continue;
            }

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

            if ($orientatedItem) {

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

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

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

                $this->usedLength = max($this->usedLength, $this->layerLength);
                $this->usedWidth = max($this->usedWidth, $this->layerWidth);

                //allow items to be stacked in place within the same footprint up to current layerdepth
                $stackableDepth = $this->layerDepth - $orientatedItem->getDepth();
                $this->tryAndStackItemsIntoSpace($packedItems, $prevItem, $nextItem, $orientatedItem->getWidth(), $orientatedItem->getLength(), $stackableDepth);

                $prevItem = $orientatedItem;

                if ($this->items->isEmpty()) {
                    $this->usedDepth += $this->layerDepth;
                }
            } else {

                $prevItem = null;

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

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

                $this->layerWidth = $this->layerLength = $this->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,
            $this->widthLeft,
            $this->lengthLeft,
            $this->depthLeft,
            $this->remainingWeight,
            $this->usedWidth,
            $this->usedLength,
            $this->usedDepth);
    }

    /**
     * @param Item $itemToPack
     * @param OrientatedItem|null $prevItem
     *
     * @return OrientatedItem|false
     */
    protected function getOrientationForItem(Item $itemToPack, OrientatedItem $prevItem = null, Item $nextItem = null, $maxWidth, $maxLength, $maxDepth)
    {
        $this->logger->debug(
            "evaluating item {$itemToPack->getDescription()} for fit",
            [
                'item' => $itemToPack,
                'space' => [
                    'maxWidth'    => $maxWidth,
                    'maxLength'   => $maxLength,
                    'maxDepth'    => $maxDepth,
                    'layerWidth'  => $this->layerWidth,
                    'layerLength' => $this->layerLength,
                    'layerDepth'  => $this->layerDepth
                ]
            ]
        );

        $orientatedItemFactory = new OrientatedItemFactory();
        $orientatedItemFactory->setLogger($this->logger);
        $orientatedItem = $orientatedItemFactory->getBestOrientation($this->box, $itemToPack, $prevItem, $nextItem, $maxWidth, $maxLength, $maxDepth);

        return $orientatedItem;
    }

    /**
     * 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 ItemList       $packedItems
     * @param OrientatedItem $prevItem

     * @param Item           $nextItem

     * @param int            $maxWidth
     * @param int            $maxLength
     * @param int            $maxDepth
     */
    protected function tryAndStackItemsIntoSpace(
        ItemList $packedItems,
        OrientatedItem $prevItem = null,
        Item $nextItem = null,
        $maxWidth,
        $maxLength,
        $maxDepth
    ) {
        while (!$this->items->isEmpty() && $this->remainingWeight >= $this->items->top()->getWeight()) {
            $stackedItem = $this->getOrientationForItem(
                $this->items->top(),
                $prevItem,
                $nextItem,
                $maxWidth,
                $maxLength,
                $maxDepth
            );
            if ($stackedItem) {
                $this->remainingWeight -= $this->items->top()->getWeight();
                $maxDepth -= $stackedItem->getDepth();
                $packedItems->insert($this->items->extract());
            } else {
                break;
            }
        }
    }

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

    /**
     * As well as purely dimensional constraints, there are other constraints that need to be met
     * e.g. weight limits or item-specific restrictions (e.g. max <x> batteries per box)
     *
     * @param Item     $itemToPack
     * @param ItemList $packedItems
     *
     * @return bool
     */
    protected function checkNonDimensionalConstraints(Item $itemToPack, ItemList $packedItems)
    {
        $weightOK = $itemToPack->getWeight() <= $this->remainingWeight;

        if ($itemToPack instanceof ConstrainedItem) {
            return $weightOK && $itemToPack->canBePackedInBox(clone $packedItems, $this->box);
        }

        return $weightOK;
    }
}


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		* Remaining width of the box to pack items into
36		* @var int
37		*/
38		protected $widthLeft;
39
40		/**
41		* Remaining length of the box to pack items into
42		* @var int
43		*/
44		protected $lengthLeft;
45
46		/**
47		* Remaining depth of the box to pack items into
48		* @var int
49		*/
50		protected $depthLeft;
51
52		/**
53		* Remaining weight capacity of the box
54		* @var int
55		*/
56		protected $remainingWeight;
57
58		/**
59		* Used width inside box for packing items
60		* @var int
61		*/
62		protected $usedWidth = 0;
63
64		/**
65		* Used length inside box for packing items
66		* @var int
67		*/
68		protected $usedLength = 0;
69
70		/**
71		* Used depth inside box for packing items
72		* @var int
73		*/
74		protected $usedDepth = 0;
75
76		/**
77		* @var int
78		*/
79		protected $layerWidth = 0;
80
81		/**
82		* @var int
83		*/
84		protected $layerLength = 0;
85
86		/**
87		* @var int
88		*/
89		protected $layerDepth = 0;
90
91		/**
92		* Constructor
93		*
94		* @param Box $box
95		* @param ItemList $items
96		*/
97	33	public function __construct(Box $box, ItemList $items)
98		{
99	33	$this->logger = new NullLogger();
100
101	33	$this->box = $box;
102	33	$this->items = $items;
103
104	33	$this->depthLeft = $this->box->getInnerDepth();
105	33	$this->remainingWeight = $this->box->getMaxWeight() - $this->box->getEmptyWeight();
106	33	$this->widthLeft = $this->box->getInnerWidth();
107	33	$this->lengthLeft = $this->box->getInnerLength();
108		}
109
110		/**
111		* Pack as many items as possible into specific given box
112		* @return PackedBox packed box
113		*/
114	33	public function pack()
115		{
116	33	$this->logger->debug("[EVALUATING BOX] {$this->box->getReference()}");
117
118	33	$packedItems = new ItemList;
119
120	33	$this->layerWidth = $this->layerLength = $this->layerDepth = 0;
121
122	33	$prevItem = null;
123
124	33	while (!$this->items->isEmpty()) {
125
126	33	$itemToPack = $this->items->extract();
127
128		//skip items that are simply too heavy
129	33	if (!$this->checkNonDimensionalConstraints($itemToPack, $packedItems)) {
130	5	continue;
131		}
132
133	33	$nextItem = !$this->items->isEmpty() ? $this->items->top() : null;
134	33	$orientatedItem = $this->getOrientationForItem($itemToPack, $prevItem, $nextItem, $this->widthLeft, $this->lengthLeft, $this->depthLeft);
135
136	33	if ($orientatedItem) {
137
138	33	$packedItems->insert($orientatedItem->getItem());
139	33	$this->remainingWeight -= $orientatedItem->getItem()->getWeight();
140
141	33	$this->lengthLeft -= $orientatedItem->getLength();
142	33	$this->layerLength += $orientatedItem->getLength();
143	33	$this->layerWidth = max($orientatedItem->getWidth(), $this->layerWidth);
144
145	33	$this->layerDepth = max($this->layerDepth, $orientatedItem->getDepth()); //greater than 0, items will always be less deep
146
147	33	$this->usedLength = max($this->usedLength, $this->layerLength);
148	33	$this->usedWidth = max($this->usedWidth, $this->layerWidth);
149
150		//allow items to be stacked in place within the same footprint up to current layerdepth
151	33	$stackableDepth = $this->layerDepth - $orientatedItem->getDepth();
152	33	$this->tryAndStackItemsIntoSpace($packedItems, $prevItem, $nextItem, $orientatedItem->getWidth(), $orientatedItem->getLength(), $stackableDepth);
153
154	33	$prevItem = $orientatedItem;
155
156	33	if ($this->items->isEmpty()) {
157	33	$this->usedDepth += $this->layerDepth;
158		}
159		} else {
160
161	25	$prevItem = null;
162
163	25	if ($this->widthLeft >= min($itemToPack->getWidth(), $itemToPack->getLength()) && $this->isLayerStarted()) {
164	24	$this->logger->debug("No more fit in lengthwise, resetting for new row");
165	24	$this->lengthLeft += $this->layerLength;
166	24	$this->widthLeft -= $this->layerWidth;
167	24	$this->layerWidth = $this->layerLength = 0;
168	24	$this->items->insert($itemToPack);
169	24	continue;
170	19	} elseif ($this->lengthLeft < min($itemToPack->getWidth(), $itemToPack->getLength()) \|\| $this->layerDepth == 0) {
171	8	$this->logger->debug("doesn't fit on layer even when empty");
172	8	$this->usedDepth += $this->layerDepth;
173	8	continue;
174		}
175
176	17	$this->widthLeft = $this->layerWidth ? min(floor($this->layerWidth * 1.1), $this->box->getInnerWidth()) : $this->box->getInnerWidth();
177	17	$this->lengthLeft = $this->layerLength ? min(floor($this->layerLength * 1.1), $this->box->getInnerLength()) : $this->box->getInnerLength();
178	17	$this->depthLeft -= $this->layerDepth;
179	17	$this->usedDepth += $this->layerDepth;
180
181	17	$this->layerWidth = $this->layerLength = $this->layerDepth = 0;
182	17	$this->logger->debug("doesn't fit, so starting next vertical layer");
183	17	$this->items->insert($itemToPack);
184		}
185		}
186	33	$this->logger->debug("done with this box");
187	33	return new PackedBox(
188	33	$this->box,
189		$packedItems,
190	33	$this->widthLeft,
191	33	$this->lengthLeft,
192	33	$this->depthLeft,
193	33	$this->remainingWeight,
194	33	$this->usedWidth,
195	33	$this->usedLength,
196	33	$this->usedDepth);
197		}
198
199		/**
200		* @param Item $itemToPack
201		* @param OrientatedItem\|null $prevItem
202		*
203		* @return OrientatedItem\|false
204		*/
205	33	protected function getOrientationForItem(Item $itemToPack, OrientatedItem $prevItem = null, Item $nextItem = null, $maxWidth, $maxLength, $maxDepth)
206		{
207	33	$this->logger->debug(
208	33	"evaluating item {$itemToPack->getDescription()} for fit",
209		[
210	33	'item' => $itemToPack,
211		'space' => [
212	33	'maxWidth' => $maxWidth,
213	33	'maxLength' => $maxLength,
214	33	'maxDepth' => $maxDepth,
215	33	'layerWidth' => $this->layerWidth,
216	33	'layerLength' => $this->layerLength,
217	33	'layerDepth' => $this->layerDepth
218		]
219		]
220		);
221
222	33	$orientatedItemFactory = new OrientatedItemFactory();
223	33	$orientatedItemFactory->setLogger($this->logger);
224	33	$orientatedItem = $orientatedItemFactory->getBestOrientation($this->box, $itemToPack, $prevItem, $nextItem, $maxWidth, $maxLength, $maxDepth);
225
226	33	return $orientatedItem;
227		}
228
229		/**
230		* Figure out if we can stack the next item vertically on top of this rather than side by side
231		* Used when we've packed a tall item, and have just put a shorter one next to it
232		*
233		* @param ItemList $packedItems
234		* @param OrientatedItem $prevItem
		0 ignored issues – show Documentation introduced 2017-01-07 19:45 UTC by Report Bug Copy Issue Report Show Similar Issues like this Should the type for parameter `$prevItem` not be `null\|OrientatedItem`? This check looks for `@param` annotations where the type inferred by our type inference engine differs from the declared type. It makes a suggestion as to what type it considers more descriptive. Most often this is a case of a parameter that can be null in addition to its declared types. Loading history...
235		* @param Item $nextItem
		0 ignored issues – show Documentation introduced 2017-01-07 19:45 UTC by Report Bug Copy Issue Report Show Similar Issues like this Should the type for parameter `$nextItem` not be `null\|Item`? This check looks for `@param` annotations where the type inferred by our type inference engine differs from the declared type. It makes a suggestion as to what type it considers more descriptive. Most often this is a case of a parameter that can be null in addition to its declared types. Loading history...
236		* @param int $maxWidth
237		* @param int $maxLength
238		* @param int $maxDepth
239		*/
240	33	protected function tryAndStackItemsIntoSpace(
241		ItemList $packedItems,
242		OrientatedItem $prevItem = null,
243		Item $nextItem = null,
244		$maxWidth,
245		$maxLength,
246		$maxDepth
247		) {
248	33	while (!$this->items->isEmpty() && $this->remainingWeight >= $this->items->top()->getWeight()) {
249	31	$stackedItem = $this->getOrientationForItem(
250	31	$this->items->top(),
251		$prevItem,
252		$nextItem,
253		$maxWidth,
254		$maxLength,
255		$maxDepth
256		);
257	31	if ($stackedItem) {
258	3	$this->remainingWeight -= $this->items->top()->getWeight();
259	3	$maxDepth -= $stackedItem->getDepth();
260	3	$packedItems->insert($this->items->extract());
261		} else {
262	31	break;
263		}
264		}
265		}
266
267		/**
268		* @return bool
269		*/
270	25	protected function isLayerStarted()
271		{
272	25	return $this->layerWidth > 0 && $this->layerLength > 0 && $this->layerDepth > 0;
273		}
274
275		/**
276		* As well as purely dimensional constraints, there are other constraints that need to be met
277		* e.g. weight limits or item-specific restrictions (e.g. max <x> batteries per box)
278		*
279		* @param Item $itemToPack
280		* @param ItemList $packedItems
281		*
282		* @return bool
283		*/
284	33	protected function checkNonDimensionalConstraints(Item $itemToPack, ItemList $packedItems)
285		{
286	33	$weightOK = $itemToPack->getWeight() <= $this->remainingWeight;
287
288	33	if ($itemToPack instanceof ConstrainedItem) {
289	1	return $weightOK && $itemToPack->canBePackedInBox(clone $packedItems, $this->box);
290		}
291
292	32	return $weightOK;
293		}
294		}
295

dvdoug / BoxPacker

Push — iterate_at_each_attempt ( 083b1f )

VolumePacker.php (2 issues)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Duplication Side-by-Side

Filter issues like