Copyright  Conor McBride and Ross Paterson 2005 

License  BSDstyle (see the LICENSE file in the distribution) 
Maintainer  libraries@haskell.org 
Stability  experimental 
Portability  portable 
Safe Haskell  Trustworthy 
Language  Haskell2010 
This module describes a structure intermediate between a functor and
a monad (technically, a strong lax monoidal functor). Compared with
monads, this interface lacks the full power of the binding operation
>>=
, but
 it has more instances.
 it is sufficient for many uses, e.g. contextfree parsing, or the
Traversable
class.  instances can perform analysis of computations before they are executed, and thus produce shared optimizations.
This interface was introduced for parsers by Niklas Röjemo, because it admits more sharing than the monadic interface. The names here are mostly based on parsing work by Doaitse Swierstra.
For more details, see Applicative Programming with Effects, by Conor McBride and Ross Paterson.
 class Functor f => Applicative f where
 class Applicative f => Alternative f where
 newtype Const a b = Const {
 getConst :: a
 newtype WrappedMonad m a = WrapMonad {
 unwrapMonad :: m a
 newtype WrappedArrow a b c = WrapArrow {
 unwrapArrow :: a b c
 newtype ZipList a = ZipList {
 getZipList :: [a]
 (<$>) :: Functor f => (a > b) > f a > f b
 (<$) :: Functor f => a > f b > f a
 (<**>) :: Applicative f => f a > f (a > b) > f b
 liftA :: Applicative f => (a > b) > f a > f b
 liftA3 :: Applicative f => (a > b > c > d) > f a > f b > f c > f d
 optional :: Alternative f => f a > f (Maybe a)
Applicative functors
class Functor f => Applicative f where Source #
A functor with application, providing operations to
A minimal complete definition must include implementations of pure
and of either <*>
or liftA2
. If it defines both, then they must behave
the same as their default definitions:
(
<*>
) = liftA2
id
liftA2
f x y = f <$>
x <*>
y
Further, any definition must satisfy the following:
 identity
pure
id
<*>
v = v composition
pure
(.)<*>
u<*>
v<*>
w = u<*>
(v<*>
w) homomorphism
pure
f<*>
pure
x =pure
(f x) interchange
u
<*>
pure
y =pure
($
y)<*>
u
The other methods have the following default definitions, which may be overridden with equivalent specialized implementations:
As a consequence of these laws, the Functor
instance for f
will satisfy
It may be useful to note that supposing
forall x y. p (q x y) = f x . g y
it follows from the above that
liftA2
p (liftA2
q u v) =liftA2
f u .liftA2
g v
If f
is also a Monad
, it should satisfy
(which implies that pure
and <*>
satisfy the applicative functor laws).
Lift a value.
(<*>) :: f (a > b) > f a > f b infixl 4 Source #
Sequential application.
A few functors support an implementation of <*>
that is more
efficient than the default one.
liftA2 :: (a > b > c) > f a > f b > f c Source #
Lift a binary function to actions.
Some functors support an implementation of liftA2
that is more
efficient than the default one. In particular, if fmap
is an
expensive operation, it is likely better to use liftA2
than to
fmap
over the structure and then use <*>
.
(*>) :: f a > f b > f b infixl 4 Source #
Sequence actions, discarding the value of the first argument.
(<*) :: f a > f b > f a infixl 4 Source #
Sequence actions, discarding the value of the second argument.
Applicative [] Source #  Since: 2.1 
Applicative Maybe Source #  Since: 2.1 
Applicative IO Source #  Since: 2.1 
Applicative Par1 Source #  Since: 4.9.0.0 
Applicative ReadP Source #  Since: 4.6.0.0 
Applicative ReadPrec Source #  Since: 4.6.0.0 
Applicative Last Source #  
Applicative First Source #  
Applicative Product Source #  Since: 4.8.0.0 
Applicative Sum Source #  Since: 4.8.0.0 
Applicative Dual Source #  Since: 4.8.0.0 
Applicative STM Source #  Since: 4.8.0.0 
Applicative Identity Source #  Since: 4.8.0.0 
Applicative ZipList Source #  f '<$>' 'ZipList' xs1 '<*>' ... '<*>' 'ZipList' xsN

Applicative NonEmpty Source #  Since: 4.9.0.0 
Applicative Option Source #  Since: 4.9.0.0 
Applicative Last Source #  Since: 4.9.0.0 
Applicative First Source #  Since: 4.9.0.0 
Applicative Max Source #  Since: 4.9.0.0 
Applicative Min Source #  Since: 4.9.0.0 
Applicative Complex Source #  Since: 4.9.0.0 
Applicative (Either e) Source #  Since: 3.0 
Applicative (U1 *) Source #  Since: 4.9.0.0 
Monoid a => Applicative ((,) a) Source #  For tuples, the ("hello ", (+15)) <*> ("world!", 2002) ("hello world!",2017) Since: 2.1 
Applicative (ST s) Source #  Since: 4.4.0.0 
Applicative (Proxy *) Source #  Since: 4.7.0.0 
Arrow a => Applicative (ArrowMonad a) Source #  Since: 4.6.0.0 
Monad m => Applicative (WrappedMonad m) Source #  Since: 2.1 
Applicative (ST s) Source #  Since: 2.1 
Applicative f => Applicative (Rec1 * f) Source #  Since: 4.9.0.0 
Applicative f => Applicative (Alt * f) Source #  
Monoid m => Applicative (Const * m) Source #  Since: 2.0.1 
Arrow a => Applicative (WrappedArrow a b) Source #  Since: 2.1 
Applicative ((>) LiftedRep LiftedRep a) Source #  Since: 2.1 
(Applicative f, Applicative g) => Applicative ((:*:) * f g) Source #  Since: 4.9.0.0 
(Applicative f, Applicative g) => Applicative (Product * f g) Source #  Since: 4.9.0.0 
Applicative f => Applicative (M1 * i c f) Source #  Since: 4.9.0.0 
(Applicative f, Applicative g) => Applicative ((:.:) * * f g) Source #  Since: 4.9.0.0 
(Applicative f, Applicative g) => Applicative (Compose * * f g) Source #  Since: 4.9.0.0 
Alternatives
class Applicative f => Alternative f where Source #
A monoid on applicative functors.
If defined, some
and many
should be the least solutions
of the equations:
The identity of <>
(<>) :: f a > f a > f a infixl 3 Source #
An associative binary operation
One or more.
Zero or more.
Instances
The Const
functor.
Generic1 k (Const k a) Source #  
Show2 (Const *) Source #  Since: 4.9.0.0 
Read2 (Const *) Source #  Since: 4.9.0.0 
Ord2 (Const *) Source #  Since: 4.9.0.0 
Eq2 (Const *) Source #  Since: 4.9.0.0 
Bifunctor (Const *) Source #  Since: 4.8.0.0 
Bifoldable (Const *) Source #  Since: 4.10.0.0 
Bitraversable (Const *) Source #  Since: 4.10.0.0 
Functor (Const * m) Source #  Since: 2.1 
Monoid m => Applicative (Const * m) Source #  Since: 2.0.1 
Foldable (Const * m) Source #  Since: 4.7.0.0 
Traversable (Const * m) Source #  Since: 4.7.0.0 
Show a => Show1 (Const * a) Source #  Since: 4.9.0.0 
Read a => Read1 (Const * a) Source #  Since: 4.9.0.0 
Ord a => Ord1 (Const * a) Source #  Since: 4.9.0.0 
Eq a => Eq1 (Const * a) Source #  Since: 4.9.0.0 
Bounded a => Bounded (Const k a b) Source #  
Enum a => Enum (Const k a b) Source #  
Eq a => Eq (Const k a b) Source #  
Floating a => Floating (Const k a b) Source #  
Fractional a => Fractional (Const k a b) Source #  
Integral a => Integral (Const k a b) Source #  
(Typeable * k3, Data a, Typeable k3 b) => Data (Const k3 a b) Source #  Since: 4.10.0.0 
Num a => Num (Const k a b) Source #  
Ord a => Ord (Const k a b) Source #  
Read a => Read (Const k a b) Source #  This instance would be equivalent to the derived instances of the
Since: 4.8.0.0 
Real a => Real (Const k a b) Source #  
RealFloat a => RealFloat (Const k a b) Source #  
RealFrac a => RealFrac (Const k a b) Source #  
Show a => Show (Const k a b) Source #  This instance would be equivalent to the derived instances of the
Since: 4.8.0.0 
Ix a => Ix (Const k a b) Source #  
IsString a => IsString (Const * a b) Source #  Since: 4.9.0.0 
Generic (Const k a b) Source #  
Semigroup a => Semigroup (Const k a b) Source #  Since: 4.9.0.0 
Monoid a => Monoid (Const k a b) Source #  
FiniteBits a => FiniteBits (Const k a b) Source #  
Bits a => Bits (Const k a b) Source #  
Storable a => Storable (Const k a b) Source #  
type Rep1 k (Const k a) Source #  
type Rep (Const k a b) Source #  
newtype WrappedMonad m a Source #
WrapMonad  

Monad m => Monad (WrappedMonad m) Source #  
Monad m => Functor (WrappedMonad m) Source #  Since: 2.1 
Monad m => Applicative (WrappedMonad m) Source #  Since: 2.1 
MonadPlus m => Alternative (WrappedMonad m) Source #  Since: 2.1 
Generic1 * (WrappedMonad m) Source #  
Generic (WrappedMonad m a) Source #  
type Rep1 * (WrappedMonad m) Source #  
type Rep (WrappedMonad m a) Source #  
newtype WrappedArrow a b c Source #
WrapArrow  

Generic1 * (WrappedArrow a b) Source #  
Arrow a => Functor (WrappedArrow a b) Source #  Since: 2.1 
Arrow a => Applicative (WrappedArrow a b) Source #  Since: 2.1 
(ArrowZero a, ArrowPlus a) => Alternative (WrappedArrow a b) Source #  Since: 2.1 
Generic (WrappedArrow a b c) Source #  
type Rep1 * (WrappedArrow a b) Source #  
type Rep (WrappedArrow a b c) Source #  
Lists, but with an Applicative
functor based on zipping.
ZipList  

Functor ZipList Source #  
Applicative ZipList Source #  f '<$>' 'ZipList' xs1 '<*>' ... '<*>' 'ZipList' xsN

Foldable ZipList Source #  
Traversable ZipList Source #  Since: 4.9.0.0 
Eq a => Eq (ZipList a) Source #  
Ord a => Ord (ZipList a) Source #  
Read a => Read (ZipList a) Source #  
Show a => Show (ZipList a) Source #  
Generic (ZipList a) Source #  
Generic1 * ZipList Source #  
type Rep (ZipList a) Source #  
type Rep1 * ZipList Source #  
Utility functions
(<$>) :: Functor f => (a > b) > f a > f b infixl 4 Source #
An infix synonym for fmap
.
The name of this operator is an allusion to $
.
Note the similarities between their types:
($) :: (a > b) > a > b (<$>) :: Functor f => (a > b) > f a > f b
Whereas $
is function application, <$>
is function
application lifted over a Functor
.
Examples
Convert from a
to a Maybe
Int
using Maybe
String
show
:
>>>
show <$> Nothing
Nothing>>>
show <$> Just 3
Just "3"
Convert from an
to an Either
Int
Int
Either
Int
String
using show
:
>>>
show <$> Left 17
Left 17>>>
show <$> Right 17
Right "17"
Double each element of a list:
>>>
(*2) <$> [1,2,3]
[2,4,6]
Apply even
to the second element of a pair:
>>>
even <$> (2,2)
(2,True)
(<**>) :: Applicative f => f a > f (a > b) > f b infixl 4 Source #
A variant of <*>
with the arguments reversed.
liftA :: Applicative f => (a > b) > f a > f b Source #
liftA3 :: Applicative f => (a > b > c > d) > f a > f b > f c > f d Source #
Lift a ternary function to actions.
optional :: Alternative f => f a > f (Maybe a) Source #
One or none.