tomo-List.shuffle.3

(38 lines)
   1 '\" t
   2 .\" Copyright (c) 2026 Bruce Hill
   3 .\" All rights reserved.
   4 .\"
   5 .TH List.shuffle 3 2026-03-08 "Tomo man-pages"
   6 .SH NAME
   7 List.shuffle \- shuffle a list in place
   8 .SH LIBRARY
   9 Tomo Standard Library
  10 .SH SYNOPSIS
  11 .nf
  12 .BI List.shuffle\ :\ func(list:\ @[T],\ random:\ func(min,max:Int64->Int64)?\ =\ none\ ->\ Void)
  13 .fi
  14 .SH DESCRIPTION
  15 Shuffles the elements of the list in place.
  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 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 Nothing.
  30 
  31 .SH EXAMPLES
  32 .EX
  33 nums := &[10, 20, 30, 40]
  34 nums.shuffle()
  35 # E.g. [20, 40, 10, 30]
  36 .EE
  37 .SH SEE ALSO
  38 .BR Tomo-List (3)