Data.BigDecimal

Documentation

data BigDecimal

BigDecimal is represented by an unscaled Integer value and a Natural that defines the scale E.g.: (BigDecimal 1234 2) represents the decimal value 12.34.

Constructors

BigDecimal

Fields

• value :: Integer

  the unscaled Integer value

• scale :: Natural

  the scale (i.e. the number of digits after the decimal point)

Instances

Floating BigDecimal

Defined in Data.BigFloating

Methods

pi :: BigDecimal

exp :: BigDecimal -> BigDecimal

log :: BigDecimal -> BigDecimal

sqrt :: BigDecimal -> BigDecimal

(**) :: BigDecimal -> BigDecimal -> BigDecimal

logBase :: BigDecimal -> BigDecimal -> BigDecimal

sin :: BigDecimal -> BigDecimal

cos :: BigDecimal -> BigDecimal

tan :: BigDecimal -> BigDecimal

asin :: BigDecimal -> BigDecimal

acos :: BigDecimal -> BigDecimal

atan :: BigDecimal -> BigDecimal

sinh :: BigDecimal -> BigDecimal

cosh :: BigDecimal -> BigDecimal

tanh :: BigDecimal -> BigDecimal

asinh :: BigDecimal -> BigDecimal

acosh :: BigDecimal -> BigDecimal

atanh :: BigDecimal -> BigDecimal

log1p :: BigDecimal -> BigDecimal

expm1 :: BigDecimal -> BigDecimal

log1pexp :: BigDecimal -> BigDecimal

log1mexp :: BigDecimal -> BigDecimal

Num BigDecimal

Defined in Data.BigDecimal

Methods

(+) :: BigDecimal -> BigDecimal -> BigDecimal

(-) :: BigDecimal -> BigDecimal -> BigDecimal

(*) :: BigDecimal -> BigDecimal -> BigDecimal

negate :: BigDecimal -> BigDecimal

abs :: BigDecimal -> BigDecimal

signum :: BigDecimal -> BigDecimal

fromInteger :: Integer -> BigDecimal

Read BigDecimal

Defined in Data.BigDecimal

Methods

readsPrec :: Int -> ReadS BigDecimal

readList :: ReadS [BigDecimal]

readPrec :: ReadPrec BigDecimal

readListPrec :: ReadPrec [BigDecimal]

Fractional BigDecimal

Defined in Data.BigDecimal

Methods

(/) :: BigDecimal -> BigDecimal -> BigDecimal

recip :: BigDecimal -> BigDecimal

fromRational :: Rational -> BigDecimal

Real BigDecimal

Defined in Data.BigDecimal

Methods

toRational :: BigDecimal -> Rational

Show BigDecimal

Defined in Data.BigDecimal

Methods

showsPrec :: Int -> BigDecimal -> ShowS

show :: BigDecimal -> String

showList :: [BigDecimal] -> ShowS

Eq BigDecimal

Defined in Data.BigDecimal

Methods

(==) :: BigDecimal -> BigDecimal -> Bool

(/=) :: BigDecimal -> BigDecimal -> Bool

Ord BigDecimal

Defined in Data.BigDecimal

Methods

compare :: BigDecimal -> BigDecimal -> Ordering

(<) :: BigDecimal -> BigDecimal -> Bool

(<=) :: BigDecimal -> BigDecimal -> Bool

(>) :: BigDecimal -> BigDecimal -> Bool

(>=) :: BigDecimal -> BigDecimal -> Bool

max :: BigDecimal -> BigDecimal -> BigDecimal

min :: BigDecimal -> BigDecimal -> BigDecimal

data RoundingMode

RoundingMode defines how to handle loss of precision in divisions or explicit rounding.

Constructors

UP

Rounding mode to round away from zero.

DOWN

Rounding mode to round towards zero.

CEILING

Rounding mode to round towards positive infinity.

FLOOR

Rounding mode to round towards negative infinity.

HALF_UP

Rounding mode to round towards "nearest neighbor" unless both neighbors are equidistant, in which case round up.

HALF_DOWN

Rounding mode to round towards "nearest neighbor" unless both neighbors are equidistant, in which case round down.

HALF_EVEN

Rounding mode to round towards "nearest neighbor" unless both neighbors are equidistant, in which case, round towards the even neighbor.

PRECISE

Rounding mode to assert that the requested operation has an exact result, hence no rounding is applied.

type RoundingAdvice = (RoundingMode, Maybe Natural)

A RoundingAdvice is interpreted by divisions and rounding operations to specify the expected loss of precision and the rounding behaviour. RoundingAdvice is a pair of a RoundingMode and a target precision of type Maybe Natural. The precision defines the number of digits after the decimal point. If Nothing is given as precision all decimal digits are to be preserved, that is precision is not limited.

precision :: BigDecimal -> Natural

returns the number of digits of a BigDecimal.

trim :: Natural -> BigDecimal -> BigDecimal

removes trailing zeros from a BigDecimals intValue by decreasing the scale

nf :: BigDecimal -> BigDecimal

computes the normal form of a BigDecimal

divide

Arguments

:: (BigDecimal, BigDecimal)

the tuple of dividend and divisor. I.e. (dividend, divisor)

-> RoundingAdvice

RoundingAdvice (i.e. a tuple of RoundingMode and the specified precision) defines the rounding behaviour. if Nothing if given as precision the maximum possible precision is used.

-> BigDecimal

the resulting BigDecimal

divide two BigDecimals and applies the RoundingAdvice (i.e. a tuple of RoundingMode and the specified precision) for rounding.

roundBD :: BigDecimal -> RoundingAdvice -> BigDecimal

round a BigDecimal according to a RoundingAdvice to n digits applying the RoundingMode rMode

fromRatio :: Rational -> RoundingAdvice -> BigDecimal

creates a BigDecimal from a Rational value. RoundingAdvice defines precision and rounding mode.

halfUp :: Natural -> RoundingAdvice

construct a RoundingAdvice for rounding HALF_UP with scl decimal digits

fromString :: String -> BigDecimal

read a BigDecimal from a human readable decimal notation. e.g. fromString "3.14" yields 'BigDecimal 314 2'

fromStringMaybe :: String -> Maybe BigDecimal

read a BigDecimal from a human readable decimal notation. e.g. fromString "3.14" yields 'BigDecimal 314 2'

fromNatural :: Num a => Natural -> a

convert a Natural to any numeric type a

matchScales :: (BigDecimal, BigDecimal) -> (BigDecimal, BigDecimal)

match the scales of a tuple of BigDecimals