summaryrefslogtreecommitdiffstats
path: root/upstream/opensuse-tumbleweed/man3/clog.3
diff options
context:
space:
mode:
Diffstat (limited to 'upstream/opensuse-tumbleweed/man3/clog.3')
-rw-r--r--upstream/opensuse-tumbleweed/man3/clog.372
1 files changed, 72 insertions, 0 deletions
diff --git a/upstream/opensuse-tumbleweed/man3/clog.3 b/upstream/opensuse-tumbleweed/man3/clog.3
new file mode 100644
index 00000000..5a75d36c
--- /dev/null
+++ b/upstream/opensuse-tumbleweed/man3/clog.3
@@ -0,0 +1,72 @@
+'\" t
+.\" Copyright 2002 Walter Harms (walter.harms@informatik.uni-oldenburg.de)
+.\"
+.\" SPDX-License-Identifier: GPL-1.0-or-later
+.\"
+.TH clog 3 2023-07-20 "Linux man-pages 6.05.01"
+.SH NAME
+clog, clogf, clogl \- natural logarithm of a complex number
+.SH LIBRARY
+Math library
+.RI ( libm ", " \-lm )
+.SH SYNOPSIS
+.nf
+.B #include <complex.h>
+.PP
+.BI "double complex clog(double complex " z );
+.BI "float complex clogf(float complex " z );
+.BI "long double complex clogl(long double complex " z );
+.fi
+.SH DESCRIPTION
+These functions calculate the complex natural logarithm of
+.IR z ,
+with a branch cut along the negative real axis.
+.PP
+The logarithm
+.BR clog ()
+is the inverse function of the exponential
+.BR cexp (3).
+Thus, if \fIy\ =\ clog(z)\fP, then \fIz\ =\ cexp(y)\fP.
+The imaginary part of
+.I y
+is chosen in the interval [\-pi,pi].
+.PP
+One has:
+.PP
+.in +4n
+.EX
+clog(z) = log(cabs(z)) + I * carg(z)
+.EE
+.in
+.PP
+Note that
+.I z
+close to zero will cause an overflow.
+.SH ATTRIBUTES
+For an explanation of the terms used in this section, see
+.BR attributes (7).
+.TS
+allbox;
+lbx lb lb
+l l l.
+Interface Attribute Value
+T{
+.na
+.nh
+.BR clog (),
+.BR clogf (),
+.BR clogl ()
+T} Thread safety MT-Safe
+.TE
+.sp 1
+.SH STANDARDS
+C11, POSIX.1-2008.
+.SH HISTORY
+glibc 2.1.
+C99, POSIX.1-2001.
+.SH SEE ALSO
+.BR cabs (3),
+.BR cexp (3),
+.BR clog10 (3),
+.BR clog2 (3),
+.BR complex (7)