Padam87 · Padam87 · Apr 29, 2023 · Apr 29, 2023 · Apr 29, 2023 · May 18, 2024
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,6 @@
 composer.phar
 /vendor/
 composer.lock
+.phpunit.result.cache
+docker-compose.yml
+Dockerfile
diff --git a/.phpunit.result.cache b/.phpunit.result.cache
diff --git a/README.md b/README.md
@@ -5,18 +5,19 @@
 ### Basic
 
 ```php
-$bin = new Bin(1000, 1000);
-$blocks = [
-    new Block(100, 100),
-    new Block(300, 100),
-    new Block(175, 125),
-    new Block(200, 75),
-    new Block(200, 75),
-];
-
-$packer = new BinPacker();
-
-$blocks = $packer->pack($bin, $blocks);
+$fitHeuristic = new BestShortSideFit();
+$splitHeuristic = new MaximizeAreaSplit();
+
+$binPacker = new BinPacker($fitHeuristic, $splitHeuristic);
+
+$bin = new Bin(680, 980);
+$blocks = [];
+
+for ($i = 0; $i < 30; $i++) {
+    $blocks[] = new Block(148, 210, true, $i + 1);
+}
+
+$state = $binPacker->pack($bin, $blocks);
 ```
 
 #### Determining the result (was a block packed?)
@@ -29,9 +30,20 @@ foreach ($blocks as $block) {
 }
 ```
 
+Or the other way around:
+
+```php
+foreach ($state->getUsedNodes() as $node) {
+    if ($node->isUsed()) {
+        $node->getBlock(); // packed block
+    }
+}
+```
+
+
 ### Rotation
 
-By default, all blocks are allowed to rotate. Rotation occures only if a fit is not found with the initial orientation.
+By default, all blocks are allowed to rotate. Rotation occurs only if a fit is not found with the initial orientation.
 
 You can disable rotation by passing `false` as the 3rd parameter to the block's constructor.
 ```php
@@ -60,45 +72,44 @@ $bin = new Bin(1000, 1000, true);
 You can use the visualizer to create pictures of the packed bin.
 
 ```php
-$bin = new Bin(1000, 1000);
-$blocks = [
-    new Block(100, 100),
-    new Block(300, 100),
-    new Block(175, 125),
-    new Block(200, 75),
-    new Block(200, 75),
-];
-
-$packer = new BinPacker();
+$state = //...;
 
-$blocks = $packer->pack($bin, $blocks);
+$visualizer = new Visualizer();
 
-$image = $visualizer->visualize($bin, $blocks);
+$image = $visualizer->visualize($bin, $state);
 ```
 
-This feature uses the Imagick extension, and returns an \Imagick class. You can use the result to save, or display the image.
+This feature uses the GD extension, and returns a `\GdImage` class. You can use the result to save, or display the image.
 
 ```php
-$image->setFormat('jpg');
-$image->writeImage('bin.jpg');
+ob_start();
+
+imagejpeg($image);
+$content = ob_get_contents();
+
+ob_end_clean();
+
+
+file_put_contents($filename, $content);
 ```
 
-![visualizer](docs/bin.jpg)
+![visualizer](docs/A5_B1/BSSF_MAXAS.jpg)
 
 ## GIF creator
 
 **WARNING**
-The GIF creators performance is very slow. I would suggest only using it for debug purposes, or non real-time scenarios
+The GIF creators performance is relatively slow. I would suggest only using it for debug purposes, or non real-time scenarios.
 
 ```php
-$packer = new BinPacker();
 $gifMaker = new GifMaker(new Visualizer());
-
-$blocks = $packer->pack($bin, $blocks, $gifMaker);
+$state = $binPacker->pack($bin, $blocks, $gifMaker);
 
 $gif = $gifMaker->create();
-
-$gif->writeImages('bin.gif', true);
+$gif->writeImages($filename, true);
 ```
 
