| Copyright | Conor McBride and Ross Paterson 2005 |
|---|---|
| License | BSD-style (see the LICENSE file in the distribution) |
| Maintainer | libraries@haskell.org |
| Stability | experimental |
| Portability | portable |
| Safe Haskell | Trustworthy |
| Language | Haskell2010 |
Control.Applicative
Description
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. context-free parsing, or the
Traversableclass. - 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
- liftA2 :: Applicative f => (a -> b -> c) -> f a -> f b -> f c
- 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 these functions satisfying the following laws:
- identity
pureid<*>v = v- composition
pure(.)<*>u<*>v<*>w = u<*>(v<*>w)- homomorphism
puref<*>purex =pure(f x)- interchange
u
<*>purey =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
If f is also a Monad, it should satisfy
(which implies that pure and <*> satisfy the applicative functor laws).
Methods
Lift a value.
(<*>) :: f (a -> b) -> f a -> f b infixl 4 Source
Sequential application.
(*>) :: 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.
Instances
| Applicative [] | |
| Applicative Maybe | |
| Applicative IO | |
| Applicative ReadP | |
| Applicative ReadPrec | |
| Applicative Last | |
| Applicative First | |
| Applicative Product | |
| Applicative Sum | |
| Applicative Dual | |
| Applicative STM | |
| Applicative ZipList | |
| Applicative Complex | |
| Applicative NonEmpty | |
| Applicative Option | |
| Applicative Last | |
| Applicative First | |
| Applicative Max | |
| Applicative Min | |
| Applicative Identity | |
| Applicative ((->) a) | |
| Applicative (Either e) | |
| Monoid a => Applicative ((,) a) | |
| Applicative (ST s) | |
| Applicative (Proxy (TYPE Lifted)) | |
| Arrow a => Applicative (ArrowMonad a) | |
| Monad m => Applicative (WrappedMonad m) | |
| Applicative (ST s) | |
| Applicative f => Applicative (Alt (TYPE Lifted) f) | |
| Monoid m => Applicative (Const (TYPE Lifted) m) | |
| Arrow a => Applicative (WrappedArrow a b) | |
| (Applicative f, Applicative g) => Applicative (Product (TYPE Lifted) f g) | |
| (Applicative f, Applicative g) => Applicative (Compose (TYPE Lifted) (TYPE Lifted) f g) | |
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:
Methods
The identity of <|>
(<|>) :: f a -> f a -> f a infixl 3 Source
An associative binary operation
One or more.
Zero or more.
Instances
| Alternative [] | |
| Alternative Maybe | |
| Alternative IO | |
| Alternative ReadP | |
| Alternative ReadPrec | |
| Alternative STM | |
| Alternative Option | |
| ArrowPlus a => Alternative (ArrowMonad a) | |
| MonadPlus m => Alternative (WrappedMonad m) | |
| Alternative f => Alternative (Alt (TYPE Lifted) f) | |
| (ArrowZero a, ArrowPlus a) => Alternative (WrappedArrow a b) | |
| (Alternative f, Alternative g) => Alternative (Product (TYPE Lifted) f g) | |
| (Alternative f, Applicative g) => Alternative (Compose (TYPE Lifted) (TYPE Lifted) f g) | |
Instances
The Const functor.
Instances
| Bifunctor (Const (TYPE Lifted)) | |
| Show2 (Const (TYPE Lifted)) | |
| Read2 (Const (TYPE Lifted)) | |
| Ord2 (Const (TYPE Lifted)) | |
| Eq2 (Const (TYPE Lifted)) | |
| Functor (Const (TYPE Lifted) m) | |
| Monoid m => Applicative (Const (TYPE Lifted) m) | |
| Foldable (Const (TYPE Lifted) m) | |
| Traversable (Const (TYPE Lifted) m) | |
| Generic1 (Const (TYPE Lifted) a) | |
| Show a => Show1 (Const (TYPE Lifted) a) | |
| Read a => Read1 (Const (TYPE Lifted) a) | |
| Ord a => Ord1 (Const (TYPE Lifted) a) | |
| Eq a => Eq1 (Const (TYPE Lifted) a) | |
| Bounded a => Bounded (Const k a b) | |
| Enum a => Enum (Const k a b) | |
| Eq a => Eq (Const k a b) | |
| Ord a => Ord (Const k a b) | |
| Read a => Read (Const k a b) | This instance would be equivalent to the derived instances of the
|
| Show a => Show (Const k a b) | This instance would be equivalent to the derived instances of the
|
| Ix a => Ix (Const k a b) | |
| Generic (Const k a b) | |
| Semigroup a => Semigroup (Const k a b) | |
| Monoid a => Monoid (Const k a b) | |
| Storable a => Storable (Const k a b) | |
| type Rep1 (Const k a) = D1 (MetaData "Const" "Data.Functor.Const" "base" True) (C1 (MetaCons "Const" PrefixI True) (S1 (MetaSel (Just Symbol "getConst") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 a))) | |
| type Rep (Const k a b) = D1 (MetaData "Const" "Data.Functor.Const" "base" True) (C1 (MetaCons "Const" PrefixI True) (S1 (MetaSel (Just Symbol "getConst") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 a))) | |
newtype WrappedMonad m a Source
Constructors
| WrapMonad | |
Fields
| |
Instances
| Monad m => Monad (WrappedMonad m) | |
| Monad m => Functor (WrappedMonad m) | |
| Monad m => Applicative (WrappedMonad m) | |
| Generic1 (WrappedMonad m) | |
| MonadPlus m => Alternative (WrappedMonad m) | |
| Generic (WrappedMonad m a) | |
| type Rep1 (WrappedMonad m) = D1 (MetaData "WrappedMonad" "Control.Applicative" "base" True) (C1 (MetaCons "WrapMonad" PrefixI True) (S1 (MetaSel (Just Symbol "unwrapMonad") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec1 m))) | |
| type Rep (WrappedMonad m a) = D1 (MetaData "WrappedMonad" "Control.Applicative" "base" True) (C1 (MetaCons "WrapMonad" PrefixI True) (S1 (MetaSel (Just Symbol "unwrapMonad") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (m a)))) | |
newtype WrappedArrow a b c Source
Constructors
| WrapArrow | |
Fields
| |
Instances
| Arrow a => Functor (WrappedArrow a b) | |
| Arrow a => Applicative (WrappedArrow a b) | |
| Generic1 (WrappedArrow a b) | |
| (ArrowZero a, ArrowPlus a) => Alternative (WrappedArrow a b) | |
| Generic (WrappedArrow a b c) | |
| type Rep1 (WrappedArrow a b) = D1 (MetaData "WrappedArrow" "Control.Applicative" "base" True) (C1 (MetaCons "WrapArrow" PrefixI True) (S1 (MetaSel (Just Symbol "unwrapArrow") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec1 (a b)))) | |
| type Rep (WrappedArrow a b c) = D1 (MetaData "WrappedArrow" "Control.Applicative" "base" True) (C1 (MetaCons "WrapArrow" PrefixI True) (S1 (MetaSel (Just Symbol "unwrapArrow") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (a b c)))) | |
Lists, but with an Applicative functor based on zipping, so that
f<$>ZipListxs1<*>...<*>ZipListxsn =ZipList(zipWithn f xs1 ... xsn)
Constructors
| ZipList | |
Fields
| |
Instances
| Functor ZipList | |
| Applicative ZipList | |
| Foldable ZipList | |
| Traversable ZipList | |
| Generic1 ZipList | |
| Eq a => Eq (ZipList a) | |
| Ord a => Ord (ZipList a) | |
| Read a => Read (ZipList a) | |
| Show a => Show (ZipList a) | |
| Generic (ZipList a) | |
| type Rep1 ZipList = D1 (MetaData "ZipList" "Control.Applicative" "base" True) (C1 (MetaCons "ZipList" PrefixI True) (S1 (MetaSel (Just Symbol "getZipList") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec1 []))) | |
| type Rep (ZipList a) = D1 (MetaData "ZipList" "Control.Applicative" "base" True) (C1 (MetaCons "ZipList" PrefixI True) (S1 (MetaSel (Just Symbol "getZipList") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [a]))) | |
Utility functions
(<$>) :: Functor f => (a -> b) -> f a -> f b infixl 4 Source
An infix synonym for fmap.
Examples
Convert from a to a Maybe Int using Maybe Stringshow:
>>>show <$> NothingNothing>>>show <$> Just 3Just "3"
Convert from an to an Either Int IntEither IntString using show:
>>>show <$> Left 17Left 17>>>show <$> Right 17Right "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
liftA2 :: Applicative f => (a -> b -> c) -> f a -> f b -> f c Source
Lift a binary function to actions.
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.