ArrayList::get() - Code Metrics - Inspection of "Moved insert method to ListAbstract class" - SiroDiaz/DataStructures - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( b02a4e...93d881 )

by Siro Díaz

created 2017-07-14 23:29 UTC

ArrayList::get() A

↳ Parent: ArrayList

Complexity

Conditions	3
Paths	2

Size

Total Lines	7
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?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\Traits\{CountTrait, ArrayAccessTrait};
use DataStructures\Lists\ListAbstract;
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 extends ListAbstract {
    use ArrayAccessTrait;

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

    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++;
    }

    protected function insertAt($index, $data) {}

    protected function insertEnd($data) {}

    protected function insertBeginning($data) {}
    
    /**
     * 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;
        }
    }

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

    /**
     * {@inheritDoc}
     */
    public function indexOf($data) {
        return array_search($data, $this->data, true);
    }

    /**
     * {@inheritDoc}
     */
    public function lastIndexOf($data) {
        for($i = $this->size - 1; $i >= 0; $i--) {
            if($this->data[$i] === $data) {
                return $i;
            }
        }

        return false;
    }

    /**
     * {@inheritDoc}
     */
    public function remove($data) {
        $i = 0;
        
        while($i < $this->size) {
            if($this->data[$i] === $data) {
                $aux = $this->data[$i];
                array_splice($this->data, $i, 1);
                
                return $aux;
            }
            $i++;
        }
        return null;
    }

    /**
     * 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;
    }

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

SiroDiaz / DataStructures

Push — master ( b02a4e...93d881 )

ArrayList::get() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like