-![visualizer](docs/bin.gif)
+![visualizer](docs/demo.gif)
+
+## Growth
+
+![visualizer](docs/growth.gif)
diff --git a/composer.json b/composer.json
@@ -3,14 +3,16 @@
     "description": "2D bin packing for PHP",
     "type": "library",
     "require": {
-        "php": "^7.2 || ^8.0"
+        "php": "^8.1"
     },
     "require-dev": {
         "phpunit/phpunit": "^8.1",
+        "ext-gd": "*",
         "ext-imagick": "*"
     },
     "suggest": {
-        "ext-imagick": "To use the visualizer and GIF maker"
+        "ext-gd": "To use the visualizer.",
+        "ext-imagick": "To use the GIF maker."
     },
     "autoload": {
         "psr-4": {

diff --git a/docs/A5_B1/ASBF_LAS.jpg b/docs/A5_B1/ASBF_LAS.jpg
diff --git a/docs/A5_B1/ASBF_LLAS.jpg b/docs/A5_B1/ASBF_LLAS.jpg
diff --git a/docs/A5_B1/ASBF_MAXAS.jpg b/docs/A5_B1/ASBF_MAXAS.jpg
diff --git a/docs/A5_B1/ASBF_MINAS.jpg b/docs/A5_B1/ASBF_MINAS.jpg
diff --git a/docs/A5_B1/ASBF_SAS.jpg b/docs/A5_B1/ASBF_SAS.jpg
diff --git a/docs/A5_B1/ASBF_SLAS.jpg b/docs/A5_B1/ASBF_SLAS.jpg
diff --git a/docs/A5_B1/BLSF_LAS.jpg b/docs/A5_B1/BLSF_LAS.jpg
diff --git a/docs/A5_B1/BLSF_LLAS.jpg b/docs/A5_B1/BLSF_LLAS.jpg
diff --git a/docs/A5_B1/BLSF_MAXAS.jpg b/docs/A5_B1/BLSF_MAXAS.jpg
diff --git a/docs/A5_B1/BLSF_MINAS.jpg b/docs/A5_B1/BLSF_MINAS.jpg
diff --git a/docs/A5_B1/BLSF_SAS.jpg b/docs/A5_B1/BLSF_SAS.jpg
diff --git a/docs/A5_B1/BLSF_SLAS.jpg b/docs/A5_B1/BLSF_SLAS.jpg
diff --git a/docs/A5_B1/BSSF_LAS.jpg b/docs/A5_B1/BSSF_LAS.jpg
diff --git a/docs/A5_B1/BSSF_LLAS.jpg b/docs/A5_B1/BSSF_LLAS.jpg
diff --git a/docs/A5_B1/BSSF_MAXAS.jpg b/docs/A5_B1/BSSF_MAXAS.jpg
diff --git a/docs/A5_B1/BSSF_MINAS.jpg b/docs/A5_B1/BSSF_MINAS.jpg
diff --git a/docs/A5_B1/BSSF_SAS.jpg b/docs/A5_B1/BSSF_SAS.jpg
diff --git a/docs/A5_B1/BSSF_SLAS.jpg b/docs/A5_B1/BSSF_SLAS.jpg
diff --git a/docs/A5_B1/NEG_BLSF_LAS.jpg b/docs/A5_B1/NEG_BLSF_LAS.jpg
diff --git a/docs/A5_B1/NEG_BLSF_LLAS.jpg b/docs/A5_B1/NEG_BLSF_LLAS.jpg
diff --git a/docs/A5_B1/NEG_BLSF_MAXAS.jpg b/docs/A5_B1/NEG_BLSF_MAXAS.jpg
diff --git a/docs/A5_B1/NEG_BLSF_MINAS.jpg b/docs/A5_B1/NEG_BLSF_MINAS.jpg
diff --git a/docs/A5_B1/NEG_BLSF_SAS.jpg b/docs/A5_B1/NEG_BLSF_SAS.jpg
diff --git a/docs/A5_B1/NEG_BLSF_SLAS.jpg b/docs/A5_B1/NEG_BLSF_SLAS.jpg
diff --git a/docs/A5_B1/NEG_BSSF_LAS.jpg b/docs/A5_B1/NEG_BSSF_LAS.jpg
diff --git a/docs/A5_B1/NEG_BSSF_LLAS.jpg b/docs/A5_B1/NEG_BSSF_LLAS.jpg
diff --git a/docs/A5_B1/NEG_BSSF_MAXAS.jpg b/docs/A5_B1/NEG_BSSF_MAXAS.jpg
diff --git a/docs/A5_B1/NEG_BSSF_MINAS.jpg b/docs/A5_B1/NEG_BSSF_MINAS.jpg
diff --git a/docs/A5_B1/NEG_BSSF_SAS.jpg b/docs/A5_B1/NEG_BSSF_SAS.jpg
diff --git a/docs/A5_B1/NEG_BSSF_SLAS.jpg b/docs/A5_B1/NEG_BSSF_SLAS.jpg
diff --git a/docs/bin.gif b/docs/bin.gif
diff --git a/docs/bin.jpg b/docs/bin.jpg
diff --git a/docs/demo.gif b/docs/demo.gif
diff --git a/docs/generate_doc_images.php b/docs/generate_doc_images.php
@@ -0,0 +1,212 @@
+<?php
+
+require_once __DIR__ . '/../vendor/autoload.php';
+
+use Padam87\BinPacker\BinPacker;
+use Padam87\BinPacker\FitHeuristic;
+use Padam87\BinPacker\FitHeuristic\BestAreaFit;
+use Padam87\BinPacker\GrowthHeuristic;
+use Padam87\BinPacker\GifMaker;
+use Padam87\BinPacker\Model\Bin;
+use Padam87\BinPacker\Model\Block;
+use Padam87\BinPacker\NodeMerger;
+use Padam87\BinPacker\NodeSlider;
+use Padam87\BinPacker\SplitHeuristic;
+use Padam87\BinPacker\State;
+use Padam87\BinPacker\Visualizer;
+
+A5_B1();
+mergerAndSlider();
+gif();
+growth();
+
+function A5_B1()
+{
+    $fitHeuristics = [
+        new FitHeuristic\BestAreaFit(),
+        new FitHeuristic\BestLongSideFit(),
+        new FitHeuristic\BestShortSideFit(),
+        new FitHeuristic\NegateScoreFit(new FitHeuristic\BestAreaFit()),
+        new FitHeuristic\NegateScoreFit(new FitHeuristic\BestLongSideFit()),
+        new FitHeuristic\NegateScoreFit(new FitHeuristic\BestShortSideFit()),
+        new FitHeuristic\AssumeSameBlocksFit(),
+    ];
+
+    $splitHeuristics = [
+        new SplitHeuristic\LongerAxisSplit(),
+        new SplitHeuristic\ShorterAxisSplit(),
+        new SplitHeuristic\LongerLeftoverAxisSplit(),
+        new SplitHeuristic\ShorterLeftoverAxisSplit(),
+        new SplitHeuristic\MaximizeAreaSplit(),
+        new SplitHeuristic\MinimizeAreaSplit(),
+    ];
+
+    foreach ($fitHeuristics as $fitHeuristic) {
+        foreach ($splitHeuristics as $splitHeuristic) {
+            $binPacker = new BinPacker($fitHeuristic, $splitHeuristic);
+
+            $bin = new Bin(680, 980);
+            $blocks = [];
+
+            for ($i = 0; $i < 30; $i++) {
+                $blocks[] = new Block(148, 210, true, $i + 1);
+            }
+
+            $state = $binPacker->pack($bin, $blocks);
+
+            $filename = implode('_', [$fitHeuristic->getName(), $splitHeuristic->getName()]) . '.jpg';
+
+            createImage($state, $fitHeuristic, $splitHeuristic, 'A5_B1', $filename);
+        }
+    }
+}
+
+function mergerAndSlider()
+{
+    $fitHeuristic = new FitHeuristic\BestLongSideFit();
+    $splitHeuristic = new SplitHeuristic\LongerLeftoverAxisSplit();
+
+    $binPacker = new BinPacker($fitHeuristic, $splitHeuristic);
+
+    $bin = new Bin(680, 980);
+    $blocks = [];
+
+    for ($i = 0; $i < 30; $i++) {
+        $blocks[] = new Block(148, 210, true, $i + 1);
+    }
+
+    $state = $binPacker->pack($bin, $blocks);
+
+    createImage($state, $fitHeuristic, $splitHeuristic, 'merger_slider', '1_regular.jpg');
+
+    // merger
+
+    $bin = new Bin(680, 980);
+    $blocks = [];
+
+    for ($i = 0; $i < 30; $i++) {
+        $blocks[] = new Block(148, 210, true, $i + 1);
+    }
+
+    $merger = new NodeMerger();
+    $state = $binPacker->pack($bin, $blocks, function ($state, $node, $block) use ($merger) {
+        $merger($state);
+    });
+
+    createImage($state, $fitHeuristic, $splitHeuristic, 'merger_slider', '2_merger.jpg');
+
+    // slider
+
+    $bin = new Bin(680, 980);
+    $blocks = [];
+
+    for ($i = 0; $i < 30; $i++) {
+        $blocks[] = new Block(148, 210, true, $i + 1);
+    }
+
+    $slider = new NodeSlider();
+    $state = $binPacker->pack($bin, $blocks, function ($state, $node, $block) use ($slider) {
+        $slider($state);
+    });
+
+    createImage($state, $fitHeuristic, $splitHeuristic, 'merger_slider', '3_slider.jpg');
+
+    // both
+
+    $bin = new Bin(680, 980);
+    $blocks = [];
+
+    for ($i = 0; $i < 30; $i++) {
+        $blocks[] = new Block(148, 210, true, $i + 1);
+    }
+
+    $merger = new NodeMerger();
+    $slider = new NodeSlider();
+    $state = $binPacker->pack($bin, $blocks, function ($state, $node, $block) use ($slider) {
+        $slider($state);
+    });
+    $merger($state);
+
+    $state = $binPacker->pack($bin, $blocks, null, $state);
+
+    createImage($state, $fitHeuristic, $splitHeuristic, 'merger_slider', '4_both.jpg');
+}
+
+function gif()
+{
+    ini_set('memory_limit', -1);
+
+    $fitHeuristic = new FitHeuristic\AssumeSameBlocksFit();
+    $splitHeuristic = new SplitHeuristic\MaximizeAreaSplit();
+
+    $binPacker = new BinPacker($fitHeuristic, $splitHeuristic);
+
+    $bin = new Bin(680, 980);
+    $blocks = [];
+
+    for ($i = 0; $i < 30; $i++) {
+        $blocks[] = new Block(148, 210, true, $i + 1);
+    }
+
+    $gifMaker = new GifMaker(new Visualizer());
+    $state = $binPacker->pack($bin, $blocks, $gifMaker);
+
+    $gif = $gifMaker->create();
+    $gif->writeImages(__DIR__ . DIRECTORY_SEPARATOR . 'demo.gif', true);
+}
+
+function growth()
+{
+    ini_set('memory_limit', -1);
+
+    $fitHeuristic = new FitHeuristic\BestAreaFit();
+    $splitHeuristic = new SplitHeuristic\MaximizeAreaSplit();
+    $growthHeuristic = new GrowthHeuristic\GrowRightFirst();
+
+    $binPacker = new BinPacker($fitHeuristic, $splitHeuristic, $growthHeuristic);
+
+    $bin = new Bin(400, 400);
+    $blocks = [];
+
+    for ($i = 0; $i < 15; $i++) {
+        $blocks[] = new Block(200, 100, true, $i + 1);
+    }
+
+    $blocks[] = new Block(300, 300, true, $i + 1);
+
+    for ($i = 16; $i < 41; $i++) {
+        $blocks[] = new Block(100, 200, true, $i + 1);
+    }
+
+    $blocks[] = new Block(100, 100, true, $i + 1);
+
+    $gifMaker = new GifMaker(new Visualizer());
+    $state = $binPacker->pack($bin, $blocks, $gifMaker);
+
+    $gif = $gifMaker->create();
+    $gif->writeImages(__DIR__ . DIRECTORY_SEPARATOR . 'growth.gif', true);
+}
+
+function createImage(State $state, FitHeuristic\FitHeuristic $fitHeuristic, SplitHeuristic\SplitHeuristic $splitHeuristic, string $directory, string $filename)
+{
+    $visualizer = new Visualizer();
+
+    $image = $visualizer->visualize($state, sprintf(
+        'Fit heuristic: %s; Split heuristic: %s; Fit count: %s',
+        $fitHeuristic->getName(),
+        $splitHeuristic->getName(),
+        count($state->getUsedNodes())
+    ));
+
+    ob_start();
+
+    imagejpeg($image);
+    $content = ob_get_contents();
+
+    ob_end_clean();
+
+    echo $filename . PHP_EOL;
+
+    @mkdir(__DIR__ . DIRECTORY_SEPARATOR . $directory);
+    file_put_contents(__DIR__ . DIRECTORY_SEPARATOR . $directory . DIRECTORY_SEPARATOR . $filename, $content);
+}
diff --git a/docs/growth.gif b/docs/growth.gif
diff --git a/docs/merger_slider/1_regular.jpg b/docs/merger_slider/1_regular.jpg
diff --git a/docs/merger_slider/2_merger.jpg b/docs/merger_slider/2_merger.jpg
diff --git a/docs/merger_slider/3_slider.jpg b/docs/merger_slider/3_slider.jpg
diff --git a/docs/merger_slider/4_both.jpg b/docs/merger_slider/4_both.jpg