Safe Haskell	None
Language	Haskell2010

Numeric.CollectErrors

Contents

Type of numeric errors
Utilities
- Applicable general collect-error utilities

Synopsis

data NumError
- = DivByZero
- | OutOfDomain String
- | NumError String
data ErrorCertaintyLevel
- = ErrorCertain
- | ErrorPotential
data NumErrors
type CN = CollectErrors NumErrors
cn :: v -> CN v
unCN :: CN p -> p
(~!) :: Show es => CollectErrors es p -> p
noValueNumErrorCertain :: NumError -> CN v
noValueNumErrorPotential :: NumError -> CN v
removeValueErrorCertain :: CN t -> NumError -> CN t
removeValueErrorPotential :: CN t -> NumError -> CN t
prependErrorCertain :: NumError -> CN t -> CN t
prependErrorPotential :: NumError -> CN t -> CN t
class CanClearPotentialErrors cnt where
- clearPotentialErrors :: cnt -> cnt
type CanTakeCNErrors = CanTakeErrors NumErrors
noValue :: es -> CollectErrors es v
removeValue :: Monoid es => CollectErrors es v -> es -> CollectErrors es v
prependErrors :: Monoid es => es -> CollectErrors es v -> CollectErrors es v
class CanTestErrorsCertain es where
- hasCertainError :: es -> Bool
class CanTestErrorsPresent es where
- hasError :: es -> Bool
toEither :: CanBeErrors es => CollectErrors es v -> Either es v
withErrorOrValue :: CanBeErrors es => (es -> t) -> (v -> t) -> CollectErrors es v -> t
filterValuesWithoutError :: CanBeErrors es => [CollectErrors es v] -> [v]
lift :: Monoid es => (a -> b) -> CollectErrors es a -> CollectErrors es b
liftCN :: (a -> CN c) -> CN a -> CN c
liftPair :: Monoid es => (a -> (c, d)) -> CollectErrors es a -> (CollectErrors es c, CollectErrors es d)
lift2 :: Monoid es => (a -> b -> c) -> CollectErrors es a -> CollectErrors es b -> CollectErrors es c
lift2CN :: (a -> b -> CN c) -> CN a -> CN b -> CN c
lift1T :: Monoid es => (a -> b -> c) -> CollectErrors es a -> b -> CollectErrors es c
liftT1 :: Monoid es => (a -> b -> c) -> a -> CollectErrors es b -> CollectErrors es c
lift1TCN :: (a -> b -> CN c) -> CN a -> b -> CN c
liftT1CN :: (a -> b -> CN c) -> a -> CN b -> CN c
lift2pair :: Monoid es => (a -> b -> (c, d)) -> CollectErrors es a -> CollectErrors es b -> (CollectErrors es c, CollectErrors es d)
lift1Tpair :: Monoid es => (a -> b -> (c, d)) -> CollectErrors es a -> b -> (CollectErrors es c, CollectErrors es d)
liftT1pair :: Monoid es => (a -> b -> (c, d)) -> a -> CollectErrors es b -> (CollectErrors es c, CollectErrors es d)
class CanTakeErrors es t where
- takeErrors :: es -> t -> t
- takeErrorsNoValue :: es -> t
liftTakeErrors :: CanTakeErrors es t2 => (t1 -> t2) -> CollectErrors es t1 -> t2

Type of numeric errors

data NumError Source #

Constructors

DivByZero
OutOfDomain String
NumError String

Instances

Instances details

Eq NumError Source #
Instance details Defined in Numeric.CollectErrors.Type Methods (==) :: NumError -> NumError -> Bool # (/=) :: NumError -> NumError -> Bool #
Ord NumError Source #
Instance details Defined in Numeric.CollectErrors.Type Methods compare :: NumError -> NumError -> Ordering # (<) :: NumError -> NumError -> Bool # (<=) :: NumError -> NumError -> Bool # (>) :: NumError -> NumError -> Bool # (>=) :: NumError -> NumError -> Bool # max :: NumError -> NumError -> NumError # min :: NumError -> NumError -> NumError #
Show NumError Source #
Instance details Defined in Numeric.CollectErrors.Type Methods showsPrec :: Int -> NumError -> ShowS # show :: NumError -> String # showList :: [NumError] -> ShowS #
Generic NumError Source #
Instance details Defined in Numeric.CollectErrors.Type Associated Types type Rep NumError :: Type -> Type # Methods from :: NumError -> Rep NumError x # to :: Rep NumError x -> NumError #
NFData NumError Source #
Instance details Defined in Numeric.CollectErrors.Type Methods rnf :: NumError -> () #
CanTestErrorsCertain NumErrorLevel Source #
Instance details Defined in Numeric.CollectErrors.Type Methods hasCertainError :: NumErrorLevel -> Bool Source #
type Rep NumError Source #
Instance details Defined in Numeric.CollectErrors.Type type Rep NumError = D1 ('MetaData "NumError" "Numeric.CollectErrors.Type" "collect-errors-0.1.5.0-DAyNZ8BMV4w4yqJNdU6hiq" 'False) (C1 ('MetaCons "DivByZero" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "OutOfDomain" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String)) :+: C1 ('MetaCons "NumError" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String))))

