rounded-0.1.0.1: Correctly-rounded arbitrary-precision floating-point arithmetic

Copyright(C) 2012-2014 Edward Kmett Daniel Peebles
(C) 2013-2018 Claude Heiland-Allen
LicenseBSD3
MaintainerClaude Heiland-Allen <claude@mathr.co.uk>
Stabilityexperimental
Portabilitynon-portable
Safe HaskellNone
LanguageHaskell2010

Numeric.Rounded.Simple

Contents

Description

This module provides an interface without advanced type system features, that may be more convenient if the precision is changed often.

Synopsis

Floating point numbers with a specified rounding mode and precision

data Rounded #

A properly rounded floating-point number with a given rounding mode and precision.

Instances
Eq Rounded # 
Instance details

Defined in Numeric.Rounded.Simple

Methods

(==) :: Rounded -> Rounded -> Bool #

(/=) :: Rounded -> Rounded -> Bool #

Ord Rounded # 
Instance details

Defined in Numeric.Rounded.Simple

Methods

compare :: Rounded -> Rounded -> Ordering #

(<) :: Rounded -> Rounded -> Bool #

(<=) :: Rounded -> Rounded -> Bool #

(>) :: Rounded -> Rounded -> Bool #

(>=) :: Rounded -> Rounded -> Bool #

max :: Rounded -> Rounded -> Rounded #

min :: Rounded -> Rounded -> Rounded #

reifyRounded :: Rounded -> (forall p. Precision p => Rounded r p -> a) -> a #

simplify :: Rounded r p -> Rounded #

fromInt :: RoundingMode -> Precision -> Int -> Rounded #

fromDouble :: RoundingMode -> Precision -> Double -> Rounded #

fromLongDouble :: RoundingMode -> Precision -> LongDouble -> Rounded #

toDouble :: RoundingMode -> Rounded -> Double #

toLongDouble :: RoundingMode -> Rounded -> LongDouble #

toInteger' :: RoundingMode -> Rounded -> Integer #

precRound :: RoundingMode -> Precision -> Rounded -> Rounded #

Precision

type Precision = Int #

precision :: Rounded -> Precision #

Rounding

data RoundingMode #

Constructors

TowardNearestWithTiesAwayFromZero

currently unsupported placeholder

TowardNearest

roundTiesToEven in IEEE 754-2008

TowardZero

roundTowardZero in IEEE 754-2008

TowardInf

roundTowardPositive in IEEE 754-2008

TowardNegInf

roundTowardNegative in IEEE 754-2008

AwayFromZero

round away from zero

Faithfully

currently unsupported placeholder

Instances
Bounded RoundingMode # 
Instance details

Defined in Numeric.Rounded.Rounding

Methods

minBound :: RoundingMode #

maxBound :: RoundingMode #

Enum RoundingMode # 
Instance details

Defined in Numeric.Rounded.Rounding

Methods

succ :: RoundingMode -> RoundingMode #

pred :: RoundingMode -> RoundingMode #

toEnum :: Int -> RoundingMode #

fromEnum :: RoundingMode -> Int #

enumFrom :: RoundingMode -> [RoundingMode] #

enumFromThen :: RoundingMode -> RoundingMode -> [RoundingMode] #

enumFromTo :: RoundingMode -> RoundingMode -> [RoundingMode] #

enumFromThenTo :: RoundingMode -> RoundingMode -> RoundingMode -> [RoundingMode] #

Eq RoundingMode # 
Instance details

Defined in Numeric.Rounded.Rounding

Methods

(==) :: RoundingMode -> RoundingMode -> Bool #

(/=) :: RoundingMode -> RoundingMode -> Bool #

Data RoundingMode # 
Instance details

Defined in Numeric.Rounded.Rounding

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> RoundingMode -> c RoundingMode #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c RoundingMode #

toConstr :: RoundingMode -> Constr #

