Checks whether the heap has no remaining entries.
The examples focus on the operation itself, including the important distinction: count returns the number of remaining elements.
What It Does
Use the examples below to observe the behavior on a small dataset before extending it to application code.
Syntax and Return Value
SplHeap::isEmpty()
The displayed signature describes the API or identifies any correction or optional dependency. When a parameter is optional, supply it only when the task requires it.
Example 1: Basic Use
SplMaxHeap is used because the abstract SplHeap cannot be instantiated. The isEmpty call is shown on a small, inspectable dataset.
<?php
$heap = new SplMaxHeap();
$heap->insert(4);
$heap->insert(12);
$heap->insert(7);
echo $heap->isEmpty() ? "empty" : "not empty";
Output from a successful local PHP 8.4 run:
not empty
Example 2: Checking Behavior
SplMaxHeap is used because the abstract SplHeap cannot be instantiated. The isEmpty call is shown on a small, inspectable dataset.
<?php
$heap = new SplMaxHeap();
$heap->insert(2);
$heap->insert(9);
$heap->insert(5);
$heap->insert(1);
echo $heap->isEmpty() ? "empty" : "not empty";
Output from a successful local PHP 8.4 run:
not empty
Example 3: Practical Example
SplMaxHeap is used because the abstract SplHeap cannot be instantiated. The isEmpty call is shown on a small, inspectable dataset.
<?php
$heap = new SplMaxHeap();
$heap->insert(19);
$heap->insert(3);
$heap->insert(11);
echo $heap->isEmpty() ? "empty" : "not empty";
Output from a successful local PHP 8.4 run:
not empty
Important Behavior and Edge Cases
Iterating or calling extract consumes entries, so an initially populated heap may become empty.
Comparison with Related Approaches
| Approach | Difference |
|---|---|
| SplHeap::isEmpty | Checks whether the heap has no remaining entries. |
| Related API or alternative | count returns the number of remaining elements. |
Common Beginner Mistakes
| Mistake | Correct approach |
|---|---|
| Ignoring the operation-specific limits | Iterating or calling extract consumes entries, so an initially populated heap may become empty. |
| Confusing it with a related API | count returns the number of remaining elements. |
Key Takeaways
- Checks whether the heap has no remaining entries.
- Iterating or calling extract consumes entries, so an initially populated heap may become empty.
- count returns the number of remaining elements.
Use SplHeap::isEmpty when its documented behavior matches the problem. Test the relevant edge cases in your own runtime before deploying it.