Patchwork [libquadmath] Document typedef and constants in libquadmath.texi

login
register
mail settings
Submitter Tobias Burnus
Date Jan. 15, 2011, 5:53 p.m.
Message ID <4D31DEFF.30009@net-b.de>
Download mbox | patch
Permalink /patch/79058/
State New
Headers show

Comments

Tobias Burnus - Jan. 15, 2011, 5:53 p.m.
The patch contains also the constants of the approved patch at 
http://gcc.gnu.org/ml/gcc-patches/2011-01/msg00332.html

OK for committal?

Tobias
Ian Taylor - Jan. 17, 2011, 6:18 p.m.
On Sat, Jan 15, 2011 at 9:53 AM, Tobias Burnus <burnus@net-b.de> wrote:
> The patch contains also the constants of the approved patch at
> http://gcc.gnu.org/ml/gcc-patches/2011-01/msg00332.html
>
> OK for committal?

This is OK.

In general no additional approval is required for an update to the
documentation relevant for a patch you have yourself written.

Thanks.

Ian

Patch

2011-01-15  Tobias Burnus  <burnus@net-b.de>

	PR fortran/47295
	* libquadmath.text: Document typedef and constants.

diff --git a/libquadmath/libquadmath.texi b/libquadmath/libquadmath.texi
index 8818a37..e19f9b1 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 ---------------------------------------------------------------------