Skip to content

Commit

Permalink
change maintainer, and clarify comments. (#10)
Browse files Browse the repository at this point in the history
  • Loading branch information
julialongtin authored Dec 20, 2023
1 parent 50feec6 commit ca7518e
Showing 1 changed file with 13 additions and 10 deletions.
23 changes: 13 additions & 10 deletions src/Data/Bits/Floating.hs
Original file line number Diff line number Diff line change
@@ -1,14 +1,15 @@
{-# LANGUAGE FunctionalDependencies #-}
-----------------------------------------------------------------------------
-- |
-- Copyright : (C) 2015 Anselm Jonas Scholl
-- Copyright : (C) 2015 Anselm Jonas Scholl, (C) 2023 Julia Longtin
-- License : BSD3
-- Maintainer : Anselm Jonas Scholl <anselm.scholl@tu-harburg.de>
-- Maintainer : Julia Longtin <Julia.Longtin@gmail.com>
-- Stability : experimental
-- Portability : GHC-specific
--
-- Conversions between floating point values and integral values preserving
-- the bit-patterns.
-- Functions for performing conversions between floating point values and
-- Integral values, for retrieving the Unit of Least Precision of a floating
-- point value, and for incrementing / decrementing a value by one ULP..
----------------------------------------------------------------------------
module Data.Bits.Floating (

Expand Down Expand Up @@ -57,14 +58,16 @@ class (Floating f, Integral w) => FloatingBits f w | f -> w where
-- @'coerceToWord' ('coerceToFloat' w) /= w@.
coerceToFloat :: w -> f
-- | Return the next floating point value in the direction of +INF.
-- If the argument is NaN, NaN is returned. If the argument is +INF,
-- +INF is returned. If the argument is 0.0, the minimum value greater than
-- 0.0 is returned.
-- If the argument is NaN, NaN is returned.
-- If the argument is +INF, +INF is returned.
-- If the argument is 0.0, the minimum value greater than 0.0 is returned.
-- If the argument is -INF, -INF is returned.
nextUp :: f -> f
-- | Return the next floating point value in the direction of -INF.
-- If the argument is NaN, NaN is returned. If the argument is -INF,
-- +INF is returned. If the argument is 0.0, the maximum value smaller than
-- 0.0 is returned.
-- If the argument is NaN, NaN is returned.
-- If the argument is +INF, +INF is returned.
-- If the argument is 0.0, the maximum value smaller than 0.0 is returned.
-- If the argument is -INF, -INF is returned.
nextDown :: f -> f
-- | Return the size of an ulp of the argument. If the argument is NaN, NaN
-- is returned. If the argument is +INF or -INF, +INF is returned. If
Expand Down

0 comments on commit ca7518e

Please sign in to comment.