code / tomo

   1 '\" t
   2 .\" Copyright (c) 2026 Bruce Hill
   3 .\" All rights reserved.
   4 .\"
   5 .TH List.remove_at 3 2026-03-08 "Tomo man-pages"
   6 .SH NAME
   7 List.remove_at \- remove an item by index
   8 .SH LIBRARY
   9 Tomo Standard Library
  10 .SH SYNOPSIS
  11 .nf
  12 .BI List.remove_at\ :\ func(list:\ @[T],\ at:\ Int\ =\ -1,\ count:\ Int\ =\ 1\ ->\ Void)
  13 .fi
  14 .SH DESCRIPTION
  15 Removes elements from the list starting at a specified index.
  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. 	-
  26 at	Int	The index at which to start removing elements. 	-1
  27 count	Int	The number of elements to remove. 	1
  28 .TE
  29 .SH RETURN
  30 Nothing.
  31 
  32 .SH NOTES
  33 Since negative indices are counted from the back, the default behavior is to remove the last item.
  34 
  35 .SH EXAMPLES
  36 .EX
  37 list := &[10, 20, 30, 40, 50]
  38 list.remove_at(2)
  39 assert list == [10, 30, 40, 50]
  40 
  41 list.remove_at(2, count=2)
  42 assert list == [10, 50]
  43 .EE
  44 .SH SEE ALSO
  45 .BR Tomo-List (3)