blob: ea78d895f22a1ba279de44706486a7e9d61e2a10 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
|
'\" 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)
|