Passed
Push — master ( 723f6d...528355 )
by Doug
14:53
created

OrientatedItem::getLength()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 3
Code Lines 1

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 2
CRAP Score 1

Importance

Changes 2
Bugs 2 Features 0
Metric Value
cc 1
eloc 1
c 2
b 2
f 0
nc 1
nop 0
dl 0
loc 3
ccs 2
cts 2
cp 1
crap 1
rs 10
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 JsonSerializable;
12
use Stringable;
13
14
use function atan;
15
use function min;
16
use function sort;
17
18
/**
19
 * An item to be packed.
20
 */
21
class OrientatedItem implements JsonSerializable, Stringable
22
{
23
    public readonly int $surfaceFootprint;
24
25
    /**
26
     * @var array<string, bool>
27
     */
28
    protected static array $stabilityCache = [];
29
30
    /**
31
     * @var int[]
32
     */
33
    protected array $dimensionsAsArray;
34
35 98
    public function __construct(
36
        public readonly Item $item,
37
        public readonly int $width,
38
        public readonly int $length,
39
        public readonly int $depth
40
    ) {
41 98
        $this->surfaceFootprint = $width * $length;
0 ignored issues
show
Bug introduced by
The property surfaceFootprint is declared read-only in DVDoug\BoxPacker\OrientatedItem.
Loading history...
42
43 98
        $this->dimensionsAsArray = [$width, $length, $depth];
44 98
        sort($this->dimensionsAsArray);
45
    }
46
47
    /**
48
     * Is this item stable (low centre of gravity), calculated as if the tipping point is >15 degrees.
49
     *
50 94
     * N.B. Assumes equal weight distribution.
51
     */
52 94
    public function isStable(): bool
53
    {
54
        $cacheKey = $this->width . '|' . $this->length . '|' . $this->depth;
55
56
        return static::$stabilityCache[$cacheKey] ?? (static::$stabilityCache[$cacheKey] = atan(min($this->length, $this->width) / ($this->depth ?: 1)) > 0.261);
57
    }
58 97
59
    /**
60 97
     * Is the supplied item the same size as this one?
61
     *
62
     * @internal
63
     */
64
    public function isSameDimensions(Item $item): bool
65
    {
66 97
        if ($item === $this->item) {
67
            return true;
68 97
        }
69
70
        $itemDimensions = [$item->getWidth(), $item->getLength(), $item->getDepth()];
71
        sort($itemDimensions);
72
73
        return $this->dimensionsAsArray === $itemDimensions;
74 97
    }
75
76 97
    public function jsonSerialize(): array
77
    {
78
        return [
79
            'item' => $this->item,
80
            'width' => $this->width,
81
            'length' => $this->length,
82 18
            'depth' => $this->depth,
83
        ];
84 18
    }
85
86
    public function __toString(): string
87
    {
88
        return $this->width . '|' . $this->length . '|' . $this->depth;
89
    }
90
}
91