All pages: Remove the 5th argument to .TH

[thirdparty/man-pages.git] / man3 / copysign.3

.\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk)
.\"
.\" SPDX-License-Identifier: Linux-man-pages-copyleft
.\"
.\" References consulted:
.\"     Linux libc source code
.\"     Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991)
.\"     386BSD man pages
.\" Modified 1993-07-24 by Rik Faith (faith@cs.unc.edu)
.\" Modified 2002-08-10 by Walter Harms (walter.harms@informatik.uni-oldenburg.de)
.TH COPYSIGN 3  2021-03-22 "Linux man-pages (unreleased)"
.SH NAME
copysign, copysignf, copysignl \- copy sign of a number
.SH LIBRARY
Math library
.RI ( libm ", " \-lm )
.SH SYNOPSIS
.nf
.B #include <math.h>
.PP
.BI "double copysign(double " x ", double " y );
.BI "float copysignf(float " x ", float " y );
.BI "long double copysignl(long double " x ", long double " y );
.fi
.PP
.RS -4
Feature Test Macro Requirements for glibc (see
.BR feature_test_macros (7)):
.RE
.PP
.BR copysign (),
.BR copysignf (),
.BR copysignl ():
.nf
    _ISOC99_SOURCE || _POSIX_C_SOURCE >= 200112L
        || /* Since glibc 2.19: */ _DEFAULT_SOURCE
        || /* Glibc <= 2.19: */ _BSD_SOURCE || _SVID_SOURCE
.fi
.SH DESCRIPTION
These functions return a value whose absolute value matches that of
.IR x ,
but whose sign bit matches that of
.IR y .
.PP
For example,
.I "copysign(42.0,\ \-1.0)"
and
.I "copysign(\-42.0, \-1.0)"
both return \-42.0.
.SH RETURN VALUE
On success, these functions return a value whose magnitude is taken from
.I x