tomo-List.sorted.3

(39 lines)
   1 '\" t
   2 .\" Copyright (c) 2026 Bruce Hill
   3 .\" All rights reserved.
   4 .\"
   5 .TH List.sorted 3 2026-03-08 "Tomo man-pages"
   6 .SH NAME
   7 List.sorted \- sorted copy of a list
   8 .SH LIBRARY
   9 Tomo Standard Library
  10 .SH SYNOPSIS
  11 .nf
  12 .BI List.sorted\ :\ func(list:\ [T],\ by\ =\ T.compare\ ->\ [T])
  13 .fi
  14 .SH DESCRIPTION
  15 Creates a new list with elements sorted.
  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 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 A new list with sorted elements.
  30 
  31 .SH EXAMPLES
  32 .EX
  33 assert [40, 10, -30, 20].sorted() == [-30, 10, 20, 40]
  34 assert [40, 10, -30, 20].sorted(
  35    func(a,b:&Int) a.abs() <> b.abs()
  36 ) == [10, 20, -30, 40]
  37 .EE
  38 .SH SEE ALSO
  39 .BR Tomo-List (3)