blob: 0d01aefaacf13078a3384952e11ba331362de5f1 (
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
|
'\" t
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
.TH Int.clamped 3 2025-04-21T14:54:02.044116 "Tomo man-pages"
.SH NAME
Int.clamped \- clamp an integer
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Int.clamped\ :\ func(x:\ Int,\ low:\ Int,\ high:\ Int\ ->\ Int)
.fi
.SH DESCRIPTION
Returns the given number clamped between two values so that it is within that range.
.SH ARGUMENTS
.TS
allbox;
lb lb lbx lb
l l l l.
Name Type Description Default
x Int The integer to clamp. -
low Int The lowest value the result can take. -
high Int The highest value the result can take. -
.TE
.SH RETURN
The first argument clamped between the other two arguments.
.SH EXAMPLES
.EX
>> (2).clamped(5, 10)
= 5
.EE
|