dataTypeOf :: RoundingMode -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c RoundingMode) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c RoundingMode) #

gmapT :: (forall b. Data b => b -> b) -> RoundingMode -> RoundingMode #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> RoundingMode -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> RoundingMode -> r #

gmapQ :: (forall d. Data d => d -> u) -> RoundingMode -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> RoundingMode -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> RoundingMode -> m RoundingMode #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> RoundingMode -> m RoundingMode #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> RoundingMode -> m RoundingMode #

Ord RoundingMode # 
Instance details

Defined in Numeric.Rounded.Rounding

Methods

compare :: RoundingMode -> RoundingMode -> Ordering #

(<) :: RoundingMode -> RoundingMode -> Bool #

(<=) :: RoundingMode -> RoundingMode -> Bool #

(>) :: RoundingMode -> RoundingMode -> Bool #

(>=) :: RoundingMode -> RoundingMode -> Bool #

max :: RoundingMode -> RoundingMode -> RoundingMode #

min :: RoundingMode -> RoundingMode -> RoundingMode #

Read RoundingMode # 
Instance details

Defined in Numeric.Rounded.Rounding

Methods

readsPrec :: Int -> ReadS RoundingMode #

readList :: ReadS [RoundingMode] #

readPrec :: ReadPrec RoundingMode #

readListPrec :: ReadPrec [RoundingMode] #

Show RoundingMode # 
Instance details

Defined in Numeric.Rounded.Rounding

Methods

showsPrec :: Int -> RoundingMode -> ShowS #

show :: RoundingMode -> String #

showList :: [RoundingMode] -> ShowS #

SingI TowardNearestWithTiesAwayFromZero # 
Instance details

Defined in Numeric.Rounded.Rounding

Methods

sing :: Sing TowardNearestWithTiesAwayFromZero #

SingI TowardNearest # 
Instance details

Defined in Numeric.Rounded.Rounding

Methods

sing :: Sing TowardNearest #

SingI TowardZero # 
Instance details

Defined in Numeric.Rounded.Rounding

Methods

sing :: Sing TowardZero #

SingI TowardInf # 
Instance details

Defined in Numeric.Rounded.Rounding

Methods

sing :: Sing TowardInf #

SingI TowardNegInf # 
Instance details

Defined in Numeric.Rounded.Rounding

Methods

sing :: Sing TowardNegInf #

SingI AwayFromZero # 
Instance details

Defined in Numeric.Rounded.Rounding

Methods

sing :: Sing AwayFromZero #

SingI Faithfully # 
Instance details

Defined in Numeric.Rounded.Rounding

Methods

sing :: Sing Faithfully #

newtype Sing (m :: RoundingMode) # 
Instance details

Defined in Numeric.Rounded.Rounding

newtype Sing (m :: RoundingMode) = SRounding RoundingMode

Useful Constants

kPi :: RoundingMode -> Precision -> Rounded #

kLog2 :: RoundingMode -> Precision -> Rounded #

kEuler :: RoundingMode -> Precision -> Rounded #

kCatalan :: RoundingMode -> Precision -> Rounded #

Ord

min_ :: RoundingMode -> Precision -> Rounded -> Rounded -> Rounded #

max_ :: RoundingMode -> Precision -> Rounded -> Rounded -> Rounded #

Num

add_ :: RoundingMode -> Precision -> Rounded -> Rounded -> Rounded #

sub_ :: RoundingMode -> Precision -> Rounded -> Rounded -> Rounded #

mul_ :: RoundingMode -> Precision -> Rounded -> Rounded -> Rounded #

negate_ :: RoundingMode -> Precision -> Rounded -> Rounded #

abs_ :: RoundingMode -> Precision -> Rounded -> Rounded #

fromInteger' :: RoundingMode -> Precision -> Integer -> Rounded #

Fractional

div_ :: RoundingMode -> Precision -> Rounded -> Rounded -> Rounded #

