Completed
Push — master ( 8863d6...f6a034 )
by Siro Díaz
01:40
created

CircularLinkedList::indexOf()   B

Complexity

Conditions 4
Paths 4

Size

Total Lines 28
Code Lines 11

Duplication

Lines 28
Ratio 100 %

Importance

Changes 0
Metric Value
dl 28
loc 28
rs 8.5806
c 0
b 0
f 0
cc 4
eloc 11
nc 4
nop 1
1
<?php
2
/**
3
 * DataStructures for PHP
4
 *
5
 * @link      https://github.com/SiroDiaz/DataStructures
6
 * @copyright Copyright (c) 2017 Siro Díaz Palazón
7
 * @license   https://github.com/SiroDiaz/DataStructures/blob/master/README.md (MIT License)
8
 */
9
namespace DataStructures\Lists;
10
11
use DataStructures\Lists\Traits\{CountTrait, ArrayAccessTrait};
12
use DataStructures\Lists\Nodes\SimpleLinkedListNode;
13
use DataStructures\Lists\Interfaces\ListInterface;
14
use OutOfBoundsException;
15
16
/**
17
 * CircularLinkedList
18
 *
19
 * CircularLinkedList is a single and circular linked list that has
20
 * a pointer to the next node and also and last node points to head.
21
 *
22
 * @author Siro Diaz Palazon <[email protected]>
23
 */
