tomo-List.heapify.3

(37 lines)
   1 '\" t
   2 .\" Copyright (c) 2026 Bruce Hill
   3 .\" All rights reserved.
   4 .\"
   5 .TH List.heapify 3 2026-03-08 "Tomo man-pages"
   6 .SH NAME
   7 List.heapify \- convert a list into a heap
   8 .SH LIBRARY
   9 Tomo Standard Library
  10 .SH SYNOPSIS
  11 .nf
  12 .BI List.heapify\ :\ func(list:\ @[T],\ by:\ func(x,y:&T->Int32)\ =\ T.compare\ ->\ Void)
  13 .fi
  14 .SH DESCRIPTION
  15 Converts a list into a 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 list to be heapified. 	-
  26 by	func(x,y:&T->Int32)	The comparison function used to determine order. If not specified, the default comparison function for the item type will be used. 	T.compare
  27 .TE
  28 .SH RETURN
  29 Nothing.
  30 
  31 .SH EXAMPLES
  32 .EX
  33 my_heap := &[30, 10, 20]
  34 my_heap.heapify()
  35 .EE
  36 .SH SEE ALSO
  37 .BR Tomo-List (3)