xref: /freebsd/lib/msun/man/copysign.3 (revision 5ca8e32633c4ffbbcd6762e5888b6a4ba0708c6c)
1.\" Copyright (c) 1985, 1991 Regents of the University of California.
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\" 3. Neither the name of the University nor the names of its contributors
13.\"    may be used to endorse or promote products derived from this software
14.\"    without specific prior written permission.
15.\"
16.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26.\" SUCH DAMAGE.
27.\"
28.Dd January 26, 2005
29.Dt COPYSIGN 3
30.Os
31.Sh NAME
32.Nm copysign ,
33.Nm copysignf ,
34.Nm copysignl
35.Nd copy sign
36.Sh LIBRARY
37.Lb libm
38.Sh SYNOPSIS
39.In math.h
40.Ft double
41.Fn copysign "double x" "double y"
42.Ft float
43.Fn copysignf "float x" "float y"
44.Ft long double
45.Fn copysignl "long double x" "long double y"
46.Sh DESCRIPTION
47The
48.Fn copysign ,
49.Fn copysignf
50and
51.Fn copysignl
52functions
53return
54.Fa x
55with its sign changed to
56.Fa y Ns 's .
57.Sh SEE ALSO
58.Xr fabs 3 ,
59.Xr fdim 3 ,
60.Xr ieee 3 ,
61.Xr math 3
62.Sh STANDARDS
63The
64.Fn copysign ,
65.Fn copysignf ,
66and
67.Fn copysignl
68routines conform to
69.St -isoC-99 .
70They implement the Copysign function recommended by
71.St -ieee754 .
72.Sh HISTORY
73The
74.Fn copysign ,
75.Fn copysignf ,
76and
77.Fn copysignl
78functions appeared in
79.Bx 4.3 ,
80.Fx 2.0 ,
81and
82.Fx 5.3 ,
83respectively.
84