tomo-Int.clamped.3

(37 lines)
   1 '\" t
   2 .\" Copyright (c) 2026 Bruce Hill
   3 .\" All rights reserved.
   4 .\"
   5 .TH Int.clamped 3 2026-01-19 "Tomo man-pages"
   6 .SH NAME
   7 Int.clamped \- clamp an integer
   8 .SH LIBRARY
   9 Tomo Standard Library
  10 .SH SYNOPSIS
  11 .nf
  12 .BI Int.clamped\ :\ func(x:\ Int,\ low:\ Int,\ high:\ Int\ ->\ Int)
  13 .fi
  14 .SH DESCRIPTION
  15 Returns the given number clamped between two values so that it is within that range.
  16 
  17 
  18 .SH ARGUMENTS
  19 
  20 .TS
  21 allbox;
  22 lb lb lbx
  23 l l l.
  24 Name	Type	Description
  25 x	Int	The integer to clamp. 
  26 low	Int	The lowest value the result can take. 
  27 high	Int	The highest value the result can take. 
  28 .TE
  29 .SH RETURN
  30 The first argument clamped between the other two arguments.
  31 
  32 .SH EXAMPLES
  33 .EX
  34 assert 2.clamped(5, 10) == 5
  35 .EE
  36 .SH SEE ALSO
  37 .BR Tomo-Int (3)