code / tomo

   1 '\" t
   2 .\" Copyright (c) 2025 Bruce Hill
   3 .\" All rights reserved.
   4 .\"
   5 .TH Num.is_between 3 2025-12-31 "Tomo man-pages"
   6 .SH NAME
   7 Num.is_between \- check if a number is in a range
   8 .SH LIBRARY
   9 Tomo Standard Library
  10 .SH SYNOPSIS
  11 .nf
  12 .BI Num.is_between\ :\ func(x:\ Num,\ low:\ Num,\ high:\ Num\ ->\ Bool)
  13 .fi
  14 .SH DESCRIPTION
  15 Determines if a number is between two numbers (inclusive).
  16 
  17 
  18 .SH ARGUMENTS
  19 
  20 .TS
  21 allbox;
  22 lb lb lbx
  23 l l l.
  24 Name	Type	Description
  25 x	Num	The integer to be checked. 
  26 low	Num	One end of the range to check (inclusive). 
  27 high	Num	The other end of the range to check (inclusive). 
  28 .TE
  29 .SH RETURN
  30 `yes` if `a <= x and x <= b` or `b <= x and x <= a`, otherwise `no`
  31 
  32 .SH EXAMPLES
  33 .EX
  34 assert (7.5).is_between(1, 10) == yes
  35 assert (7.5).is_between(10, 1) == yes
  36 assert (7.5).is_between(100, 200) == no
  37 assert (7.5).is_between(1, 7.5) == yes
  38 .EE
  39 .SH SEE ALSO
  40 .BR Tomo-Num (3)