incipit-base-0.3.0.0: lib/Incipit/Fixed.hs

-- |Safe overrides of the "Data.Fixed" division functions.
module Incipit.Fixed where

import qualified Data.Fixed as Fixed
import Data.Maybe (Maybe)
import GHC.Real (Integral, Real)

import Incipit.Integral (safeOp)

-- | Generalisation of 'GHC.Real.div' to any instance of 'Real'
div' ::
  Real a =>
  Integral b =>
  a ->
  a ->
  Maybe b
div' =
  safeOp Fixed.div'

-- | Generalisation of 'GHC.Real.divMod' to any instance of 'Real'
divMod' ::
  Real a =>
  Integral b =>
  a ->
  a ->
  Maybe (b, a)
divMod' =
  safeOp Fixed.divMod'

-- | Generalisation of 'GHC.Real.mod' to any instance of 'Real'
mod' ::
  Real a =>
  a ->
  a ->
  Maybe a
mod' =
  safeOp Fixed.mod'