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

keyメソッドは、SplMaxHeapオブジェクトが保持するコレクションにおいて、現在イテレータが指している要素に関連付けられたキーを取得するメソッドです。SplMaxHeapは、最大値が常にルートに位置するヒープ構造を実装しており、要素の追加や取り出しによって内部的に要素が整理されます。このヒープはイテレータインターフェースを実装しているため、foreachループなどでその内容を順に処理することが可能です。

keyメソッドが返す値は、現在の要素の「位置」や「順序」を示す整数値です。これは、配列のインデックスに似た役割を果たし、currentメソッドが要素そのものの値を返すのに対し、keyメソッドはその要素がヒープのイテレーション順序において何番目であるかを示します。例えば、ヒープに要素を追加した順に1番目、2番目といった形でキーが割り当てられ、イテレータが進むにつれてこのキーも増加します。このメソッドを使用することで、ヒープを走査する際に、各要素の内部的な順序情報を把握することができます。

Copy
1<?php
2
3$heap = new SplMaxHeap();
4$heap->key();
5
6?>

引数なし

引数はありません

mixed

SplMaxHeap::key() は、現在の最大要素のキーを返します。