[PPL-devel] [GIT] ppl/ppl(master): Documentation of restore_pre_PPL_rounding() extended .

[Roberto Bagnara]

Module: ppl/ppl
Branch: master
Commit: 38a6756260a2c339f5aaddd012532194af1709e5
URL:    http://www.cs.unipr.it/git/gitweb.cgi?p=ppl/ppl.git;a=commit;h=38a6756260a2c339f5aaddd012532194af1709e5

Author: Roberto Bagnara <bagnara at cs.unipr.it>
Date:   Thu Jun 21 17:38:55 2012 +0200

Documentation of restore_pre_PPL_rounding() extended.

---

 src/Init.defs.hh |    5 +++++
 1 files changed, 5 insertions(+), 0 deletions(-)

diff --git a/src/Init.defs.hh b/src/Init.defs.hh
index f31121c..a6dfc73 100644
--- a/src/Init.defs.hh
+++ b/src/Init.defs.hh
@@ -42,6 +42,11 @@ void set_rounding_for_PPL();
 /*! \brief
   Sets the FPU rounding mode as it was before initialization of the PPL.
 
+  This is important if the application uses floating-point computations
+  outside the PPL.  It is crucial when the application uses functions
+  from a mathematical library that is not guaranteed to work correctly
+  under all rounding modes.
+
   After calling this function it is absolutely necessary to call
   set_rounding_for_PPL() before using any PPL abstractions based on
   floating point numbers.