original/man3/copysign.3

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