base-compat-batteries-0.13.1: base-compat with extra batteries

Safe Haskell | Safe-Inferred
Language | Haskell2010

Data.Tuple.Compat

Description

This uses the `OneTuple` compatibility library to backport `Solo` to old versions of GHC. Note that `OneTuple` makes use of pattern synonyms, which cannot be defined on pre-7.8 versions of GHC. As such, it is not feasible to backport the `Solo` data constructor on pre-7.8 versions of GHC, as `OneTuple` defines this as a pattern synonym.

Synopsis

- data Solo a where
  - MkSolo a
  - pattern Solo :: a -> (a)
- getSolo :: (a) -> a
- fst :: (a, b) -> a
- snd :: (a, b) -> b
- curry :: ((a, b) -> c) -> a -> b -> c
- uncurry :: (a -> b -> c) -> (a, b) -> c
- swap :: (a, b) -> (b, a)

# Documentation

data Solo a Source #

`Solo` is the canonical lifted 1-tuple, just like `(,)` is the canonical lifted 2-tuple (pair) and `(,,)` is the canonical lifted 3-tuple (triple).

The most important feature of `Solo` is that it is possible to force its "outside" (usually by pattern matching) without forcing its "inside", because it is defined as a datatype rather than a newtype. One situation where this can be useful is when writing a function to extract a value from a data structure. Suppose you write an implementation of arrays and offer only this function to index into them:

    index :: Array a -> Int -> a

Now imagine that someone wants to extract a value from an array and store it in a lazy-valued finite map/dictionary:

    insert "hello" (arr index 12) m

This can actually lead to a space leak. The value is not actually extracted from the array until that value (now buried in a map) is forced. That means the entire array may be kept live by just that value! Often, the solution is to use a strict map, or to force the value before storing it, but for some purposes that's undesirable.

One common solution is to include an indexing function that can produce its result in an arbitrary `Applicative` context:

    indexA :: Applicative f => Array a -> Int -> f a

When using `indexA` in a pure context, `Solo` serves as a handy `Applicative` functor to hold the result. You could write a non-leaky version of the above example thus:

    case arr indexA 12 of
      Solo a -> insert "hello" a m

While such simple extraction functions are the most common uses for unary tuples, they can also be useful for fine-grained control of strict-spined data structure traversals, and for unifying the implementations of lazy and strict mapping functions.

Constructors

MkSolo a |

Bundled Patterns

pattern Solo :: a -> (a) |

#### Instances

Instances details

Foldable Solo | Since: base-4.15

Instance details

Defined in Data.Foldable

Methods

fold :: Monoid m => Solo m -> m Source #

foldMap :: Monoid m => (a -> m) -> Solo a -> m Source #

foldMap' :: Monoid m => (a -> m) -> Solo a -> m Source #

foldr :: (a -> b -> b) -> b -> Solo a -> b Source #

foldr' :: (a -> b -> b) -> b -> Solo a -> b Source #

foldl :: (b -> a -> b) -> b -> Solo a -> b Source #

foldl' :: (b -> a -> b) -> b -> Solo a -> b Source #

foldr1 :: (a -> a -> a) -> Solo a -> a Source #

foldl1 :: (a -> a -> a) -> Solo a -> a Source #

toList :: Solo a -> [a] Source #

null :: Solo a -> Bool Source #

length :: Solo a -> Int Source #

elem :: Eq a => a -> Solo a -> Bool Source #

maximum :: Ord a => Solo a -> a Source #

minimum :: Ord a => Solo a -> a Source #

sum :: Num a => Solo a -> a Source #

product :: Num a => Solo a -> a Source #

Foldable1 Solo | Since: base-4.18.0.0

Instance details

Defined in Data.Foldable1

Methods

fold1 :: Semigroup m => Solo m -> m Source #

foldMap1 :: Semigroup m => (a -> m) -> Solo a -> m Source #

foldMap1' :: Semigroup m => (a -> m) -> Solo a -> m Source #

toNonEmpty :: Solo a -> NonEmpty a Source #

maximum :: Ord a => Solo a -> a Source #

minimum :: Ord a => Solo a -> a Source #

head :: Solo a -> a Source #

last :: Solo a -> a Source #

foldrMap1 :: (a -> b) -> (a -> b -> b) -> Solo a -> b Source #

foldlMap1' :: (a -> b) -> (b -> a -> b) -> Solo a -> b Source #

foldlMap1 :: (a -> b) -> (b -> a -> b) -> Solo a -> b Source #

