v2.0.0

.github/workflows/ci.yml

@@ -0,0 +1,38 @@
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+  ci:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        php-versions: ['7.3', '7.4', '8.0']
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Install PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php-versions }}
+
+      - name: Validate composer.json and composer.lock
+        run: composer validate --strict
+
+      - name: Cache Composer packages
+        id: composer-cache
+        uses: actions/cache@v2
+        with:
+          path: vendor
+          key: ${{ runner.os }}-php-${{ hashFiles('**/composer.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-php-
+
+      - name: Install dependencies
+        run: composer install --prefer-dist --no-progress
+
+      - name: Run test suite
+        run: composer run-script tests
+
+      - name: Analyze code
+        run: composer run-script analyze

.gitignore

@@ -1 +1,4 @@
-vendor
+vendor
+.idea
+composer.lock
+.phpunit.cache

LICENSE

@@ -0,0 +1,177 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

README.md

@@ -1,50 +1,124 @@
 # PHP Interval tree
-Implementation of interval binary search tree.
+[![Latest Stable Version](http://poser.pugx.org/dan-on/php-interval-tree/v)](https://packagist.org/packages/dan-on/php-interval-tree) [![Total Downloads](http://poser.pugx.org/dan-on/php-interval-tree/downloads)](https://packagist.org/packages/dan-on/php-interval-tree) [![License](http://poser.pugx.org/dan-on/php-interval-tree/license)](https://packagist.org/packages/dan-on/php-interval-tree) [![PHP Version Require](http://poser.pugx.org/dan-on/php-interval-tree/require/php)](https://packagist.org/packages/dan-on/php-interval-tree)
+
+## Overview
+
+Package **dan-on/php-interval-tree** is an implementation of self balancing binary search tree data structure called Red-Black Tree.
+
+Based on interval tree described in "Introduction to Algorithms 3rd Edition", published by Thomas H. Cormen, Charles E. Leiserson, Ronald L. Rivest, and Clifford Stein.
+
+## Complexity
+
+| Operation | Best, Average, Worst   |
+|-----------|------------------------|
+| Insertion | O(log(n))              |
+| Search    | O(log(n))              |
+| Remove    | O(log(n))              |
+| Space     | O(n)                   |
+
+## Installing via Composer
 
-## Installing
 ```
 composer require dan-on/php-interval-tree
 ```
 
 ## Usage
 
-```php
-<?php
-require_once 'vendor/autoload.php';
+### Interval Tree
 
+#### insert(IntervalInterface $interval, mixed $value): void
+Insert new pair (interval + value) into interval tree
+```php
 use Danon\IntervalTree\IntervalTree;
 
 $tree = new IntervalTree();
-$intervals = [[6, 8], [1, 4], [2, 3], [5, 12], [1, 1], [3, 5], [5, 7]];
-
-// Insert interval as a key and interval index as a value 
-for ($i=0; $i < count($intervals); $i++) {
-    $tree->insert($intervals[$i], $i);
-}
+$tree->insert(new NumericInterval(1, 10), 'val1');
+$tree->insert(new NumericInterval(2, 5), 'val2');
+$tree->insert(new NumericInterval(11, 12), 'val3');
+```
 
-// Iterate nodes which keys intersect with given interval
-$nodesInRange = $tree->iterateIntersections([2, 3]);
-$intersectedIntervalIndexes = [];
-foreach ($nodesInRange as $node) {
-    $intersectedIntervalIndexes[] = $node->getValue();
+#### findIntersections(IntervalInterface $interval): Iterator\<Pair>
+Find pairs which intervals intersect with given interval
+```php
+$intersections = $tree->findIntersections(new NumericInterval(3, 5));
+foreach($intersections as $pair) {
+    $pair->getInterval()->getLow(); // 1, 2
+    $pair->getInterval()->getHigh(); // 10, 5
+    $pair->getValue(); // 'val1', 'val2'
 }
-// Expected array: [1, 2, 5]
+```
+
+#### hasIntersection(IntervalInterface $interval): bool
+Returns true if interval has at least one intersection in tree
+```php
+$tree->hasIntersection(new NumericInterval(3, 5)); // true
+```
 
-// Check that interval has at least one intersection
-$tree->hasIntersection([2, 3]);
-// Expected value: true
+#### countIntersections(IntervalInterface $interval): int
+Count intersections given interval in tree
+```php
+$tree->countIntersections(new NumericInterval(3, 5)); // 2
+```
+
+#### remove(IntervalInterface $interval, $value): bool
+Remove node from tree by interval and value
+```php
+$tree->remove(new NumericInterval(11, 12), 'val3'); // true
+```
+
+#### exist(IntervalInterface $interval, $value): bool
+Returns true if interval and value exist in the tree
+```php
+$tree->exists(new NumericInterval(11, 12), 'val3'); // true
+```
+
+#### isEmpty(): bool
+Returns true if tree is empty
+```php
+$tree->isEmpty(); // false
+```
+
+#### getSize(): int
+Get number of items stored in the interval tree
+```php
+$tree->getSize(); // 3
+```
+
+### Intervals
+
+There are numeric and DateTimeInterface-based interval types included.
+
+#### Numeric interval
+
+```php
+use Danon\IntervalTree\Interval\NumericInterval;
+
+// Instantiate numeric interval from array
+$numericInterval = NumericInterval::fromArray([1, 100]);
+
+// Instantiate numeric interval with constructor
+$numericInterval = new NumericInterval(1, 100);
+```
+
+#### DateTime interval
+```php
+use Danon\IntervalTree\Interval\DateTimeInterval;
 
-// Count intervals that has intersections
-$tree->countIntersections([2, 3]);
-// Expected value: 3
+// Instantiate DateTime interval from array
+$dateTimeInterval = DateTimeInterval::fromArray([
+    new DateTimeImmutable('2021-01-01 00:00:00'),
+    new DateTimeImmutable('2021-01-02 00:00:00'),
+]);
 
-// Get array of keys sorted in ascendant order
-$sortedIntervals = $tree->getKeys(); 
-// Expected array: [[1, 1], [1, 4], [2, 3], [3, 5], [5, 7], [5, 12], [6, 8]]
+// Instantiate DateTime interval with constructor
+$dateTimeInterval = new DateTimeInterval(
+    new DateTimeImmutable('2021-01-01 00:00:00'), 
+    new DateTimeImmutable('2021-01-02 00:00:00')
+);
 ```
 
 ## Tests
 
 ```
-./vendor/bin/phpunit tests
+./vendor/bin/phpunit
 ```