【PHP8.x】SplMaxHeap::current()メソッドの使い方

currentメソッドは、SplMaxHeapの現在位置にある要素を取得するメソッドです。

SplMaxHeapは、常に最大の要素を最上位に保つ「最大ヒープ」という特殊なデータ構造をPHPで実装したクラスです。この構造により、要素の追加や削除が行われても、常に最も大きな値の要素に素早くアクセスできるという特徴があります。

このcurrentメソッドは、SplMaxHeapオブジェクトをイテレータとして使用する際に、イテレータが現在指し示している要素の値を返します。例えば、foreachループを使ってヒープ内の要素を順に処理する際、各ループのステップでcurrentメソッドが内部的に呼び出され、その時点での要素を取得します。

currentメソッドの振る舞いは、イテレータの他のメソッドと連携して理解することが重要です。rewind()メソッドを呼び出すと、イテレータはヒープの最上位要素、つまり現在最大の要素を指す状態になります。その後、current()を呼び出すことで、この最上位要素を取得できます。さらに、next()メソッドを呼び出すと、現在指している要素がヒープから削除され、次に最大の要素が新たな最上位要素となり、イテレータがそれを指すようになります。このようにして、currentメソッドは、extract()メソッドと同様に、ヒープから常に最大の要素を順番に取り出しながら要素をたどる際に利用されます。

これにより、SplMaxHeapに格納された要素を、大きい順に効率よく処理することが可能になります。

Copy
1<?php
2$maxHeap = new SplMaxHeap();
3$currentElement = $maxHeap->current();
4?>

引数なし

引数はありません

mixed

SplMaxHeap::current() は、ヒープの現在の要素を返します。これは、イテレータが指している要素であり、最大ヒープにおいては最大値の要素となります。