summaryrefslogtreecommitdiff
path: root/dev-haskell/chasingbottoms/metadata.xml
diff options
context:
space:
mode:
authorV3n3RiX <venerix@redcorelinux.org>2018-07-14 21:03:06 +0100
committerV3n3RiX <venerix@redcorelinux.org>2018-07-14 21:03:06 +0100
commit8376ef56580626e9c0f796d5b85b53a0a1c7d5f5 (patch)
tree7681bbd4e8b05407772df40a4bf04cbbc8afc3fa /dev-haskell/chasingbottoms/metadata.xml
parent30a9caf154332f12ca60756e1b75d2f0e3e1822d (diff)
gentoo resync : 14.07.2018
Diffstat (limited to 'dev-haskell/chasingbottoms/metadata.xml')
-rw-r--r--dev-haskell/chasingbottoms/metadata.xml102
1 files changed, 102 insertions, 0 deletions
diff --git a/dev-haskell/chasingbottoms/metadata.xml b/dev-haskell/chasingbottoms/metadata.xml
new file mode 100644
index 000000000000..ec83e2946e46
--- /dev/null
+++ b/dev-haskell/chasingbottoms/metadata.xml
@@ -0,0 +1,102 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE pkgmetadata SYSTEM "http://www.gentoo.org/dtd/metadata.dtd">
+<pkgmetadata>
+ <maintainer type="project">
+ <email>haskell@gentoo.org</email>
+ <name>Gentoo Haskell</name>
+ </maintainer>
+ <longdescription>
+ Do you ever feel the need to test code involving bottoms (e.g. calls to
+ the @error@ function), or code involving infinite values? Then this
+ library could be useful for you.
+
+ It is usually easy to get a grip on bottoms by showing a value and
+ waiting to see how much gets printed before the first exception is
+ encountered. However, that quickly gets tiresome and is hard to automate
+ using e.g. QuickCheck
+ (&lt;http://www.cse.chalmers.se/~rjmh/QuickCheck/&gt;). With this library you
+ can do the tests as simply as the following examples show.
+
+ Testing explicitly for bottoms:
+
+ [@&gt; isBottom (head [\])@] @True@
+
+ [@&gt; isBottom bottom@] @True@
+
+ [@&gt; isBottom (\\_ -&gt; bottom)@] @False@
+
+ [@&gt; isBottom (bottom, bottom)@] @False@
+
+ Comparing finite, partial values:
+
+ [@&gt; ((bottom, 3) :: (Bool, Int)) ==! (bottom, 2+5-4)@] @True@
+
+ [@&gt; ((bottom, bottom) :: (Bool, Int)) &lt;! (bottom, 8)@] @True@
+
+ Showing partial and infinite values (@\\\/!@ is join and @\/\\!@ is meet):
+
+ [@&gt; approxShow 4 $ (True, bottom) \\\/! (bottom, \'b\')@] @\"Just (True, \'b\')\"@
+
+ [@&gt; approxShow 4 $ (True, bottom) \/\\! (bottom, \'b\')@] @\"(_|_, _|_)\"@
+
+ [@&gt; approxShow 4 $ ([1..\] :: [Int\])@] @\"[1, 2, 3, _\"@
+
+ [@&gt; approxShow 4 $ (cycle [bottom\] :: [Bool\])@] @\"[_|_, _|_, _|_, _\"@
+
+ Approximately comparing infinite, partial values:
+
+ [@&gt; approx 100 [2,4..\] ==! approx 100 (filter even [1..\] :: [Int\])@] @True@
+
+ [@&gt; approx 100 [2,4..\] \/=! approx 100 (filter even [bottom..\] :: [Int\])@] @True@
+
+ The code above relies on the fact that @bottom@, just as @error
+ \"...\"@, @undefined@ and pattern match failures, yield
+ exceptions. Sometimes we are dealing with properly non-terminating
+ computations, such as the following example, and then it can be nice to
+ be able to apply a time-out:
+
+ [@&gt; timeOut' 1 (reverse [1..5\])@] @Value [5,4,3,2,1]@
+
+ [@&gt; timeOut' 1 (reverse [1..\])@] @NonTermination@
+
+ The time-out functionality can be used to treat \"slow\" computations as
+ bottoms:
+
+ [@&gt; let tweak = Tweak &amp;#x7b; approxDepth = Just 5, timeOutLimit = Just 2 &amp;#x7d;@]
+
+ [@&gt; semanticEq tweak (reverse [1..\], [1..\]) (bottom :: [Int\], [1..\] :: [Int\])@] @True@
+
+ [@&gt; let tweak = noTweak &amp;#x7b; timeOutLimit = Just 2 &amp;#x7d;@]
+
+ [@&gt; semanticJoin tweak (reverse [1..\], True) ([\] :: [Int\], bottom)@] @Just ([],True)@
+
+ This can of course be dangerous:
+
+ [@&gt; let tweak = noTweak &amp;#x7b; timeOutLimit = Just 0 &amp;#x7d;@]
+
+ [@&gt; semanticEq tweak (reverse [1..100000000\]) (bottom :: [Integer\])@] @True@
+
+ Timeouts can also be applied to @IO@ computations:
+
+ [@&gt; let primes = unfoldr (\\(x:xs) -&gt; Just (x, filter ((\/= 0) . (\`mod\` x)) xs)) [2..\]@]
+
+ [@&gt; timeOutMicro 100 (print $ filter ((== 1) . (\`mod\` 83)) primes)@] @[167,499,9NonTermination@
+
+ [@&gt; timeOutMicro 100 (print $ take 6 $ filter ((== 1) . (\`mod\` 83)) primes)@] @[167,499,997,1163,1993NonTermination@
+
+ [@&gt; timeOutMicro 100 (print $ take 6 $ filter ((== 1) . (\`mod\` 83)) primes)@] @[167,499,997,1163,1993,2657]@
+
+ [@ @] @Value ()@
+
+ For the underlying theory and a larger example involving use of
+ QuickCheck, see the article \"Chasing Bottoms, A Case Study in Program
+ Verification in the Presence of Partial and Infinite Values\"
+ (&lt;http://www.cse.chalmers.se/~nad/publications/danielsson-jansson-mpc2004.html&gt;).
+
+ The code has been tested using GHC. Most parts can probably be
+ ported to other Haskell compilers, but this would require some work.
+ The @TimeOut@ functions require preemptive scheduling, and most of
+ the rest requires @Data.Generics@; @isBottom@ only requires
+ exceptions, though.
+ </longdescription>
+</pkgmetadata>