Copyright	(c) Sirui Lu 2024
License	BSD-3-Clause (see the LICENSE file)
Maintainer	siruilu@cs.washington.edu
Stability	Experimental
Portability	GHC only
Safe Haskell	None
Language	Haskell2010

Grisette.Internal.Core.Data.Class.SafeFdiv

Description

Synopsis

class (MonadError e m, TryMerge m, Mergeable a) => SafeFdiv e a (m :: Type -> Type) where
- safeFdiv :: a -> a -> m a
- safeRecip :: a -> m a
class FdivOr a where
- fdivOr :: a -> a -> a -> a
- recipOr :: a -> a -> a
fdivOrZero :: (FdivOr a, Num a) => a -> a -> a
recipOrZero :: (FdivOr a, Num a) => a -> a

Documentation

class (MonadError e m, TryMerge m, Mergeable a) => SafeFdiv e a (m :: Type -> Type) where Source #

Safe fractional division with monadic error handling in multi-path execution. These procedures throw an exception when the denominator is zero. The result should be able to handle errors with MonadError.

Minimal complete definition

safeFdiv

Methods

safeFdiv :: a -> a -> m a Source #

Safe fractional division with monadic error handling in multi-path execution.

>>> safeFdiv "a" "b" :: ExceptT ArithException Union SymAlgReal
ExceptT {If (= b 0.0) (Left Ratio has zero denominator) (Right (fdiv a b))}

safeRecip :: a -> m a Source #

Safe fractional reciprocal with monadic error handling in multi-path execution.

>>> safeRecip "a" :: ExceptT ArithException Union SymAlgReal
ExceptT {If (= a 0.0) (Left Ratio has zero denominator) (Right (recip a))}

default safeRecip :: Fractional a => a -> m a Source #

Instances

Instances details

(MonadError ArithException m, TryMerge m) => SafeFdiv ArithException AlgReal m Source #
Instance details Defined in Grisette.Internal.Core.Data.Class.SafeFdiv Methods safeFdiv :: AlgReal -> AlgReal -> m AlgReal Source # safeRecip :: AlgReal -> m AlgReal Source #
(MonadError ArithException m, MonadUnion m) => SafeFdiv ArithException SymAlgReal m Source #
Instance details Defined in Grisette.Internal.Core.Data.Class.SafeFdiv Methods safeFdiv :: SymAlgReal -> SymAlgReal -> m SymAlgReal Source # safeRecip :: SymAlgReal -> m SymAlgReal Source #
SafeFdiv e a m => SafeFdiv e (AsKey a) m Source #
Instance details Defined in Grisette.Internal.Core.Data.Class.SafeFdiv Methods safeFdiv :: AsKey a -> AsKey a -> m (AsKey a) Source # safeRecip :: AsKey a -> m (AsKey a) Source #

class FdivOr a where Source #

Safe fractional with default values returned on exception.

Methods

fdivOr :: a -> a -> a -> a Source #

Safe / with default values returned on exception.

>>> fdivOr "d" "a" "b" :: SymAlgReal
(ite (= b 0.0) d (fdiv a b))

recipOr :: a -> a -> a Source #

Safe recip with default values returned on exception.

>>> recipOr "d" "a" :: SymAlgReal
(ite (= a 0.0) d (recip a))

Instances

Instances details

FdivOr AlgReal Source #
Instance details Defined in Grisette.Internal.Core.Data.Class.SafeFdiv Methods fdivOr :: AlgReal -> AlgReal -> AlgReal -> AlgReal Source # recipOr :: AlgReal -> AlgReal -> AlgReal Source #
FdivOr SymAlgReal Source #
Instance details Defined in Grisette.Internal.Core.Data.Class.SafeFdiv Methods fdivOr :: SymAlgReal -> SymAlgReal -> SymAlgReal -> SymAlgReal Source # recipOr :: SymAlgReal -> SymAlgReal -> SymAlgReal Source #
FdivOr a => FdivOr (AsKey a) Source #
Instance details Defined in Grisette.Internal.Core.Data.Class.SafeFdiv Methods fdivOr :: AsKey a -> AsKey a -> AsKey a -> AsKey a Source # recipOr :: AsKey a -> AsKey a -> AsKey a Source #

fdivOrZero :: (FdivOr a, Num a) => a -> a -> a Source #

Safe / with 0 returned on exception.

recipOrZero :: (FdivOr a, Num a) => a -> a Source #

Safe recip with 0 returned on exception.