diff options
| author |   martynas <martynas@openbsd.org> | 2011-07-20 17:50:43 +0000 |
|---|---|---|
| committer | martynas <martynas@openbsd.org> | 2011-07-20 17:50:43 +0000 |
| commit | 2bfdbafec9951640ad90a58b3c5683cd216ec3b5 (patch) | |
| tree | 1b50665a05a65c2d284a6bdb519d024b25e119ea /lib/libm/man/csqrt.3 | |
| parent | - Replace digicert 2nd-level cert with the root which issued it. (diff) | |
| download | wireguard-openbsd-2bfdbafec9951640ad90a58b3c5683cd216ec3b5.tar.xz wireguard-openbsd-2bfdbafec9951640ad90a58b3c5683cd216ec3b5.zip | |
Document complex math library.
Diffstat (limited to 'lib/libm/man/csqrt.3')
| -rw-r--r-- | lib/libm/man/csqrt.3 | 72 |
1 files changed, 72 insertions, 0 deletions
diff --git a/lib/libm/man/csqrt.3 b/lib/libm/man/csqrt.3 new file mode 100644 index 00000000000..0e12237138f --- /dev/null +++ b/lib/libm/man/csqrt.3 @@ -0,0 +1,72 @@ +.\" $OpenBSD: csqrt.3,v 1.1 2011/07/20 17:50:43 martynas Exp $ +.\" +.\" Copyright (c) 2011 Martynas Venckus <martynas@openbsd.org> +.\" +.\" Permission to use, copy, modify, and distribute this software for any +.\" purpose with or without fee is hereby granted, provided that the above +.\" copyright notice and this permission notice appear in all copies. +.\" +.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES +.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF +.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR +.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES +.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN +.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF +.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. +.\" +.Dd $Mdocdate: July 20 2011 $ +.Dt CSQRT 3 +.Os +.Sh NAME +.Nm csqrt , +.Nm csqrtf , +.Nm csqrtl +.Nd complex square root +.Sh SYNOPSIS +.Fd #include <complex.h> +.Ft double complex +.Fn csqrt "double complex z" +.Ft float complex +.Fn csqrtf "float complex z" +.Ft long double complex +.Fn csqrtl "long double complex z" +.Sh DESCRIPTION +The +.Fn csqrt , +.Fn csqrtf +and +.Fn csqrtl +functions compute the complex square root of +.Fa z . +.Pp +If +.Fa z += x + iy, then +.Bd -literal -offset indent +Re csqrt(z) = [ (|z| + x) / 2 ]^(1/2). +Im csqrt(z) = [ (|z| - x) / 2 ]^(1/2). +.Ed +.Pp +Note that -csqrt(z) is also a square root of +.Fa z . +The root chosen +is always in the right half plane and Im csqrt(z) has the same sign +as y. +.Sh RETURN VALUES +The +.Fn csqrt , +.Fn csqrtf +and +.Fn csqrtl +functions return the complex square root of +.Fa z . +.Sh SEE ALSO +.Xr cpow 3 +.Sh STANDARDS +The +.Fn csqrt , +.Fn csqrtf +and +.Fn csqrtl +functions conform to +.St -isoC-99 . |