summaryrefslogtreecommitdiff
path: root/libquadmath
diff options
context:
space:
mode:
authorburnus <burnus@138bc75d-0d04-0410-961f-82ee72b054a4>2011-01-17 19:03:28 +0000
committerburnus <burnus@138bc75d-0d04-0410-961f-82ee72b054a4>2011-01-17 19:03:28 +0000
commit9ca6b8e19edefea5003d514b35d133f796add639 (patch)
tree38d035a053d09ea1651ea84d45c02a8a11081dea /libquadmath
parent9b19281364923ce44387287dcbfa45322ca07129 (diff)
downloadgcc-9ca6b8e19edefea5003d514b35d133f796add639.tar.gz
2011-01-17 Tobias Burnus <burnus@net-b.de>
PR fortran/47295 * libquadmath.text: Document typedef and constants. git-svn-id: svn+ssh://gcc.gnu.org/svn/gcc/trunk@168930 138bc75d-0d04-0410-961f-82ee72b054a4
Diffstat (limited to 'libquadmath')
-rw-r--r--libquadmath/ChangeLog5
-rw-r--r--libquadmath/libquadmath.texi47
2 files changed, 52 insertions, 0 deletions
diff --git a/libquadmath/ChangeLog b/libquadmath/ChangeLog
index f5308db895c..b6929df0258 100644
--- a/libquadmath/ChangeLog
+++ b/libquadmath/ChangeLog
@@ -1,5 +1,10 @@
2011-01-17 Tobias Burnus <burnus@net-b.de>
+ PR fortran/47295
+ * libquadmath.text: Document typedef and constants.
+
+2011-01-17 Tobias Burnus <burnus@net-b.de>
+
PR fortran/46817
* quadmath-imp.h: Refer to libquadmath not ot libiberty,
bump copyright year and use /**/ instead of // comments.
diff --git a/libquadmath/libquadmath.texi b/libquadmath/libquadmath.texi
index 3dbbe5d6380..bcd205939d9 100644
--- a/libquadmath/libquadmath.texi
+++ b/libquadmath/libquadmath.texi
@@ -72,6 +72,7 @@ Math Library Application Programming Interface (API).
@comment better formatting.
@comment
@menu
+* Typedef and constants:: Defined data types and constants
* Math Library Routines:: The Libquadmath math runtime application
programming interface.
* I/O Library Routines:: The Libquadmath I/O runtime application
@@ -84,6 +85,52 @@ Math Library Application Programming Interface (API).
@c ---------------------------------------------------------------------
+@c Defined macros
+@c ---------------------------------------------------------------------
+
+@node Typedef and constants
+@chapter Typedef and constants
+
+The following data type has been defined via @code{typedef}.
+
+@table @asis
+@item @code{__complex128}: @code{__float128}-based complex number
+@end table
+
+The following macros are defined, which give the numeric limits of the
+@code{__float128} data type.
+
+@table @asis
+@item @code{FLT128_MAX}: largest finite number
+@item @code{FLT128_MIN}: smallest positive number with full precision
+@item @code{FLT128_EPSILON}: difference between 1 and the next larger
+ representable number
+@item @code{FLT128_DENORM_MIN}: smallest positive denormalized number
+@item @code{FLT128_MANT_DIG}: number of digits in the mantissa (bit precision)
+@item @code{FLT128_MIN_EXP}: maximal negative exponent
+@item @code{FLT128_MAX_EXP}: maximal positive exponent
+@end table
+
+The following mathematical constants of type @code{__float128} are defined.
+
+@table @asis
+@item @code{M_Eq}: the constant e (Euler's number)
+@item @code{M_LOG2Eq}: binary logarithm of 2
+@item @code{M_LOG10Eq}: common, decimal logarithm of 2
+@item @code{M_LN2q}: natural logarithm of 2
+@item @code{M_LN10q}: natural logarithm of 10
+@item @code{M_PIq}: pi
+@item @code{M_PI_2q}: two pi
+@item @code{M_PI_4q}: four pi
+@item @code{M_1_PIq}: one over pi
+@item @code{M_2_PIq}: one over two pi
+@item @code{M_2_SQRTPIq}: two over square root of pi
+@item @code{M_SQRT2q}: square root of 2
+@item @code{M_SQRT1_2q}: one over square root of 2
+@end table
+
+
+@c ---------------------------------------------------------------------
@c Math routines
@c ---------------------------------------------------------------------