ArrayList::rewind() - Code Metrics - Inspection of "Added contains method in list classes and tests" - SiroDiaz/DataStructures - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( bca99a...ce603c )

by Siro Díaz

created 2017-07-07 17:27 UTC

ArrayList::rewind() A

↳ Parent: ArrayList

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	1
eloc	3
nc	1
nop	0

<?php
/**
 * DataStructures for PHP
 *
 * @link      https://github.com/SiroDiaz/DataStructures
 * @copyright Copyright (c) 2017 Siro Díaz Palazón
 * @license   https://github.com/SiroDiaz/DataStructures/blob/master/README.md (MIT License)
 */
namespace DataStructures\Lists;

use DataStructures\Lists\Interfaces\ListInterface;
use DataStructures\Lists\Traits\{CountTrait, ArrayAccessTrait};
use OutOfBoundsException;

/**
 * ArrayList
 *
 * This class is an implementation of a list based in native arrays.
 * The access time is, in general, O(1) since all in PHP is a hash table.
 *
 * @author Siro Diaz Palazon <[email protected]>
 */
class ArrayList implements ListInterface {
    use CountTrait;
    use ArrayAccessTrait;

    private $data;
    private $current;
    private $position;
    private $size;

    public function __construct() {
        $this->data = [];
        $this->size = 0;
        $this->position = 0;
    }

    /**
     * Add a new node in the specified index.
     *
     * @param integer $index the position.
     * @param mixed $data the data to be stored.
     */
    public function insert($index, $data) {
        array_splice($this->data, $index, 0, $data);
        $this->size++;
    }
    
    /**
     * Removes all the array items.
     */
    public function clear() {
        $this->data = [];
        $this->size = 0;
    }
    
     /**
     * Returns the array in the especified index.
     *
     * @param integer $index Index that must be greater than 0
     *  and lower than the list size.
     * @return mixed The data stored in the given index
     * @throws OutOfBoundsException if index is out bounds.
     */
    public function get($index) {
        if($index < 0 || $index > $this->size - 1) {
            throw new OutOfBoundsException();
        }

        return $this->data[$index];
    }

    /**
     * Returns the last node with O(1).
     *
     * @return mixed null if the array is empty.
     */
    public function getLast() {
        if(!$this->empty()) {
            return $this->data[$this->size - 1];
        }
        
        return null;
    }

    public function getAll() {
        foreach($this->data as $data) {
            yield $data;
        }
    }
    
    /**
     * Removes and returns the last item in the array.
     *
     * @return mixed data in node.
     */
    public function pop() {
        return $this->delete(($this->size === 0) ? 0 : $this->size - 1);
    }

    /**
     * Adds at the end of the list new node containing
     * the data to be stored.
     *
     * @param mixed $data The data
     */
    public function push($data) {
        $this->data[] = $data;
        $this->size++;
    }

    /**
     *
     */
    public function contains($data) : bool {
        return in_array($data, $this->data);
    }

    /**
     * Adds at the beginning a node in the list.
     *
     * @param mixed $data
     * @return mixed the data stored.
     */
    public function unshift($data) {
        $this->insert(0, $data);
    }

    /**
     * Delete a node in the given position and returns it back.
     *
     * @param integer $index the position.
     * @throws OutOfBoundsException if index is negative
     *  or is greater than the size of the list.
     */
    public function delete($index) {
        if($this->size === 0 || $index < 0 || $index > $this->size - 1) {
            throw new OutOfBoundsException();
        }
        
        $data = $this->data[$index];
        array_splice($this->data, $index, 1);
        $this->size--;

        return $data;
    }
    
    /**
     * Deletes the first node of the list and returns it.
     *
     * @return mixed the data.
     */
    public function shift() {
        return $this->delete(0);
    }

    /**
     * Returns array stored in the data attribute.
     *
     * @return array data stored in all nodes.
     */
    public function toArray() : array {
        return $this->data;
    }

    /**
     * Reset the cursor position.
     */
    public function rewind() {
        $this->position = 0;
        $this->current = $this->data[$this->position];
    }

    /**
     * Returns the current node data.
     *
     * @return mixed
     */
    public function current() {
        return $this->current;
    }

    /**
     * Key or index that indicates the cursor position.
     *
     * @return integer The current position.
     */
    public function key() {
        return $this->position;
    }

    /**
     * Move the cursor to the next node and increments the
     * position counter.
     */
    public function next() {
        ++$this->position;
        $this->current = $this->data[$this->position];
    }

