ilyakooo0/streamly
1
0
Fork 0
mirror of https://github.com/ilyakooo0/streamly.git synced 2024-09-17 11:37:20 +03:00
Code Issues Packages Projects Releases Wiki Activity

Make the array docs clearer

Browse Source 
Use more efficient array transformation example
This commit is contained in:
Harendra Kumar 2024-01-18 16:48:42 +05:30
parent 944e248ed0
commit 63aae127c1
1 changed files with 4 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
core/src/Streamly/Data/Array.hs
View File

@ -126,7 +126,7 @@ import Prelude hiding (read, length)
--
-- Convert array to stream, transform, and fold back to array:
--
-- >>> amap f arr = Array.read arr & fmap f & Stream.fold Array.create
-- >>> amap f arr = Array.read arr & fmap f & Stream.fold (Array.createOf (Array.length arr))
-- >>> amap (+1) (Array.fromList [1,2,3::Int])
-- fromList [2,3,4]
--
@ -153,12 +153,11 @@ import Prelude hiding (read, length)
-- See the 'fromPureStream' unreleased API to generate an array from an
-- Identity stream safely without using MonadIO constraint.
--
--
-- Note that 'Identity' streams can be generalized to IO streams:
--
-- >>> pure = Stream.fromList [1,2,3] :: Stream Identity Int
-- >>> generally = Stream.morphInner (return . runIdentity)
-- >>> Stream.fold Array.create (generally pure :: Stream IO Int)
-- >>> stream = Stream.fromList [1,2,3] :: Stream Identity Int
-- >>> pure2IO s = Stream.morphInner (return . runIdentity) s :: Stream IO Int
-- >>> Stream.fold Array.create (pure2IO stream)
-- fromList [1,2,3]
--
-- == Programming Tips