tomo-Num.hypot.3

(36 lines)
   1 '\" t
   2 .\" Copyright (c) 2025 Bruce Hill
   3 .\" All rights reserved.
   4 .\"
   5 .TH Num.hypot 3 2025-11-29 "Tomo man-pages"
   6 .SH NAME
   7 Num.hypot \- Euclidean distance function
   8 .SH LIBRARY
   9 Tomo Standard Library
  10 .SH SYNOPSIS
  11 .nf
  12 .BI Num.hypot\ :\ func(x:\ Num,\ y:\ Num\ ->\ Num)
  13 .fi
  14 .SH DESCRIPTION
  15 Computes the Euclidean norm, $\sqrt{x^2 + y^2}$, of two numbers.
  16 
  17 
  18 .SH ARGUMENTS
  19 
  20 .TS
  21 allbox;
  22 lb lb lbx
  23 l l l.
  24 Name	Type	Description
  25 x	Num	The first number. 
  26 y	Num	The second number. 
  27 .TE
  28 .SH RETURN
  29 The Euclidean norm of `x` and `y`.
  30 
  31 .SH EXAMPLES
  32 .EX
  33 assert Num.hypot(3, 4) == 5
  34 .EE
  35 .SH SEE ALSO
  36 .BR Tomo-Num (3)