PackedBox::getInnerVolume() - Code Metrics - Inspection of "Remove getInnerVolume from Box interface - the lib..." - dvdoug/BoxPacker - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 2dde72...6f5502 )

by Doug

created 2017-08-19 17:09 UTC

PackedBox::getInnerVolume() A

↳ Parent: PackedBox

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	4
c	0
b	0
f	0
ccs	2
cts	2
cp	1
rs	10
cc	1
eloc	2
nc	1
nop	0
crap	1

<?php
/**
 * Box packing (3D bin packing, knapsack problem)
 * @package BoxPacker
 * @author Doug Wright
 */
namespace DVDoug\BoxPacker;

/**
 * A "box" with items
 * @author Doug Wright
 * @package BoxPacker
 */
class PackedBox
{

    /**
     * Box used
     * @var Box
     */
    protected $box;

    /**
     * Items in the box
     * @var PackedItemList
     */
    protected $items;

    /**
     * Total weight of box
     * @var int
     */
    protected $weight;

    /**
     * Get box used
     * @return Box
     */
    public function getBox()
    {
        return $this->box;
    }

    /**
     * Get items packed
     * @return PackedItemList
     */
    public function getItems()
    {
        return $this->items;
    }

    /**
     * Get packed weight
     * @return int weight in grams
     */
    public function getWeight()
    {
        if (!is_null($this->weight)) {
            return $this->weight;
        }

        $this->weight = $this->box->getEmptyWeight();
        $items = clone $this->items;
        /** @var PackedItem $item */
        foreach ($items as $item) {
            $this->weight += $item->getItem()->getWeight();
        }
        return $this->weight;
    }

    /**
     * Get remaining width inside box for another item
     * @return int
     */
    public function getRemainingWidth()
    {
        return $this->box->getInnerWidth() - $this->getUsedWidth();
    }

    /**
     * Get remaining length inside box for another item
     * @return int
     */
    public function getRemainingLength()
    {
        return $this->box->getInnerLength() - $this->getUsedLength();
    }

    /**
     * Get remaining depth inside box for another item
     * @return int
     */
    public function getRemainingDepth()
    {
        return $this->box->getInnerDepth() - $this->getUsedDepth();
    }

    /**
     * Used width inside box for packing items
     * @return int
     */
    public function getUsedWidth()
    {
        $maxWidth = 0;

        /** @var PackedItem $item */
        foreach (clone $this->items as $item) {
            $maxWidth = max($maxWidth, $item->getX() + $item->getWidth());
        }

        return $maxWidth;
    }

    /**
     * Used length inside box for packing items
     * @return int
     */
    public function getUsedLength()
    {
        $maxLength = 0;

        /** @var PackedItem $item */
        foreach (clone $this->items as $item) {
            $maxLength = max($maxLength, $item->getY() + $item->getLength());
        }

        return $maxLength;
    }

    /**
     * Used depth inside box for packing items
     * @return int
     */
    public function getUsedDepth()
    {
        $maxDepth = 0;

        /** @var PackedItem $item */
        foreach (clone $this->items as $item) {
            $maxDepth = max($maxDepth, $item->getZ() + $item->getDepth());
        }

        return $maxDepth;
    }

    /**
     * Get remaining weight inside box for another item
     * @return int
     */
    public function getRemainingWeight()
    {
        return $this->box->getMaxWeight() - $this->getWeight();
    }

    /**
     * @return int
     */
    public function getInnerVolume()
    {
        return $this->box->getInnerDepth() * $this->box->getInnerDepth() * $this->box->getInnerDepth();
    }

    /**
     * Get volume utilisation of the packed box
     * @return float
     */
    public function getVolumeUtilisation()
    {
        $itemVolume = 0;

        /** @var PackedItem $item */
        foreach (clone $this->items as $item) {
            $itemVolume += $item->getItem()->getVolume();
        }

        return round($itemVolume / $this->getInnerVolume() * 100, 1);
    }


