Add benchmark comparing with brute force method

Author: dan-on

composer.json

@@ -22,6 +22,7 @@
         "phpunit/phpunit": "^9",
         "phpstan/phpstan": "^0.12.91",
         "vimeo/psalm": "^4.8",
-        "nunomaduro/phpinsights": "^2.0"
+        "nunomaduro/phpinsights": "^2.0",
+        "phpbench/phpbench": "^1.0"
     }
 }

phpbench.json

@@ -0,0 +1,5 @@
+{
+  "runner.bootstrap": "vendor/autoload.php",
+  "runner.path": "tests/Benchmark",
+  "runner.file_pattern": "*Bench.php"
+}

tests/Benchmark/CountIntersectionsBench.php

@@ -0,0 +1,62 @@
+<?php
+declare(strict_types=1);
+
+namespace Danon\IntervalTree\Tests\Benchmark;
+
+use Danon\IntervalTree\Interval;
+use Danon\IntervalTree\IntervalTree;
+use PhpBench\Benchmark\Metadata\Annotations\Revs;
+
+/**
+ * @BeforeMethods({"init"})
+ */
+class CountIntersectionsBench
+{
+    use GenerateIntervalTrait;
+
+    private const AMOUNT_INTERVALS_IN_TREE = 10000;
+    private const MAX_INTERVAL_HIGH        = 250000;
+    private const MAX_INTERVAL_OFFSET      = 100;
+
+    /**
+     * @var IntervalTree
+     */
+    private $tree;
+
+    /**
+     * @var Interval[]
+     */
+    private $bruteForceList;
+
+    public function init(): void
+    {
+        $this->tree = new IntervalTree();
+        $this->bruteForceList = [];
+
+        for ($i = 0; $i < self::AMOUNT_INTERVALS_IN_TREE; $i++) {
+            $interval = $this->generateInterval();
+            $this->tree->insert($interval);
+            $this->bruteForceList[] = $interval;
+        }
+    }
+
+    /**
+     * @Revs(1000)
+     */
+    public function benchTree(): void
+    {
+        $searchedInterval = $this->generateInterval();
+        $this->tree->countIntersections($searchedInterval);
+    }
+
+    /**
+     * @Revs(1000)
+     */
+    public function benchBruteForce(): void
+    {
+        $searchedInterval = $this->generateInterval();
+        foreach ($this->bruteForceList as $interval) {
+            $interval->intersect($searchedInterval);
+        }
+    }
+}

tests/Benchmark/GenerateIntervalTrait.php

@@ -0,0 +1,25 @@
+<?php
+declare(strict_types=1);
+
+namespace Danon\IntervalTree\Tests\Benchmark;
+
+use Danon\IntervalTree\Interval;
+use Exception;
+
+trait GenerateIntervalTrait
+{
+    /**
+     * @return Interval
+     */
+    private function generateInterval(): Interval
+    {
+        try {
+            $low = random_int(0, self::MAX_INTERVAL_HIGH);
+            $high = random_int($low, min($low + self::MAX_INTERVAL_OFFSET, self::MAX_INTERVAL_HIGH));
+        } catch (Exception $exception) {
+            echo 'Cannot generate interval: ' . $exception->getMessage();
+            exit;
+        }
+        return new Interval($low, $high);
+    }
+}

tests/Benchmark/HasIntersectionBench.php

@@ -0,0 +1,80 @@
+<?php
+declare(strict_types=1);
+
+namespace Danon\IntervalTree\Tests\Benchmark;
+
+use Danon\IntervalTree\Interval;
+use Danon\IntervalTree\IntervalTree;
+use Exception;
+use PhpBench\Benchmark\Metadata\Annotations\Revs;
+
+/**
+ * @BeforeMethods({"init"})
+ */
+class HasIntersectionBench
+{
+    use GenerateIntervalTrait;
+
+    private const AMOUNT_INTERVALS_IN_TREE = 10000;
+    private const MAX_INTERVAL_HIGH        = 250000;
+    private const MAX_INTERVAL_OFFSET      = 100;
+
+    /**
+     * @var IntervalTree
+     */
+    private $tree;
+
+    /**
+     * @var Interval[]
+     */
+    private $bruteForceList;
+
+    public function init(): void
+    {
+        $this->tree = new IntervalTree();
+        $this->bruteForceList = [];
+
+        for ($i = 0; $i < self::AMOUNT_INTERVALS_IN_TREE; $i++) {
+            $interval = $this->generateInterval();
+            $this->tree->insert($interval);
+            $this->bruteForceList[] = $interval;
+        }
+    }
+
+    /**
+     * @Revs(1000)
+     */
+    public function benchTree(): void
+    {
+        $searchedInterval = $this->generateInterval();
+        $this->tree->hasIntersection($searchedInterval);
+    }
+
+    /**
+     * @Revs(1000)
+     */
+    public function benchBruteForce(): void
+    {
+        $searchedInterval = $this->generateInterval();
+        foreach ($this->bruteForceList as $interval) {
+            if ($interval->intersect($searchedInterval)) {
+                break;
+            }
+        }
+    }
+
+    /**
+     * @return Interval
+     */
+    private function generateInterval(): Interval
+    {
+        try {
+            $low = random_int(0, self::MAX_INTERVAL_HIGH);
+            $high = random_int($low, min($low + self::MAX_INTERVAL_OFFSET, self::MAX_INTERVAL_HIGH));
+        } catch (Exception $exception) {
+            echo 'Cannot generate interval: ' . $exception->getMessage();
+            exit;
+        }
+        return new Interval($low, $high);
+    }
+}