tomo-List.sort.3

(41 lines)
   1 '\" t
   2 .\" Copyright (c) 2026 Bruce Hill
   3 .\" All rights reserved.
   4 .\"
   5 .TH List.sort 3 2026-03-08 "Tomo man-pages"
   6 .SH NAME
   7 List.sort \- sort a list
   8 .SH LIBRARY
   9 Tomo Standard Library
  10 .SH SYNOPSIS
  11 .nf
  12 .BI List.sort\ :\ func(list:\ @[T],\ by\ =\ T.compare\ ->\ Void)
  13 .fi
  14 .SH DESCRIPTION
  15 Sorts the elements of the list in place in ascending order (small to large).
  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 sorted. 	-
  26 by		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 list := &[40, 10, -30, 20]
  34 list.sort()
  35 assert list == [-30, 10, 20, 40]
  36 
  37 list.sort(func(a,b:&Int) a.abs() <> b.abs())
  38 assert list == [10, 20, -30, 40]
  39 .EE
  40 .SH SEE ALSO
  41 .BR Tomo-List (3)