Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add Mutable.mapM et al, clarify that Mutable.mapM_ does not modify #417

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

add Mutable.mapM et al, clarify that Mutable.mapM_ does not modify #417

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 49 additions & 4 deletions vector/src/Data/Vector/Generic/Mutable.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,8 @@ module Data.Vector.Generic.Mutable (
read, write, modify, modifyM, swap, exchange,
unsafeRead, unsafeWrite, unsafeModify, unsafeModifyM, unsafeSwap, unsafeExchange,

-- * Folds
-- * Maps and folds
mapM, imapM, forM, iforM,
mapM_, imapM_, forM_, iforM_,
foldl, foldl', foldM, foldM',
foldr, foldr', foldrM, foldrM',
Expand Down Expand Up @@ -88,7 +89,7 @@ import Data.Vector.Internal.Check
import Control.Monad.Primitive ( PrimMonad(..), RealWorld, stToPrim )

import Prelude hiding ( length, null, replicate, reverse, map, read,
take, drop, splitAt, init, tail, mapM_, foldr, foldl )
take, drop, splitAt, init, tail, mapM, mapM_, foldr, foldl )

#include "vector.h"

Expand Down Expand Up @@ -727,6 +728,44 @@ unsafeExchange v i x = checkIndex Unsafe i (length v) $ stToPrim $ do
-- Folds
-- -----

