man3/copysign.3

   1 .\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk)
   2 .\"
   3 .\" %%%LICENSE_START(VERBATIM)
   4 .\" Permission is granted to make and distribute verbatim copies of this
   5 .\" manual provided the copyright notice and this permission notice are
   6 .\" preserved on all copies.
   7 .\"
   8 .\" Permission is granted to copy and distribute modified versions of this
   9 .\" manual under the conditions for verbatim copying, provided that the
  10 .\" entire resulting derived work is distributed under the terms of a
  11 .\" permission notice identical to this one.
  12 .\"
  13 .\" Since the Linux kernel and libraries are constantly changing, this
  14 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  15 .\" responsibility for errors or omissions, or for damages resulting from
  16 .\" the use of the information contained herein.  The author(s) may not
  17 .\" have taken the same level of care in the production of this manual,
  18 .\" which is licensed free of charge, as they might when working
  19 .\" professionally.
  20 .\"
  21 .\" Formatted or processed versions of this manual, if unaccompanied by
  22 .\" the source, must acknowledge the copyright and authors of this work.
  23 .\" %%%LICENSE_END
  24 .\"
  25 .\" References consulted:
  26 .\"     Linux libc source code
  27 .\"     Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991)
  28 .\"     386BSD man pages
  29 .\" Modified 1993-07-24 by Rik Faith (faith@cs.unc.edu)
  30 .\" Modified 2002-08-10 by Walter Harms (walter.harms@informatik.uni-oldenburg.de)
  31 .TH COPYSIGN 3  2021-03-22 "GNU" "Linux Programmer's Manual"
  32 .SH NAME
  33 copysign, copysignf, copysignl \- copy sign of a number
  34 .SH SYNOPSIS
  35 .nf
  36 .B #include <math.h>
  37 .PP
  38 .BI "double copysign(double " x ", double " y );
  39 .BI "float copysignf(float " x ", float " y );
  40 .BI "long double copysignl(long double " x ", long double " y );
  41 .fi
  42 .PP
  43 Link with \fI\-lm\fP.
  44 .PP
  45 .RS -4
  46 Feature Test Macro Requirements for glibc (see
  47 .BR feature_test_macros (7)):
  48 .RE
  49 .PP
  50 .BR copysign (),
  51 .BR copysignf (),
  52 .BR copysignl ():
  53 .nf
  54     _ISOC99_SOURCE || _POSIX_C_SOURCE >= 200112L
  55         || /* Since glibc 2.19: */ _DEFAULT_SOURCE
  56         || /* Glibc <= 2.19: */ _BSD_SOURCE || _SVID_SOURCE
  57 .fi
  58 .SH DESCRIPTION
  59 These functions return a value whose absolute value matches that of
  60 .IR x ,
  61 but whose sign bit matches that of
  62 .IR y .
  63 .PP
  64 For example,
  65 .I "copysign(42.0,\ \-1.0)"
  66 and
  67 .I "copysign(\-42.0, \-1.0)"
  68 both return \-42.0.
  69 .SH RETURN VALUE
  70 On success, these functions return a value whose magnitude is taken from
  71 .I x
  72 and whose sign is taken from
  73 .IR y .
  74 .PP
  75 If
  76 .I x
  77 is a NaN,
  78 a NaN with the sign bit of
  79 .I y
  80 is returned.
  81 .SH ERRORS
  82 No errors occur.
  83 .SH ATTRIBUTES
  84 For an explanation of the terms used in this section, see
  85 .BR attributes (7).
  86 .ad l
  87 .nh
  88 .TS
  89 allbox;
  90 lbx lb lb
  91 l l l.
  92 Interface       Attribute       Value
  93 T{
  94 .BR copysign (),
  95 .BR copysignf (),
  96 .BR copysignl ()
  97 T}      Thread safety   MT-Safe
  98 .TE
  99 .hy
 100 .ad
 101 .sp 1
 102 .SH CONFORMING TO
 103 C99, POSIX.1-2001, POSIX.1-2008.
 104 .\" 4.3BSD.
 105 This function is defined in IEC 559 (and the appendix with
 106 recommended functions in IEEE 754/IEEE 854).
 107 .SH NOTES
 108 On architectures where the floating-point formats are not IEEE 754 compliant,
 109 these
 110 functions may treat a negative zero as positive.
 111 .SH SEE ALSO
 112 .BR signbit (3)