https://github.com/syaiful6/headbanger
Headbanger! PHP Data structure
https://github.com/syaiful6/headbanger
Last synced: 8 months ago
JSON representation
Headbanger! PHP Data structure
- Host: GitHub
- URL: https://github.com/syaiful6/headbanger
- Owner: syaiful6
- Created: 2016-04-28T00:03:22.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2016-05-30T08:59:19.000Z (about 10 years ago)
- Last Synced: 2024-11-18T09:59:05.480Z (over 1 year ago)
- Language: PHP
- Size: 49.8 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
### Headbanger
PHP data structure and or collections.
Motivation: PHP only give us array and object as compound type. There are no list,
hash table, set, etc. Array on PHP doest it all. This make operation on array not predictable, is sometimes act as ordered set, list, ordered map.
This package aim to provide some basic data structure to cover this gap.
### Install
```composer require syaiful6/headbanger```
This package contains implementations of Map, List, Set and Str. We consider string
as container, because it can be accessed via array notation and when we want
to iterate string, we actually want to iterate over character.
### Map
Python call this dict, Ruby call this type Hash. Whatever the name, this data
type can 'map' key value pair. Typically the key are unique (within one map).
The main operations on a map are storing a value with some key and extracting
the value given the key. It's also should possible to delete a key-value pair
for the given key.
This package provide one implementation for this data type. ```HashMap``` that
also implements Countable, Traversable and ArrayAccess. So you can treat this
instance as array. To delete key-value pair use ```unset($hash['somekey'])```
Note: ```HashMap``` is unordered map and not permit adding item during iteration,
replacing a key-value is fine. Iterate over map will give you the key only, with
this key you can access the value anyway. If you need the value use ```values``` method,
if you need both use ```items`` method.
```
$map = new Headbanger\HashMap();
// Add item, or just give map your array or any traversable on constructor
$map['one'] = 1;
$map['two'] = 2;
$map['three'] = 3;
// deleting
unset($map['one']);
// check if item exists
isset($map['one']);
```
### List
A list or sequence, represents an ordered sequence of values, these values may
occur more than once within on list. Think of it as finite sequence. Currently
only one implementation provided: ArrayList. Using SplFixedArray as their storage.
You can use ArrayList as ```Stack```, where the last element added is the first
element retrieved (“last-in, first-out”). Use ```push``` to add item, and retrieve
an item from the top use ```pop``` (without argument). However dont use ArrayList
as Queue, they are not efficient for this purpose. But it possible.
### Set
A set is an unordered collection with no duplicate elements. The common operations
are remove duplicates entries and membership testing. Set also support mathematical
operations like union, intersection, difference, etc.