code / tomo

   1 '\" t
   2 .\" Copyright (c) 2025 Bruce Hill
   3 .\" All rights reserved.
   4 .\"
   5 .TH Byte.is_between 3 2025-12-31 "Tomo man-pages"
   6 .SH NAME
   7 Byte.is_between \- test if inside a range
   8 .SH LIBRARY
   9 Tomo Standard Library
  10 .SH SYNOPSIS
  11 .nf
  12 .BI Byte.is_between\ :\ func(x:\ Byte,\ low:\ Byte,\ high:\ Byte\ ->\ Bool)
  13 .fi
  14 .SH DESCRIPTION
  15 Determines if an integer 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	Byte	The integer to be checked. 
  26 low	Byte	One end of the range to check (inclusive); 
  27 high	Byte	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 Byte(7).is_between(1, 10) == yes
  35 assert Byte(7).is_between(10, 1) == yes
  36 assert Byte(7).is_between(100, 200) == no
  37 assert Byte(7).is_between(1, 7) == yes
  38 .EE
  39 .SH SEE ALSO
  40 .BR Tomo-Byte (3)