Packer::sanityPrecheck() - Code Metrics - Inspection of "Remove non-benchmark tests" - dvdoug/BoxPacker - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — issue_187 ( 8952f9...e99851 )

by Doug

created 2020-01-30 23:49 UTC

Packer::sanityPrecheck() A

↳ Parent: Packer

Complexity

Conditions	5
Paths	7

Size

Total Lines	15
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	8
CRAP Score	5

Importance

Changes

Metric	Value
cc	5
eloc	7
c	0
b	0
f	0
nc	7
nop	0
dl	0
loc	15
ccs	8
cts	8
cp	1
crap	5
rs	9.6111

<?php
/**
 * Box packing (3D bin packing, knapsack problem).
 *
 * @author Doug Wright
 */
declare(strict_types=1);

namespace DVDoug\BoxPacker;

use function count;
use Psr\Log\LoggerAwareInterface;
use Psr\Log\LoggerAwareTrait;
use Psr\Log\LogLevel;
use Psr\Log\NullLogger;
use SplObjectStorage;
use function usort;

/**
 * Actual packer.
 *
 * @author Doug Wright
 */
class Packer implements LoggerAwareInterface
{
    use LoggerAwareTrait;

    /**
     * Number of boxes at which balancing weight is deemed not worth it.
     *
     * @var int
     */
    protected $maxBoxesToBalanceWeight = 12;

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

    /**
     * List of box sizes available to pack items into.
     *
     * @var BoxList
     */
    protected $boxes;

    /**
     * Quantities available of each box type.
     *
     * @var SplObjectStorage
     */
    protected $boxesQtyAvailable;

    /**
     * Constructor.
     */
    public function __construct()
    {
        $this->items = new ItemList();
        $this->boxes = new BoxList();
        $this->boxesQtyAvailable = new SplObjectStorage();

        $this->logger = new NullLogger();
    }

    /**
     * Add item to be packed.
     */
    public function addItem(Item $item, int $qty = 1): void
    {
        for ($i = 0; $i < $qty; ++$i) {
            $this->items->insert($item);
        }
        $this->logger->log(LogLevel::INFO, "added {$qty} x {$item->getDescription()}", ['item' => $item]);
    }

    /**
     * Set a list of items all at once.
     */
    public function setItems(iterable $items): void
    {
        if ($items instanceof ItemList) {
            $this->items = clone $items;
        } else {
            $this->items = new ItemList();
            foreach ($items as $item) {
                $this->items->insert($item);
            }
        }
    }

    /**
     * Add box size.
     */
    public function addBox(Box $box): void
    {
        $this->boxes->insert($box);
        $this->setBoxQuantity($box, $box instanceof LimitedSupplyBox ? $box->getQuantityAvailable() : PHP_INT_MAX);
        $this->logger->log(LogLevel::INFO, "added box {$box->getReference()}", ['box' => $box]);
    }

    /**
     * Add a pre-prepared set of boxes all at once.
     */
    public function setBoxes(BoxList $boxList): void
    {
        $this->boxes = $boxList;
        foreach ($this->boxes as $box) {
            $this->setBoxQuantity($box, $box instanceof LimitedSupplyBox ? $box->getQuantityAvailable() : PHP_INT_MAX);
        }
    }

    /**
     * Set the quantity of this box type available.
     */
    public function setBoxQuantity(Box $box, int $qty): void
    {
        $this->boxesQtyAvailable[$box] = $qty;
    }

    /**
     * Number of boxes at which balancing weight is deemed not worth the extra computation time.
     */
    public function getMaxBoxesToBalanceWeight(): int
    {
        return $this->maxBoxesToBalanceWeight;
    }

    /**
     * Number of boxes at which balancing weight is deemed not worth the extra computation time.
     */
    public function setMaxBoxesToBalanceWeight(int $maxBoxesToBalanceWeight): void
    {
        $this->maxBoxesToBalanceWeight = $maxBoxesToBalanceWeight;
    }

