on master help sign in
reorder haddock docs in prelude
331a96fHarendra Kumar
src/Streamly/Prelude.hs+24−10
@@ -17,29 +17,39 @@
17--
17--
18module Streamly.Prelude
18module Streamly.Prelude
19 (
19 (
20− -- * Construction
20+ -- * Construction and Deconstruction
21+ -- | Primitives to construct or inspect a stream.
21 nil
22 nil
22 , cons
23 , cons
23 , (.:)
24 , (.:)
25+ , uncons
26+
27+ -- * Generation
28+ -- | Generate a monadic stream from an input structure, a seed or a
29+ -- generation function.
24 , unfoldr
30 , unfoldr
25 , unfoldrM
31 , unfoldrM
26− , fromFoldable
27 , iterate
32 , iterate
28 , iterateM
33 , 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.
29
42
30− -- * Elimination
31 -- ** General Folds
43 -- ** General Folds
32 , foldr
44 , foldr
33 , foldrM
45 , foldrM
34 , foldl'
46 , foldl'
35 , foldlM'
47 , foldlM'
36− , scanl'
37− , scanx
38 , foldx
48 , foldx
39 , foldxM
49 , foldxM
40− , uncons
41
50
42 -- ** Special Folds
51 -- ** Special Folds
52+ , mapM_
43 , toList
53 , toList
44 , all
54 , all
45 , any
55 , any
@@ -50,12 +60,15 @@ module Streamly.Prelude
50 , length
60 , length
51 , elem
61 , elem
52 , notElem
62 , notElem
53− , reverse
54 , maximum
63 , maximum
55 , minimum
64 , minimum
56 , sum
65 , sum
57 , product
66 , product
58
67
68+ -- * Scans
69+ , scanl'
70+ , scanx
71+
59 -- * Filtering
72 -- * Filtering
60 , filter
73 , filter
61 , take
74 , take
@@ -63,11 +76,12 @@ module Streamly.Prelude
63 , drop
76 , drop
64 , dropWhile
77 , dropWhile
65
78
66− -- * Transformation
79+ -- * Reordering
80+ , reverse
81+
82+ -- * Mapping
67 , mapM
83 , mapM
68− , mapM_
69 , sequence
84 , sequence
70− , replicateM
71
85
72 -- * Zipping
86 -- * Zipping
73 , zipWith
87 , zipWith