on master help sign in
Make the array docs clearer
63aae12Harendra Kumar
core/src/Streamly/Data/Array.hs+4−5
@@ -126,7 +126,7 @@ import Prelude hiding (read, length)
126--
126--
127-- Convert array to stream, transform, and fold back to array:
127-- Convert array to stream, transform, and fold back to array:
128--
128--
129−-- >>> amap f arr = Array.read arr & fmap f & Stream.fold Array.create
129+-- >>> amap f arr = Array.read arr & fmap f & Stream.fold (Array.createOf (Array.length arr))
130-- >>> amap (+1) (Array.fromList [1,2,3::Int])
130-- >>> amap (+1) (Array.fromList [1,2,3::Int])
131-- fromList [2,3,4]
131-- fromList [2,3,4]
132--
132--
@@ -153,12 +153,11 @@ import Prelude hiding (read, length)
153-- See the 'fromPureStream' unreleased API to generate an array from an
153-- See the 'fromPureStream' unreleased API to generate an array from an
154-- Identity stream safely without using MonadIO constraint.
154-- Identity stream safely without using MonadIO constraint.
155--
155--
156−--
157-- Note that 'Identity' streams can be generalized to IO streams:
156-- Note that 'Identity' streams can be generalized to IO streams:
158--
157--
159−-- >>> pure = Stream.fromList [1,2,3] :: Stream Identity Int
158+-- >>> stream = Stream.fromList [1,2,3] :: Stream Identity Int
160−-- >>> generally = Stream.morphInner (return . runIdentity)
159+-- >>> pure2IO s = Stream.morphInner (return . runIdentity) s :: Stream IO Int
161−-- >>> Stream.fold Array.create (generally pure :: Stream IO Int)
160+-- >>> Stream.fold Array.create (pure2IO stream)
162-- fromList [1,2,3]
161-- fromList [1,2,3]
163--
162--
164-- == Programming Tips
163-- == Programming Tips