aboutsummaryrefslogtreecommitdiff
path: root/man/man3/tomo-Int.is_between.3
blob: fd54eb41a328d67eaa7e4e9b0866c89de6217fb9 (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 Int.is_between 3 2025-12-31 "Tomo man-pages"
.SH NAME
Int.is_between \- test if an int is in a range
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Int.is_between\ :\ func(x:\ Int,\ a:\ Int,\ b:\ Int\ ->\ Bool)
.fi
.SH DESCRIPTION
Determines if an integer is between two numbers (inclusive).


.SH ARGUMENTS

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

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