]> git.ipfire.org Git - thirdparty/man-pages.git/blobdiff - man3/scalb.3
man*/: ffix (un-bracket tables)
[thirdparty/man-pages.git] / man3 / scalb.3
index 567f6d930aa03e5e16872ae76071f97ee3a88702..a92a1d77fd545037e45a8731bccc453a7d42f284 100644 (file)
@@ -1,66 +1,46 @@
+'\" t
 .\" Copyright 2004 Andries Brouwer <aeb@cwi.nl>.
 .\" and Copyright 2008, Linux Foundation, written by Michael Kerrisk
 .\"     <mtk.manpages@gmail.com>
 .\"
-.\" %%%LICENSE_START(VERBATIM)
-.\" Permission is granted to make and distribute verbatim copies of this
-.\" manual provided the copyright notice and this permission notice are
-.\" preserved on all copies.
+.\" SPDX-License-Identifier: Linux-man-pages-copyleft
 .\"
-.\" Permission is granted to copy and distribute modified versions of this
-.\" manual under the conditions for verbatim copying, provided that the
-.\" entire resulting derived work is distributed under the terms of a
-.\" permission notice identical to this one.
-.\"
-.\" Since the Linux kernel and libraries are constantly changing, this
-.\" manual page may be incorrect or out-of-date.  The author(s) assume no
-.\" responsibility for errors or omissions, or for damages resulting from
-.\" the use of the information contained herein.  The author(s) may not
-.\" have taken the same level of care in the production of this manual,
-.\" which is licensed free of charge, as they might when working
-.\" professionally.
-.\"
-.\" Formatted or processed versions of this manual, if unaccompanied by
-.\" the source, must acknowledge the copyright and authors of this work.
-.\" %%%LICENSE_END
-.\"
-.TH SCALB 3 2016-03-15 "" "Linux Programmer's Manual"
+.TH scalb 3 (date) "Linux man-pages (unreleased)"
 .SH NAME
 scalb, scalbf, scalbl \- multiply floating-point number
 by integral power of radix (OBSOLETE)
+.SH LIBRARY
+Math library
+.RI ( libm ", " \-lm )
 .SH SYNOPSIS
+.nf
 .B #include <math.h>
-.sp
-.BI "double scalb(double " x ", double " exp );
-.br
-.BI "float scalbf(float " x ", float " exp );
-.br
-.BI "long double scalbl(long double " x ", long double " exp );
-.sp
-Link with \fI\-lm\fP.
-.sp
-.in -4n
+.PP
+.BI "[[deprecated]] double scalb(double " x ", double " exp );
+.BI "[[deprecated]] float scalbf(float " x ", float " exp );
+.BI "[[deprecated]] long double scalbl(long double " x ", long double " exp );
+.fi
+.PP
+.RS -4
 Feature Test Macro Requirements for glibc (see
 .BR feature_test_macros (7)):
-.in
-.sp
-.ad l
-.BR scalb ():
-.RS 4
-_XOPEN_SOURCE\ >=\ 500
-.\"    || _XOPEN_SOURCE\ &&\ _XOPEN_SOURCE_EXTENDED
-    || /* Since glibc 2.19: */ _DEFAULT_SOURCE
-    || /* Glibc versions <= 2.19: */ _BSD_SOURCE || _SVID_SOURCE
 .RE
-.br
+.PP
+.BR scalb ():
+.nf
+    _XOPEN_SOURCE >= 500
+.\"    || _XOPEN_SOURCE && _XOPEN_SOURCE_EXTENDED
+        || /* Since glibc 2.19: */ _DEFAULT_SOURCE
+        || /* glibc <= 2.19: */ _BSD_SOURCE || _SVID_SOURCE
+.fi
+.PP
 .BR scalbf (),
 .BR scalbl ():
-.RS 4
-_XOPEN_SOURCE\ >=\ 600
-    || /* Since glibc 2.19: */ _DEFAULT_SOURCE
-    || /* Glibc versions <= 2.19: */ _BSD_SOURCE || _SVID_SOURCE
-.RE
-.ad b
+.nf
+    _XOPEN_SOURCE >= 600
+        || /* Since glibc 2.19: */ _DEFAULT_SOURCE
+        || /* glibc <= 2.19: */ _BSD_SOURCE || _SVID_SOURCE
+.fi
 .SH DESCRIPTION
 These functions multiply their first argument
 .I x
@@ -70,11 +50,11 @@ by
 to the power of
 .IR exp ,
 that is:
+.PP
 .nf
-
     x * FLT_RADIX ** exp
 .fi