    /**
     * Pack items into boxes.
     */
    public function pack(): PackedBoxList
    {
        $packedBoxes = $this->doVolumePacking();

        //If we have multiple boxes, try and optimise/even-out weight distribution
        if ($packedBoxes->count() > 1 && $packedBoxes->count() <= $this->maxBoxesToBalanceWeight) {
            $redistributor = new WeightRedistributor($this->boxes, $this->boxesQtyAvailable);
            $redistributor->setLogger($this->logger);
            $packedBoxes = $redistributor->redistributeWeight($packedBoxes);
        }

        $this->logger->log(LogLevel::INFO, "[PACKING COMPLETED], {$packedBoxes->count()} boxes");

        return $packedBoxes;
    }

    /**
     * Pack items into boxes using the principle of largest volume item first.
     *
     * @throws NoBoxesAvailableException
     */
    public function doVolumePacking(): PackedBoxList
    {
        $packedBoxes = new PackedBoxList();

        $this->sanityPrecheck();

        //Keep going until everything packed
        while ($this->items->count()) {
            $packedBoxesIteration = [];

            //Loop through boxes starting with smallest, see what happens
            foreach ($this->boxes as $box) {
                if ($this->boxesQtyAvailable[$box] > 0) {
                    $volumePacker = new VolumePacker($box, clone $this->items);
                    $volumePacker->setLogger($this->logger);
                    $packedBox = $volumePacker->pack();
                    if ($packedBox->getItems()->count()) {
                        $packedBoxesIteration[] = $packedBox;

                        //Have we found a single box that contains everything?
                        if ($packedBox->getItems()->count() === $this->items->count()) {
                            break;
                        }
                    }
                }
            }

            //Find best box of iteration, and remove packed items from unpacked list
            $bestBox = $this->findBestBoxFromIteration($packedBoxesIteration);

            /** @var PackedItem $packedItem */
            foreach ($bestBox->getItems() as $packedItem) {
                $this->items->remove($packedItem->getItem());
            }

            $packedBoxes->insert($bestBox);
            $this->boxesQtyAvailable[$bestBox->getBox()] = $this->boxesQtyAvailable[$bestBox->getBox()] - 1;
        }

        return $packedBoxes;
    }

    /**
     * @param PackedBox[] $packedBoxes
     */
    protected function findBestBoxFromIteration(array $packedBoxes): PackedBox
    {
        if (count($packedBoxes) === 0) {
            throw new NoBoxesAvailableException("No boxes could be found for item '{$this->items->top()->getDescription()}'", $this->items->top());
        }

        usort($packedBoxes, [$this, 'compare']);

        return $packedBoxes[0];
    }

    private function sanityPrecheck(): void
    {
        /** @var Item $item */
        foreach ($this->items as $item) {
            $possibleFits = 0;

            /** @var Box $box */
            foreach ($this->boxes as $box) {
                if ($item->getWeight() <= ($box->getMaxWeight() - $box->getEmptyWeight())) {
                    $possibleFits += count((new OrientatedItemFactory($box))->getPossibleOrientationsInEmptyBox($item));
                }
            }

            if ($possibleFits === 0) {
                throw new ItemTooLargeException("Item '{$item->getDescription()}' is too large to fit into any box", $item);
            }
        }
    }

    private static function compare(PackedBox $boxA, PackedBox $boxB): int
    {
        $choice = $boxB->getItems()->count() <=> $boxA->getItems()->count();

        if ($choice === 0) {
            $choice = $boxB->getVolumeUtilisation() <=> $boxA->getVolumeUtilisation();
        }
        if ($choice === 0) {
            $choice = $boxB->getUsedVolume() <=> $boxA->getUsedVolume();
        }

        return $choice;
    }
}


