code / tomo

   1 '\" t
   2 .\" Copyright (c) 2026 Bruce Hill
   3 .\" All rights reserved.
   4 .\"
   5 .TH List.heap_push 3 2026-03-08 "Tomo man-pages"
   6 .SH NAME
   7 List.heap_push \- heap push
   8 .SH LIBRARY
   9 Tomo Standard Library
  10 .SH SYNOPSIS
  11 .nf
  12 .BI List.heap_push\ :\ func(list:\ @[T],\ item:\ T,\ by\ =\ T.compare\ ->\ Void)
  13 .fi
  14 .SH DESCRIPTION
  15 Adds an element to the heap and maintains the heap property. By default, this is a *minimum* heap.
  16 
  17 
  18 .SH ARGUMENTS
  19 
  20 .TS
  21 allbox;
  22 lb lb lbx lb
  23 l l l l.
  24 Name	Type	Description	Default
  25 list	@[T]	The mutable reference to the heap. 	-
  26 item	T	The item to be added. 	-
  27 by		The comparison function used to determine order. If not specified, the default comparison function for the item type will be used. 	T.compare
  28 .TE
  29 .SH RETURN
  30 Nothing.
  31 
  32 .SH EXAMPLES
  33 .EX
  34 my_heap : &[Int]
  35 my_heap.heap_push(10)
  36 assert my_heap.heap_pop() == 10
  37 .EE
  38 .SH SEE ALSO
  39 .BR Tomo-List (3)