README

一个提供常见堆实现的PHP库。

安装

{
   	"require": {
        "chroma-x/stack-util": "~1.0"
    }
}

使用

自动加载和命名空间

require_once('path/to/vendor/autoload.php');

处理堆

向堆中添加元素

use ChromaX\StackUtil\Stack;

$stack = new Stack();

$stack
	->push('Item')
	->push('Another item')
	->push(12)
	->push(null)
	->push(8.12);

$stackSize = $stack->size();
echo 'Stack size: ' . $stackSize . PHP_EOL;

输出

Stack size: 5

从堆中读取

获取最后一个元素

$lastItem = $stack->get();
echo 'Last item: ' . $lastItem . PHP_EOL;

输出

Last item: 8.12

通过索引获取元素

如果索引不可用，则返回null

$secondItem = $stack->get(1);
echo 'Second item: ' . $secondItem . PHP_EOL;

输出

Second item: Another item

从堆中移除元素

$poppedItem = $stack->pop();
echo 'Popped item: ' . $poppedItem . PHP_EOL;

$stackSize = $stack->size();
echo 'Stack size: ' . $stackSize . PHP_EOL;

输出

Popped item: 8.12
Stack size: 4

更新堆值

更新最后一个元素

$lastItem = $stack
	->set('9.12')
	->get();
echo 'Updated last item: ' . $lastItem . PHP_EOL;

输出

Updated last item: 9.12

通过索引更新元素

$thirdItem = $stack
	->set('Third item', 2)
	->get(2);
echo 'Updated third item: ' . $thirdItem . PHP_EOL;

输出

Updated third item: Third item

从堆中移除元素

echo 'Stack size: ' . $stack->size() . PHP_EOL;
$stack->delete(1);
echo 'Stack size: ' . $stack->size() . PHP_EOL;

输出

Stack size: 4
Stack size: 3

遍历堆

使用foreach

foreach ($stack as $stackItemKey => $stackItemValue) {
	echo 'Stack item ' . $stackItemKey . ': ' . $stackItemValue . PHP_EOL;
}

输出

Stack item 0: Item
Stack item 1: Third item
Stack item 2: 9.12

使用for

for ($i = 0, $n = $stack->size(); $i < $n; $i++) {
	echo 'Stack index ' . $i . ': ' . $stack->get($i) . PHP_EOL;
}

输出

Stack index 0: Item
Stack index 1: Third item
Stack index 2: 9.12

贡献

对我们的项目做出贡献总是非常受欢迎的。
但是：请遵循在CONTRIBUTING.md文档中记录的贡献指南。

许可证

PHP Stack Util 采用 MIT 许可证。