Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/sirodiaz/datastructures

Collection of lot high performance data structures for PHP
https://github.com/sirodiaz/datastructures

algorithm algorithms avl-tree bst data-structures datastructures disjoint-sets hashmap hashset list oop php php7 radix-tree stack tree trie

Last synced: about 2 months ago
JSON representation

Collection of lot high performance data structures for PHP

Awesome Lists containing this project

README 

        
# DataStructures [![Build Status](https://travis-ci.org/SiroDiaz/DataStructures.svg?branch=master)](https://travis-ci.org/SiroDiaz/DataStructures) [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/SiroDiaz/DataStructures/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/SiroDiaz/DataStructures/?branch=master) 

Data structures for PHP >= 7.0. Use data structures in your project using this library.



## Index



[Install](https://github.com/SiroDiaz/DataStructures#install)


**[API](https://github.com/SiroDiaz/DataStructures#api)**



*[List implementations](https://github.com/SiroDiaz/DataStructures#lists)*


 - [Singly linked list](https://github.com/SiroDiaz/DataStructures#singly-linked-list)


 - [Singly circular linked list](https://github.com/SiroDiaz/DataStructures#circular-linked-list)


 - [Doubly circular linked list](https://github.com/SiroDiaz/DataStructures#doubly-circular-linked-list)


 - [Array list](https://github.com/SiroDiaz/DataStructures#array-list)


 - [Stack](https://github.com/SiroDiaz/DataStructures#stack)


 - [Queue](https://github.com/SiroDiaz/DataStructures#queue)


*[Tree implementations](https://github.com/SiroDiaz/DataStructures#trees)*


 - [Trie tree](https://github.com/SiroDiaz/DataStructures#trie-tree)


 - [Binary search tree](https://github.com/SiroDiaz/DataStructures#binary-search-tree)


 - [AVL Tree](https://github.com/SiroDiaz/DataStructures#avl-tree)


## Install



Via Composer just copy and paste:

```sh

composer require siro-diaz/data-structures:"dev-master"

```

## API

### Lists



The list data structures supported are the following:



*list type*: **class**



 - *Singly linked list*: **SinglyLinkedList**

 - *Circular singly linked list*: **CircularLinkedList**

 - *Circular doubly linked list*: **DoublyLinkedList**

 - *Array list*: **ArrayList**

 - *Stack*: **Stack**

 - *Queue*: **Queue**



#### Singly linked list

##### Introduction

Singly linked list is the simplest linked list that can be created. It has a pointer

to the next node in the list and the last node points to null.

All lists except stacks and queues have the same methods because they implements the same

interface.

##### Methods

 - size()

 - empty()

 - get($index)

 - getAll()

 - getLast()

 - delete($index)

 - clear()

 - pop()

 - insert($index, $data)

 - push($data)

 - unshift($data)

 - shift()

 - toArray()

##### Example

```php

use DataStructures\Lists\SinglyLinkedList;



$myList = new SinglyLinkedList();

$myList->push(20);

echo "Size of : ". $myList->size();

$myList->unshift(100);

echo "Item at the beginnig: ". $myList->get(0);

```



#### Circular linked list



##### Introduction

Circular linked list is a singly linked list that has a pointer to the last and first node. 

All lists except stacks and queues have the same methods because they implements the same

interface.



##### Methods

 - size()

 - empty()

 - get($index)

 - getAll()

 - getLast()

 - delete($index)

 - clear()

 - pop()

 - insert($index, $data)

 - push($data)

 - unshift($data)

 - shift()

 - toArray()

##### Example

```php

use DataStructures\Lists\CircularLinkedList;



$myList = new CircularLinkedList();

$myList->push(20);

$myList->push(10);

echo "Size of : ". $myList->size();

$myList->unshift(100);

echo "Item at the beginnig: ". $myList->get(0);

echo "Last item: ". $myList->getLast();

```



#### Doubly circular linked list



##### Introduction

Doubly circular linked list is a doubly linked list that each node contained in the list

contains a pointer to the next and previous node. In the of the first node it is going to point 

to the last node. It uses some performance tricks for insert, get, and delete operations.



##### Methods

 - size()

 - empty()

 - get($index)

 - getAll()

 - getLast()

 - delete($index)

 - clear()

 - pop()

 - insert($index, $data)

 - push($data)

 - unshift($data)

 - shift()

 - toArray()



##### Example

```php

use DataStructures\Lists\DoublyLinkedList;



$myList = new DoublyLinkedList();

$myList->push(20);

$myList->push(10);

echo "Size of : ". $myList->size();

$myList->unshift(100);

echo "Item at position 1: ". $myList->get(1);

echo "Last item: ". $myList->getLast();

```



#### Array list



##### Introduction

Array list uses the built in arrays as lists. In PHP all uses hash tables and it give

array lists some performance advantages in operations like get that will be O(1). 

Array list auto increments their size internally, without the necessity of increment it

manually. It is translates in a very easy way to implement this type of list.



##### Methods

 - size()

 - empty()

 - get($index)

 - getAll()

 - getLast()

 - delete($index)

 - clear()

 - pop()

 - insert($index, $data)

 - push($data)

 - unshift($data)

 - shift()

 - toArray()



##### Example

```php

use DataStructures\Lists\ArrayList;



$myList = new ArrayList();

$myList->push(20);

$myList->push(10);

echo "Size of : ". $myList->size();

$myList->unshift(100);

echo "Item at position 1: ". $myList->get(1);

echo "Last item: ". $myList->getLast();

```



#### Stack



##### Introduction

Stack is a LIFO (Last In First Out) data structure that works like a stack (as its name

said). Last element that is inserted will be the first in going out. 

The implementation used in this library allow to especify a maximum size, in other words,

it can be a limited stack. When limited stack is been used is important check if it is full

before insert a new element.



##### Methods

 - size()

 - empty()

 - isFull()

 - peek()

 - pop()

 - push($data)



##### Example

```php

use DataStructures\Lists\Stack;



$myStack = new Stack(); // unlimited stack.

// new Stack(5) will contain a maximum of 5 elements.

$myStack->push(20);

$myStack->push(10);

echo "Size of : ". $myStack->size();

echo "Front element: ". $myStack->peek(1);

echo "Last element inserted and being removed: ". $myStack->pop();

```



### Trees



The tree data structures supported are the following:



*tree type*: **class**



 - *Trie tree*: **TrieTree**

 - *Binary search tree*: **BinarySearchTree**

 - *AVL tree*: **AVLTree**



#### Trie tree

##### Introduction

Singly linked list is the simplest linked list that can be created. It has a pointer

to the next node in the list and the last node points to null.

All lists except stacks and queues have the same methods because they implements the same

interface.

##### Methods

 - size()

 - empty()

 - wordCount()

 - withPrefix($prefix)

 - startsWith($prefix)

 - getWords()

 - clear()

 - delete($word)

 - contains($word)

 - add($word)

##### Example

```php

use DataStructures\Trees\TrieTree;



$trie = new TrieTree();

$trie->add('hello');

$trie->add('hell');

$trie->add('world');

echo "Size of : ". $trie->wordCount();  // 3

$trie->contains('hell');    // true



echo "There are words that start with 'he': ". $trie->startsWith('he');   // true

```



#### Binary Search Tree

##### Introduction

Binary search tree (BST) is a data structure which has a root node that may have up to 2 siblings.

Each sibling also can have a maximum of 2 siblings. If the node have not siblings it is called leaf node.

The left sibling is lower than the parent node and right sibling is grater than it parent.

##### Methods

 - size()

 - empty()

 - delete($key)

 - put($key, $data, $update = false)

 - putOrUpdate($key, $data)

 - get($key)

 - getRoot()

 - exists($key)

 - min()

 - max()

 - deleteMin(BinaryNodeInterface $node = null)

 - deleteMax(BinaryNodeInterface $node = null)

 - search($key)

 - isLeaf($node)

 - isRoot($node)

 - preorder(Callable $callback = null)

 - inorder(Callable $callback = null)

 - postorder(Callable $callback = null)

##### Example

```php

use DataStructures\Trees\BinarySearchTree;



$bst = new BinarySearchTree();

$bst->put(4, 10);

$bst->put(2, 100);

$bst->put(10, 1000);

echo "Size of : ". $bst->size();

$bst->exists(100);  // false

echo "Is leaf?: ". $bst->isLeaf($bst->min());   // true

```



#### AVL Tree

##### Introduction

AVL Tree is a binary search tree that has a balance condition. The condition consists in each

subnode can have a maximum height of one respect the oposite side subtree (it means that right subtree of a node can't be higher than one, compared with the left subtree). If it has a height of two or more then is rebalanced the tree using a single left rotation, single right rotation, double left rotation or a double right rotation.

##### Methods

Same method that binary search tree.

##### Example

```php

use DataStructures\Trees\AVLTree;



$avl = new BinarySearchTree();

$avl->put(4, 10);

$avl->put(2, 100);

$avl->put(10, 1000);

echo "Size of : ". $avl->size();

$avl->exists(100);  // false

echo "Is leaf?: ". $avl->isLeaf($avl->min());   // true

```