original/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  2012-03-25 "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 .sp
  38 .BI "double copysign(double " x ", double " y );
  39 .br
  40 .BI "float copysignf(float " x ", float " y );
  41 .br
  42 .BI "long double copysignl(long double " x ", long double " y );
  43 .fi
  44 .sp
  45 Link with \fI\-lm\fP.
  46 .sp
  47 .in -4n
  48 Feature Test Macro Requirements for glibc (see
  49 .BR feature_test_macros (7)):
  50 .in
  51 .sp
  52 .ad l
  53 .BR copysign (),
  54 .BR copysignf (),
  55 .BR copysignl ():
  56 .RS 4
  57 _SVID_SOURCE || _BSD_SOURCE || _XOPEN_SOURCE\ >=\ 600 || _ISOC99_SOURCE ||
  58 _POSIX_C_SOURCE\ >=\ 200112L;
  59 .br
  60 or
  61 .I cc\ -std=c99
  62 .RE
  63 .ad b
  64 .SH DESCRIPTION
  65 The
  66 .BR copysign ()
  67 functions return a value whose absolute value matches
  68 that of
  69 .IR x ,
  70 but whose sign bit matches that of
  71 .IR y .
  72
  73 For example,
  74 .I "copysign(42.0,\ \-1.0)"
  75 and
  76 .I "copysign(\-42.0, \-1.0)"
  77 both return \-42.0.
  78 .SH RETURN VALUE
  79 On success, these functions return a value whose magnitude is taken from
  80 .I x
  81 and whose sign is taken from
  82 .IR y .
  83
  84 If
  85 .I x
  86 is a NaN,
  87 a NaN with the sign bit of
  88 .I y
  89 is returned.
  90 .SH ERRORS
  91 No errors occur.
  92 .SH CONFORMING TO
  93 C99, POSIX.1-2001.
  94 .\" 4.3BSD.
  95 This function is defined in IEC 559 (and the appendix with
  96 recommended functions in IEEE 754/IEEE 854).
  97 .SH NOTES
  98 On architectures where the floating-point formats are not IEEE 754 compliant,
  99 the
 100 .BR copysign ()
 101 functions may treat a negative zero as positive.
 102 .SH SEE ALSO
 103 .BR signbit (3)