VolumePacker::pack() - Code Metrics - Inspection of "Factor out volume packer into own class" - dvdoug/BoxPacker - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( e1493c...297f74 )

by Doug

created 2016-01-31 17:41 UTC

VolumePacker::pack() C

↳ Parent: VolumePacker

Complexity

Conditions	14
Paths	16

Size

Total Lines	78
Code Lines	56

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	78
rs	5.1581
cc	14
eloc	56
nc	16
nop	0

How to fix Long Method Complexity

<?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\LogLevel;
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->log(LogLevel::DEBUG, "[EVALUATING BOX] {$this->box->getReference()}");

        $packedItems = new ItemList;
        $remainingDepth = $this->box->getInnerDepth();
        $remainingWeight = $this->box->getMaxWeight() - $this->box->getEmptyWeight();
        $remainingWidth = $this->box->getInnerWidth();
        $remainingLength = $this->box->getInnerLength();

        $layerWidth = $layerLength = $layerDepth = 0;
        while (!$this->items->isEmpty()) {

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

            //skip items that are simply too large
            if ($this->isItemTooLargeForBox($itemToPack, $remainingDepth, $remainingWeight)) {
                $this->items->extract();
                continue;
            }

            $this->logger->log(LogLevel::DEBUG, "evaluating item {$itemToPack->getDescription()}");
            $this->logger->log(LogLevel::DEBUG, "remaining width: {$remainingWidth}, length: {$remainingLength}, depth: {$remainingDepth}");
            $this->logger->log(LogLevel::DEBUG, "layerWidth: {$layerWidth}, layerLength: {$layerLength}, layerDepth: {$layerDepth}");

            $itemWidth = $itemToPack->getWidth();
            $itemLength = $itemToPack->getLength();

            if ($this->fitsGap($itemToPack, $remainingWidth, $remainingLength)) {

                $packedItems->insert($this->items->extract());
                $remainingWeight -= $itemToPack->getWeight();

                $nextItem = !$this->items->isEmpty() ? $this->items->top() : null;
                if ($this->fitsBetterRotated($itemToPack, $nextItem, $remainingWidth, $remainingLength)) {
                    $this->logger->log(LogLevel::DEBUG, "fits (better) unrotated");
                    $remainingLength -= $itemLength;
                    $layerLength += $itemLength;
                    $layerWidth = max($itemWidth, $layerWidth);
                } else {
                    $this->logger->log(LogLevel::DEBUG, "fits (better) rotated");
                    $remainingLength -= $itemWidth;
                    $layerLength += $itemWidth;
                    $layerWidth = max($itemLength, $layerWidth);
                }
                $layerDepth = max($layerDepth, $itemToPack->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 - $itemToPack->getDepth();
                while (!$this->items->isEmpty() && $this->canStackItemInLayer($itemToPack, $this->items->top(), $maxStackDepth, $remainingWeight)) {
                    $remainingWeight -= $this->items->top()->getWeight();
                    $maxStackDepth -= $this->items->top()->getDepth();
                    $packedItems->insert($this->items->extract());
                }
            } else {
                if ($remainingWidth >= min($itemWidth, $itemLength) && $this->isLayerStarted($layerWidth, $layerLength, $layerDepth)) {
                    $this->logger->log(LogLevel::DEBUG, "No more fit in lengthwise, resetting for new row");
                    $remainingLength += $layerLength;
                    $remainingWidth -= $layerWidth;
                    $layerWidth = $layerLength = 0;
                    continue;
                } elseif ($remainingLength < min($itemWidth, $itemLength) || $layerDepth == 0) {
                    $this->logger->log(LogLevel::DEBUG, "doesn't fit on layer even when empty");
                    $this->items->extract();
                    continue;
                }

                $remainingWidth = $layerWidth ? min(floor($layerWidth * 1.1), $this->box->getInnerWidth()) : $this->box->getInnerWidth();
                $remainingLength = $layerLength ? min(floor($layerLength * 1.1), $this->box->getInnerLength()) : $this->box->getInnerLength();
                $remainingDepth -= $layerDepth;

                $layerWidth = $layerLength = $layerDepth = 0;
                $this->logger->log(LogLevel::DEBUG, "doesn't fit, so starting next vertical layer");
            }
        }
        $this->logger->log(LogLevel::DEBUG, "done with this box");
        return new PackedBox($this->box, $packedItems, $remainingWidth, $remainingLength, $remainingDepth, $remainingWeight);
    }

    /**
     * @param Item $item
     * @param int $remainingDepth
     * @param int $remainingWeight
     * @return bool
     */
    protected function isItemTooLargeForBox(Item $item, $remainingDepth, $remainingWeight) {
        return $item->getDepth() > $remainingDepth || $item->getWeight() > $remainingWeight;
    }

    /**
     * Figure out space left for next item if we pack this one in it's regular orientation
     * @param Item $item
     * @param int $remainingWidth
     * @param int $remainingLength
     * @return int
     */
    protected function fitsSameGap(Item $item, $remainingWidth, $remainingLength) {
        return min($remainingWidth - $item->getWidth(), $remainingLength - $item->getLength());
    }

    /**
     * Figure out space left for next item if we pack this one rotated by 90deg
     * @param Item $item
     * @param int $remainingWidth
     * @param int $remainingLength
     * @return int
     */
    protected function fitsRotatedGap(Item $item, $remainingWidth, $remainingLength) {
        return min($remainingWidth - $item->getLength(), $remainingLength - $item->getWidth());
    }

    /**
     * @param Item $item
     * @param Item|null $nextItem
     * @param $remainingWidth
     * @param $remainingLength
     * @return bool
     */
    protected function fitsBetterRotated(Item $item, Item $nextItem = null, $remainingWidth, $remainingLength) {

        $fitsSameGap = $this->fitsSameGap($item, $remainingWidth, $remainingLength);
        $fitsRotatedGap = $this->fitsRotatedGap($item, $remainingWidth, $remainingLength);

        return !!($fitsRotatedGap < 0 ||
        ($fitsSameGap >= 0 && $fitsSameGap <= $fitsRotatedGap) ||
        ($item->getWidth() <= $remainingWidth && $nextItem == $item && $remainingLength >= 2 * $item->getLength()));
    }

    /**
     * Does item fit in specified gap
     * @param Item $item
     * @param $remainingWidth
     * @param $remainingLength
     * @return bool
     */
    protected function fitsGap(Item $item, $remainingWidth, $remainingLength) {
        return $this->fitsSameGap($item, $remainingWidth, $remainingLength) >= 0 ||
               $this->fitsRotatedGap($item, $remainingWidth, $remainingLength) >= 0;
    }

    /**
     * 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\LogLevel;
12			use Psr\Log\NullLogger;
13
14			/**
15			* Actual packer
16			* @author Doug Wright
17			* @package BoxPacker
18			*/
19			class VolumePacker implements LoggerAwareInterface
20			{
21			use LoggerAwareTrait;
22
23			/**
24			* Box to pack items into
25			* @var Box
26			*/
27			protected $box;
28
29			/**
30			* List of items to be packed
31			* @var ItemList
32			*/
33			protected $items;
34
35			/**
36			* Constructor
37			*/
38			public function __construct(Box $box, ItemList $items)
39			{
40			$this->box = $box;
41			$this->items = $items;
42			$this->logger = new NullLogger();
43			}
44
45			/**
46			* Pack as many items as possible into specific given box
47			* @return PackedBox packed box
48			*/
49			public function pack()
50			{
51			$this->logger->log(LogLevel::DEBUG, "[EVALUATING BOX] {$this->box->getReference()}");
52
53			$packedItems = new ItemList;
54			$remainingDepth = $this->box->getInnerDepth();
55			$remainingWeight = $this->box->getMaxWeight() - $this->box->getEmptyWeight();
56			$remainingWidth = $this->box->getInnerWidth();
57			$remainingLength = $this->box->getInnerLength();
58
59			$layerWidth = $layerLength = $layerDepth = 0;
60			while (!$this->items->isEmpty()) {
61
62			$itemToPack = $this->items->top();
63
64			//skip items that are simply too large
65			if ($this->isItemTooLargeForBox($itemToPack, $remainingDepth, $remainingWeight)) {
66			$this->items->extract();
67			continue;
68			}
69
70			$this->logger->log(LogLevel::DEBUG, "evaluating item {$itemToPack->getDescription()}");
71			$this->logger->log(LogLevel::DEBUG, "remaining width: {$remainingWidth}, length: {$remainingLength}, depth: {$remainingDepth}");
72			$this->logger->log(LogLevel::DEBUG, "layerWidth: {$layerWidth}, layerLength: {$layerLength}, layerDepth: {$layerDepth}");
73
74			$itemWidth = $itemToPack->getWidth();
75			$itemLength = $itemToPack->getLength();
76
77			if ($this->fitsGap($itemToPack, $remainingWidth, $remainingLength)) {
78
79			$packedItems->insert($this->items->extract());
80			$remainingWeight -= $itemToPack->getWeight();
81
82			$nextItem = !$this->items->isEmpty() ? $this->items->top() : null;
83			if ($this->fitsBetterRotated($itemToPack, $nextItem, $remainingWidth, $remainingLength)) {
84			$this->logger->log(LogLevel::DEBUG, "fits (better) unrotated");
85			$remainingLength -= $itemLength;
86			$layerLength += $itemLength;
87			$layerWidth = max($itemWidth, $layerWidth);
88			} else {
89			$this->logger->log(LogLevel::DEBUG, "fits (better) rotated");
90			$remainingLength -= $itemWidth;
91			$layerLength += $itemWidth;
92			$layerWidth = max($itemLength, $layerWidth);
93			}
94			$layerDepth = max($layerDepth, $itemToPack->getDepth()); //greater than 0, items will always be less deep
95
96			//allow items to be stacked in place within the same footprint up to current layerdepth
97			$maxStackDepth = $layerDepth - $itemToPack->getDepth();
98			while (!$this->items->isEmpty() && $this->canStackItemInLayer($itemToPack, $this->items->top(), $maxStackDepth, $remainingWeight)) {
99			$remainingWeight -= $this->items->top()->getWeight();
100			$maxStackDepth -= $this->items->top()->getDepth();
101			$packedItems->insert($this->items->extract());
102			}
103			} else {
104			if ($remainingWidth >= min($itemWidth, $itemLength) && $this->isLayerStarted($layerWidth, $layerLength, $layerDepth)) {
105			$this->logger->log(LogLevel::DEBUG, "No more fit in lengthwise, resetting for new row");
106			$remainingLength += $layerLength;
107			$remainingWidth -= $layerWidth;
108			$layerWidth = $layerLength = 0;
109			continue;
110			} elseif ($remainingLength < min($itemWidth, $itemLength) \|\| $layerDepth == 0) {
111			$this->logger->log(LogLevel::DEBUG, "doesn't fit on layer even when empty");
112			$this->items->extract();
113			continue;
114			}
115
116			$remainingWidth = $layerWidth ? min(floor($layerWidth * 1.1), $this->box->getInnerWidth()) : $this->box->getInnerWidth();
117			$remainingLength = $layerLength ? min(floor($layerLength * 1.1), $this->box->getInnerLength()) : $this->box->getInnerLength();
118			$remainingDepth -= $layerDepth;
119
120			$layerWidth = $layerLength = $layerDepth = 0;
121			$this->logger->log(LogLevel::DEBUG, "doesn't fit, so starting next vertical layer");
122			}
123			}
124			$this->logger->log(LogLevel::DEBUG, "done with this box");
125			return new PackedBox($this->box, $packedItems, $remainingWidth, $remainingLength, $remainingDepth, $remainingWeight);
126			}
127
128			/**
129			* @param Item $item
130			* @param int $remainingDepth
131			* @param int $remainingWeight
132			* @return bool
133			*/
134			protected function isItemTooLargeForBox(Item $item, $remainingDepth, $remainingWeight) {
135			return $item->getDepth() > $remainingDepth \|\| $item->getWeight() > $remainingWeight;
136			}
137
138			/**
139			* Figure out space left for next item if we pack this one in it's regular orientation
140			* @param Item $item
141			* @param int $remainingWidth
142			* @param int $remainingLength
143			* @return int
144			*/
145			protected function fitsSameGap(Item $item, $remainingWidth, $remainingLength) {
146			return min($remainingWidth - $item->getWidth(), $remainingLength - $item->getLength());
147			}
148
149			/**
150			* Figure out space left for next item if we pack this one rotated by 90deg
151			* @param Item $item
152			* @param int $remainingWidth
153			* @param int $remainingLength
154			* @return int
155			*/
156			protected function fitsRotatedGap(Item $item, $remainingWidth, $remainingLength) {
157			return min($remainingWidth - $item->getLength(), $remainingLength - $item->getWidth());
158			}
159
160			/**
161			* @param Item $item
162			* @param Item\|null $nextItem
163			* @param $remainingWidth
164			* @param $remainingLength
165			* @return bool
166			*/
167			protected function fitsBetterRotated(Item $item, Item $nextItem = null, $remainingWidth, $remainingLength) {
168
169			$fitsSameGap = $this->fitsSameGap($item, $remainingWidth, $remainingLength);
170			$fitsRotatedGap = $this->fitsRotatedGap($item, $remainingWidth, $remainingLength);
171
172			return !!($fitsRotatedGap < 0 \|\|
173			($fitsSameGap >= 0 && $fitsSameGap <= $fitsRotatedGap) \|\|
174			($item->getWidth() <= $remainingWidth && $nextItem == $item && $remainingLength >= 2 * $item->getLength()));
175			}
176
177			/**
178			* Does item fit in specified gap
179			* @param Item $item
180			* @param $remainingWidth
181			* @param $remainingLength
182			* @return bool
183			*/
184			protected function fitsGap(Item $item, $remainingWidth, $remainingLength) {
185			return $this->fitsSameGap($item, $remainingWidth, $remainingLength) >= 0 \|\|
186			$this->fitsRotatedGap($item, $remainingWidth, $remainingLength) >= 0;
187			}
188
189			/**
190			* Figure out if we can stack the next item vertically on top of this rather than side by side
191			* Used when we've packed a tall item, and have just put a shorter one next to it
192			* @param Item $item
193			* @param Item $nextItem
194			* @param $maxStackDepth
195			* @param $remainingWeight
196			* @return bool
197			*/
198			protected function canStackItemInLayer(Item $item, Item $nextItem, $maxStackDepth, $remainingWeight)
199			{
200			return $nextItem->getDepth() <= $maxStackDepth &&
201			$nextItem->getWeight() <= $remainingWeight &&
202			$nextItem->getWidth() <= $item->getWidth() &&
203			$nextItem->getLength() <= $item->getLength();
204			}
205
206			/**
207			* @param $layerWidth
208			* @param $layerLength
209			* @param $layerDepth
210			* @return bool
211			*/
212			protected function isLayerStarted($layerWidth, $layerLength, $layerDepth) {
213			return $layerWidth > 0 && $layerLength > 0 && $layerDepth > 0;
214			}
215			}
216

dvdoug / BoxPacker

Push — master ( e1493c...297f74 )

VolumePacker::pack() C

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like