data ErrorCertaintyLevel Source #

Constructors

ErrorCertain
ErrorPotential

Instances

Instances details

Eq ErrorCertaintyLevel Source #
Instance details Defined in Numeric.CollectErrors.Type Methods (==) :: ErrorCertaintyLevel -> ErrorCertaintyLevel -> Bool # (/=) :: ErrorCertaintyLevel -> ErrorCertaintyLevel -> Bool #
Ord ErrorCertaintyLevel Source #
Instance details Defined in Numeric.CollectErrors.Type Methods compare :: ErrorCertaintyLevel -> ErrorCertaintyLevel -> Ordering # (<) :: ErrorCertaintyLevel -> ErrorCertaintyLevel -> Bool # (<=) :: ErrorCertaintyLevel -> ErrorCertaintyLevel -> Bool # (>) :: ErrorCertaintyLevel -> ErrorCertaintyLevel -> Bool # (>=) :: ErrorCertaintyLevel -> ErrorCertaintyLevel -> Bool # max :: ErrorCertaintyLevel -> ErrorCertaintyLevel -> ErrorCertaintyLevel # min :: ErrorCertaintyLevel -> ErrorCertaintyLevel -> ErrorCertaintyLevel #
Show ErrorCertaintyLevel Source #
Instance details Defined in Numeric.CollectErrors.Type Methods showsPrec :: Int -> ErrorCertaintyLevel -> ShowS # show :: ErrorCertaintyLevel -> String # showList :: [ErrorCertaintyLevel] -> ShowS #
Generic ErrorCertaintyLevel Source #
Instance details Defined in Numeric.CollectErrors.Type Associated Types type Rep ErrorCertaintyLevel :: Type -> Type # Methods from :: ErrorCertaintyLevel -> Rep ErrorCertaintyLevel x # to :: Rep ErrorCertaintyLevel x -> ErrorCertaintyLevel #
NFData ErrorCertaintyLevel Source #
Instance details Defined in Numeric.CollectErrors.Type Methods rnf :: ErrorCertaintyLevel -> () #
CanTestErrorsCertain NumErrorLevel Source #
Instance details Defined in Numeric.CollectErrors.Type Methods hasCertainError :: NumErrorLevel -> Bool Source #
type Rep ErrorCertaintyLevel Source #
Instance details Defined in Numeric.CollectErrors.Type type Rep ErrorCertaintyLevel = D1 ('MetaData "ErrorCertaintyLevel" "Numeric.CollectErrors.Type" "collect-errors-0.1.5.0-DAyNZ8BMV4w4yqJNdU6hiq" 'False) (C1 ('MetaCons "ErrorCertain" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ErrorPotential" 'PrefixI 'False) (U1 :: Type -> Type))

data NumErrors Source #

Instances

Instances details

Eq NumErrors Source #
Instance details Defined in Numeric.CollectErrors.Type Methods (==) :: NumErrors -> NumErrors -> Bool # (/=) :: NumErrors -> NumErrors -> Bool #
Show NumErrors Source #
Instance details Defined in Numeric.CollectErrors.Type Methods showsPrec :: Int -> NumErrors -> ShowS # show :: NumErrors -> String # showList :: [NumErrors] -> ShowS #
Generic NumErrors Source #
Instance details Defined in Numeric.CollectErrors.Type Associated Types type Rep NumErrors :: Type -> Type # Methods from :: NumErrors -> Rep NumErrors x # to :: Rep NumErrors x -> NumErrors #
Semigroup NumErrors Source #
Instance details Defined in Numeric.CollectErrors.Type Methods (<>) :: NumErrors -> NumErrors -> NumErrors # sconcat :: NonEmpty NumErrors -> NumErrors # stimes :: Integral b => b -> NumErrors -> NumErrors #
Monoid NumErrors Source #
Instance details Defined in Numeric.CollectErrors.Type Methods mempty :: NumErrors # mappend :: NumErrors -> NumErrors -> NumErrors # mconcat :: [NumErrors] -> NumErrors #
NFData NumErrors Source #
Instance details Defined in Numeric.CollectErrors.Type Methods rnf :: NumErrors -> () #
CanTestErrorsPresent NumErrors Source #
Instance details Defined in Numeric.CollectErrors.Type Methods hasError :: NumErrors -> Bool Source #
CanTestErrorsCertain NumErrors Source #
Instance details Defined in Numeric.CollectErrors.Type Methods hasCertainError :: NumErrors -> Bool Source #
(Floating v, Ord v, Show v) => Floating (CN v) Source #
Instance details Defined in Numeric.CollectErrors.PreludeInstances Methods pi :: CN v # exp :: CN v -> CN v # log :: CN v -> CN v # sqrt :: CN v -> CN v # (**) :: CN v -> CN v -> CN v # logBase :: CN v -> CN v -> CN v # sin :: CN v -> CN v # cos :: CN v -> CN v # tan :: CN v -> CN v # asin :: CN v -> CN v # acos :: CN v -> CN v # atan :: CN v -> CN v # sinh :: CN v -> CN v # cosh :: CN v -> CN v # tanh :: CN v -> CN v # asinh :: CN v -> CN v # acosh :: CN v -> CN v # atanh :: CN v -> CN v # log1p :: CN v -> CN v # expm1 :: CN v -> CN v # log1pexp :: CN v -> CN v # log1mexp :: CN v -> CN v #
(Fractional v, Eq v) => Fractional (CN v) Source #
Instance details Defined in Numeric.CollectErrors.PreludeInstances Methods (/) :: CN v -> CN v -> CN v # recip :: CN v -> CN v # fromRational :: Rational -> CN v #
(Integral v, Ord v, Show v) => Integral (CN v) Source #
Instance details Defined in Numeric.CollectErrors.PreludeInstances Methods quot :: CN v -> CN v -> CN v # rem :: CN v -> CN v -> CN v # div :: CN v -> CN v -> CN v # mod :: CN v -> CN v -> CN v # quotRem :: CN v -> CN v -> (CN v, CN v) # divMod :: CN v -> CN v -> (CN v, CN v) # toInteger :: CN v -> Integer #
CanClearPotentialErrors (CN t) Source #
Instance details Defined in Numeric.CollectErrors.Type Methods clearPotentialErrors :: CN t -> CN t Source #
type Rep NumErrors Source #
Instance details Defined in Numeric.CollectErrors.Type type Rep NumErrors = D1 ('MetaData "NumErrors" "Numeric.CollectErrors.Type" "collect-errors-0.1.5.0-DAyNZ8BMV4w4yqJNdU6hiq" 'True) (C1 ('MetaCons "NumErrors" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Set NumErrorLevel))))

type CN = CollectErrors NumErrors Source #

cn :: v -> CN v Source #

unCN :: CN p -> p Source #

(~!) :: Show es => CollectErrors es p -> p Source #

Unsafe way to get a value out of the CollectErrors wrapper.

Utilities

noValueNumErrorCertain :: NumError -> CN v Source #

Construct an empty wrapper indicating that given error has certainly occurred.

noValueNumErrorPotential :: NumError -> CN v Source #

Construct an empty wrapper indicating that given error may have occurred.

removeValueErrorCertain :: CN t -> NumError -> CN t Source #

removeValueErrorPotential :: CN t -> NumError -> CN t Source #

prependErrorCertain :: NumError -> CN t -> CN t Source #

prependErrorPotential :: NumError -> CN t -> CN t Source #

class CanClearPotentialErrors cnt where Source #

Methods

clearPotentialErrors :: cnt -> cnt Source #

If there is a value, remove any potential errors that are associated with it.

Instances

Instances details

CanClearPotentialErrors t => CanClearPotentialErrors [t] Source #
Instance details Defined in Numeric.CollectErrors.Type Methods clearPotentialErrors :: [t] -> [t] Source #
CanClearPotentialErrors (CN t) Source #
Instance details Defined in Numeric.CollectErrors.Type Methods clearPotentialErrors :: CN t -> CN t Source #
(CanClearPotentialErrors t1, CanClearPotentialErrors t2) => CanClearPotentialErrors (t1, t2) Source #
Instance details Defined in Numeric.CollectErrors.Type Methods clearPotentialErrors :: (t1, t2) -> (t1, t2) Source #

type CanTakeCNErrors = CanTakeErrors NumErrors Source #

Applicable general collect-error utilities

noValue :: es -> CollectErrors es v Source #

removeValue :: Monoid es => CollectErrors es v -> es -> CollectErrors es v Source #

Take a CE-value, add new errors into it and remove the value, if any

prependErrors :: Monoid es => es -> CollectErrors es v -> CollectErrors es v Source #

class CanTestErrorsCertain es where Source #

Methods

hasCertainError :: es -> Bool Source #

Instances

Instances details

CanTestErrorsCertain NumErrorLevel Source #
Instance details Defined in Numeric.CollectErrors.Type Methods hasCertainError :: NumErrorLevel -> Bool Source #
CanTestErrorsCertain NumErrors Source #
Instance details Defined in Numeric.CollectErrors.Type Methods hasCertainError :: NumErrors -> Bool Source #
CanTestErrorsCertain es => CanTestErrorsCertain [es] Source #
Instance details Defined in Control.CollectErrors.Type Methods hasCertainError :: [es] -> Bool Source #
CanTestErrorsCertain es => CanTestErrorsCertain (Set es) Source #
Instance details Defined in Control.CollectErrors.Type Methods hasCertainError :: Set es -> Bool Source #
CanTestErrorsCertain es => CanTestErrorsCertain (CollectErrors es v) Source #
Instance details Defined in Control.CollectErrors.Type Methods hasCertainError :: CollectErrors es v -> Bool Source #

class CanTestErrorsPresent es where Source #

Methods

hasError :: es -> Bool Source #

Instances

Instances details

CanTestErrorsPresent NumErrors Source #
Instance details Defined in Numeric.CollectErrors.Type Methods hasError :: NumErrors -> Bool Source #
CanTestErrorsPresent [es] Source #
Instance details Defined in Control.CollectErrors.Type Methods hasError :: [es] -> Bool Source #
CanTestErrorsPresent (Set es) Source #
Instance details Defined in Control.CollectErrors.Type Methods hasError :: Set es -> Bool Source #
CanTestErrorsPresent es => CanTestErrorsPresent (CollectErrors es v) Source #
Instance details Defined in Control.CollectErrors.Type Methods hasError :: CollectErrors es v -> Bool Source #

toEither :: CanBeErrors es => CollectErrors es v -> Either es v Source #

A safe way to get a value out of the CollectErrors wrapper.

withErrorOrValue :: CanBeErrors es => (es -> t) -> (v -> t) -> CollectErrors es v -> t Source #

filterValuesWithoutError :: CanBeErrors es => [CollectErrors es v] -> [v] Source #

lift :: Monoid es => (a -> b) -> CollectErrors es a -> CollectErrors es b Source #

liftCN :: (a -> CN c) -> CN a -> CN c Source #

liftPair :: Monoid es => (a -> (c, d)) -> CollectErrors es a -> (CollectErrors es c, CollectErrors es d) Source #

lift2 :: Monoid es => (a -> b -> c) -> CollectErrors es a -> CollectErrors es b -> CollectErrors es c Source #

lift2CN :: (a -> b -> CN c) -> CN a -> CN b -> CN c Source #

lift1T :: Monoid es => (a -> b -> c) -> CollectErrors es a -> b -> CollectErrors es c Source #

liftT1 :: Monoid es => (a -> b -> c) -> a -> CollectErrors es b -> CollectErrors es c Source #

lift1TCN :: (a -> b -> CN c) -> CN a -> b -> CN c Source #

liftT1CN :: (a -> b -> CN c) -> a -> CN b -> CN c Source #

lift2pair :: Monoid es => (a -> b -> (c, d)) -> CollectErrors es a -> CollectErrors es b -> (CollectErrors es c, CollectErrors es d) Source #

lift1Tpair :: Monoid es => (a -> b -> (c, d)) -> CollectErrors es a -> b -> (CollectErrors es c, CollectErrors es d) Source #

liftT1pair :: Monoid es => (a -> b -> (c, d)) -> a -> CollectErrors es b -> (CollectErrors es c, CollectErrors es d) Source #

class CanTakeErrors es t where Source #

Methods

takeErrors :: es -> t -> t Source #

takeErrorsNoValue :: es -> t Source #

Instances

Instances details

(CanTakeErrors es t1, CanTakeErrors es t2) => CanTakeErrors es (t1, t2) Source #
Instance details Defined in Control.CollectErrors.Type Methods takeErrors :: es -> (t1, t2) -> (t1, t2) Source # takeErrorsNoValue :: es -> (t1, t2) Source #
Monoid es => CanTakeErrors es (CollectErrors es t) Source #
Instance details Defined in Control.CollectErrors.Type Methods takeErrors :: es -> CollectErrors es t -> CollectErrors es t Source # takeErrorsNoValue :: es -> CollectErrors es t Source #

liftTakeErrors :: CanTakeErrors es t2 => (t1 -> t2) -> CollectErrors es t1 -> t2 Source #

Key	Shortcut
s	Open this search box
esc	Close this search box
↓,ctrl + j	Move down in search results
↑,ctrl + k	Move up in search results
↵	Go to active search result