Hackage :: [Package]

rounded: Correctly-rounded arbitrary-precision floating-point arithmetic

[ bsd3, library, math, numeric ] [ Propose Tags ] [ Report a vulnerability ]

This package provides numeric instances for MPFR that use "Implicit Configurations" from http://www.cs.rutgers.edu/~ccshan/prepose/prepose.pdf to choose a Rounding and Precision. For those that do not want to use reflection, explicit instances are provided for common precisions and for the built-in rounding modes.

This package should work correctly with GHC 8.4.4 or later.

>>> import Numeric.Rounded
>>> :set -XDataKinds
>>> exp pi :: Rounded TowardZero 512
23.140692632779269005729086367948547380266106242600211993445046409524342350690452783516971997067549219675952704801087773144428044414693835844717445879609842

rounded version 1.x is for MPFR version 4.0 and above.

[Skip to Readme]

Modules

[Last Documentation]

  • Numeric
    • MPFR
      • Numeric.MPFR.Raw
        • Numeric.MPFR.Raw.Safe
        • Numeric.MPFR.Raw.Unsafe
      • Numeric.MPFR.Types
    • Numeric.Rounded
      • Numeric.Rounded.Interval
      • Numeric.Rounded.Simple

Downloads

Note: This package has metadata revisions in the cabal description newer than included in the tarball. To unpack the package including the revisions, use 'cabal get'.

Maintainer's Corner

Package maintainers

For package maintainers and hackage trustees

Candidates

Versions [RSS] 0.1, 0.1.0.1, 0.2, 0.3, 1.0, 1.1, 1.1.1
Change log CHANGELOG.markdown
Dependencies base (>=4.11 && <4.16), ghc-prim (>=0.4 && <0.8), hgmp (>=0.1.1 && <0.2), long-double (>=0.1 && <0.2), reflection (>=2.1.2 && <2.2) [details]
Tested with ghc ==8.4.4, ghc ==8.6.5, ghc ==8.8.4, ghc ==8.10.4, ghc ==9.0.1
License BSD-3-Clause
Copyright Copyright (C) 2012-2014 Edward A. Kmett, Daniel G. Peebles; Copyright (C) 2013-2019 Claude Heiland-Allen
Author Edward A. Kmett, Daniel G. Peebles, Claude Heiland-Allen
Maintainer Claude Heiland-Allen <claude@mathr.co.uk>
Revised Revision 1 made by ClaudeHeilandAllen at 2021-06-04T10:51:25Z
Category Numeric, Math
Home page https://github.com/ekmett/rounded
Bug tracker https://github.com/ekmett/rounded/issues
Source repo head: git clone git://github.com/ekmett/rounded.git
this: git clone git://github.com/ekmett/rounded.git(tag rounded-1.1)
Uploaded by ClaudeHeilandAllen at 2020-05-19T18:18:03Z
Distributions
Reverse Dependencies 2 direct, 5 indirect [details]
Downloads 2611 total (3 in the last 30 days)
Rating (no votes yet) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Docs not available [build log]
All reported builds failed as of 2020-05-19 [all 3 reports]

Readme for rounded-1.1

[back to package description]

rounded

Build Status

This package provides properly rounded floating point numbers of arbitrary precision. It does so by wrapping the GNU MPFR library.

Phantom types carry the information about the precision and rounding mode, letting you treat properly rounded floating point numbers as instances of Num or Floating, like any other numeric type in Haskell.

Unlike other attempts to port MPFR to Haskell, this library does not require you to cripple Integer performance or link your code in an unnatural way.

Usage

{-# LANGUAGE DataKinds #-}
{-# LANGUAGE ScopedTypeVariables #-}
import Numeric.Rounded
import Data.Proxy

To use a 53 bit significand (the same size as used by a Double), and round down intermediate results:

>>> pi :: Rounded TowardZero Double
3.141592653589793

We can also round away from zero, or use other rounding modes.

>>> pi :: Rounded AwayFromZero Double
3.1415926535897936

We can specify the significand size directly using type literals in GHC:

>>> kCatalan :: Rounded TowardZero 128
0.915965594177219015054603514932384110773

You can also specify a dynamic significand size at runtime:

>>> reifyPrecision 512 (\(_ :: Proxy p) -> show (logBase 10 2 :: Rounded TowardNearest p))
"0.3010299956639811952137388947244930267681898814621085413104274611271081892744245094869272521181861720406844771914309953790947678811335235059996923337046956"

or a dynamic rounding mode:

ghci> reifyRounding TowardZero (\(_ :: Proxy r) -> show (logBase 10 2 :: Rounded r 512))
"0.30102999566398119521373889472449302676818988146210854131042746112710818927442450948692725211818617204068447719143099537909476788113352350599969233370469556"

Contact Information

Please, feel free to contact me with questions, concerns, or bug fixes.

I can be reached as ekmett via github or as edwardk on the #haskell IRC channel on irc.freenode.net.

-Edward Kmett