diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,355 @@ +Mozilla Public License Version 2.0 +================================== + +### 1. Definitions + +**1.1. “Contributor”** + means each individual or legal entity that creates, contributes to + the creation of, or owns Covered Software. + +**1.2. “Contributor Version”** + means the combination of the Contributions of others (if any) used + by a Contributor and that particular Contributor's Contribution. + +**1.3. “Contribution”** + means Covered Software of a particular Contributor. + +**1.4. “Covered Software”** + means Source Code Form to which the initial Contributor has attached + the notice in Exhibit A, the Executable Form of such Source Code + Form, and Modifications of such Source Code Form, in each case + including portions thereof. + +**1.5. “Incompatible With Secondary Licenses”** + means + +* **(a)** that the initial Contributor has attached the notice described + in Exhibit B to the Covered Software; or +* **(b)** that the Covered Software was made available under the terms of + version 1.1 or earlier of the License, but not also under the + terms of a Secondary License. + +**1.6. “Executable Form”** + means any form of the work other than Source Code Form. + +**1.7. “Larger Work”** + means a work that combines Covered Software with other material, in + a separate file or files, that is not Covered Software. + +**1.8. “License”** + means this document. + +**1.9. “Licensable”** + means having the right to grant, to the maximum extent possible, + whether at the time of the initial grant or subsequently, any and + all of the rights conveyed by this License. + +**1.10. “Modifications”** + means any of the following: + +* **(a)** any file in Source Code Form that results from an addition to, + deletion from, or modification of the contents of Covered + Software; or +* **(b)** any new file in Source Code Form that contains any Covered + Software. + +**1.11. “Patent Claims” of a Contributor** + means any patent claim(s), including without limitation, method, + process, and apparatus claims, in any patent Licensable by such + Contributor that would be infringed, but for the grant of the + License, by the making, using, selling, offering for sale, having + made, import, or transfer of either its Contributions or its + Contributor Version. + +**1.12. “Secondary License”** + means either the GNU General Public License, Version 2.0, the GNU + Lesser General Public License, Version 2.1, the GNU Affero General + Public License, Version 3.0, or any later versions of those + licenses. + +**1.13. “Source Code Form”** + means the form of the work preferred for making modifications. + +**1.14. “You” (or “Your”)** + means an individual or a legal entity exercising rights under this + License. For legal entities, “You” includes any entity that + controls, is controlled by, or is under common control with You. For + purposes of this definition, “control” means **(a)** the power, direct + or indirect, to cause the direction or management of such entity, + whether by contract or otherwise, or **(b)** ownership of more than + fifty percent (50%) of the outstanding shares or beneficial + ownership of such entity. + + +### 2. License Grants and Conditions + +#### 2.1. Grants + +Each Contributor hereby grants You a world-wide, royalty-free, +non-exclusive license: + +* **(a)** under intellectual property rights (other than patent or trademark) + Licensable by such Contributor to use, reproduce, make available, + modify, display, perform, distribute, and otherwise exploit its + Contributions, either on an unmodified basis, with Modifications, or + as part of a Larger Work; and +* **(b)** under Patent Claims of such Contributor to make, use, sell, offer + for sale, have made, import, and otherwise transfer either its + Contributions or its Contributor Version. + +#### 2.2. Effective Date + +The licenses granted in Section 2.1 with respect to any Contribution +become effective for each Contribution on the date the Contributor first +distributes such Contribution. + +#### 2.3. Limitations on Grant Scope + +The licenses granted in this Section 2 are the only rights granted under +this License. No additional rights or licenses will be implied from the +distribution or licensing of Covered Software under this License. +Notwithstanding Section 2.1(b) above, no patent license is granted by a +Contributor: + +* **(a)** for any code that a Contributor has removed from Covered Software; + or +* **(b)** for infringements caused by: **(i)** Your and any other third party's + modifications of Covered Software, or **(ii)** the combination of its + Contributions with other software (except as part of its Contributor + Version); or +* **(c)** under Patent Claims infringed by Covered Software in the absence of + its Contributions. + +This License does not grant any rights in the trademarks, service marks, +or logos of any Contributor (except as may be necessary to comply with +the notice requirements in Section 3.4). + +#### 2.4. Subsequent Licenses + +No Contributor makes additional grants as a result of Your choice to +distribute the Covered Software under a subsequent version of this +License (see Section 10.2) or under the terms of a Secondary License (if +permitted under the terms of Section 3.3). + +#### 2.5. Representation + +Each Contributor represents that the Contributor believes its +Contributions are its original creation(s) or it has sufficient rights +to grant the rights to its Contributions conveyed by this License. + +#### 2.6. Fair Use + +This License is not intended to limit any rights You have under +applicable copyright doctrines of fair use, fair dealing, or other +equivalents. + +#### 2.7. Conditions + +Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted +in Section 2.1. + + +### 3. Responsibilities + +#### 3.1. Distribution of Source Form + +All distribution of Covered Software in Source Code Form, including any +Modifications that You create or to which You contribute, must be under +the terms of this License. You must inform recipients that the Source +Code Form of the Covered Software is governed by the terms of this +License, and how they can obtain a copy of this License. You may not +attempt to alter or restrict the recipients' rights in the Source Code +Form. + +#### 3.2. Distribution of Executable Form + +If You distribute Covered Software in Executable Form then: + +* **(a)** such Covered Software must also be made available in Source Code + Form, as described in Section 3.1, and You must inform recipients of + the Executable Form how they can obtain a copy of such Source Code + Form by reasonable means in a timely manner, at a charge no more + than the cost of distribution to the recipient; and + +* **(b)** You may distribute such Executable Form under the terms of this + License, or sublicense it under different terms, provided that the + license for the Executable Form does not attempt to limit or alter + the recipients' rights in the Source Code Form under this License. + +#### 3.3. Distribution of a Larger Work + +You may create and distribute a Larger Work under terms of Your choice, +provided that You also comply with the requirements of this License for +the Covered Software. If the Larger Work is a combination of Covered +Software with a work governed by one or more Secondary Licenses, and the +Covered Software is not Incompatible With Secondary Licenses, this +License permits You to additionally distribute such Covered Software +under the terms of such Secondary License(s), so that the recipient of +the Larger Work may, at their option, further distribute the Covered +Software under the terms of either this License or such Secondary +License(s). + +#### 3.4. Notices + +You may not remove or alter the substance of any license notices +(including copyright notices, patent notices, disclaimers of warranty, +or limitations of liability) contained within the Source Code Form of +the Covered Software, except that You may alter any license notices to +the extent required to remedy known factual inaccuracies. + +#### 3.5. Application of Additional Terms + +You may choose to offer, and to charge a fee for, warranty, support, +indemnity or liability obligations to one or more recipients of Covered +Software. However, You may do so only on Your own behalf, and not on +behalf of any Contributor. You must make it absolutely clear that any +such warranty, support, indemnity, or liability obligation is offered by +You alone, and You hereby agree to indemnify every Contributor for any +liability incurred by such Contributor as a result of warranty, support, +indemnity or liability terms You offer. You may include additional +disclaimers of warranty and limitations of liability specific to any +jurisdiction. + + +### 4. Inability to Comply Due to Statute or Regulation + +If it is impossible for You to comply with any of the terms of this +License with respect to some or all of the Covered Software due to +statute, judicial order, or regulation then You must: **(a)** comply with +the terms of this License to the maximum extent possible; and **(b)** +describe the limitations and the code they affect. Such description must +be placed in a text file included with all distributions of the Covered +Software under this License. Except to the extent prohibited by statute +or regulation, such description must be sufficiently detailed for a +recipient of ordinary skill to be able to understand it. + + +### 5. Termination + +**5.1.** The rights granted under this License will terminate automatically +if You fail to comply with any of its terms. However, if You become +compliant, then the rights granted under this License from a particular +Contributor are reinstated **(a)** provisionally, unless and until such +Contributor explicitly and finally terminates Your grants, and **(b)** on an +ongoing basis, if such Contributor fails to notify You of the +non-compliance by some reasonable means prior to 60 days after You have +come back into compliance. Moreover, Your grants from a particular +Contributor are reinstated on an ongoing basis if such Contributor +notifies You of the non-compliance by some reasonable means, this is the +first time You have received notice of non-compliance with this License +from such Contributor, and You become compliant prior to 30 days after +Your receipt of the notice. + +**5.2.** If You initiate litigation against any entity by asserting a patent +infringement claim (excluding declaratory judgment actions, +counter-claims, and cross-claims) alleging that a Contributor Version +directly or indirectly infringes any patent, then the rights granted to +You by any and all Contributors for the Covered Software under Section +2.1 of this License shall terminate. + +**5.3.** In the event of termination under Sections 5.1 or 5.2 above, all +end user license agreements (excluding distributors and resellers) which +have been validly granted by You or Your distributors under this License +prior to termination shall survive termination. + + +### 6. Disclaimer of Warranty + +> Covered Software is provided under this License on an “as is” +> basis, without warranty of any kind, either expressed, implied, or +> statutory, including, without limitation, warranties that the +> Covered Software is free of defects, merchantable, fit for a +> particular purpose or non-infringing. The entire risk as to the +> quality and performance of the Covered Software is with You. +> Should any Covered Software prove defective in any respect, You +> (not any Contributor) assume the cost of any necessary servicing, +> repair, or correction. This disclaimer of warranty constitutes an +> essential part of this License. No use of any Covered Software is +> authorized under this License except under this disclaimer. + +### 7. Limitation of Liability + +> Under no circumstances and under no legal theory, whether tort +> (including negligence), contract, or otherwise, shall any +> Contributor, or anyone who distributes Covered Software as +> permitted above, be liable to You for any direct, indirect, +> special, incidental, or consequential damages of any character +> including, without limitation, damages for lost profits, loss of +> goodwill, work stoppage, computer failure or malfunction, or any +> and all other commercial damages or losses, even if such party +> shall have been informed of the possibility of such damages. This +> limitation of liability shall not apply to liability for death or +> personal injury resulting from such party's negligence to the +> extent applicable law prohibits such limitation. Some +> jurisdictions do not allow the exclusion or limitation of +> incidental or consequential damages, so this exclusion and +> limitation may not apply to You. + + +### 8. Litigation + +Any litigation relating to this License may be brought only in the +courts of a jurisdiction where the defendant maintains its principal +place of business and such litigation shall be governed by laws of that +jurisdiction, without reference to its conflict-of-law provisions. +Nothing in this Section shall prevent a party's ability to bring +cross-claims or counter-claims. + + +### 9. Miscellaneous + +This License represents the complete agreement concerning the subject +matter hereof. If any provision of this License is held to be +unenforceable, such provision shall be reformed only to the extent +necessary to make it enforceable. Any law or regulation which provides +that the language of a contract shall be construed against the drafter +shall not be used to construe this License against a Contributor. + + +### 10. Versions of the License + +#### 10.1. New Versions + +Mozilla Foundation is the license steward. Except as provided in Section +10.3, no one other than the license steward has the right to modify or +publish new versions of this License. Each version will be given a +distinguishing version number. + +#### 10.2. Effect of New Versions + +You may distribute the Covered Software under the terms of the version +of the License under which You originally received the Covered Software, +or under the terms of any subsequent version published by the license +steward. + +#### 10.3. Modified Versions + +If you create software not governed by this License, and you want to +create a new license for such software, you may create and use a +modified version of this License if you rename the license and remove +any references to the name of the license steward (except to note that +such modified license differs from this License). + +#### 10.4. Distributing Source Code Form that is Incompatible With Secondary Licenses + +If You choose to distribute Source Code Form that is Incompatible With +Secondary Licenses under the terms of this version of the License, the +notice described in Exhibit B of this License must be attached. + +## Exhibit A - Source Code Form License Notice + + This Source Code Form is subject to the terms of the Mozilla Public + License, v. 2.0. If a copy of the MPL was not distributed with this + file, You can obtain one at http://mozilla.org/MPL/2.0/. + +If it is not possible or desirable to put the notice in a particular +file, then You may include the notice in a location (such as a LICENSE +file in a relevant directory) where a recipient would be likely to look +for such a notice. + +You may add additional accurate notices of copyright ownership. + +## Exhibit B - “Incompatible With Secondary Licenses” Notice + + This Source Code Form is "Incompatible With Secondary Licenses", as + defined by the Mozilla Public License, v. 2.0. diff --git a/README.md b/README.md new file mode 100644 --- /dev/null +++ b/README.md @@ -0,0 +1,8 @@ +# `siggy-chardust` + +Rounding rationals to significant digits and decimal places. + +The 'round' function from the prelude returns an integer. The standard librarys +of C and C++ have round functions that return floating point numbers. Rounding +in this library takes and returns 'Rational's and can round to a number of +significant digits or a number of decimal places. diff --git a/Setup.hs b/Setup.hs new file mode 100644 --- /dev/null +++ b/Setup.hs @@ -0,0 +1,7 @@ +-- This script is used to build and install your package. Typically you don't +-- need to change it. The Cabal documentation has more information about this +-- file: . +import qualified Distribution.Simple + +main :: IO () +main = Distribution.Simple.defaultMain diff --git a/changelog.md b/changelog.md new file mode 100644 --- /dev/null +++ b/changelog.md @@ -0,0 +1,6 @@ +# 1.0.0 + +Initial version with; + +* `dpRound` for rounding rational numbers to decimal places. +* `sdRound` for rounding rational numbers to significant digits. diff --git a/library/Data/Ratio/Rounding.hs b/library/Data/Ratio/Rounding.hs new file mode 100644 --- /dev/null +++ b/library/Data/Ratio/Rounding.hs @@ -0,0 +1,169 @@ +{-| +Module: Data.Ratio.Rounding +Copyright: + © 2018 Phil de Joux + © 2018 Block Scope Limited +License: MPL-2.0 +Maintainer: Phil de Joux +Stability: experimental + +Rounding rationals to significant digits and decimal places. + +The 'round' function from the prelude returns an integer. The standard librarys +of C and C++ have round functions that return floating point numbers. Rounding +in this library takes and returns 'Rational's and can round to a number of +significant digits or a number of decimal places. +-} +module Data.Ratio.Rounding + ( + -- * About the Name + -- $name + + -- * Rounding to Decimal Places + dpRound + -- * Rounding to Significant Digits + , sdRound + ) where + +import Numeric.Natural (Natural) + +-- | Rounds to a non-negative number of __d__ecimal __p__laces. After rounding +-- the result would have the given number of decimal places if converted to +-- a floating point number, such as by using 'fromRational'. +-- +-- >>> dpRound 2 (1234.56789 :: Rational) +-- 123457 % 100 +-- >>> dpRound 2 (123456789 :: Rational) +-- 123456789 % 1 +-- +-- Some examples that may be easier to read using decimal point notation. +-- +-- >>> dpRound 2 (123456789 :: Rational) == (123456789 :: Rational) +-- True +-- >>> dpRound 2 (1234.56789 :: Rational) == (1234.57 :: Rational) +-- True +-- >>> dpRound 2 (123.456789 :: Rational) == (123.46 :: Rational) +-- True +-- >>> dpRound 2 (12.3456789 :: Rational) == (12.35 :: Rational) +-- True +-- >>> dpRound 2 (1.23456789 :: Rational) == (1.23 :: Rational) +-- True +-- >>> dpRound 2 (0.123456789 :: Rational) == (0.12 :: Rational) +-- True +-- >>> dpRound 2 (0.0123456789 :: Rational) == (0.01 :: Rational) +-- True +-- >>> dpRound 2 (0.0000123456789 :: Rational) == (0.0 :: Rational) +-- True +-- +-- If the required number of decimal places is less than zero it is taken to +-- be zero. +-- +-- >>> dpRound 0 (1234.56789 :: Rational) +-- 1235 % 1 +-- >>> dpRound (-1) (1234.56789 :: Rational) +-- 1235 % 1 +-- >>> dpRound 0 (123456789 :: Rational) +-- 123456789 % 1 +-- >>> dpRound (-1) (123456789 :: Rational) +-- 123456789 % 1 +-- +-- Rounding to the existing number of decimal places or more makes no +-- difference. +-- +-- >>> 1234.56789 :: Rational +-- 123456789 % 100000 +-- >>> dpRound 5 (1234.56789 :: Rational) +-- 123456789 % 100000 +-- >>> dpRound 6 (1234.56789 :: Rational) +-- 123456789 % 100000 + +-- SEE: https://stackoverflow.com/questions/12450501/round-number-to-specified-number-of-digits +dpRound :: Integer -> Rational -> Rational +dpRound n f + | n < 0 = dpRound 0 f + | otherwise = + fromInteger (round $ f * (10^n)) / (10.0^^n) + +-- | Rounds to a non-negative number of __s__ignificant __d__igits. +-- +-- >>> sdRound 1 (123456789 :: Rational) +-- 100000000 % 1 +-- >>> sdRound 4 (123456789 :: Rational) +-- 123500000 % 1 +-- >>> sdRound 8 (1234.56789 :: Rational) +-- 12345679 % 10000 +-- +-- More examples using decimal point notation. +-- +-- >>> sdRound 4 (123456789 :: Rational) == (123500000 :: Rational) +-- True +-- >>> sdRound 4 (1234.56789 :: Rational) == (1235 :: Rational) +-- True +-- >>> sdRound 4 (123.456789 :: Rational) == (123.5 :: Rational) +-- True +-- >>> sdRound 4 (12.3456789 :: Rational) == (12.35 :: Rational) +-- True +-- >>> sdRound 4 (1.23456789 :: Rational) == (1.235 :: Rational) +-- True +-- >>> sdRound 4 (0.123456789 :: Rational) == (0.1235 :: Rational) +-- True +-- >>> sdRound 4 (0.0123456789 :: Rational) == (0.01235 :: Rational) +-- True +-- >>> sdRound 4 (0.0000123456789 :: Rational) == (0.00001235 :: Rational) +-- True +-- +-- Rounding to the existing number of significant digits or more makes no +-- difference. +-- +-- >>> 1234.56789 :: Rational +-- 123456789 % 100000 +-- >>> sdRound 9 (1234.56789 :: Rational) +-- 123456789 % 100000 +-- >>> sdRound 10 (1234.56789 :: Rational) +-- 123456789 % 100000 +-- +-- Rounding to zero significant digits is always zero. +-- +-- >>> sdRound 0 (123456789 :: Rational) +-- 0 % 1 +-- >>> sdRound 0 (1234.56789 :: Rational) +-- 0 % 1 +-- >>> sdRound 0 (0.123456789 :: Rational) +-- 0 % 1 +-- >>> sdRound 0 (0.0000123456789 :: Rational) +-- 0 % 1 +sdRound :: Natural -> Rational -> Rational +sdRound sd' f = + if m < 0 + then + dpRound sd gZ / 10^^pZ + else + case compare n 0 of + EQ -> dpRound n f + GT -> dpRound n f + LT -> 10^^p * fromInteger (round g) + where + sd = toInteger sd' + f' = fromRational f :: Double + + m = logBase 10 f' + mZ = truncate m + + n = sd - (mZ + 1) + + p = negate n + pZ = negate mZ + + g = f / 10^p + gZ = f * 10^pZ + +-- $name +-- Rounding to decimal places is a special case of rounding significant digits. +-- When the number is split into whole and fractional parts, rounding to +-- decimal places is rounding to significant digits in the fractional part. +-- +-- The digits that are discarded become dust and a digit when written down is +-- a char. +-- +-- The package name is __siggy__ for significant digits and __chardust__ for +-- the digits that are discarded. diff --git a/package.dhall b/package.dhall new file mode 100644 --- /dev/null +++ b/package.dhall @@ -0,0 +1,62 @@ + ./defaults.dhall +⫽ { name = + "siggy-chardust" + , version = + "1.0.0" + , synopsis = + "Rounding rationals to significant digits and decimal places." + , description = + "The round function from the prelude returns an integer. The standard librarys of C and C++ have round functions that return floating point numbers. Rounding in this library takes and returns rationals and can round to a number of significant digits or a number of decimal places." + , category = + "data, math, numeric" + , github = + "blockscope/flare-timing/siggy-chardust" + , homepage = + "https://github.com/blockscope/flare-timing/tree/master/siggy-chardust#readme" + , library = + { dependencies = + "base >=4.8 && <5" + , source-dirs = + "library" + , exposed-modules = + "Data.Ratio.Rounding" + } + , tests = + { hlint = + { dependencies = + [ "base", "hlint" ] + , ghc-options = + [ "-rtsopts", "-threaded", "-with-rtsopts=-N" ] + , main = + "HLint.hs" + , source-dirs = + [ "library", "test-suite-hlint" ] + } + , doctest = + { dependencies = + [ "base", "doctest" ] + , ghc-options = + [ "-rtsopts", "-threaded", "-with-rtsopts=-N" ] + , main = + "DocTest.hs" + , source-dirs = + [ "library", "test-suite-doctest" ] + } + , digits = + { dependencies = + [ "base" + , "tasty" + , "tasty-hunit" + , "tasty-quickcheck" + , "tasty-smallcheck" + , "smallcheck" + ] + , ghc-options = + [ "-rtsopts", "-threaded", "-with-rtsopts=-N" ] + , main = + "Rounding.hs" + , source-dirs = + [ "library", "test-suite-digits" ] + } + } + } diff --git a/siggy-chardust.cabal b/siggy-chardust.cabal new file mode 100644 --- /dev/null +++ b/siggy-chardust.cabal @@ -0,0 +1,92 @@ +-- This file has been generated from package.dhall by hpack version 0.27.0. +-- +-- see: https://github.com/sol/hpack +-- +-- hash: caddbc72be273f0c35678cbd4bf92145658c4269405fbef8b37e9f7b77adabe0 + +name: siggy-chardust +version: 1.0.0 +synopsis: Rounding rationals to significant digits and decimal places. +description: The round function from the prelude returns an integer. The standard librarys of C and C++ have round functions that return floating point numbers. Rounding in this library takes and returns rationals and can round to a number of significant digits or a number of decimal places. +category: data, math, numeric +homepage: https://github.com/blockscope/flare-timing/tree/master/siggy-chardust#readme +bug-reports: https://github.com/blockscope/flare-timing/issues +author: Phil de Joux +maintainer: phil.dejoux@blockscope.com +copyright: © 2017-2018 Phil de Joux, © 2017-2018 Block Scope Limited +license: MPL-2.0 +license-file: LICENSE.md +tested-with: GHC == 8.2.2 +build-type: Simple +cabal-version: >= 1.10 + +extra-source-files: + changelog.md + package.dhall + README.md + +source-repository head + type: git + location: https://github.com/blockscope/flare-timing + subdir: siggy-chardust + +library + exposed-modules: + Data.Ratio.Rounding + other-modules: + Paths_siggy_chardust + hs-source-dirs: + library + ghc-options: -Wall + build-depends: + base >=4.8 && <5 + default-language: Haskell2010 + +test-suite digits + type: exitcode-stdio-1.0 + main-is: Rounding.hs + other-modules: + Data.Ratio.Rounding + Paths_siggy_chardust + hs-source-dirs: + library + test-suite-digits + ghc-options: -Wall -rtsopts -threaded -with-rtsopts=-N + build-depends: + base + , smallcheck + , tasty + , tasty-hunit + , tasty-quickcheck + , tasty-smallcheck + default-language: Haskell2010 + +test-suite doctest + type: exitcode-stdio-1.0 + main-is: DocTest.hs + other-modules: + Data.Ratio.Rounding + Paths_siggy_chardust + hs-source-dirs: + library + test-suite-doctest + ghc-options: -Wall -rtsopts -threaded -with-rtsopts=-N + build-depends: + base + , doctest + default-language: Haskell2010 + +test-suite hlint + type: exitcode-stdio-1.0 + main-is: HLint.hs + other-modules: + Data.Ratio.Rounding + Paths_siggy_chardust + hs-source-dirs: + library + test-suite-hlint + ghc-options: -Wall -rtsopts -threaded -with-rtsopts=-N + build-depends: + base + , hlint + default-language: Haskell2010 diff --git a/test-suite-digits/Rounding.hs b/test-suite-digits/Rounding.hs new file mode 100644 --- /dev/null +++ b/test-suite-digits/Rounding.hs @@ -0,0 +1,75 @@ +module Main (main) where + +import Test.Tasty (TestTree, testGroup, defaultMain) +import Test.Tasty.HUnit as HU ((@?=), testCase) +import Test.Tasty.QuickCheck as QC + +import Data.Ratio.Rounding (dpRound, sdRound) + +main :: IO () +main = defaultMain tests + +tests :: TestTree +tests = testGroup "Tests" + [ units + , properties + ] + +properties :: TestTree +properties = testGroup "Properties" + [ qcProps + ] + +units :: TestTree +units = testGroup "Units" + [ roundUnits + ] + +roundUnits :: TestTree +roundUnits = testGroup "Rounding ..." + [ testGroup "Rounding to 2 decimal places" + [ HU.testCase "123456789.0 => no change" $ + dpRound 2 (123456789.0 :: Rational) @?= 123456789.0 + , HU.testCase "1234.56789 => 1234.57" $ + dpRound 2 (1234.56789 :: Rational) @?= 1234.57 + , HU.testCase "123.456789 => 123.46" $ + dpRound 2 (123.456789 :: Rational) @?= 123.46 + , HU.testCase "12.3456789 => 12.35" $ + dpRound 2 (12.3456789 :: Rational) @?= 12.35 + , HU.testCase "1.23456789 => 1.23" $ + dpRound 2 (1.23456789 :: Rational) @?= 1.23 + , HU.testCase "0.123456789 => 0.12" $ + dpRound 2 (0.123456789 :: Rational) @?= 0.12 + , HU.testCase "0.0123456789 => 0.01" $ + dpRound 2 (0.0123456789 :: Rational) @?= 0.01 + , HU.testCase "0.0000123456789 => 0.0" $ + dpRound 2 (0.0000123456789 :: Rational) @?= 0.0 + ] + , testGroup "Rounding 4 significant digits" + [ HU.testCase "123456789.0 => 123500000.0" $ + sdRound 4 (123456789.0 :: Rational) @?= 123500000.0 + , HU.testCase "1234.56789 => 1235.0" $ + sdRound 4 (1234.56789 :: Rational) @?= 1235.0 + , HU.testCase "123.456789 => 123.5" $ + sdRound 4 (123.456789 :: Rational) @?= 123.5 + , HU.testCase "12.3456789 => 12.35" $ + sdRound 4 (12.3456789 :: Rational) @?= 12.35 + , HU.testCase "1.23456789 => 1.235" $ + sdRound 4 (1.23456789 :: Rational) @?= 1.235 + , HU.testCase "0.123456789 => 0.1235" $ + sdRound 4 (0.123456789 :: Rational) @?= 0.1235 + , HU.testCase "0.0123456789 => 0.01235" $ + sdRound 4 (0.0123456789 :: Rational) @?= 0.01235 + , HU.testCase "0.0000123456789 => 0.00001235" $ + sdRound 4 (0.0000123456789 :: Rational) @?= 0.00001235 + ] + ] + +qcProps :: TestTree +qcProps = testGroup "(checked by QuickCheck)" + [ QC.testProperty "Rounding is idempotent" dpIdempotent + ] + +dpIdempotent :: Integer -> Rational -> Bool +dpIdempotent dp x = + let y = dpRound dp x in dpRound dp y == y diff --git a/test-suite-doctest/DocTest.hs b/test-suite-doctest/DocTest.hs new file mode 100644 --- /dev/null +++ b/test-suite-doctest/DocTest.hs @@ -0,0 +1,12 @@ +module Main (main) where + +import Test.DocTest (doctest) + +arguments :: [String] +arguments = + [ "-isrc" + , "library/Data/Ratio/Rounding.hs" + ] + +main :: IO () +main = doctest arguments diff --git a/test-suite-hlint/HLint.hs b/test-suite-hlint/HLint.hs new file mode 100644 --- /dev/null +++ b/test-suite-hlint/HLint.hs @@ -0,0 +1,16 @@ +module Main (main) where + +import Language.Haskell.HLint (hlint) +import System.Exit (exitFailure, exitSuccess) + +arguments :: [String] +arguments = + [ "library" + , "test-suite-hlint" + , "test-suite-digits" + ] + +main :: IO () +main = do + hints <- hlint arguments + if null hints then exitSuccess else exitFailure