code / tomo

   1 '\" t
   2 .\" Copyright (c) 2026 Bruce Hill
   3 .\" All rights reserved.
   4 .\"
   5 .TH List.shuffled 3 2026-03-08 "Tomo man-pages"
   6 .SH NAME
   7 List.shuffled \- return a shuffled list
   8 .SH LIBRARY
   9 Tomo Standard Library
  10 .SH SYNOPSIS
  11 .nf
  12 .BI List.shuffled\ :\ func(list:\ [T],\ random:\ func(min,max:Int64->Int64)?\ =\ none\ ->\ [T])
  13 .fi
  14 .SH DESCRIPTION
  15 Creates a new list with elements shuffled.
  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 shuffled. 	-
  26 random	func(min,max:Int64->Int64)?	If provided, this function will be used to get a random index in the list. Returned values must be between \fBmin\fR and \fBmax\fR (inclusive). (Used for deterministic pseudorandom number generation) 	none
  27 .TE
  28 .SH RETURN
  29 A new list with shuffled elements.
  30 
  31 .SH EXAMPLES
  32 .EX
  33 nums := [10, 20, 30, 40]
  34 _ := nums.shuffled()
  35 # E.g. [20, 40, 10, 30]
  36 .EE
  37 .SH SEE ALSO
  38 .BR Tomo-List (3)