aboutsummaryrefslogtreecommitdiff
path: root/man/man3/tomo-Float.fdim.3
blob: a3be0af59c45df85ba6f636a14b293217e3c91cc (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
'\" t
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
.TH Float.fdim 3 2025-12-11 "Tomo man-pages"
.SH NAME
Float.fdim \- positive difference
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Float.fdim\ :\ func(x:\ Float,\ y:\ Float\ ->\ Float)
.fi
.SH DESCRIPTION
Computes the positive difference between two numbers.


.SH ARGUMENTS

.TS
allbox;
lb lb lbx
l l l.
Name	Type	Description
x	Float	The first number. 
y	Float	The second number. 
.TE
.SH RETURN
The positive difference $\max(0, x - y)$.

.SH EXAMPLES
.EX
fd

assert (5.0).fdim(3) == 2
.EE
.SH SEE ALSO
.BR Tomo-Float (3)