tomo-Int.onward.3

(40 lines)
   1 '\" t
   2 .\" Copyright (c) 2026 Bruce Hill
   3 .\" All rights reserved.
   4 .\"
   5 .TH Int.onward 3 2026-03-08 "Tomo man-pages"
   6 .SH NAME
   7 Int.onward \- iterate from a number onward
   8 .SH LIBRARY
   9 Tomo Standard Library
  10 .SH SYNOPSIS
  11 .nf
  12 .BI Int.onward\ :\ func(first:\ Int,\ step:\ Int\ =\ 1\ ->\ Text)
  13 .fi
  14 .SH DESCRIPTION
  15 Return an iterator that counts infinitely from the starting integer (with an optional step size).
  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 first	Int	The starting integer. 	-
  26 step	Int	The increment step size. 	1
  27 .TE
  28 .SH RETURN
  29 An iterator function that counts onward from the starting integer.
  30 
  31 .SH EXAMPLES
  32 .EX
  33 nums : &[Int] = &[]
  34 for i in 5.onward()
  35     nums.insert(i)
  36     stop if i == 10
  37 assert nums[] == [5, 6, 7, 8, 9, 10]
  38 .EE
  39 .SH SEE ALSO
  40 .BR Tomo-Int (3)