    /**
     * Constructor
     *
     * @param Box      $box
     * @param PackedItemList $itemList
     */
    public function __construct(Box $box, PackedItemList $itemList)
    {
        $this->box = $box;
        $this->items = $itemList;
    }
}


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		/**
10		* A "box" with items
11		* @author Doug Wright
12		* @package BoxPacker
13		*/
14		class PackedBox
15		{
16
17		/**
18		* Box used
19		* @var Box
20		*/
21		protected $box;
22
23		/**
24		* Items in the box
25		* @var PackedItemList
26		*/
27		protected $items;
28
29		/**
30		* Total weight of box
31		* @var int
32		*/
33		protected $weight;
34
35		/**
36		* Get box used
37		* @return Box
38		*/
39	4	public function getBox()
40		{
41	4	return $this->box;
42		}
43
44		/**
45		* Get items packed
46		* @return PackedItemList
47		*/
48	35	public function getItems()
49		{
50	35	return $this->items;
51		}
52
53		/**
54		* Get packed weight
55		* @return int weight in grams
56		*/
57	9	public function getWeight()
58		{
59	9	if (!is_null($this->weight)) {
60	6	return $this->weight;
61		}
62
63	9	$this->weight = $this->box->getEmptyWeight();
64	9	$items = clone $this->items;
65		/** @var PackedItem $item */
66	9	foreach ($items as $item) {
67	9	$this->weight += $item->getItem()->getWeight();
68		}
69	9	return $this->weight;
70		}
71
72		/**
73		* Get remaining width inside box for another item
74		* @return int
75		*/
76	1	public function getRemainingWidth()
77		{
78	1	return $this->box->getInnerWidth() - $this->getUsedWidth();
79		}
80
81		/**
82		* Get remaining length inside box for another item
83		* @return int
84		*/
85	1	public function getRemainingLength()
86		{
87	1	return $this->box->getInnerLength() - $this->getUsedLength();
88		}
89
90		/**
91		* Get remaining depth inside box for another item
92		* @return int
93		*/
94	1	public function getRemainingDepth()
95		{
96	1	return $this->box->getInnerDepth() - $this->getUsedDepth();
97		}
98
99		/**
100		* Used width inside box for packing items
101		* @return int
102		*/
103	5	public function getUsedWidth()
104		{
105	5	$maxWidth = 0;
106
107		/** @var PackedItem $item */
108	5	foreach (clone $this->items as $item) {
109	5	$maxWidth = max($maxWidth, $item->getX() + $item->getWidth());
110		}
111
112	5	return $maxWidth;
113		}
114
115		/**
116		* Used length inside box for packing items
117		* @return int
118		*/
119	5	public function getUsedLength()
120		{
121	5	$maxLength = 0;
122
123		/** @var PackedItem $item */
124	5	foreach (clone $this->items as $item) {
125	5	$maxLength = max($maxLength, $item->getY() + $item->getLength());
126		}
127
128	5	return $maxLength;
129		}
130
131		/**
132		* Used depth inside box for packing items
133		* @return int
134		*/
135	5	public function getUsedDepth()
136		{
137	5	$maxDepth = 0;
138
139		/** @var PackedItem $item */
140	5	foreach (clone $this->items as $item) {
141	5	$maxDepth = max($maxDepth, $item->getZ() + $item->getDepth());
142		}
143
144	5	return $maxDepth;
145		}
146
147		/**
148		* Get remaining weight inside box for another item
149		* @return int
150		*/
151	1	public function getRemainingWeight()
152		{
153	1	return $this->box->getMaxWeight() - $this->getWeight();
154		}
155
156		/**
157		* @return int
158		*/
159	5	public function getInnerVolume()
160		{
161	5	return $this->box->getInnerDepth() * $this->box->getInnerDepth() * $this->box->getInnerDepth();
162		}
163
164		/**
165		* Get volume utilisation of the packed box
166		* @return float
167		*/
168	1	public function getVolumeUtilisation()
169		{
170	1	$itemVolume = 0;
171
172		/** @var PackedItem $item */
173	1	foreach (clone $this->items as $item) {
174	1	$itemVolume += $item->getItem()->getVolume();
175		}
176
177	1	return round($itemVolume / $this->getInnerVolume() * 100, 1);
178		}
179
180
181		/**
182		* Constructor
183		*
184		* @param Box $box
185		* @param PackedItemList $itemList
186		*/
187	38	public function __construct(Box $box, PackedItemList $itemList)
188		{
189	38	$this->box = $box;
190	38	$this->items = $itemList;
191		}
192		}
193

dvdoug / BoxPacker

Push — master ( 2dde72...6f5502 )

PackedBox::getInnerVolume() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like