Numeric.NonNegative

Non-negative numbers:

ghci> import Numeric.NonNegative
ghci> 2 + 3 :: NonNegative Double
5.0
ghci> 2 - 3 :: NonNegative Double
*** Exception: arithmetic underflow

Documentation

data NonNegative a

An opaque newtype around a number n that asserts that n >= 0. The constructor is not exported to maintain the invariant.

Instances

(Inj p a, Ord a, Num a) => Inj p (NonNegative a)

Defined in Numeric.NonNegative

Methods

inj :: p -> NonNegative a

(Ord a, Num a, Enum a) => Enum (NonNegative a)

Throws Underflow.

Defined in Numeric.NonNegative

Methods

succ :: NonNegative a -> NonNegative a

pred :: NonNegative a -> NonNegative a

toEnum :: Int -> NonNegative a

fromEnum :: NonNegative a -> Int

enumFrom :: NonNegative a -> [NonNegative a]

enumFromThen :: NonNegative a -> NonNegative a -> [NonNegative a]

enumFromTo :: NonNegative a -> NonNegative a -> [NonNegative a]

enumFromThenTo :: NonNegative a -> NonNegative a -> NonNegative a -> [NonNegative a]

Eq a => Eq (NonNegative a)

Defined in Numeric.NonNegative

Methods

(==) :: NonNegative a -> NonNegative a -> Bool

(/=) :: NonNegative a -> NonNegative a -> Bool

(Ord a, Num a, Floating a) => Floating (NonNegative a)

Throws Underflow.

Defined in Numeric.NonNegative

Methods

pi :: NonNegative a

exp :: NonNegative a -> NonNegative a

log :: NonNegative a -> NonNegative a

sqrt :: NonNegative a -> NonNegative a

(**) :: NonNegative a -> NonNegative a -> NonNegative a

logBase :: NonNegative a -> NonNegative a -> NonNegative a

sin :: NonNegative a -> NonNegative a

cos :: NonNegative a -> NonNegative a

tan :: NonNegative a -> NonNegative a

asin :: NonNegative a -> NonNegative a

acos :: NonNegative a -> NonNegative a

atan :: NonNegative a -> NonNegative a

sinh :: NonNegative a -> NonNegative a

cosh :: NonNegative a -> NonNegative a

tanh :: NonNegative a -> NonNegative a

asinh :: NonNegative a -> NonNegative a

acosh :: NonNegative a -> NonNegative a

atanh :: NonNegative a -> NonNegative a

log1p :: NonNegative a -> NonNegative a

expm1 :: NonNegative a -> NonNegative a

log1pexp :: NonNegative a -> NonNegative a

log1mexp :: NonNegative a -> NonNegative a

(Ord a, Fractional a) => Fractional (NonNegative a)

Throws Underflow.

Defined in Numeric.NonNegative

Methods

(/) :: NonNegative a -> NonNegative a -> NonNegative a

recip :: NonNegative a -> NonNegative a

fromRational :: Rational -> NonNegative a

Integral a => Integral (NonNegative a)

Defined in Numeric.NonNegative

Methods

quot :: NonNegative a -> NonNegative a -> NonNegative a

rem :: NonNegative a -> NonNegative a -> NonNegative a

div :: NonNegative a -> NonNegative a -> NonNegative a

mod :: NonNegative a -> NonNegative a -> NonNegative a

quotRem :: NonNegative a -> NonNegative a -> (NonNegative a, NonNegative a)

divMod :: NonNegative a -> NonNegative a -> (NonNegative a, NonNegative a)

toInteger :: NonNegative a -> Integer

(Ord a, Num a) => Num (NonNegative a)

Throws Underflow.

Defined in Numeric.NonNegative

Methods

(+) :: NonNegative a -> NonNegative a -> NonNegative a

(-) :: NonNegative a -> NonNegative a -> NonNegative a

(*) :: NonNegative a -> NonNegative a -> NonNegative a

negate :: NonNegative a -> NonNegative a

abs :: NonNegative a -> NonNegative a

signum :: NonNegative a -> NonNegative a

fromInteger :: Integer -> NonNegative a

Ord a => Ord (NonNegative a)

Defined in Numeric.NonNegative

Methods

