Numeric.Eps

Description

Testing for values "near" zero

Synopsis

Documentation

class (Floating a, Num a) => Epsilon a where #

Provides a test to see if a quantity is near zero.

>>> nearZero (1e-11 :: Double)
False

>>> nearZero (1e-17 :: Double)
True

>>> nearZero (1e-5 :: Float)
False

>>> nearZero (1e-7 :: Float)
True

Minimal complete definition

Methods

Determine if a quantity is near zero.

Instances

Epsilon Double #	`abs` a `<=` 1e-12
Methods nearZero :: Double -> Bool #
Epsilon Float #	`abs` a `<=` 1e-6
Methods nearZero :: Float -> Bool #
Epsilon CFloat #	`abs` a `<=` 1e-6
Methods nearZero :: CFloat -> Bool #
Epsilon CDouble #	`abs` a `<=` 1e-12
Methods nearZero :: CDouble -> Bool #
Epsilon (Complex Double) #	`magnitude` a `<=` 1e-12
Methods nearZero :: Complex Double -> Bool #
Epsilon (Complex Float) #	`magnitude` a `<=` 1e-6
Methods nearZero :: Complex Float -> Bool #
Epsilon (Complex CFloat) #	`magnitude` a `<=` 1e-6
Methods nearZero :: Complex CFloat -> Bool #
Epsilon (Complex CDouble) #	`magnitude` a `<=` 1e-12
Methods nearZero :: Complex CDouble -> Bool #

Is this quantity distinguishable from 0 ?

roundOne :: Epsilon a => a -> a #

Round to respectively 0 or 1

Is this quantity close to 1 ?