tomo-List.slice.3

(38 lines)
   1 '\" t
   2 .\" Copyright (c) 2025 Bruce Hill
   3 .\" All rights reserved.
   4 .\"
   5 .TH List.slice 3 2025-11-29 "Tomo man-pages"
   6 .SH NAME
   7 List.slice \- get a slice of a list
   8 .SH LIBRARY
   9 Tomo Standard Library
  10 .SH SYNOPSIS
  11 .nf
  12 .BI List.slice\ :\ func(list:\ [T],\ from:\ Int,\ to:\ Int\ ->\ [T])
  13 .fi
  14 .SH DESCRIPTION
  15 Returns a slice of the list spanning the given indices (inclusive).
  16 
  17 
  18 .SH ARGUMENTS
  19 
  20 .TS
  21 allbox;
  22 lb lb lbx
  23 l l l.
  24 Name	Type	Description
  25 list	[T]	The original list. 
  26 from	Int	The first index to include. 
  27 to	Int	The last index to include. 
  28 .TE
  29 .SH RETURN
  30 A new list spanning the given indices. Note: negative indices are counted from the back of the list, so `-1` refers to the last element, `-2` the second-to-last, and so on.
  31 
  32 .SH EXAMPLES
  33 .EX
  34 assert [10, 20, 30, 40, 50].slice(2, 4) == [20, 30, 40]
  35 assert [10, 20, 30, 40, 50].slice(-3, -2) == [30, 40]
  36 .EE
  37 .SH SEE ALSO
  38 .BR Tomo-List (3)