1		<?php
2		/**
3		* Box packing (3D bin packing, knapsack problem).
4		*
5		* @author Doug Wright
6		*/
7		declare(strict_types=1);
8
9		namespace DVDoug\BoxPacker;
10
11		use function count;
12		use Psr\Log\LoggerAwareInterface;
13		use Psr\Log\LoggerAwareTrait;
14		use Psr\Log\LogLevel;
15		use Psr\Log\NullLogger;
16		use SplObjectStorage;
17		use function usort;
18
19		/**
20		* Actual packer.
21		*
22		* @author Doug Wright
23		*/
24		class Packer implements LoggerAwareInterface
25		{
26		use LoggerAwareTrait;
27
28		/**
29		* Number of boxes at which balancing weight is deemed not worth it.
30		*
31		* @var int
32		*/
33		protected $maxBoxesToBalanceWeight = 12;
34
35		/**
36		* List of items to be packed.
37		*
38		* @var ItemList
39		*/
40		protected $items;
41
42		/**
43		* List of box sizes available to pack items into.
44		*
45		* @var BoxList
46		*/
47		protected $boxes;
48
49		/**
50		* Quantities available of each box type.
51		*
52		* @var SplObjectStorage
53		*/
54		protected $boxesQtyAvailable;
55
56		/**
57		* Constructor.
58		*/
59	8	public function __construct()
60		{
61	8	$this->items = new ItemList();
62	8	$this->boxes = new BoxList();
63	8	$this->boxesQtyAvailable = new SplObjectStorage();
64
65	8	$this->logger = new NullLogger();
66	8	}
67
68		/**
69		* Add item to be packed.
70		*/
71	1	public function addItem(Item $item, int $qty = 1): void
72		{
73	1	for ($i = 0; $i < $qty; ++$i) {
74	1	$this->items->insert($item);
75		}
76	1	$this->logger->log(LogLevel::INFO, "added {$qty} x {$item->getDescription()}", ['item' => $item]);
77	1	}
78
79		/**
80		* Set a list of items all at once.
81		*/
82	8	public function setItems(iterable $items): void
83		{
84	8	if ($items instanceof ItemList) {
85	7	$this->items = clone $items;
86		} else {
87	1	$this->items = new ItemList();
88	1	foreach ($items as $item) {
89	1	$this->items->insert($item);
90		}
91		}
92	8	}
93
94		/**
95		* Add box size.
96		*/
97	1	public function addBox(Box $box): void
98		{
99	1	$this->boxes->insert($box);
100	1	$this->setBoxQuantity($box, $box instanceof LimitedSupplyBox ? $box->getQuantityAvailable() : PHP_INT_MAX);
101	1	$this->logger->log(LogLevel::INFO, "added box {$box->getReference()}", ['box' => $box]);
102	1	}
103
104		/**
105		* Add a pre-prepared set of boxes all at once.
106		*/
107	8	public function setBoxes(BoxList $boxList): void
108		{
109	8	$this->boxes = $boxList;
110	8	foreach ($this->boxes as $box) {
111	8	$this->setBoxQuantity($box, $box instanceof LimitedSupplyBox ? $box->getQuantityAvailable() : PHP_INT_MAX);
112		}
113	8	}
114
115		/**
116		* Set the quantity of this box type available.
117		*/
118	8	public function setBoxQuantity(Box $box, int $qty): void
119		{
120	8	$this->boxesQtyAvailable[$box] = $qty;
121	8	}
122
123		/**
124		* Number of boxes at which balancing weight is deemed not worth the extra computation time.
125		*/
126		public function getMaxBoxesToBalanceWeight(): int
127		{
128		return $this->maxBoxesToBalanceWeight;
129		}
130
131		/**
132		* Number of boxes at which balancing weight is deemed not worth the extra computation time.
133		*/
134		public function setMaxBoxesToBalanceWeight(int $maxBoxesToBalanceWeight): void
135		{
136		$this->maxBoxesToBalanceWeight = $maxBoxesToBalanceWeight;
137		}
138
139		/**
140		* Pack items into boxes.
141		*/
142	8	public function pack(): PackedBoxList
143		{
144	8	$packedBoxes = $this->doVolumePacking();
145
146		//If we have multiple boxes, try and optimise/even-out weight distribution
147	8	if ($packedBoxes->count() > 1 && $packedBoxes->count() <= $this->maxBoxesToBalanceWeight) {
148	2	$redistributor = new WeightRedistributor($this->boxes, $this->boxesQtyAvailable);
149	2	$redistributor->setLogger($this->logger);
150	2	$packedBoxes = $redistributor->redistributeWeight($packedBoxes);
151		}
152
153	8	$this->logger->log(LogLevel::INFO, "[PACKING COMPLETED], {$packedBoxes->count()} boxes");
154
155	8	return $packedBoxes;
156		}
157
158		/**
159		* Pack items into boxes using the principle of largest volume item first.
160		*
161		* @throws NoBoxesAvailableException
162		*/
163	8	public function doVolumePacking(): PackedBoxList
164		{
165	8	$packedBoxes = new PackedBoxList();
166
167	8	$this->sanityPrecheck();
168
169		//Keep going until everything packed
170	8	while ($this->items->count()) {
171	7	$packedBoxesIteration = [];
172
173		//Loop through boxes starting with smallest, see what happens
174	7	foreach ($this->boxes as $box) {
175	7	if ($this->boxesQtyAvailable[$box] > 0) {
176	7	$volumePacker = new VolumePacker($box, clone $this->items);
177	7	$volumePacker->setLogger($this->logger);
178	7	$packedBox = $volumePacker->pack();
179	7	if ($packedBox->getItems()->count()) {
180	7	$packedBoxesIteration[] = $packedBox;
181
182		//Have we found a single box that contains everything?
183	7	if ($packedBox->getItems()->count() === $this->items->count()) {
184	7	break;
185		}
186		}
187		}
188		}
189
190		//Find best box of iteration, and remove packed items from unpacked list
191	7	$bestBox = $this->findBestBoxFromIteration($packedBoxesIteration);
192
193		/** @var PackedItem $packedItem */
194	7	foreach ($bestBox->getItems() as $packedItem) {
195	7	$this->items->remove($packedItem->getItem());
196		}
197
198	7	$packedBoxes->insert($bestBox);
199	7	$this->boxesQtyAvailable[$bestBox->getBox()] = $this->boxesQtyAvailable[$bestBox->getBox()] - 1;
200		}
201
202	8	return $packedBoxes;
203		}
204
205		/**
206		* @param PackedBox[] $packedBoxes
207		*/
208	7	protected function findBestBoxFromIteration(array $packedBoxes): PackedBox
209		{
210	7	if (count($packedBoxes) === 0) {
211		throw new NoBoxesAvailableException("No boxes could be found for item '{$this->items->top()->getDescription()}'", $this->items->top());
212		}
213
214	7	usort($packedBoxes, [$this, 'compare']);
215
216	7	return $packedBoxes[0];
217		}
218
219	8	private function sanityPrecheck(): void
220		{
221		/** @var Item $item */
222	8	foreach ($this->items as $item) {
223	8	$possibleFits = 0;
224
225		/** @var Box $box */
226	8	foreach ($this->boxes as $box) {
227	8	if ($item->getWeight() <= ($box->getMaxWeight() - $box->getEmptyWeight())) {
228	8	$possibleFits += count((new OrientatedItemFactory($box))->getPossibleOrientationsInEmptyBox($item));
229		}
230		}
231
232	8	if ($possibleFits === 0) {
233	8	throw new ItemTooLargeException("Item '{$item->getDescription()}' is too large to fit into any box", $item);
234		}
235		}
236	8	}
237
238	3	private static function compare(PackedBox $boxA, PackedBox $boxB): int
239		{
240	3	$choice = $boxB->getItems()->count() <=> $boxA->getItems()->count();
241
242	3	if ($choice === 0) {
243	1	$choice = $boxB->getVolumeUtilisation() <=> $boxA->getVolumeUtilisation();
244		}
245	3	if ($choice === 0) {
246	1	$choice = $boxB->getUsedVolume() <=> $boxA->getUsedVolume();
247		}
248
249	3	return $choice;
250		}
251		}
252

dvdoug / BoxPacker

Push — issue_187 ( 8952f9...e99851 )

Packer::sanityPrecheck() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like