code / tomo

   1 '\" t
   2 .\" Copyright (c) 2026 Bruce Hill
   3 .\" All rights reserved.
   4 .\"
   5 .TH List.remove_item 3 2026-03-08 "Tomo man-pages"
   6 .SH NAME
   7 List.remove_item \- remove an item by value
   8 .SH LIBRARY
   9 Tomo Standard Library
  10 .SH SYNOPSIS
  11 .nf
  12 .BI List.remove_item\ :\ func(list:\ @[T],\ item:\ T,\ max_count:\ Int\ =\ -1\ ->\ Void)
  13 .fi
  14 .SH DESCRIPTION
  15 Removes all occurrences of a specified item from the list.
  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 item	T	The item to be removed. 	-
  27 max_count	Int	The maximum number of occurrences to remove. 	-1
  28 .TE
  29 .SH RETURN
  30 Nothing.
  31 
  32 .SH NOTES
  33 A negative `max_count` means "remove all occurrences".
  34 
  35 .SH EXAMPLES
  36 .EX
  37 list := &[10, 20, 10, 20, 30]
  38 list.remove_item(10)
  39 assert list == [20, 20, 30]
  40 
  41 list.remove_item(20, max_count=1)
  42 assert list == [20, 30]
  43 .EE
  44 .SH SEE ALSO
  45 .BR Tomo-List (3)