@@ -23,39 +23,6 @@ composer require dan-on/php-interval-tree
2323
2424## Usage
2525
26- ### Intervals
27-
28- There are numeric and DateTimeInterface-based interval types included.
29-
30- #### Numeric interval
31-
32- ``` php
33- use Danon\IntervalTree\Interval\NumericInterval;
34-
35- // Instantiate numeric interval from array
36- $numericInterval = NumericInterval::fromArray([1, 100]);
37-
38- // Instantiate numeric interval with constructor
39- $numericInterval = new NumericInterval(1, 100);
40- ```
41-
42- #### DateTime interval
43- ``` php
44- use Danon\IntervalTree\Interval\DateTimeInterval;
45-
46- // Instantiate DateTime interval from array
47- $dateTimeInterval = DateTimeInterval::fromArray([
48- new DateTimeImmutable('2021-01-01 00:00:00'),
49- new DateTimeImmutable('2021-01-02 00:00:00'),
50- ]);
51-
52- // Instantiate DateTime interval with constructor
53- $dateTimeInterval = new DateTimeInterval(
54- new DateTimeImmutable('2021-01-01 00:00:00'),
55- new DateTimeImmutable('2021-01-02 00:00:00')
56- );
57- ```
58-
5926### Interval Tree
6027
6128#### insert(IntervalInterface $interval, mixed $value): void
@@ -87,7 +54,7 @@ $tree->hasIntersection(new NumericInterval(3, 5)); // true
8754```
8855
8956#### countIntersections(IntervalInterface $interval): int
90- Count intervals that has intersections
57+ Count intersections given interval in tree
9158``` php
9259$tree->countIntersections(new NumericInterval(3, 5)); // 2
9360```
@@ -111,11 +78,44 @@ $tree->isEmpty(); // false
11178```
11279
11380#### getSize(): int
114- Returns number of items stored in the interval tree
81+ Get number of items stored in the interval tree
11582``` php
11683$tree->getSize(); // 3
11784```
11885
86+ ### Intervals
87+
88+ There are numeric and DateTimeInterface-based interval types included.
89+
90+ #### Numeric interval
91+
92+ ``` php
93+ use Danon\IntervalTree\Interval\NumericInterval;
94+
95+ // Instantiate numeric interval from array
96+ $numericInterval = NumericInterval::fromArray([1, 100]);
97+
98+ // Instantiate numeric interval with constructor
99+ $numericInterval = new NumericInterval(1, 100);
100+ ```
101+
102+ #### DateTime interval
103+ ``` php
104+ use Danon\IntervalTree\Interval\DateTimeInterval;
105+
106+ // Instantiate DateTime interval from array
107+ $dateTimeInterval = DateTimeInterval::fromArray([
108+ new DateTimeImmutable('2021-01-01 00:00:00'),
109+ new DateTimeImmutable('2021-01-02 00:00:00'),
110+ ]);
111+
112+ // Instantiate DateTime interval with constructor
113+ $dateTimeInterval = new DateTimeInterval(
114+ new DateTimeImmutable('2021-01-01 00:00:00'),
115+ new DateTimeImmutable('2021-01-02 00:00:00')
116+ );
117+ ```
118+
119119## Tests
120120
121121```
0 commit comments