foldrMap1' :: (a -> b) -> (a -> b -> b) -> Solo a -> b Source #

Traversable Solo | Since: base-4.15
Instance details Defined in Data.Traversable Methods traverse :: Applicative f => (a -> f b) -> Solo a -> f (Solo b) Source # sequenceA :: Applicative f => Solo (f a) -> f (Solo a) Source # mapM :: Monad m => (a -> m b) -> Solo a -> m (Solo b) Source # sequence :: Monad m => Solo (m a) -> m (Solo a) Source #
Applicative Solo | Since: base-4.15
Instance details Defined in GHC.Base Methods pure :: a -> Solo a Source # (<*>) :: Solo (a -> b) -> Solo a -> Solo b Source # liftA2 :: (a -> b -> c) -> Solo a -> Solo b -> Solo c Source # (*>) :: Solo a -> Solo b -> Solo b Source # (<*) :: Solo a -> Solo b -> Solo a Source #
Functor Solo | Since: base-4.15
Instance details Defined in GHC.Base Methods fmap :: (a -> b) -> Solo a -> Solo b Source # (<$) :: a -> Solo b -> Solo a Source #
Monad Solo | Since: base-4.15
Instance details Defined in GHC.Base Methods (>>=) :: Solo a -> (a -> Solo b) -> Solo b Source # (>>) :: Solo a -> Solo b -> Solo b Source # return :: a -> Solo a Source #
Monoid a => Monoid (a) | Since: base-4.15
Instance details Defined in GHC.Base Methods mempty :: (a) Source # mappend :: (a) -> (a) -> (a) Source # mconcat :: [(a)] -> (a) Source #
Semigroup a => Semigroup (a) | Since: base-4.15
Instance details Defined in GHC.Base Methods (<>) :: (a) -> (a) -> (a) Source # sconcat :: NonEmpty (a) -> (a) Source # stimes :: Integral b => b -> (a) -> (a) Source #
Bounded a => Bounded (a) |
Instance details Defined in GHC.Enum Methods minBound :: (a) Source # maxBound :: (a) Source #
Enum a => Enum (a) |
Instance details Defined in GHC.Enum Methods succ :: (a) -> (a) Source # pred :: (a) -> (a) Source # toEnum :: Int -> (a) Source # fromEnum :: (a) -> Int Source # enumFrom :: (a) -> [(a)] Source # enumFromThen :: (a) -> (a) -> [(a)] Source # enumFromTo :: (a) -> (a) -> [(a)] Source # enumFromThenTo :: (a) -> (a) -> (a) -> [(a)] Source #
Read a => Read (a) | Since: base-4.15
Instance details Defined in GHC.Read Methods readsPrec :: Int -> ReadS (a) Source # readList :: ReadS [(a)] Source # readPrec :: ReadPrec (a) Source # readListPrec :: ReadPrec [(a)] Source #
Show a => Show (a) | Since: base-4.15
Instance details Defined in GHC.Show Methods showsPrec :: Int -> (a) -> ShowS Source # show :: (a) -> String Source # showList :: [(a)] -> ShowS Source #
Eq a => Eq (a) |
Instance details Defined in GHC.Classes Methods (==) :: (a) -> (a) -> Bool Source # (/=) :: (a) -> (a) -> Bool Source #
Ord a => Ord (a) |
Instance details Defined in GHC.Classes Methods compare :: (a) -> (a) -> Ordering Source # (<) :: (a) -> (a) -> Bool Source # (<=) :: (a) -> (a) -> Bool Source # (>) :: (a) -> (a) -> Bool Source # (>=) :: (a) -> (a) -> Bool Source # max :: (a) -> (a) -> (a) Source # min :: (a) -> (a) -> (a) Source #

getSolo :: (a) -> a Source #

fst :: (a, b) -> a Source #

Extract the first component of a pair.

snd :: (a, b) -> b Source #

Extract the second component of a pair.

curry :: ((a, b) -> c) -> a -> b -> c Source #

`curry` converts an uncurried function to a curried function.

#### Examples

Expand

    >>> curry fst 1 2
    1

uncurry :: (a -> b -> c) -> (a, b) -> c Source #

`uncurry` converts a curried function to a function on pairs.

#### Examples

Expand

    >>> uncurry (+) (1,2)
    3

    >>> uncurry ($) (show, 1)
    "1"

    >>> map (uncurry max) [(1,2), (3,4), (6,8)]
    [2,4,8]

swap :: (a, b) -> (b, a) Source #

Swap the components of a pair.