24
class CircularLinkedList implements ListInterface {
25
    use ArrayAccessTrait;
26
    private $head;
27
    private $tail;
28
    private $size;
29
    private $current;
30
    private $position;
31
32 View Code Duplication
    public function __construct() {
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
33
        $this->head = null;
34
        $this->tail = &$this->head;
35
        $this->size = 0;
36
        $this->position = 0;
37
        $this->current = &$this->head;
38
    }
39
40
    /**
41
     * Inserts data in the specified position.
42
     *
43
     * @param integer $index the position.
44
     * @param mixed $data the data to store.
45
     */
46 View Code Duplication
    public function insert($index, $data) {
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
47
        if($index < 0) {
48
            throw new OutOfBoundsException();
49
        }
50
51
        if($index === 0) {
52
            $this->insertBeginning($data);
53
        } else if($index >= $this->size) {
54
            $this->insertEnd($data);
55
        } else if($index > 0 && $index < $this->size) {
56
            $this->insertAt($index, $data);
57
        }
58
        $this->current = &$this->head;
59
        $this->size++;
60
    }
61
62
    /**
63
     * Inserts at the beginning of the list.
64
     *
65
     * @param mixed $data
66
     */
67
    private function insertBeginning($data) {
68
        $newNode = new SimpleLinkedListNode($data);
69
        if($this->head === null) {
70
            $newNode->next = &$this->head;
71
            $this->head = &$newNode;
72
            $this->tail = &$newNode;
73
        } else {
74
            $this->tail->next = &$newNode;
75
            $newNode->next = $this->head;
76
            $this->head = &$newNode;
77
        }
78
    }
79
80
    /**
81
     * Add a new node in the specified index.
82
     *
83
     * @param integer $index the position.
0 ignored issues
show
Bug introduced by
There is no parameter named $index. Was it maybe removed?

This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function.

Consider the following example. The parameter $italy is not defined by the method finale(...).

/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}

The most likely cause is that the parameter was removed, but the annotation was not.

Loading history...
84
     * @param mixed $data the data to be stored.
85
     */
86
    private function insertEnd($data) {
87
        $newNode = new SimpleLinkedListNode($data);
88
        $this->tail->next = &$newNode;
89
        $newNode->next = &$this->head;
90
        $this->tail = &$newNode;
91
    }
92
93
    /**
94
     * Add a new node in the specified index.
95
     *
96
     * @param integer $index the position.
97
     * @param mixed $data the data to be stored.
98
     */
99
    private function insertAt($index, $data) {
100
        $newNode = new SimpleLinkedListNode($data);
101
        $current = $this->head;
102
        $prev = null;
103
        $i = 0;
104
        while($i < $index) {
105
            $prev = $current;
106
            $current = $current->next;
107
            $i++;
108
        }
109
        
110
        $prev->next = &$newNode;
111
        $newNode->next = &$current;
112
    }
113
114
    /**
115
     * Adds at the end of the list new node containing
116
     * the data to be stored.
117
     *
118
     * @param mixed $data The data
119
     */
120
    public function push($data) {
121
        $this->insert($this->size, $data);
122
    }
123
124
    /**
125
     * Adds at the beginning a node in the list.
126
     *
127
     * @param mixed $data
128
     * @return mixed the data stored.
129
     */
130
    public function unshift($data) {
131
        $this->insert(0, $data);
132
    }
133
134
    /**
135
     * Returns the last node data with O(1).
136
     *
137
     * @return mixed null if the list is empty.
138
     */
139
    public function getLast() {
140
        $node = $this->searchLast();
141
142
        return $node !== null ? $node->data : null;
143
    }
144
145
    /**
146
     * Returns the last node with O(1).
147
     *
148
     * @return mixed null if the list is empty.
149
     */
150
    protected function searchLast() {
151
        if($this->head === null) {
152
            return null;
153
        }
154
155
        return $this->tail;
156
    }
157
    
158
    /**
159
     * Returns the data stored in the given position.
160
     * If index is 0 or size - 1 the method is O(1) else O(n).
161
     *
162
     * @param integer $index the position.
163
     * @throws OutOfBoundsException if it is out of limits (< 0 or > size - 1)
164
     * @return mixed the data stored in $index node.
165
     */
166 View Code Duplication
    public function get($index) {
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
167
        $node = $this->search($index);
168
        if($node === null) {
169
            return null;
170
        }
171
172
        return $node->data;
173
    }
174
175
    /**
176
     * Returns the node stored in the given position.
177
     * If index is 0 or (size - 1) the method is O(1) else O(n).
178
     *
179
     * @param integer $index the position.
180
     * @throws OutOfBoundsException if it is out of limits (< 0 or > size - 1)
181
     * @return DataStructures\Lists\Nodes\SimpleLinkedListNode the node stored in $index.
182
     */
183
    protected function search($index) {
184
        if($index < 0 || $index > $this->size - 1) {
185
            throw new OutOfBoundsException();
186
        }
187
188
        if($index === 0) {
189
            return $this->head;
0 ignored issues
show
Bug Compatibility introduced by
The expression $this->head; of type null|DataStructures\List...es\SimpleLinkedListNode adds the type DataStructures\Lists\Nodes\SimpleLinkedListNode to the return on line 189 which is incompatible with the return type documented by DataStructures\Lists\CircularLinkedList::search of type DataStructures\Lists\Dat...es\SimpleLinkedListNode.
Loading history...
190
        }
191
192
        if($index === $this->size - 1) {
193
            return $this->searchLast();
0 ignored issues
show
Bug Compatibility introduced by
The expression $this->searchLast(); of type null|DataStructures\List...es\SimpleLinkedListNode adds the type DataStructures\Lists\Nodes\SimpleLinkedListNode to the return on line 193 which is incompatible with the return type documented by DataStructures\Lists\CircularLinkedList::search of type DataStructures\Lists\Dat...es\SimpleLinkedListNode.
Loading history...
194
        }
195
196
        $i = 0;
197
        $current = $this->head;
198
        while($i < $index) {
199
            $current = $current->next;
200
            $i++;
201
        }
202
203
        return $current;
204
    }
205
206
    /**
207
     *
208
     */
209
    public function contains($data) : bool {
210
        if($this->size === 0) {
211
            return false;
212
        }
213
214
        $current = $this->head->next;
215
        $prev = $this->head;
216
        while($current !== $this->head) {
217
            if($prev->data === $data) {
218
                return true;
219
            }
220
            $prev = $current;
221
            $current = $current->next;
222
        }
223
224
        return false;
225
    }
226
227
    /**
228
     *
229
     */
230 View Code Duplication
    public function indexOf($data) {
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
231
        if($this->head === null) {
232
            return false;
233
        }
234
        
235
        $current = $this->head;
236
        $i = 0;
237
        
238
        while($i < $this->size) {
239
            if($current->data == $data) {
240
                return $i;
241
            }
242
243
            $current = $current->next;
244
            $i++;
245
        }
246
247
        return false;
248
        /*
0 ignored issues
show
Unused Code Comprehensibility introduced by
57% of this comment could be valid code. Did you maybe forget this after debugging?

Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it.

The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production.

This check looks for comments that seem to be mostly valid code and reports them.

Loading history...
249
        foreach($this as $index => $val) {
250
            if($data === $val) {
251
                return $index;
252
            }
253
        }
254
255
        return false;
256
        */
257
    }
258
259
    /**
260
     * Generator for retrieve all nodes stored.
261
     * 
262
     * @return null if the head is null (or list is empty)
263
     */
264 View Code Duplication
    public function getAll() {
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
265
        if($this->head === null) {
266
            return;
267
        }
268
        
269
        if($this->head->next === $this->tail) {
270
            yield $this->head->data;
271
        } else {
272
            $current = $this->head;
273
            $i = 0;
274
            while($i < $this->size) {
275
                yield $current->data;
276
                $current = $current->next;
277
                $i++;
278
            }
279
        }
280
    }
281
    
282
    /**
283
     * Delete a node in the given position and returns it back.
284
     *
285
     * @param integer $index the position.
286
     * @throws OutOfBoundsException if index is negative
287
     *  or is greater than the size of the list.
288
     */
289 View Code Duplication
    public function delete($index) {
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
290
        if($index < 0 || ($index > 0 && $index > $this->size - 1)) {
291
            throw new OutOfBoundsException();
292
        }
293
294
        // if the list is empty
295
        if($this->head === null) {
296
            return null;
297
        }
298
        
299
        // if only there is an element
300
        if($this->head->next === $this->head) {
301
            $temp = $this->head;
302
            $this->head = null;
303
            $this->size--;
304
305
            return $temp->data;
306
        }
307
308
        if($index === 0) {
309
            return $this->deleteBeginning();
310
        } else if($index === $this->size - 1) {
311
            return $this->deleteEnd();
312
        } else {
313
            return $this->deleteAt($index);
314
        }
315
    }
316
317
    /**
318
     * Deletes at the beginnig of the list and returns the data stored.
319
     *
320
     * @return mixed the data stored in the node.
321
     */
322 View Code Duplication
    private function deleteBeginning() {
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
323
        $temp = $this->head;
324
        $this->head = &$this->head->next;
325
        $this->tail->next = &$this->head;
326
        $this->size--;
327
328
        return $temp->data;
329
    }
330
331
    /**
332
     * Deletes at the specified position and returns the data stored.
333
     *
334
     * @param integer $index the position.
335
     * @return mixed the data stored in the node.
336
     */
337
    private function deleteAt($index) {
338
        $i = 0;
339
        $prev = $this->head;
340
        $current = $this->head;
341
        
342
        while($i < $index) {
343
            $prev = $current;
344
            $current = $current->next;
345
            $i++;
346
        }
347
348
        $prev->next = &$current->next;
349
        $this->size--;
350
351
        return $current->data;
352
    }
353
354
    /**
355
     * Deletes at the end of the list and returns the data stored.
356
     *
357
     * @return mixed the data stored in the node.
358
     */
359 View Code Duplication
    private function deleteEnd() {
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
360
        $prev = $this->head;
361
        $current = $this->head;
362
        
363
        while($current !== $this->tail) {
364
            $prev = $current;
365
            $current = $current->next;
366
        }
367
        
368
        $temp = $current;
369
        $prev->next = &$this->head;
370
        $this->tail = &$prev;
371
        $current = null;
0 ignored issues
show
Unused Code introduced by
$current is not used, you could remove the assignment.

This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently.

$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

Both the $myVar assignment in line 1 and the $higher assignment in line 2 are dead. The first because $myVar is never used and the second because $higher is always overwritten for every possible time line.

Loading history...
372
373
        $this->size--;
374
375
        return $temp->data;
376
    }
377
378
    /**
379
     * Deletes the first node of the list and returns it.
380
     *
381
     * @return mixed the data.
382
     */
383
    public function shift() {
384
        return $this->delete(0);
385
    }
386
387
    /**
388
     * Removes and returns the last node in the list.
389
     *
390
     * @return mixed data in node.
391
     */
392
    public function pop() {
393
        return $this->delete($this->size - 1);
394
    }
395
396
    /**
397
     * Removes all nodes of the list. It removes from the beginning.
398
     */
399
    public function clear() {
400
        while($this->head !== null) {
401
            $this->shift();
402
        }
403
    }
404
405
    /**
406
     * Converts/exports the list content into array type.
407
     *
408
     * @return array data stored in all nodes.
409
     */
410
    public function toArray() : array {
411
        $arr = [];
412
        foreach($this->getAll() as $node) {
413
            $arr[] = $node;
414
        }
415
416
        return $arr;
417
    }
418
419
    /**
420
     * Reset the cursor position.
421
     */
422
    public function rewind() {
423
        $this->position = 0;
424
        $this->current = &$this->head;
425
    }
426
427
    /**
428
     * Returns the current node data.
429
     *
430
     * @return mixed
431
     */
432
    public function current() {
433
        return $this->current->data;
434
    }
435
436
    /**
437
     * Key or index that indicates the cursor position.
438
     *
439
     * @return integer The current position.
440
     */
441
    public function key() {
442
        return $this->position;
443
    }
444
445
    /**
446
     * Move the cursor to the next node and increments the
447
     * position counter.
448
     */
449
    public function next() {
450
        ++$this->position;
451
        $this->current = $this->current->next;
452
    }
453
454
    /**
455
     * Returns if the current pointer position is valid.
456
     *
457
     * @return boolean true if pointer is not last, else false.
458
     */
459
    public function valid() {
460
        return $this->position < $this->size;
461
    }
462
463
    /**
464
     * Binds to count() method. This is equal to make $this->tree->size().
465
     *
466
     * @return integer the tree size. 0 if it is empty.
467
     */
468
    public function count() {
469
        return $this->size;
470
    }
471
472
    /**
473
     * Returns the array size.
474
     *
475
     * @return int the length
476
     */
477
    public function size() : int {
478
        return $this->size;
479
    }
480
481
    /**
482
     * Checks if the list is empty.
483
     *
484
     * @return boolean true if is empty, else false.
485
     */
486
    public function empty() : bool {
487
        return $this->size === 0;
488
    }
489
}