    /**
     * Returns if the current pointer position is valid.
     *
     * @return boolean true if pointer is not last, else false.
     */
    public function valid() {
        return $this->position < $this->size;
    }
}

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\Interfaces\ListInterface;
12			use DataStructures\Lists\Traits\{CountTrait, ArrayAccessTrait};
13			use OutOfBoundsException;
14
15			/**
16			* ArrayList
17			*
18			* This class is an implementation of a list based in native arrays.
19			* The access time is, in general, O(1) since all in PHP is a hash table.
20			*
21			* @author Siro Diaz Palazon <[email protected]>
22			*/
23			class ArrayList implements ListInterface {
24			use CountTrait;
25			use ArrayAccessTrait;
26
27			private $data;
28			private $current;
29			private $position;
30			private $size;
31
32			public function __construct() {
33			$this->data = [];
34			$this->size = 0;
35			$this->position = 0;
36			}
37
38			/**
39			* Add a new node in the specified index.
40			*
41			* @param integer $index the position.
42			* @param mixed $data the data to be stored.
43			*/
44			public function insert($index, $data) {
45			array_splice($this->data, $index, 0, $data);
46			$this->size++;
47			}
48
49			/**
50			* Removes all the array items.
51			*/
52			public function clear() {
53			$this->data = [];
54			$this->size = 0;
55			}
56
57			/**
58			* Returns the array in the especified index.
59			*
60			* @param integer $index Index that must be greater than 0
61			* and lower than the list size.
62			* @return mixed The data stored in the given index
63			* @throws OutOfBoundsException if index is out bounds.
64			*/
65			public function get($index) {
66			if($index < 0 \|\| $index > $this->size - 1) {
67			throw new OutOfBoundsException();
68			}
69
70			return $this->data[$index];
71			}
72
73			/**
74			* Returns the last node with O(1).
75			*
76			* @return mixed null if the array is empty.
77			*/
78			public function getLast() {
79			if(!$this->empty()) {
80			return $this->data[$this->size - 1];
81			}
82
83			return null;
84			}
85
86			public function getAll() {
87			foreach($this->data as $data) {
88			yield $data;
89			}
90			}
91
92			/**
93			* Removes and returns the last item in the array.
94			*
95			* @return mixed data in node.
96			*/
97			public function pop() {
98			return $this->delete(($this->size === 0) ? 0 : $this->size - 1);
99			}
100
101			/**
102			* Adds at the end of the list new node containing
103			* the data to be stored.
104			*
105			* @param mixed $data The data
106			*/
107			public function push($data) {
108			$this->data[] = $data;
109			$this->size++;
110			}
111
112			/**
113			*
114			*/
115			public function contains($data) : bool {
116			return in_array($data, $this->data);
117			}
118
119			/**
120			* Adds at the beginning a node in the list.
121			*
122			* @param mixed $data
123			* @return mixed the data stored.
124			*/
125			public function unshift($data) {
126			$this->insert(0, $data);
127			}
128
129			/**
130			* Delete a node in the given position and returns it back.
131			*
132			* @param integer $index the position.
133			* @throws OutOfBoundsException if index is negative
134			* or is greater than the size of the list.
135			*/
136			public function delete($index) {
137			if($this->size === 0 \|\| $index < 0 \|\| $index > $this->size - 1) {
138			throw new OutOfBoundsException();
139			}
140
141			$data = $this->data[$index];
142			array_splice($this->data, $index, 1);
143			$this->size--;
144
145			return $data;
146			}
147
148			/**
149			* Deletes the first node of the list and returns it.
150			*
151			* @return mixed the data.
152			*/
153			public function shift() {
154			return $this->delete(0);
155			}
156
157			/**
158			* Returns array stored in the data attribute.
159			*
160			* @return array data stored in all nodes.
161			*/
162			public function toArray() : array {
163			return $this->data;
164			}
165
166			/**
167			* Reset the cursor position.
168			*/
169			public function rewind() {
170			$this->position = 0;
171			$this->current = $this->data[$this->position];
172			}
173
174			/**
175			* Returns the current node data.
176			*
177			* @return mixed
178			*/
179			public function current() {
180			return $this->current;
181			}
182
183			/**
184			* Key or index that indicates the cursor position.
185			*
186			* @return integer The current position.
187			*/
188			public function key() {
189			return $this->position;
190			}
191
192			/**
193			* Move the cursor to the next node and increments the
194			* position counter.
195			*/
196			public function next() {
197			++$this->position;
198			$this->current = $this->data[$this->position];
199			}
200
201			/**
202			* Returns if the current pointer position is valid.
203			*
204			* @return boolean true if pointer is not last, else false.
205			*/
206			public function valid() {
207			return $this->position < $this->size;
208			}
209			}

SiroDiaz / DataStructures

Push — master ( bca99a...ce603c )

ArrayList::rewind() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like