|
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 array_filter; |
|
12
|
|
|
use function array_merge; |
|
13
|
|
|
use function count; |
|
14
|
|
|
use function iterator_to_array; |
|
15
|
|
|
use Psr\Log\LoggerAwareInterface; |
|
16
|
|
|
use Psr\Log\LoggerAwareTrait; |
|
17
|
|
|
use Psr\Log\LogLevel; |
|
18
|
|
|
use Psr\Log\NullLogger; |
|
19
|
|
|
use SplObjectStorage; |
|
20
|
|
|
use function usort; |
|
21
|
|
|
|
|
22
|
|
|
/** |
|
23
|
|
|
* Actual packer. |
|
24
|
|
|
* |
|
25
|
|
|
* @author Doug Wright |
|
26
|
|
|
* @internal |
|
27
|
|
|
*/ |
|
28
|
|
|
class WeightRedistributor implements LoggerAwareInterface |
|
29
|
|
|
{ |
|
30
|
|
|
use LoggerAwareTrait; |
|
31
|
|
|
|
|
32
|
|
|
/** |
|
33
|
|
|
* List of box sizes available to pack items into. |
|
34
|
|
|
* |
|
35
|
|
|
* @var BoxList |
|
36
|
|
|
*/ |
|
37
|
|
|
private $boxes; |
|
38
|
|
|
|
|
39
|
|
|
/** |
|
40
|
|
|
* Quantities available of each box type. |
|
41
|
|
|
* |
|
42
|
|
|
* @var SplObjectStorage |
|
43
|
|
|
*/ |
|
44
|
|
|
private $boxesQtyAvailable; |
|
45
|
|
|
|
|
46
|
|
|
/** |
|
47
|
|
|
* Constructor. |
|
48
|
|
|
*/ |
|
49
|
2 |
|
public function __construct(BoxList $boxList, SplObjectStorage $boxQuantitiesAvailable) |
|
50
|
|
|
{ |
|
51
|
2 |
|
$this->boxes = $boxList; |
|
52
|
2 |
|
$this->boxesQtyAvailable = $boxQuantitiesAvailable; |
|
53
|
2 |
|
$this->logger = new NullLogger(); |
|
54
|
2 |
|
} |
|
55
|
|
|
|
|
56
|
|
|
/** |
|
57
|
|
|
* Given a solution set of packed boxes, repack them to achieve optimum weight distribution. |
|
58
|
|
|
*/ |
|
59
|
2 |
|
public function redistributeWeight(PackedBoxList $originalBoxes): PackedBoxList |
|
60
|
|
|
{ |
|
61
|
2 |
|
$targetWeight = $originalBoxes->getMeanItemWeight(); |
|
62
|
2 |
|
$this->logger->log(LogLevel::DEBUG, "repacking for weight distribution, weight variance {$originalBoxes->getWeightVariance()}, target weight {$targetWeight}"); |
|
63
|
|
|
|
|
64
|
|
|
/** @var PackedBox[] $boxes */ |
|
65
|
2 |
|
$boxes = iterator_to_array($originalBoxes); |
|
66
|
|
|
|
|
67
|
|
|
usort($boxes, static function (PackedBox $boxA, PackedBox $boxB) { |
|
68
|
2 |
|
return $boxB->getWeight() <=> $boxA->getWeight(); |
|
69
|
2 |
|
}); |
|
70
|
|
|
|
|
71
|
|
|
do { |
|
72
|
2 |
|
$iterationSuccessful = false; |
|
73
|
|
|
|
|
74
|
2 |
|
foreach ($boxes as $a => &$boxA) { |
|
75
|
2 |
|
foreach ($boxes as $b => &$boxB) { |
|
76
|
2 |
|
if ($b <= $a || $boxA->getWeight() === $boxB->getWeight()) { |
|
77
|
2 |
|
continue; //no need to evaluate |
|
78
|
|
|
} |
|
79
|
|
|
|
|
80
|
2 |
|
$iterationSuccessful = $this->equaliseWeight($boxA, $boxB, $targetWeight); |
|
81
|
2 |
|
if ($iterationSuccessful) { |
|
82
|
|
|
$boxes = array_filter($boxes, static function (?PackedBox $box) { //remove any now-empty boxes from the list |
|
83
|
1 |
|
return $box instanceof PackedBox; |
|
84
|
1 |
|
}); |
|
85
|
2 |
|
break 2; |
|
86
|
|
|
} |
|
87
|
|
|
} |
|
88
|
|
|
} |
|
89
|
2 |
|
} while ($iterationSuccessful); |
|
90
|
|
|
|
|
91
|
|
|
//Combine back into a single list |
|
92
|
2 |
|
$packedBoxes = new PackedBoxList(); |
|
93
|
2 |
|
$packedBoxes->insertFromArray($boxes); |
|
94
|
|
|
|
|
95
|
2 |
|
return $packedBoxes; |
|
96
|
|
|
} |
|
97
|
|
|
|
|
98
|
|
|
/** |
|
99
|
|
|
* Attempt to equalise weight distribution between 2 boxes. |
|
100
|
|
|
* |
|
101
|
|
|
* @return bool was the weight rebalanced? |
|
102
|
|
|
*/ |
|
103
|
2 |
|
private function equaliseWeight(PackedBox &$boxA, PackedBox &$boxB, float $targetWeight): bool |
|
104
|
|
|
{ |
|
105
|
2 |
|
$anyIterationSuccessful = false; |
|
106
|
|
|
|
|
107
|
2 |
|
if ($boxA->getWeight() > $boxB->getWeight()) { |
|
108
|
2 |
|
$overWeightBox = $boxA; |
|
109
|
2 |
|
$underWeightBox = $boxB; |
|
110
|
|
|
} else { |
|
111
|
1 |
|
$overWeightBox = $boxB; |
|
112
|
1 |
|
$underWeightBox = $boxA; |
|
113
|
|
|
} |
|
114
|
|
|
|
|
115
|
2 |
|
$overWeightBoxItems = $overWeightBox->getItems()->asItemArray(); |
|
116
|
2 |
|
$underWeightBoxItems = $underWeightBox->getItems()->asItemArray(); |
|
117
|
|
|
|
|
118
|
2 |
|
foreach ($overWeightBoxItems as $key => $overWeightItem) { |
|
119
|
2 |
|
if ($overWeightItem->getWeight() + $underWeightBox->getItemWeight() > $targetWeight) { |
|
120
|
2 |
|
continue; // moving this item would harm more than help |
|
121
|
|
|
} |
|
122
|
|
|
|
|
123
|
1 |
|
$newLighterBoxes = $this->doVolumeRepack(array_merge($underWeightBoxItems, [$overWeightItem]), $underWeightBox->getBox()); |
|
124
|
1 |
|
if ($newLighterBoxes->count() !== 1) { |
|
125
|
|
|
continue; //only want to move this item if it still fits in a single box |
|
126
|
|
|
} |
|
127
|
|
|
|
|
128
|
1 |
|
$underWeightBoxItems[] = $overWeightItem; |
|
129
|
|
|
|
|
130
|
1 |
|
if (count($overWeightBoxItems) === 1) { //sometimes a repack can be efficient enough to eliminate a box |
|
131
|
|
|
$boxB = $newLighterBoxes->top(); |
|
132
|
|
|
$boxA = null; |
|
133
|
|
|
$this->boxesQtyAvailable[$boxB->getBox()] = $this->boxesQtyAvailable[$boxB->getBox()] - 1; |
|
134
|
|
|
$this->boxesQtyAvailable[$overWeightBox->getBox()] = $this->boxesQtyAvailable[$overWeightBox->getBox()] + 1; |
|
135
|
|
|
|
|
136
|
|
|
return true; |
|
137
|
|
|
} |
|
138
|
|
|
|
|
139
|
1 |
|
unset($overWeightBoxItems[$key]); |
|
140
|
1 |
|
$newHeavierBoxes = $this->doVolumeRepack($overWeightBoxItems, $overWeightBox->getBox()); |
|
141
|
1 |
|
if (count($newHeavierBoxes) !== 1) { |
|
142
|
|
|
continue; //this should never happen, if we can pack n+1 into the box, we should be able to pack n |
|
143
|
|
|
} |
|
144
|
|
|
|
|
145
|
1 |
|
if (static::didRepackActuallyHelp($boxA, $boxB, $newHeavierBoxes->top(), $newLighterBoxes->top())) { |
|
146
|
1 |
|
$this->boxesQtyAvailable[$boxA->getBox()] = $this->boxesQtyAvailable[$boxA->getBox()] + 1; |
|
147
|
1 |
|
$this->boxesQtyAvailable[$boxB->getBox()] = $this->boxesQtyAvailable[$boxB->getBox()] + 1; |
|
148
|
1 |
|
$this->boxesQtyAvailable[$newHeavierBoxes->top()->getBox()] = $this->boxesQtyAvailable[$newHeavierBoxes->top()->getBox()] - 1; |
|
149
|
1 |
|
$this->boxesQtyAvailable[$newLighterBoxes->top()->getBox()] = $this->boxesQtyAvailable[$newLighterBoxes->top()->getBox()] - 1; |
|
150
|
1 |
|
$underWeightBox = $boxB = $newLighterBoxes->top(); |
|
151
|
1 |
|
$boxA = $newHeavierBoxes->top(); |
|
152
|
|
|
|
|
153
|
1 |
|
$anyIterationSuccessful = true; |
|
154
|
|
|
} |
|
155
|
|
|
} |
|
156
|
|
|
|
|
157
|
2 |
|
return $anyIterationSuccessful; |
|
158
|
|
|
} |
|
159
|
|
|
|
|
160
|
|
|
/** |
|
161
|
|
|
* Do a volume repack of a set of items. |
|
162
|
|
|
*/ |
|
163
|
1 |
|
private function doVolumeRepack(iterable $items, Box $currentBox): PackedBoxList |
|
164
|
|
|
{ |
|
165
|
1 |
|
$packer = new Packer(); |
|
166
|
1 |
|
$packer->setBoxes($this->boxes); // use the full set of boxes to allow smaller/larger for full efficiency |
|
167
|
1 |
|
foreach ($this->boxes as $box) { |
|
168
|
1 |
|
$packer->setBoxQuantity($box, $this->boxesQtyAvailable[$box]); |
|
169
|
|
|
} |
|
170
|
1 |
|
$packer->setBoxQuantity($currentBox, max(PHP_INT_MAX, $this->boxesQtyAvailable[$currentBox] + 1)); |
|
171
|
1 |
|
$packer->setItems($items); |
|
172
|
|
|
|
|
173
|
1 |
|
return $packer->doVolumePacking(); |
|
174
|
|
|
} |
|
175
|
|
|
|
|
176
|
|
|
/** |
|
177
|
|
|
* Not every attempted repack is actually helpful - sometimes moving an item between two otherwise identical |
|
178
|
|
|
* boxes, or sometimes the box used for the now lighter set of items actually weighs more when empty causing |
|
179
|
|
|
* an increase in total weight. |
|
180
|
|
|
*/ |
|
181
|
1 |
|
private static function didRepackActuallyHelp(PackedBox $oldBoxA, PackedBox $oldBoxB, PackedBox $newBoxA, PackedBox $newBoxB): bool |
|
182
|
|
|
{ |
|
183
|
1 |
|
$oldList = new PackedBoxList(); |
|
184
|
1 |
|
$oldList->insertFromArray([$oldBoxA, $oldBoxB]); |
|
185
|
|
|
|
|
186
|
1 |
|
$newList = new PackedBoxList(); |
|
187
|
1 |
|
$newList->insertFromArray([$newBoxA, $newBoxB]); |
|
188
|
|
|
|
|
189
|
1 |
|
return $newList->getWeightVariance() < $oldList->getWeightVariance(); |
|
190
|
|
|
} |
|
191
|
|
|
} |
|
192
|
|
|
|
dvdoug /
BoxPacker
