Guardian Native C Library Calls Reference Manual (G06.28+, H06.05+)

hypot(3) Guardian Native C Library Calls Reference Manual
NAME
hypot - Computes the Euclidean distance function
LIBRARY
G-series native Guardian processes: $SYSTEM.SYSnn.ZCRESRL
G-series native OSS processes: /G/system/sysnn/zcresrl
H-series native Guardian processes: $SYSTEM.ZDLLnnn.ZCREDLL
H-series OSS processes: /G/system/zdllnnn/zcredll
SYNOPSIS
#include <math.h>
double hypot(
double x,
double y
);
PARAMETERS
x Specifies a double value.
y Specifies a double value.
DESCRIPTION
The hypot() function computes the length of the hypotenuse of a right-angled triangle with the
formula:
√
x*x+y*y
NOTES
This function supports both IEEE Std 754-1985 floating-point and Tandem floating-point values
in the native environment. IEEE values can include NaN and infinity, and the sign of 0.0 (zero)
can be either positive or negative. Refer to the fp_class(3) reference page for a description of
IEEE value classes.
Guardian functions are available to convert between floating-point formats. Refer to the Guar-
dian Programmer’s Guide for a discussion of floating-point conversions.
RETURN VALUES
Upon successful completion, the hypot( ) function returns the length of the hypotenuse.
If the correct result would cause overflow, HUGE_VAL is returned and errno is set to
[ERANGE]. If the correct result would cause underflow, 0.0 (zero) is returned.
For IEEE floating-point values, if the value of either x or y is NaN, NaN is returned.
ERRORS
If any of the following conditions occurs, the hypot( ) function sets errno to the corresponding
value:
[ERANGE] The value to be returned would cause an overflow.
RELATED INFORMATION
Functions: exp(3), fp_class(3), isnan(3), sqrt(3).
3−56 Hewlett-Packard Company 527192-007