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  2013-10-14 "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 .BR copysignf (),
  68 and
  69 .BR copysignl ()
  70 functions return a value whose absolute value matches
  71 that of
  72 .IR x ,
  73 but whose sign bit matches that of
  74 .IR y .
  75
  76 For example,
  77 .I "copysign(42.0,\ \-1.0)"
  78 and
  79 .I "copysign(\-42.0, \-1.0)"
  80 both return \-42.0.
  81 .SH RETURN VALUE
  82 On success, these functions return a value whose magnitude is taken from
  83 .I x
  84 and whose sign is taken from
  85 .IR y .
  86
  87 If
  88 .I x
  89 is a NaN,
  90 a NaN with the sign bit of
  91 .I y
  92 is returned.
  93 .SH ERRORS
  94 No errors occur.
  95 .SH ATTRIBUTES
  96 .SS Multithreading (see pthreads(7))
  97 The
  98 .BR copysign (),
  99 .BR copysignf (),
 100 and
 101 .BR copysignl ()
 102 functions are thread-safe.
 103 .SH CONFORMING TO
 104 C99, POSIX.1-2001.
 105 .\" 4.3BSD.
 106 This function is defined in IEC 559 (and the appendix with
 107 recommended functions in IEEE 754/IEEE 854).
 108 .SH NOTES
 109 On architectures where the floating-point formats are not IEEE 754 compliant,
 110 these
 111 functions may treat a negative zero as positive.
 112 .SH SEE ALSO
 113 .BR signbit (3)
 114 .SH COLOPHON
 115 This page is part of release 3.67 of the Linux
 116 .I man-pages
 117 project.
 118 A description of the project,
 119 information about reporting bugs,
 120 and the latest version of this page,
 121 can be found at
 122 \%http://www.kernel.org/doc/man\-pages/.