-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | Non IEEE-754 compliant compile-time floating-point optimisations
--   
--   The <a>Numeric.FastMath</a> module brings into scope RULES for
--   <a>Float</a>s and <a>Double</a>s that rewrite <tt>x-x</tt>,
--   <tt>0*x</tt> and <tt>x*0</tt> to <tt>0</tt>. This disagrees with
--   IEEE-754 when <tt>x</tt> is <tt>NaN</tt>, but is acceptable for most
--   applications.
--   
--   Importing <a>Numeric.FastMath.Infinitesimal</a> also rewrites
--   <tt>0/x</tt> to <tt>0</tt>.
--   
--   Optimisation (at least <tt>-O1</tt>) must be enabled for any RULES to
--   take effect.
@package fast-math
@version 0.1


-- | Also rewrite <tt>0/x</tt> to <tt>+0</tt>, which should really be
--   <tt>-0</tt> for negative <tt>x</tt>.
module Numeric.FastMath.Infinitesimal


-- | Compile-time optimisations for <a>Float</a> and <a>Double</a> that
--   break IEEE-754 compatibility.
--   
--   Namely, this otherwise empty module contains RULES that rewrite
--   <tt>x-x</tt>, <tt>x*0</tt> and <tt>0*x</tt> to <tt>0</tt>, which is
--   incorrect (according to IEEE-754) when <tt>x</tt> is <tt>NaN</tt>.
--   
--   At the time of writing, <tt>base-4.3.1.0:GHC/Base.lhs</tt> erroneously
--   includes these rules for <a>Float</a>s, but not for <a>Double</a>s.
--   This has been reported as GHC bug #5178:
--   <a>http://hackage.haskell.org/trac/ghc/ticket/5178</a>.
module Numeric.FastMath