Initial commit

Author: lukewatts

.gitignore

@@ -0,0 +1,4 @@
+.idea
+.phpunit.cache
+.vscode
+vendor

LICENCE

@@ -0,0 +1,8 @@
+Copyright 2024 Luke Watts
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

README.md

@@ -0,0 +1,54 @@
+# Heap Class in PHP
+
+The `Heap` class is an implementation of a Max Heap data structure in PHP. A Heap is a complete binary tree where the value of each node is greater than or equal to the values of its children, which makes it useful for efficiently finding the maximum element.
+
+## Features
+
+- **Heap Construction**: Initialize the heap with an array and build a max heap.
+- **Insert**: Add a new element to the heap.
+- **Remove**: Remove a specific element from the heap.
+- **Sort**: Perform heap sort and return the array sorted in ascending or descending order.
+
+## Installation
+
+Install the `Heap` class via composer:
+
+```bash
+composer require affinity4/heap
+```
+
+## Usage
+
+Here is an example of how to use the `Heap` class:
+
+```php
+<?php
+
+require_once __DIR__ . '/vendor/autoload.php';
+
+use Affinity4\Heap\Heap;
+
+// Initialize the heap with an array
+$initialArray = [3, 10, 5, 1, 2, 7];
+$heap = new Heap($initialArray);
+
+// Insert a new value
+$heap->insert(12);
+
+// Sort the heap
+$sortedArray = $heap->sort();
+echo "Sorted Array: " . implode(', ', $sortedArray) . "\n";
+
+// Remove a value from the heap
+$heap->remove(5);
+echo "Heap after removing 5: " . implode(', ', $heap->heap) . "\n";
+
+```
+
+## Tests
+
+Run tests with:
+
+```bash
+./vendor/bin/phpunit
+```

composer.json

@@ -0,0 +1,20 @@
+{
+    "name": "affinity4/heap",
+    "description": "Full Binary Heap implementation with maxheap, minheap and memory-efficient O(nlogn) and space-complexity of O(1) heapsort algorithm",
+    "type": "library",
+    "license": "MIT",
+    "autoload": {
+        "psr-4": {
+            "Affinity4\\Heap\\": "src/"
+        }
+    },
+    "authors": [
+        {
+            "name": "Luke Watts",
+            "email": "[email protected]"
+        }
+    ],
+    "require-dev": {
+        "phpunit/phpunit": "^10.5"
+    }
+}