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

topメソッドは、SplHeapクラスのヒープ構造から最上位の要素を取得するメソッドです。

SplHeapは、優先順位に基づいたデータ構造である「ヒープ」を扱うための抽象クラスで、常に最も優先度の高い（または低い）要素に効率的にアクセスできる特性を持っています。このtopメソッドは、そのヒープ構造において、現在最も優先度が高い（または低い）と判断される要素を、ヒープの根から参照するために使用されます。

重要な点として、topメソッドは要素を取得するだけで、ヒープからその要素を削除することはありません。ヒープから要素を削除しつつ取得したい場合は、代わりにextractメソッドを使用する必要があります。

また、ヒープが空の状態でtopメソッドを呼び出すと、RuntimeExceptionが発生します。そのため、メソッドを使用する前には、SplHeap::isEmpty()メソッドでヒープが空ではないかを確認することが推奨されます。このメソッドは、優先度が高いタスクを次に実行したい場合や、データセットの中から最大値や最小値に素早くアクセスしたい場合などに非常に有効です。

Copy
1<?php
2$heap = new SplMaxHeap();
3$heap->insert(10);
4$heap->insert(30);
5$heap->insert(20);
6
7$topElement = $heap->top();
8?>

引数なし

引数はありません

mixed

SplHeapクラスのtopメソッドは、ヒープの先頭（最大値または最小値）の要素を返します。