diff --git a/LICENSE b/LICENSE new file mode 100644 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2016 Eric Rochester + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/Setup.hs b/Setup.hs new file mode 100644 --- /dev/null +++ b/Setup.hs @@ -0,0 +1,2 @@ +import Distribution.Simple +main = defaultMain diff --git a/algo-s.cabal b/algo-s.cabal new file mode 100644 --- /dev/null +++ b/algo-s.cabal @@ -0,0 +1,78 @@ +name: algo-s +version: 0.1.0.0 +cabal-version: >=1.10 +build-type: Simple +license: Apache-2.0 +license-file: LICENSE +copyright: 2016 Eric Rochester +maintainer: erochest@gmail.com +synopsis: An implementation of Knuth's algorithm S. +description: + An implementaiton of Knuth's algorithm S + (https://rosettacode.org/wiki/Knuth%27s_algorithm_S) + with a command-line utility for sampling from STDIN. +category: Data +author: Eric Rochester + +source-repository head + type: git + location: https://github.com/erochest/algo-s + +library + exposed-modules: + Data.Sample.AlgoS + Data.Sample.AlgoS.Types + build-depends: + base ==4.8.*, + foldl >=1.2.1 && <1.3, + mwc-random >=0.13.4.0 && <0.14, + primitive >=0.6.1.0 && <0.7, + unordered-containers >=0.2.7.1 && <0.3 + default-language: Haskell2010 + hs-source-dirs: src + +executable sample + main-is: Main.hs + build-depends: + base >=4.8 && <5, + algo-s >=0.1.0.0 && <0.2, + bytestring >=0.10.6.0 && <0.11, + errors >=2.1.2 && <2.2, + mwc-random >=0.13.4.0 && <0.14, + optparse-applicative >=0.12.1.0 && <0.13 + default-language: Haskell2010 + hs-source-dirs: app + other-modules: + Actions + Opts + Types + ghc-options: -threaded -rtsopts -with-rtsopts=-N + +test-suite algo-s-specs + type: exitcode-stdio-1.0 + main-is: Specs.hs + build-depends: + base >=4.8.2.0 && <4.9, + algo-s >=0.1.0.0 && <0.2, + errors >=2.1.2 && <2.2, + foldl >=1.2.1 && <1.3, + mwc-random >=0.13.4.0 && <0.14, + QuickCheck >=2.8.2 && <2.9, + smallcheck >=1.1.1 && <1.2, + hspec >=2.2.3 && <2.3 + default-language: Haskell2010 + hs-source-dirs: specs + other-modules: + Data.Sample.AlgoSSpec + ghc-options: -threaded -rtsopts + +benchmark algo-s-bench + type: exitcode-stdio-1.0 + main-is: Bench.hs + build-depends: + base >=4.8.2.0 && <4.9, + algo-s >=0.1.0.0 && <0.2, + criterion >=1.1.1.0 && <1.2 + default-language: Haskell2010 + hs-source-dirs: bench + ghc-options: -threaded -rtsopts diff --git a/app/Actions.hs b/app/Actions.hs new file mode 100644 --- /dev/null +++ b/app/Actions.hs @@ -0,0 +1,22 @@ +{-# LANGUAGE OverloadedLists #-} +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE RecordWildCards #-} + + +module Actions where + + +import Control.Error +import qualified Data.ByteString.Lazy.Char8 as L8 +import System.Random.MWC + +import Data.Sample.AlgoS + +import Types + + +action :: Actions -> Script () +action Sample{..} = scriptIO . withSystemRandom . asGenIO $ \g -> + L8.getContents + >>= flip (sample sampleN) g . L8.lines + >>= L8.putStr . L8.unlines diff --git a/app/Main.hs b/app/Main.hs new file mode 100644 --- /dev/null +++ b/app/Main.hs @@ -0,0 +1,14 @@ +{-# LANGUAGE OverloadedStrings #-} + + +module Main where + + +import Control.Error + +import Actions +import Opts + + +main :: IO () +main = runScript . action =<< parseOpts diff --git a/app/Opts.hs b/app/Opts.hs new file mode 100644 --- /dev/null +++ b/app/Opts.hs @@ -0,0 +1,33 @@ +{-# LANGUAGE LambdaCase #-} + + +module Opts + ( Actions(..) + , opts + , execParser + , parseOpts + ) where + + +import Options.Applicative + +import Types + + +defaultOpts :: Parser Actions +defaultOpts = Sample + <$> option auto ( short 'n' <> long "n" + <> value 1000 <> metavar "SAMPLE_SIZE" + <> help "The number of items to return in the\ + \ sample. Defaults to 1,000.") + +opts :: ParserInfo Actions +opts = info (helper <*> defaultOpts) + ( fullDesc + <> progDesc "An implementaiton of Knuth's algorithm S\ + \ (https://rosettacode.org/wiki/Knuth%27s_algorithm_S)\ + \ with a command-line utility for sampling from STDIN." + <> header "algo-s - An implementation of Knuth's algorithm S.") + +parseOpts :: IO Actions +parseOpts = execParser opts diff --git a/app/Types.hs b/app/Types.hs new file mode 100644 --- /dev/null +++ b/app/Types.hs @@ -0,0 +1,10 @@ +module Types where + + +-- import Data.Sample.AlgoS.Types + + +data Actions = Sample + { sampleN :: !Int + } + deriving (Show, Eq) diff --git a/bench/Bench.hs b/bench/Bench.hs new file mode 100644 --- /dev/null +++ b/bench/Bench.hs @@ -0,0 +1,13 @@ +module Main where + + +import Criterion.Main + + +main :: IO () +main = do + defaultMain + [ bgroup "benchmarking" + [ + ] + ] diff --git a/specs/Data/Sample/AlgoSSpec.hs b/specs/Data/Sample/AlgoSSpec.hs new file mode 100644 --- /dev/null +++ b/specs/Data/Sample/AlgoSSpec.hs @@ -0,0 +1,69 @@ +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE ScopedTypeVariables #-} + + +module Data.Sample.AlgoSSpec where + + +import qualified Control.Foldl as F +import Data.Foldable +import qualified Data.List as L +import System.Random.MWC +import Test.Hspec +import Test.QuickCheck hiding (sample) +import Test.QuickCheck.Monadic + +import Data.Sample.AlgoS + + +toDouble :: Int -> Double +toDouble = fromIntegral + +spec :: Spec +spec = do + describe "sample" $ do + it "should return the input if the list is monadicIO $ do + ss <- run . withSystemRandom . asGenIO $ + sample (2 * length xs) xs + assert $ ss == xs + + it "should return a sample of the list if the list is >=N." $ + property $ \(NonEmpty xs :: NonEmptyList Int) -> monadicIO $ do + ss <- run . withSystemRandom . asGenIO $ + sample (floor $ toDouble (length xs) / 2) xs + assert $ length ss < length xs + + it "should maintain the order of the input." $ + property $ \(NonEmpty xs :: NonEmptyList Int) -> monadicIO $ do + ss <- run . withSystemRandom . asGenIO $ + sample (floor $ toDouble (length xs) / 2) $ L.sort xs + assert . all (uncurry (<=)) . zip ss $ tail ss + + describe "sampleStep" $ do + it "should return the input if the list is monadicIO $ do + ss <- run . withSystemRandom . asGenIO $ \g -> + F.foldM (sampleInit (2 * length xs) g) xs + assert $ ss == xs + + it "should return a sample of the list if the list is >=N." $ + property $ \(NonEmpty xs :: NonEmptyList Int) -> monadicIO $ do + ss <- run . withSystemRandom . asGenIO $ \g -> + F.foldM (sampleInit (floor $ toDouble (length xs) / 2) g) xs + assert $ length ss < length xs + + it "should maintain the order of the input." $ + property $ \(NonEmpty xs :: NonEmptyList Int) -> monadicIO $ do + ss <- run . withSystemRandom . asGenIO $ \g -> + F.foldM (sampleInit (floor $ toDouble (length xs)) g) + $ L.sort xs + assert . all (uncurry (<=)) . zip ss $ tail ss + + it "should accept the input incrementally." $ + property $ \(NonEmpty xs :: NonEmptyList Int) -> monadicIO $ do + ss <- run . withSystemRandom . asGenIO $ \g -> + let s = sampleInit (floor $ toDouble (length xs) / 2) g + in sampleDone =<< foldlM sampleStep s (L.sort xs) + assert $ length ss < length xs + assert . all (uncurry (<=)) . zip ss $ tail ss diff --git a/specs/Specs.hs b/specs/Specs.hs new file mode 100644 --- /dev/null +++ b/specs/Specs.hs @@ -0,0 +1,1 @@ +{-# OPTIONS_GHC -F -pgmF hspec-discover #-} diff --git a/src/Data/Sample/AlgoS.hs b/src/Data/Sample/AlgoS.hs new file mode 100644 --- /dev/null +++ b/src/Data/Sample/AlgoS.hs @@ -0,0 +1,56 @@ +{-# LANGUAGE ScopedTypeVariables #-} + + +module Data.Sample.AlgoS where + + +import qualified Control.Foldl as F +import Control.Monad.Primitive +import qualified Data.HashMap.Strict as M +import qualified Data.List as L +import Data.Ord +import System.Random.MWC + +import Data.Sample.AlgoS.Types + + +sample :: (PrimMonad m, Foldable f) => Int -> f a -> Gen (PrimState m) -> m [a] +sample k xs g = F.foldM (sampleInit k g) xs + +sampleInit :: PrimMonad m => Int -> Gen (PrimState m) -> Sampler m a +sampleInit k g = F.FoldM (foldStep g) start done + where + start = return (M.empty, 1.0) + done = return . fmap snd . L.sortBy (comparing fst) . M.toList . fst + + foldStep :: PrimMonad m + => Gen (PrimState m) + -> (M.HashMap Int a, Double) + -> a + -> m (M.HashMap Int a, Double) + foldStep g' (m, n) a + | n' <= k = return (M.insert n' a m, n + 1.0) + | otherwise = do + x :: Double <- uniform g' + if x <= (fromIntegral k / n) + then do + i <- (M.keys m !!) <$> uniformR (0, M.size m - 1) g' + return (M.insert n' a $ M.delete i m, n + 1.0) + else return (m, n + 1.0) + where + n' :: Int + n' = floor n + +sampleStep :: Monad m => Sampler m a -> a -> m (Sampler m a) +sampleStep = stepFoldM + +sampleDone :: Monad m => Sampler m a -> m [a] +sampleDone (F.FoldM _ b z) = z =<< b + +stepFold :: F.Fold a b -> a -> F.Fold a b +stepFold (F.Fold f b done) x = F.Fold f (f b x) done + +stepFoldM :: Monad m => F.FoldM m a b -> a -> m (F.FoldM m a b) +stepFoldM (F.FoldM f b done) x = do + b' <- b + return $ F.FoldM f (f b' x) done diff --git a/src/Data/Sample/AlgoS/Types.hs b/src/Data/Sample/AlgoS/Types.hs new file mode 100644 --- /dev/null +++ b/src/Data/Sample/AlgoS/Types.hs @@ -0,0 +1,9 @@ + + +module Data.Sample.AlgoS.Types where + + +import Control.Foldl (FoldM) + + +type Sampler m a = FoldM m a [a]