fromRational' :: RoundingMode -> Precision -> Rational -> Rounded #

Real

toRational' :: RoundingMode -> Rounded -> Rational #

RealFrac

properFraction_ :: Integral i => Rounded -> (i, Rounded) #

truncate_ :: Precision -> Rounded -> Rounded #

round_ :: Precision -> Rounded -> Rounded #

ceiling_ :: Precision -> Rounded -> Rounded #

floor_ :: Precision -> Rounded -> Rounded #

Floating

sqrt_ :: RoundingMode -> Precision -> Rounded -> Rounded #

exp_ :: RoundingMode -> Precision -> Rounded -> Rounded #

expm1_ :: RoundingMode -> Precision -> Rounded -> Rounded #

log_ :: RoundingMode -> Precision -> Rounded -> Rounded #

log1p_ :: RoundingMode -> Precision -> Rounded -> Rounded #

sin_ :: RoundingMode -> Precision -> Rounded -> Rounded #

cos_ :: RoundingMode -> Precision -> Rounded -> Rounded #

tan_ :: RoundingMode -> Precision -> Rounded -> Rounded #

asin_ :: RoundingMode -> Precision -> Rounded -> Rounded #

acos_ :: RoundingMode -> Precision -> Rounded -> Rounded #

atan_ :: RoundingMode -> Precision -> Rounded -> Rounded #

sinh_ :: RoundingMode -> Precision -> Rounded -> Rounded #

cosh_ :: RoundingMode -> Precision -> Rounded -> Rounded #

tanh_ :: RoundingMode -> Precision -> Rounded -> Rounded #

asinh_ :: RoundingMode -> Precision -> Rounded -> Rounded #

acosh_ :: RoundingMode -> Precision -> Rounded -> Rounded #

atanh_ :: RoundingMode -> Precision -> Rounded -> Rounded #

RealFloat

atan2_ :: RoundingMode -> Precision -> Rounded -> Rounded -> Rounded #

floatRadix' :: Rounded -> Integer #

floatDigits' :: Rounded -> Int #

floatRange' :: Rounded -> (Int, Int) #

decodeFloat' :: Rounded -> (Integer, Int) #

encodeFloat' :: RoundingMode -> Precision -> Integer -> Int -> Rounded #

exponent' :: Rounded -> Int #

significand' :: Rounded -> Rounded #

scaleFloat' :: Int -> Rounded -> Rounded #

isNaN' :: Rounded -> Bool #

isInfinite' :: Rounded -> Bool #

isDenormalized' :: Rounded -> Bool #

isNegativeZero' :: Rounded -> Bool #

isIEEE' :: Rounded -> Bool #

Show

show' :: Rounded -> String #

Read

read' :: RoundingMode -> Precision -> String -> Rounded #

Foreign Function Interface

withInRounded :: Rounded -> (Ptr MPFR -> IO a) -> IO a #

Use a value as a constant mpfr_t (attempts to modify it may explode, changing the precision will explode).

withInOutRounded :: Rounded -> (Ptr MPFR -> IO a) -> IO (Rounded, a) #

Allocates and initializes a new mpfr_t to the value. After the action it is peeked and returned.

withInOutRounded_ :: Rounded -> (Ptr MPFR -> IO a) -> IO Rounded #

Allocates and initializes a new mpfr_t to the value. After the action it is peeked and returned. The result of the action is ignored.

withOutRounded :: Precision -> (Ptr MPFR -> IO a) -> IO (Rounded, a) #

Allocates and initializes a new mpfr_t, after the action it is peeked and returned.

withOutRounded_ :: Precision -> (Ptr MPFR -> IO a) -> IO Rounded #

Allocates and initializes a new mpfr_t, after the action it is peeked and returned. The result of the action is ignored.

peekRounded :: Ptr MPFR -> IO Rounded #

Peek an mpfr_t at its actual precision.