-
+.PP
 The definition of
 .B FLT_RADIX
 can be obtained by including
@@ -82,18 +62,18 @@ can be obtained by including
 .\" not in /usr/include but in a gcc lib
 .SH RETURN VALUE
 On success, these functions return
-.IR x
+.I x
 *
 .B FLT_RADIX
 **
 .IR exp .
-
+.PP
 If
 .I x
 or
 .I exp
 is a NaN, a NaN is returned.
-
+.PP
 If
 .I x
 is positive infinity (negative infinity),
@@ -101,13 +81,13 @@ and
 .I exp
 is not negative infinity,
 positive infinity (negative infinity) is returned.
-
+.PP
 If
 .I x
 is +0 (\-0), and
 .I exp
 is not positive infinity, +0 (\-0) is returned.
-
+.PP
 If
 .I x
 is zero, and
@@ -115,7 +95,7 @@ is zero, and
 is positive infinity,
 a domain error occurs, and
 a NaN is returned.
-
+.PP
 If
 .I x
 is an infinity,
@@ -124,7 +104,7 @@ and
 is negative infinity,
 a domain error occurs, and
 a NaN is returned.
-
+.PP
 If the result overflows,
 a range error occurs,
 and the functions return
@@ -134,7 +114,7 @@ or
 .BR HUGE_VALL ,
 respectively, with a sign the same as
 .IR x .
-
+.PP
 If the result underflows,
 a range error occurs,
 and the functions return zero, with a sign the same as
@@ -150,71 +130,68 @@ The following errors can occur:
 Domain error: \fIx\fP is 0, and \fIexp\fP is positive infinity, \
 or \fIx\fP is positive infinity and \fIexp\fP is negative infinity \
 and the other argument is not a NaN
-.\" .I errno
-.\" is set to
-.\" .BR EDOM .
+.I errno
+is set to
+.BR EDOM .
 An invalid floating-point exception
 .RB ( FE_INVALID )
 is raised.
 .TP
 Range error, overflow
-.\" .I errno
-.\" is set to
-.\" .BR ERANGE .
+.I errno
+is set to
+.BR ERANGE .
 An overflow floating-point exception
 .RB ( FE_OVERFLOW )
 is raised.
 .TP
 Range error, underflow
-.\" .I errno
-.\" is set to
-.\" .BR ERANGE .
+.I errno
+is set to
+.BR ERANGE .
 An underflow floating-point exception
 .RB ( FE_UNDERFLOW )
 is raised.
-.PP
-These functions do not set
-.IR errno .
-.\" FIXME . Is it intentional that these functions do not set errno?
-.\" Bug raised: http://sources.redhat.com/bugzilla/show_bug.cgi?id=6803
-.\" Bug raised: http://sources.redhat.com/bugzilla/show_bug.cgi?id=6804
 .SH ATTRIBUTES
 For an explanation of the terms used in this section, see
 .BR attributes (7).
 .TS
 allbox;
-lbw28 lb lb
+lbx lb lb
 l l l.
 Interface      Attribute       Value
 T{
+.na
+.nh
 .BR scalb (),
 .BR scalbf (),
 .BR scalbl ()
 T}     Thread safety   MT-Safe
 .TE
-.SH CONFORMING TO
+.sp 1
+.SH STANDARDS
+None.
+.SH HISTORY
+.TP
 .BR scalb ()
-is specified in POSIX.1-2001, but marked obsolescent.
-POSIX.1-2008 removes the specification of
-.BR scalb (),
+4.3BSD.
+Obsolescent in POSIX.1-2001;
+Removed in POSIX.1-2008,
 recommending the use of
 .BR scalbln (3),
 .BR scalblnf (3),
 or
 .BR scalblnl (3)
 instead.
-The
-.BR scalb ()
-function is from 4.3BSD.
-
-.BR scalbf ()
-and
-.BR scalbl ()
-are unstandardized;
-.BR scalbf ()
-is nevertheless present on several other systems
 .\" Looking at header files: scalbf() is present on the
 .\" BSDs, Tru64, HP-UX 11, Irix 6.5; scalbl() is on HP-UX 11 and Tru64.
+.SH BUGS
+Before glibc 2.20,
+.\" https://www.sourceware.org/bugzilla/show_bug.cgi?id=6803
+.\" https://www.sourceware.org/bugzilla/show_bug.cgi?id=6804
+these functions did not set
+.I errno
+for domain and range errors.
 .SH SEE ALSO
 .BR ldexp (3),
 .BR scalbln (3)