compare :: NonNegative a -> NonNegative a -> Ordering

(<) :: NonNegative a -> NonNegative a -> Bool

(<=) :: NonNegative a -> NonNegative a -> Bool

(>) :: NonNegative a -> NonNegative a -> Bool

(>=) :: NonNegative a -> NonNegative a -> Bool

max :: NonNegative a -> NonNegative a -> NonNegative a

min :: NonNegative a -> NonNegative a -> NonNegative a

(Ord a, Num a, Read a) => Read (NonNegative a)

Defined in Numeric.NonNegative

Methods

readsPrec :: Int -> ReadS (NonNegative a)

readList :: ReadS [NonNegative a]

readPrec :: ReadPrec (NonNegative a)

readListPrec :: ReadPrec [NonNegative a]

Real a => Real (NonNegative a)

Defined in Numeric.NonNegative

Methods

toRational :: NonNegative a -> Rational

(Ord a, Num a, RealFloat a) => RealFloat (NonNegative a)

Throws Underflow.

Defined in Numeric.NonNegative

Methods

floatRadix :: NonNegative a -> Integer

floatDigits :: NonNegative a -> Int

floatRange :: NonNegative a -> (Int, Int)

decodeFloat :: NonNegative a -> (Integer, Int)

encodeFloat :: Integer -> Int -> NonNegative a

exponent :: NonNegative a -> Int

significand :: NonNegative a -> NonNegative a

scaleFloat :: Int -> NonNegative a -> NonNegative a

isNaN :: NonNegative a -> Bool

isInfinite :: NonNegative a -> Bool

isDenormalized :: NonNegative a -> Bool

isNegativeZero :: NonNegative a -> Bool

isIEEE :: NonNegative a -> Bool

atan2 :: NonNegative a -> NonNegative a -> NonNegative a

RealFrac a => RealFrac (NonNegative a)

Defined in Numeric.NonNegative

Methods

properFraction :: Integral b => NonNegative a -> (b, NonNegative a)

truncate :: Integral b => NonNegative a -> b

round :: Integral b => NonNegative a -> b

ceiling :: Integral b => NonNegative a -> b

floor :: Integral b => NonNegative a -> b

Show a => Show (NonNegative a)

Defined in Numeric.NonNegative

Methods

showsPrec :: Int -> NonNegative a -> ShowS

show :: NonNegative a -> String

showList :: [NonNegative a] -> ShowS

Semigroup a => Semigroup (NonNegative a)

Defined in Numeric.NonNegative

Methods

(<>) :: NonNegative a -> NonNegative a -> NonNegative a

sconcat :: NonEmpty (NonNegative a) -> NonNegative a

stimes :: Integral b => b -> NonNegative a -> NonNegative a

Monoid a => Monoid (NonNegative a)

Defined in Numeric.NonNegative

Methods

mempty :: NonNegative a

mappend :: NonNegative a -> NonNegative a -> NonNegative a

mconcat :: [NonNegative a] -> NonNegative a

PrintfArg a => PrintfArg (NonNegative a)

Defined in Numeric.NonNegative

Methods

formatArg :: NonNegative a -> FieldFormatter

parseFormat :: NonNegative a -> ModifierParser

Storable a => Storable (NonNegative a)

Defined in Numeric.NonNegative

Methods

sizeOf :: NonNegative a -> Int

alignment :: NonNegative a -> Int

peekElemOff :: Ptr (NonNegative a) -> Int -> IO (NonNegative a)

pokeElemOff :: Ptr (NonNegative a) -> Int -> NonNegative a -> IO ()

peekByteOff :: Ptr b -> Int -> IO (NonNegative a)

pokeByteOff :: Ptr b -> Int -> NonNegative a -> IO ()

peek :: Ptr (NonNegative a) -> IO (NonNegative a)

poke :: Ptr (NonNegative a) -> NonNegative a -> IO ()

getNonNegative :: NonNegative a -> a

Unwrap the newtype.

toNonNegative :: (Ord a, Num a) => a -> Maybe (NonNegative a)

Check if a number is non-negative and return Nothing if it is negative.

unsafeToNonNegative :: (Ord a, Num a) => a -> NonNegative a

Check if a number is non-negative and throw Underflow if it is negative.