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

currentメソッドは、SplMinHeapオブジェクトの現在の要素を取得するメソッドです。SplMinHeapは、PHPが提供するSPL（Standard PHP Library）に属する特殊なデータ構造の一つで、常に最小値が先頭（根）に位置するように要素を自動的に整理・管理する最小ヒープを実装しています。

このcurrentメソッドは、SplMinHeapをイテレータとして扱う際に、現在ポインタが指している要素の値を参照するために使用されます。具体的には、ヒープ内の現在の最小要素を、ヒープから削除することなく取得します。これは、最小要素を取り出してヒープから削除するextractメソッドとは異なる点です。

このメソッドが有効な値を返すのは、ヒープが空でなく、かつイテレータが有効な要素を指している場合のみです。通常、SplMinHeapオブジェクトをforeachループなどで反復処理する際に、ループの各ステップで現在の要素の値を取得するために利用されます。もしイテレータが有効な要素を指していない場合、例えばヒープが空の場合や、ヒープの終端に達してイテレーションが完了した場合などには、このメソッドはnullを返します。これにより、現在の要素が取得可能かどうかを事前に確認する手間を省きながら、安全に値を取得できます。

Copy
1<?php
2$heap = new SplMinHeap();
3$heap->insert(10);
4$heap->insert(5);
5$currentElement = $heap->current();

引数なし

引数はありません

mixed

SplMinHeap::current() は、ヒープの現在の要素を返します。ヒープが空の場合は false を返します。