Safe Haskell	None
Language	Haskell2010

Gini.Math.Amount.Internal

Contents

Conversion

Synopsis

data Amount
type AmountScale = 30
amountScale :: Int
plusAmounts :: MonadThrow m => Amount -> Amount -> m Amount
minusAmounts :: MonadThrow m => Amount -> Amount -> m Amount
timesAmount :: MonadThrow m => Amount -> Integer -> m Amount
quotRemAmount :: MonadThrow m => Amount -> Integer -> m (Amount, Amount)
zeroAmount :: Amount
oneAmount :: Amount
amountToRational :: Amount -> Rational
amountToFixed :: Amount -> Fixed FixedAmount
data FixedAmount

Documentation

data Amount #

Instances

Bounded Amount #
Instance details Defined in Gini.Math.Amount.Internal Methods minBound :: Amount # maxBound :: Amount #
Eq Amount #
Instance details Defined in Gini.Math.Amount.Internal Methods (==) :: Amount -> Amount -> Bool # (/=) :: Amount -> Amount -> Bool #
Ord Amount #
Instance details Defined in Gini.Math.Amount.Internal Methods compare :: Amount -> Amount -> Ordering # (<) :: Amount -> Amount -> Bool # (<=) :: Amount -> Amount -> Bool # (>) :: Amount -> Amount -> Bool # (>=) :: Amount -> Amount -> Bool # max :: Amount -> Amount -> Amount # min :: Amount -> Amount -> Amount #
Show Amount #
Instance details Defined in Gini.Math.Amount.Internal Methods showsPrec :: Int -> Amount -> ShowS # show :: Amount -> String # showList :: [Amount] -> ShowS #
Storable Amount #
Instance details Defined in Gini.Math.Amount.Internal Methods sizeOf :: Amount -> Int # alignment :: Amount -> Int # peekElemOff :: Ptr Amount -> Int -> IO Amount # pokeElemOff :: Ptr Amount -> Int -> Amount -> IO () # peekByteOff :: Ptr b -> Int -> IO Amount # pokeByteOff :: Ptr b -> Int -> Amount -> IO () # peek :: Ptr Amount -> IO Amount # poke :: Ptr Amount -> Amount -> IO () #
Persist Amount #
Instance details Defined in Gini.Math.Amount.Internal Methods put :: Amount -> Put () get :: Get Amount
Prim Amount #
Instance details Defined in Gini.Math.Amount.Internal Methods sizeOf# :: Amount -> Int# alignment# :: Amount -> Int# indexByteArray# :: ByteArray# -> Int# -> Amount readByteArray# :: MutableByteArray# s -> Int# -> State# s -> (#State# s, Amount#) writeByteArray# :: MutableByteArray# s -> Int# -> Amount -> State# s -> State# s setByteArray# :: MutableByteArray# s -> Int# -> Int# -> Amount -> State# s -> State# s indexOffAddr# :: Addr# -> Int# -> Amount readOffAddr# :: Addr# -> Int# -> State# s -> (#State# s, Amount#) writeOffAddr# :: Addr# -> Int# -> Amount -> State# s -> State# s setOffAddr# :: Addr# -> Int# -> Int# -> Amount -> State# s -> State# s
Validity Amount #
Instance details Defined in Gini.Math.Amount.Internal Methods validate :: Amount -> Validation
PersistField Amount #
Instance details Defined in Gini.Math.Amount.Internal Methods toPersistValue :: Amount -> PersistValue fromPersistValue :: PersistValue -> Either Text Amount
PersistFieldSql Amount #
Instance details Defined in Gini.Math.Amount.Internal Methods sqlType :: Proxy Amount -> SqlType
MonadThrow m => Fractional (m Amount) #
Instance details Defined in Gini.Math.Amount.Internal Methods (/) :: m Amount -> m Amount -> m Amount # recip :: m Amount -> m Amount # fromRational :: Rational -> m Amount #
MonadThrow m => Num (m Amount) #
Instance details Defined in Gini.Math.Amount.Internal Methods (+) :: m Amount -> m Amount -> m Amount # (-) :: m Amount -> m Amount -> m Amount # (*) :: m Amount -> m Amount -> m Amount # negate :: m Amount -> m Amount # abs :: m Amount -> m Amount # signum :: m Amount -> m Amount # fromInteger :: Integer -> m Amount #

type AmountScale = 30 #

amountScale :: Int #

Value level scaling.

plusAmounts :: MonadThrow m => Amount -> Amount -> m Amount #

Sum two amounts together while checking that the result is valid.

minusAmounts :: MonadThrow m => Amount -> Amount -> m Amount #

Sum two amounts while checking that the result is valid.

timesAmount :: MonadThrow m => Amount -> Integer -> m Amount #

Multiply an amount by an Integer.

>>> pia <- 3.141592653589793238462643 :: IO Amount
>>> pia `timesAmount` 10
31.415926535897932384626430
>>> pia `timesAmount` 100000
314159.265358979323846264300000
>>> pia `timesAmount` 10000000000
*** Exception: arithmetic overflow

quotRemAmount :: MonadThrow m => Amount -> Integer -> m (Amount, Amount) #

Divide the amount and keep the remainder.

>>> pia <- 3.141592653589793238462643 :: IO Amount
>>> pia `quotRemAmount` 1000000
(0.000003141592653589793238,0.000000000000000000462643)
>>> pia `quotRemAmount` (-7) :: Either SomeException (Amount, Amount)
Left arithmetic underflow
>>> pia `quotRemAmount` 0 :: Either SomeException (Amount, Amount)
Left divide by zero

zeroAmount :: Amount #

Just a convenience constructor for an amount with value 0

oneAmount :: Amount #

This is one: 1.0

Conversion

amountToRational :: Amount -> Rational #

amountToFixed :: Amount -> Fixed FixedAmount #

data FixedAmount #

Instances

HasResolution FixedAmount #
Instance details Defined in Gini.Math.Amount.Internal Methods resolution :: p FixedAmount -> Integer #