blob: 3ed483442520f4377096fc74dc155806e7790b82 (
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
|
'\" t
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
.TH Num.clamped 3 2025-09-21 "Tomo man-pages"
.SH NAME
Num.clamped \- clamp a number
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Num.clamped\ :\ func(x:\ Num,\ low:\ Num,\ high:\ Num\ ->\ Num)
.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 Num The number to clamp. -
low Num The lowest value the result can take. -
high Num The highest value the result can take. -
.TE
.SH RETURN
The first argument clamped between the other two arguments.
.SH EXAMPLES
.EX
assert (2.5).clamped(5.5, 10.5) == 5.5
.EE
|
