aboutsummaryrefslogtreecommitdiff
path: root/man/man3/tomo-Num.hypot.3
blob: c640236f62cf4d7c04d2e1f03816ddb652b887f2 (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.hypot 3 2025-04-30 "Tomo man-pages"
.SH NAME
Num.hypot \- Euclidean distance function
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Num.hypot\ :\ func(x:\ Num,\ y:\ Num\ ->\ Num)
.fi
.SH DESCRIPTION
Computes the Euclidean norm, $\sqrt{x^2 + y^2}$, of two numbers.


.SH ARGUMENTS

.TS
allbox;
lb lb lbx lb
l l l l.
Name	Type	Description	Default
x	Num	The first number. 	-
y	Num	The second number. 	-
.TE
.SH RETURN
The Euclidean norm of `x` and `y`.

.SH EXAMPLES
.EX
>> Num.hypot(3, 4)
= 5
.EE