@@ -17,29 +17,39 @@
1717--
1818module Streamly.Prelude
1919 (
20− -- * Construction
20+ -- * Construction and Deconstruction
21+ -- | Primitives to construct or inspect a stream.
2122 nil
2223 , cons
2324 , (.:)
25+ , uncons
26+
27+ -- * Generation
28+ -- | Generate a monadic stream from an input structure, a seed or a
29+ -- generation function.
2430 , unfoldr
2531 , unfoldrM
26− , fromFoldable
2732 , iterate
2833 , iterateM
34+ , replicateM
35+ , fromFoldable
36+
37+ -- * Folding
38+ -- | Folds accept a 'StreamT' type instead of a polymorphic type to ensure
39+ -- that streams have a monomorphic type by default. In case you want to use
40+ -- any other type of stream you can use one of the type combinators to
41+ -- convert the stream type before passing to a fold function.
2942
30− -- * Elimination
3143 -- ** General Folds
3244 , foldr
3345 , foldrM
3446 , foldl'
3547 , foldlM'
36− , scanl'
37− , scanx
3848 , foldx
3949 , foldxM
40− , uncons
4150
4251 -- ** Special Folds
52+ , mapM_
4353 , toList
4454 , all
4555 , any
@@ -50,12 +60,15 @@ module Streamly.Prelude
5060 , length
5161 , elem
5262 , notElem
53− , reverse
5463 , maximum
5564 , minimum
5665 , sum
5766 , product
5867
68+ -- * Scans
69+ , scanl'
70+ , scanx
71+
5972 -- * Filtering
6073 , filter
6174 , take
@@ -63,11 +76,12 @@ module Streamly.Prelude
6376 , drop
6477 , dropWhile
6578
66− -- * Transformation
79+ -- * Reordering
80+ , reverse
81+
82+ -- * Mapping
6783 , mapM
68− , mapM_
6984 , sequence
70− , replicateM
7185
7286 -- * Zipping
7387 , zipWith