-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | functions for working with arrows
--   
--   arrow-utils provides useful functions and type classes for working
--   with arrows. It provides functions similar to sequenceA.
@package arrow-utils
@version 0.1.2

module Control.Arrow.Utils

-- | Wrap the Arrow in a newtype in order to create new class instances.
--   This is a generalisation of <tt>ArrowMonad</tt>, which is isomorphic
--   to <tt><a>SameInputArrow</a> a () c</tt>.
newtype SameInputArrow a b c
SameInputArrow :: a b c -> SameInputArrow a b c
[unSameInputArrow] :: SameInputArrow a b c -> a b c

-- | Creates arrows using f, then runs all arrows in the given
--   <a>Traversable</a>, collecting the results.
--   
--   <pre>
--   traverseArr (+) [1,10] 1 == [2,11]
--   </pre>
traverseArr :: (Traversable t, Arrow a) => (x -> a b c) -> t x -> a b (t c)

-- | Creates arrows using f, then runs all arrows in the given
--   <a>Foldable</a>, discarding the results.
traverseArr_ :: (Foldable t, Arrow a) => (x -> a b c) -> t x -> a b ()

-- | Like <a>sequenceArr</a>, but discard the results.
sequenceArr_ :: (Foldable t, Arrow a) => t (a b any) -> a b ()

-- | Run all arrows in the given <a>Traversable</a>, collecting the
--   results.
--   
--   <pre>
--   sequenceArr [(+1), (+10)] 1 == [2,11]
--   </pre>
sequenceArr :: (Traversable t, Arrow a) => t (a b c) -> a b (t c)

-- | Fans each input from <tt>Vector n b</tt> to a separate arrow from the
--   given vector.
--   
--   <pre>
--   sequenceArrVec (Vec.generate ((+).fromIntegral) :: Vector 5 (Int -&gt; Int)) (Vec.replicate 1 :: Vector 5 Int) == Vector [1,2,3,4,5]
--   </pre>
zipSequenceArrVec :: (Arrow a, KnownNat n) => Vector n (a b c) -> a (Vector n b) (Vector n c)

-- | Fans each input from <tt>[b]</tt> to a separate arrow from the given
--   list. The output list has length of the minimum of the input list
--   length and the arrow list length.
--   
--   <pre>
--   sequenceArrList [(+1), (+10)] [1,2] == [2,12]
--   sequenceArrList [(+1), (+10)] [1]   == [2]
--   sequenceArrList [(+1)] [1,2,3,4]    == [2]
--   </pre>
zipSequenceArrList :: (Arrow a, ArrowChoice a) => [a b c] -> a [b] [c]

-- | Similar to <tt><tt>when</tt></tt> for <tt><a>Applicative</a></tt>.
--   Relevant for arrows which embeded a Monad.
whenArr :: ArrowChoice a => a b () -> a (Bool, b) ()

-- | Similar to <tt><tt>unless</tt></tt> for <tt><a>Applicative</a></tt>.
--   Relevant for arrows which embeded a Monad.
unlessArr :: ArrowChoice a => a b () -> a (Bool, b) ()

-- | Always output the given value.
constantly :: Arrow a => b -> a any b
instance Control.Arrow.Arrow a => GHC.Base.Functor (Control.Arrow.Utils.SameInputArrow a b)
instance Control.Arrow.Arrow a => GHC.Base.Applicative (Control.Arrow.Utils.SameInputArrow a b)