]> git.ipfire.org Git - thirdparty/man-pages.git/blobdiff - man3/clog2.3
err.3: EXAMPLES: use EXIT_FAILURE rather than 1 as exit status
[thirdparty/man-pages.git] / man3 / clog2.3
index 091882d880915950323780b3750822f9068a5190..953ace2f62bdd4c8b0a1cb7dfb3b6910c10ac371 100644 (file)
@@ -1,30 +1,44 @@
 .\" Copyright 2002 Walter Harms (walter.harms@informatik.uni-oldenburg.de)
+.\"
+.\" %%%LICENSE_START(GPL_NOVERSION_ONELINE)
 .\" Distributed under GPL
+.\" %%%LICENSE_END
 .\"
-.TH CLOG2 3 2002-07-28 "" "complex math routines"
+.TH CLOG2 3 2017-09-15 "" "Linux Programmer's Manual"
 .SH NAME
 clog2, clog2f, clog2l \- base-2 logarithm of a complex number
 .SH SYNOPSIS
 .B #include <complex.h>
-.sp
+.PP
 .BI "double complex clog2(double complex " z );
 .br
 .BI "float complex clog2f(float complex " z );
 .br
 .BI "long double complex clog2l(long double complex " z );
-.sp
-Link with \-lm.
+.\" .PP
+.\" Link with \fI\-lm\fP.
 .SH DESCRIPTION
-The logarithm is defined as log2(cabs(z))+I*carg(z).
-Please note that z close to zero will cause an overflow. 
-.SH "CONFORMING TO"
-The function name is reserved for future use in C99.
-.SH AVAILABILITY
-Not yet in glibc 2.3.2.
+The call
+.I clog2(z)
+is equivalent to
+.IR clog(z)/log(2) .
+.PP
+The other functions perform the same task for
+.I float
+and
+.IR "long double" .
+.PP
+Note that
+.I z
+close to zero will cause an overflow.
+.SH CONFORMING TO
+These function names are reserved for future use in C99.
+.PP
+Not yet in glibc, as at version 2.19.
 .\" But reserved in NAMESPACE.
-.SH "SEE ALSO"
+.SH SEE ALSO
 .BR cabs (3),
 .BR cexp (3),
 .BR clog (3),
 .BR clog10 (3),
-.BR complex (5)
+.BR complex (7)