forI :: (PrimMonad m, MVector v a) => v (PrimState m) a -> (Int -> m a) -> m ()
{-# INLINE forI #-}
forI v f = loop 0
where
loop i | i >= n = return ()
| otherwise = f i >>= unsafeWrite v i >> loop (i + 1)
n = length v

-- | /O(n)/ Apply the monadic action to every element of the vector, modifying it.
--
-- @since 0.13.0.1
mapM :: (PrimMonad m, MVector v a) => (a -> m a) -> v (PrimState m) a -> m ()
{-# INLINE mapM #-}
mapM f v = forI v $ \i -> f =<< unsafeRead v i

-- | /O(n)/ Apply the monadic action to every element of the vector and its index, modifying the vector.
--
-- @since 0.13.0.1
imapM :: (PrimMonad m, MVector v a) => (Int -> a -> m a) -> v (PrimState m) a -> m ()
{-# INLINE imapM #-}
imapM f v = forI v $ \i -> f i =<< unsafeRead v i

-- | /O(n)/ Apply the monadic action to every element of the vector,
-- modifying it. It's the same as @flip mapM_@.
--
-- @since 0.13.0.1
forM :: (PrimMonad m, MVector v a) => v (PrimState m) a -> (a -> m a) -> m ()
{-# INLINE forM #-}
forM = flip mapM

-- | /O(n)/ Apply the monadic action to every element of the vector
-- and its index, modifying the vector. It's the same as @flip imapM_@.
--
-- @since 0.13.0.1
iforM :: (PrimMonad m, MVector v a) => v (PrimState m) a -> (Int -> a -> m a) -> m ()
{-# INLINE iforM #-}
iforM = flip imapM

forI_ :: (Monad m, MVector v a) => v (PrimState m) a -> (Int -> m b) -> m ()
{-# INLINE forI_ #-}
forI_ v f = loop 0
Expand All @@ -736,29 +775,35 @@ forI_ v f = loop 0
n = length v

-- | /O(n)/ Apply the monadic action to every element of the vector, discarding the results.
-- The vector is not modified.
--
-- @since 0.12.3.0
mapM_ :: (PrimMonad m, MVector v a) => (a -> m b) -> v (PrimState m) a -> m ()
{-# INLINE mapM_ #-}
mapM_ f v = forI_ v $ \i -> f =<< unsafeRead v i

-- | /O(n)/ Apply the monadic action to every element of the vector and its index, discarding the results.
-- The vector is not modified.
--
-- @since 0.12.3.0
imapM_ :: (PrimMonad m, MVector v a) => (Int -> a -> m b) -> v (PrimState m) a -> m ()
{-# INLINE imapM_ #-}
imapM_ f v = forI_ v $ \i -> f i =<< unsafeRead v i

-- | /O(n)/ Apply the monadic action to every element of the vector,
-- discarding the results. It's the same as @flip mapM_@.
-- discarding the results. The vector is not modified.
--
-- It's the same as @flip mapM_@.
--
-- @since 0.12.3.0
forM_ :: (PrimMonad m, MVector v a) => v (PrimState m) a -> (a -> m b) -> m ()
{-# INLINE forM_ #-}
forM_ = flip mapM_

-- | /O(n)/ Apply the monadic action to every element of the vector
-- and its index, discarding the results. It's the same as @flip imapM_@.
-- and its index, discarding the results. The vector is not modified.
--
-- It's the same as @flip imapM_@.
--
-- @since 0.12.3.0
iforM_ :: (PrimMonad m, MVector v a) => v (PrimState m) a -> (Int -> a -> m b) -> m ()
Expand Down
45 changes: 41 additions & 4 deletions vector/src/Data/Vector/Mutable.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,8 @@ module Data.Vector.Mutable (
read, write, modify, modifyM, swap, exchange,
unsafeRead, unsafeWrite, unsafeModify, unsafeModifyM, unsafeSwap, unsafeExchange,

-- * Folds
-- * Maps and folds
mapM, imapM, forM, iforM,
mapM_, imapM_, forM_, iforM_,
foldl, foldl', foldM, foldM',
foldr, foldr', foldrM, foldrM',
Expand All @@ -74,7 +75,7 @@ import Data.Primitive.Array
import Control.Monad.Primitive

import Prelude hiding ( length, null, replicate, reverse, read,
take, drop, splitAt, init, tail, foldr, foldl, mapM_ )
take, drop, splitAt, init, tail, foldr, foldl, mapM, mapM_ )

import Data.Typeable ( Typeable )

Expand Down Expand Up @@ -552,30 +553,66 @@ nextPermutation = G.nextPermutation
-- Folds
-- -----

-- | /O(n)/ Apply the monadic action to every element of the vector, modifying it.
--
-- @since 0.13.0.1
mapM :: (PrimMonad m) => (a -> m a) -> MVector (PrimState m) a -> m ()
{-# INLINE mapM #-}
mapM = G.mapM

-- | /O(n)/ Apply the monadic action to every element of the vector and its index, modifying the vector.
--
-- @since 0.13.0.1
imapM :: (PrimMonad m) => (Int -> a -> m a) -> MVector (PrimState m) a -> m ()
{-# INLINE imapM #-}
imapM = G.imapM

-- | /O(n)/ Apply the monadic action to every element of the vector,
-- modifying it. It's the same as @flip mapM_@.
--
-- @since 0.13.0.1
forM :: (PrimMonad m) => MVector (PrimState m) a -> (a -> m a) -> m ()
{-# INLINE forM #-}
forM = G.forM

-- | /O(n)/ Apply the monadic action to every element of the vector
-- and its index, modifying the vector. It's the same as @flip imapM_@.
--
-- @since 0.13.0.1
iforM :: (PrimMonad m) => MVector (PrimState m) a -> (Int -> a -> m a) -> m ()
{-# INLINE iforM #-}
iforM = G.iforM

-- | /O(n)/ Apply the monadic action to every element of the vector, discarding the results.
-- The vector is not modified.
--
-- @since 0.12.3.0
mapM_ :: (PrimMonad m) => (a -> m b) -> MVector (PrimState m) a -> m ()
{-# INLINE mapM_ #-}
mapM_ = G.mapM_

-- | /O(n)/ Apply the monadic action to every element of the vector and its index, discarding the results.
-- The vector is not modified.
--
-- @since 0.12.3.0
imapM_ :: (PrimMonad m) => (Int -> a -> m b) -> MVector (PrimState m) a -> m ()
{-# INLINE imapM_ #-}
imapM_ = G.imapM_

-- | /O(n)/ Apply the monadic action to every element of the vector,
-- discarding the results. It's the same as @flip mapM_@.
-- discarding the results. The vector is not modified.
--
-- It's the same as @flip mapM_@.
--
-- @since 0.12.3.0
forM_ :: (PrimMonad m) => MVector (PrimState m) a -> (a -> m b) -> m ()
{-# INLINE forM_ #-}
forM_ = G.forM_

-- | /O(n)/ Apply the monadic action to every element of the vector
-- and its index, discarding the results. It's the same as @flip imapM_@.
-- and its index, discarding the results. The vector is not modified.
--
-- It's the same as @flip imapM_@.
--
-- @since 0.12.3.0
iforM_ :: (PrimMonad m) => MVector (PrimState m) a -> (Int -> a -> m b) -> m ()
Expand Down