summaryrefslogtreecommitdiffstats
path: root/newlib/libm/complex/cabs.c
diff options
context:
space:
mode:
authorJeff Johnston <jjohnstn@redhat.com>2010-10-18 22:40:24 +0000
committerJeff Johnston <jjohnstn@redhat.com>2010-10-18 22:40:24 +0000
commitbf5300eaee04b5e143dea58e922bc6ae260197dd (patch)
tree2d9aa73897ac0abb39e90a468babdf937e2ba513 /newlib/libm/complex/cabs.c
parentcf9e79ca7a5adbc3d6d868ce2334ddd518cda418 (diff)
downloadcygnal-bf5300eaee04b5e143dea58e922bc6ae260197dd.tar.gz
cygnal-bf5300eaee04b5e143dea58e922bc6ae260197dd.tar.bz2
cygnal-bf5300eaee04b5e143dea58e922bc6ae260197dd.zip
2010-10-18 Marco Atzeri <marco_atzeri@yahoo.it>
* libm/Makefile.am: added complex functions documentation * libm/libm.texinfo: ditto * libm/complex/Makefile.am: Ditto * libm/complex/complex.tex: Ditto * libm/complex/(cabs.c, cacos.c, cacosh.c, carg.c, casin.c, casinh.c, catan.c, catanh.c, ccos.c, ccosh.c, cexp.c, cimag.c, clog.c, conj.c, cpow.c, cproj.c, creal.c, csin.c, csinh.c, csqrt.c, ctan.c, ctanh.c): Ditto * libm/Makefile.in: Regenerate * libm/complex/Makefile.in: Ditto
Diffstat (limited to 'newlib/libm/complex/cabs.c')
-rw-r--r--newlib/libm/complex/cabs.c34
1 files changed, 34 insertions, 0 deletions
diff --git a/newlib/libm/complex/cabs.c b/newlib/libm/complex/cabs.c
index eb6366935..2750fab9a 100644
--- a/newlib/libm/complex/cabs.c
+++ b/newlib/libm/complex/cabs.c
@@ -8,6 +8,40 @@
* Marco Atzeri <marco_atzeri@yahoo.it>
*/
+/*
+FUNCTION
+ <<cabs>>, <<cabsf>>---complex absolute-value
+
+INDEX
+ cabs
+INDEX
+ cabsf
+
+ANSI_SYNOPSIS
+ #include <complex.h>
+ double cabs(double complex <[z]>);
+ float cabsf(float complex <[z]>);
+
+
+DESCRIPTION
+ These functions compute compute the complex absolute value
+ (also called norm, modulus, or magnitude) of <[z]>.
+
+ <<cabsf>> is identical to <<cabs>>, except that it performs
+ its calculations on <<floats complex>>.
+
+RETURNS
+ The cabs functions return the complex absolute value.
+
+PORTABILITY
+ <<cabs>> and <<cabsf>> are ISO C99
+
+QUICKREF
+ <<cabs>> and <<cabsf>> are ISO C99
+
+*/
+
+
#include <complex.h>
#include <math.h>