dev
Download
40 lines 882 BGroffModified 2025-12-31 raw
12345678910111213141516171819202122232425262728293031323334353637383940
'\" t
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
.TH Num.is_between 3 2025-12-31 "Tomo man-pages"
.SH NAME
Num.is_between \- check if a number is in a range
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Num.is_between\ :\ func(x:\ Num,\ low:\ Num,\ high:\ Num\ ->\ Bool)
.fi
.SH DESCRIPTION
Determines if a number is between two numbers (inclusive).


.SH ARGUMENTS

.TS
allbox;
lb lb lbx
l l l.
Name	Type	Description
x	Num	The integer to be checked. 
low	Num	One end of the range to check (inclusive). 
high	Num	The other end of the range to check (inclusive). 
.TE
.SH RETURN
`yes` if `a <= x and x <= b` or `b <= x and x <= a`, otherwise `no`

.SH EXAMPLES
.EX
assert (7.5).is_between(1, 10) == yes
assert (7.5).is_between(10, 1) == yes
assert (7.5).is_between(100, 200) == no
assert (7.5).is_between(1, 7.5) == yes
.EE
.SH SEE ALSO
.BR Tomo-Num (3)