Pudu programming language
Menu
API reference

Std.Heap.pop

1 declaration

fn

pop: &Std.Heap.Heap[T] -> Option[(T, Std.Heap.Heap[T])] where T: Ord

This is a callable function.

What it does

The smallest element and the heap without it, or None when empty.

Both together, because a caller taking the next item almost always wants

the rest as well, and rejoining the children is work worth doing once.

Read the signature

  • The text after the name is the type checked by Pudu.
  • Read arrows from left to right: inputs come first, and the final type is returned.
  • & borrows a value for this call instead of moving or copying it.
  • Names inside [ ] are type arguments, such as the item type held by a collection.
  • Option holds Some(value) or None when no value is available.

Back to Std.HeapSearch related declarations