semigroups 0.8.5 → 0.9
raw patch · 8 files changed
+869/−990 lines, 8 filesdep +natsdep ~base
Dependencies added: nats
Dependency ranges changed: base
Files
- .travis.yml +7/−0
- Data/List/NonEmpty.hs +0/−506
- Data/Semigroup.hs +0/−345
- Numeric/Natural.hs +0/−19
- Numeric/Natural/Internal.hs +0/−114
- semigroups.cabal +6/−6
- src/Data/List/NonEmpty.hs +506/−0
- src/Data/Semigroup.hs +350/−0
.travis.yml view
@@ -1,1 +1,8 @@ language: haskell+notifications:+ irc:+ channels:+ - "irc.freenode.org#haskell-lens"+ skip_join: true+ template:+ - "\x0313semigroups\x03/\x0306%{branch}\x03 \x0314%{commit}\x03 %{build_url} %{message}"
− Data/List/NonEmpty.hs
@@ -1,506 +0,0 @@-{-# LANGUAGE CPP #-}-#ifdef LANGUAGE_DeriveDataTypeable-{-# LANGUAGE DeriveDataTypeable #-}-#endif--------------------------------------------------------------------------------- |--- Module : Data.List.NonEmpty--- Copyright : (C) 2011 Edward Kmett,--- (C) 2010 Tony Morris, Oliver Taylor, Eelis van der Weegen--- License : BSD-style (see the file LICENSE)------ Maintainer : Edward Kmett <ekmett@gmail.com>--- Stability : provisional--- Portability : portable------ A NonEmpty list forms a monad as per list, but always contains at least--- one element.-------------------------------------------------------------------------------module Data.List.NonEmpty (- -- * The type of non-empty streams- NonEmpty(..)- -- * Non-empty stream transformations- , map -- :: (a -> b) -> NonEmpty a -> NonEmpty b- , intersperse -- :: a -> NonEmpty a -> NonEmpty a- , scanl -- :: Foldable f => (b -> a -> b) -> b -> f a -> NonEmpty b- , scanr -- :: Foldable f => (a -> b -> b) -> b -> f a -> NonEmpty b- , scanl1 -- :: (a -> a -> a) -> NonEmpty a -> NonEmpty a- , scanr1 -- :: (a -> a -> a) -> NonEmpty a -> NonEmpty a- --, transpose -- :: NonEmpty (NonEmpty a) -> NonEmpty (NonEmpty a)- -- * Basic functions- , head -- :: NonEmpty a -> a - , tail -- :: NonEmpty a -> [a]- , last -- :: NonEmpty a -> a- , init -- :: NonEmpty a -> [a]- , (<|), cons -- :: a -> NonEmpty a -> NonEmpty a - , uncons -- :: NonEmpty a -> (a, Maybe (NonEmpty a))- , sort -- :: NonEmpty a -> NonEmpty a- , reverse -- :: NonEmpty a -> NonEmpty a- , inits -- :: Foldable f => f a -> NonEmpty a- , tails -- :: Foldable f => f a -> NonEmpty a- -- * Building streams- , iterate -- :: (a -> a) -> a -> NonEmpty a- , repeat -- :: a -> NonEmpty a - , cycle -- :: NonEmpty a -> NonEmpty a- , unfold -- :: (a -> (b, Maybe a) -> a -> NonEmpty b- , insert -- :: (Foldable f, Ord a) => a -> f a -> NonEmpty a- -- * Extracting sublists- , take -- :: Int -> NonEmpty a -> [a]- , drop -- :: Int -> NonEmpty a -> [a]- , splitAt -- :: Int -> NonEmpty a -> ([a], [a])- , takeWhile -- :: Int -> NonEmpty a -> [a]- , dropWhile -- :: Int -> NonEmpty a -> [a]- , span -- :: Int -> NonEmpty a -> ([a],[a])- , break -- :: Int -> NonEmpty a -> ([a],[a])- , filter -- :: (a -> Bool) -> NonEmpty a -> [a]- , partition -- :: (a -> Bool) -> NonEmpty a -> ([a],[a])- , group -- :: Foldable f => Eq a => f a -> [NonEmpty a]- , groupBy -- :: Foldable f => (a -> a -> Bool) -> f a -> [NonEmpty a]- , group1 -- :: Eq a => NonEmpty a -> NonEmpty (NonEmpty a)- , groupBy1 -- :: (a -> a -> Bool) -> NonEmpty a -> NonEmpty (NonEmpty a)- -- * Sublist predicates- , isPrefixOf -- :: Foldable f => f a -> NonEmpty a -> Bool- -- * Indexing streams- , (!!) -- :: NonEmpty a -> Int -> a- -- * Zipping and unzipping streams- , zip -- :: NonEmpty a -> NonEmpty b -> NonEmpty (a,b)- , zipWith -- :: (a -> b -> c) -> NonEmpty a -> NonEmpty b -> NonEmpty c- , unzip -- :: NonEmpty (a, b) -> (NonEmpty a, NonEmpty b)- -- * Functions on streams of characters- , words -- :: NonEmpty Char -> NonEmpty String- , unwords -- :: NonEmpty String -> NonEmpty Char- , lines -- :: NonEmpty Char -> NonEmpty String- , unlines -- :: NonEmpty String -> NonEmpty Char- -- * Converting to and from a list- , fromList -- :: [a] -> NonEmpty a- , toList -- :: NonEmpty a -> [a]- , nonEmpty -- :: [a] -> Maybe (NonEmpty a)- , xor -- :: NonEmpty a -> Bool- ) where---import Prelude hiding- ( head, tail, map, reverse- , scanl, scanl1, scanr, scanr1- , iterate, take, drop, takeWhile- , dropWhile, repeat, cycle, filter- , (!!), zip, unzip, zipWith, words- , unwords, lines, unlines, break, span- , splitAt, foldr, foldl, last, init- )--import Control.Applicative--- import Control.Comonad-import Control.Monad--- import Data.Functor.Alt-import Data.Foldable hiding (toList)-import qualified Data.Foldable as Foldable-import qualified Data.List as List-import Data.Monoid (mappend)-import Data.Traversable--- import Data.Semigroup hiding (Last)--- import Data.Semigroup.Foldable--- import Data.Semigroup.Traversable--#ifdef LANGUAGE_DeriveDataTypeable-import Data.Data-#endif--infixr 5 :|, <|--data NonEmpty a = a :| [a] deriving - ( Eq, Ord, Show, Read-#ifdef LANGUAGE_DeriveDataTypeable- , Data, Typeable-#endif- )--xor :: NonEmpty Bool -> Bool-xor (x :| xs) = foldr xor' x xs- where xor' True y = not y- xor' False y = y---- | 'unfold' produces a new stream by repeatedly applying the unfolding--- function to the seed value to produce an element of type @b@ and a new--- seed value. When the unfolding function returns 'Nothing' instead of--- a new seed value, the stream ends.-unfold :: (a -> (b, Maybe a)) -> a -> NonEmpty b-unfold f a = case f a of- (b, Nothing) -> b :| []- (b, Just c) -> b <| unfold f c---- | 'nonEmpty' efficiently turns a normal list into a 'NonEmpty' stream,--- producing 'Nothing' if the input is empty.-nonEmpty :: [a] -> Maybe (NonEmpty a)-nonEmpty [] = Nothing-nonEmpty (a:as) = Just (a :| as)-{-# INLINE nonEmpty #-}---- | 'uncons' produces the first element of the stream, and a stream of the--- remaining elements, if any.-uncons :: NonEmpty a -> (a, Maybe (NonEmpty a))-uncons ~(a :| as) = (a, nonEmpty as)-{-# INLINE uncons #-}--instance Functor NonEmpty where- fmap f ~(a :| as) = f a :| fmap f as-#if MIN_VERSION_base(4,2,0)- b <$ ~(_ :| as) = b :| (b <$ as)-#endif--{--instance Extend NonEmpty where- extend f w@ ~(_ :| aas) = f w :| case aas of- [] -> []- (a:as) -> toList (extend f (a :| as))--instance Comonad NonEmpty where- extract ~(a :| _) = a- -instance Apply NonEmpty where- (<.>) = ap--instance Alt NonEmpty where- (a :| as) <!> ~(b :| bs) = a :| (as ++ b : bs)--}--instance Applicative NonEmpty where- pure a = a :| []- (<*>) = ap--instance Monad NonEmpty where- return a = a :| []- ~(a :| as) >>= f = b :| (bs ++ bs')- where b :| bs = f a- bs' = as >>= toList . f--instance Traversable NonEmpty where- traverse f ~(a :| as) = (:|) <$> f a <*> traverse f as--{--instance Traversable1 NonEmpty where- traverse1 f (a :| []) = (:|[]) <$> f a- traverse1 f (a :| (b: bs)) = (\a' (b':| bs') -> a' :| b': bs') <$> f a <.> traverse1 f (b :| bs)--}--instance Foldable NonEmpty where- foldr f z ~(a :| as) = f a (foldr f z as)- foldl f z ~(a :| as) = foldl f (f z a) as - foldl1 f ~(a :| as) = foldl f a as- foldMap f ~(a :| as) = f a `mappend` foldMap f as- fold ~(m :| ms) = m `mappend` fold ms--{--instance Foldable1 NonEmpty where- foldMap1 f (a :| []) = f a- foldMap1 f (a :| b : bs) = f a <> foldMap1 f (b :| bs)--instance Semigroup (NonEmpty a) where- (<>) = (<!>)--}---- | Extract the first element of the stream.-head :: NonEmpty a -> a-head ~(a :| _) = a-{-# INLINE head #-}---- | Extract the possibly-empty tail of the stream.-tail :: NonEmpty a -> [a]-tail ~(_ :| as) = as-{-# INLINE tail #-}---- | Extract the last element of the stream.-last :: NonEmpty a -> a-last ~(a :| as) = List.last (a : as)-{-# INLINE last #-}---- | Extract everything except the last element of the stream.-init :: NonEmpty a -> [a]-init ~(a :| as) = List.init (a : as)-{-# INLINE init #-}---- | Prepend an element to the stream.-(<|) :: a -> NonEmpty a -> NonEmpty a -a <| ~(b :| bs) = a :| b : bs-{-# INLINE (<|) #-}---- | Synonym for '<|'.-cons :: a -> NonEmpty a -> NonEmpty a-cons = (<|)-{-# INLINE cons #-}---- | Sort a stream.-sort :: Ord a => NonEmpty a -> NonEmpty a -sort = lift List.sort-{-# INLINE sort #-}---- | Converts a normal list to a 'NonEmpty' stream.------ Raises an error if given an empty list.-fromList :: [a] -> NonEmpty a -fromList (a:as) = a :| as-fromList [] = error "NonEmpty.fromList: empty list"-{-# INLINE fromList #-}---- | Convert a stream to a normal list efficiently.-toList :: NonEmpty a -> [a]-toList ~(a :| as) = a : as-{-# INLINE toList #-}---- | Lift list operations to work on a 'NonEmpty' stream.------ /Beware/: If the provided function returns an empty list,--- this will raise an error.-lift :: Foldable f => ([a] -> [b]) -> f a -> NonEmpty b-lift f = fromList . f . Foldable.toList -{-# INLINE lift #-}---- | Map a function over a 'NonEmpty' stream.-map :: (a -> b) -> NonEmpty a -> NonEmpty b-map f ~(a :| as) = f a :| fmap f as -{-# INLINE map #-}---- | The 'inits' function takes a stream @xs@ and returns all the--- finite prefixes of @xs@.-inits :: Foldable f => f a -> NonEmpty [a]-inits = fromList . List.inits . Foldable.toList-{-# INLINE inits #-}---- | The 'tails' function takes a stream @xs@ and returns all the--- suffixes of @xs@.-tails :: Foldable f => f a -> NonEmpty [a]-tails = fromList . List.tails . Foldable.toList-{-# INLINE tails #-}---- | @'insert' x xs@ inserts @x@ into the last position in @xs@ where it--- is still less than or equal to the next element. In particular, if the--- list is sorted beforehand, the result will also be sorted.-insert :: (Foldable f, Ord a) => a -> f a -> NonEmpty a-insert a = fromList . List.insert a . Foldable.toList-{-# INLINE insert #-}---- | 'scanl' is similar to 'foldl', but returns a stream of successive--- reduced values from the left:------ > scanl f z [x1, x2, ...] == z :| [z `f` x1, (z `f` x1) `f` x2, ...]------ Note that------ > last (scanl f z xs) == foldl f z xs.-scanl :: Foldable f => (b -> a -> b) -> b -> f a -> NonEmpty b-scanl f z = fromList . List.scanl f z . Foldable.toList-{-# INLINE scanl #-}---- | 'scanr' is the right-to-left dual of 'scanl'.--- Note that------ > head (scanr f z xs) == foldr f z xs.-scanr :: Foldable f => (a -> b -> b) -> b -> f a -> NonEmpty b-scanr f z = fromList . List.scanr f z . Foldable.toList-{-# INLINE scanr #-}---- | 'scanl1' is a variant of 'scanl' that has no starting value argument:------ > scanl1 f [x1, x2, ...] == x1 :| [x1 `f` x2, x1 `f` (x2 `f` x3), ...]-scanl1 :: (a -> a -> a) -> NonEmpty a -> NonEmpty a-scanl1 f ~(a :| as) = fromList (List.scanl f a as)-{-# INLINE scanl1 #-}---- | 'scanr1' is a variant of 'scanr' that has no starting value argument.-scanr1 :: (a -> a -> a) -> NonEmpty a -> NonEmpty a-scanr1 f ~(a :| as) = fromList (List.scanr1 f (a:as))-{-# INLINE scanr1 #-}---- | 'intersperse x xs' alternates elements of the list with copies of @x@.------ > intersperse 0 (1 :| [2,3]) == 1 :| [0,2,0,3]-intersperse :: a -> NonEmpty a -> NonEmpty a-intersperse a ~(b :| bs) = b :| case bs of - [] -> []- _ -> a : List.intersperse a bs-{-# INLINE intersperse #-}---- | @'iterate' f x@ produces the infinite sequence--- of repeated applications of @f@ to @x@.------ > iterate f x = x :| [f x, f (f x), ..]-iterate :: (a -> a) -> a -> NonEmpty a-iterate f a = a :| List.iterate f (f a)-{-# INLINE iterate #-}---- | @'cycle' xs@ returns the infinite repetition of @xs@:------ > cycle [1,2,3] = 1 :| [2,3,1,2,3,...]-cycle :: NonEmpty a -> NonEmpty a -cycle = fromList . List.cycle . toList -{-# INLINE cycle #-}---- | 'reverse' a finite NonEmpty stream.-reverse :: NonEmpty a -> NonEmpty a-reverse = lift List.reverse-{-# INLINE reverse #-}---- | @'repeat' x@ returns a constant stream, where all elements are--- equal to @x@.-repeat :: a -> NonEmpty a-repeat a = a :| List.repeat a-{-# INLINE repeat #-}---- | @'take' n xs@ returns the first @n@ elements of @xs@.-take :: Int -> NonEmpty a -> [a]-take n = List.take n . toList -{-# INLINE take #-}---- | @'drop' n xs@ drops the first @n@ elements off the front of--- the sequence @xs@.-drop :: Int -> NonEmpty a -> [a]-drop n = List.drop n . toList-{-# INLINE drop #-}---- | @'splitAt' n xs@ returns a pair consisting of the prefix of @xs@ --- of length @n@ and the remaining stream immediately following this prefix.------ > 'splitAt' n xs == ('take' n xs, 'drop' n xs)--- > xs == ys ++ zs where (ys, zs) = 'splitAt' n xs-splitAt :: Int -> NonEmpty a -> ([a],[a])-splitAt n = List.splitAt n . toList-{-# INLINE splitAt #-}---- | @'takeWhile' p xs@ returns the longest prefix of the stream--- @xs@ for which the predicate @p@ holds.-takeWhile :: (a -> Bool) -> NonEmpty a -> [a]-takeWhile p = List.takeWhile p . toList-{-# INLINE takeWhile #-}---- | @'dropWhile' p xs@ returns the suffix remaining after--- @'takeWhile' p xs@.-dropWhile :: (a -> Bool) -> NonEmpty a -> [a]-dropWhile p = List.dropWhile p . toList-{-# INLINE dropWhile #-}---- | @'span' p xs@ returns the longest prefix of @xs@ that satisfies--- @p@, together with the remainder of the stream.------ > 'span' p xs == ('takeWhile' p xs, 'dropWhile' p xs)--- > xs == ys ++ zs where (ys, zs) = 'span' p xs-span :: (a -> Bool) -> NonEmpty a -> ([a], [a])-span p = List.span p . toList-{-# INLINE span #-}---- | The @'break' p@ function is equivalent to @'span' (not . p)@.-break :: (a -> Bool) -> NonEmpty a -> ([a], [a])-break p = span (not . p)-{-# INLINE break #-}---- | @'filter' p xs@ removes any elements from @xs@ that do not satisfy @p@.-filter :: (a -> Bool) -> NonEmpty a -> [a]-filter p = List.filter p . toList-{-# INLINE filter #-}---- | The 'partition' function takes a predicate @p@ and a stream--- @xs@, and returns a pair of lists. The first list corresponds to the--- elements of @xs@ for which @p@ holds; the second corresponds to the--- elements of @xs@ for which @p@ does not hold.------ > 'partition' p xs = ('filter' p xs, 'filter' (not . p) xs)-partition :: (a -> Bool) -> NonEmpty a -> ([a], [a])-partition p = List.partition p . toList-{-# INLINE partition #-}---- | The 'group' function takes a stream and returns a list of--- streams such that flattening the resulting list is equal to the--- argument. Moreover, each stream in the resulting list--- contains only equal elements. For example, in list notation:------ > 'group' $ 'cycle' "Mississippi" = "M" : "i" : "ss" : "i" : "ss" : "i" : "pp" : "i" : "M" : "i" : ...-group :: (Foldable f, Eq a) => f a -> [NonEmpty a]-group = groupBy (==)-{-# INLINE group #-}---- | 'groupBy' operates like 'group', but uses the provided equality--- predicate instead of `==`.-groupBy :: Foldable f => (a -> a -> Bool) -> f a -> [NonEmpty a]-groupBy eq0 = go eq0 . Foldable.toList- where - go _ [] = []- go eq (x : xs) = (x :| ys) : groupBy eq zs- where (ys, zs) = List.span (eq x) xs- --- | 'group1' operates like 'group', but uses the knowledge that its--- input is non-empty to produce guaranteed non-empty output.-group1 :: Eq a => NonEmpty a -> NonEmpty (NonEmpty a)-group1 = groupBy1 (==)-{-# INLINE group1 #-}---- | 'groupBy1' is to 'group1' as 'groupBy' is to 'group'.-groupBy1 :: (a -> a -> Bool) -> NonEmpty a -> NonEmpty (NonEmpty a)-groupBy1 eq (x :| xs) = (x :| ys) :| groupBy eq zs- where (ys, zs) = List.span (eq x) xs-{-# INLINE groupBy1 #-}---- | The 'isPrefix' function returns @True@ if the first argument is--- a prefix of the second.-isPrefixOf :: Eq a => [a] -> NonEmpty a -> Bool-isPrefixOf [] _ = True-isPrefixOf (y:ys) (x :| xs) = (y == x) && List.isPrefixOf ys xs-{-# INLINE isPrefixOf #-}---- | @xs !! n@ returns the element of the stream @xs@ at index--- @n@. Note that the head of the stream has index 0.------ /Beware/: a negative or out-of-bounds index will cause an error.-(!!) :: NonEmpty a -> Int -> a-(!!) ~(x :| xs) n - | n == 0 = x- | n > 0 = xs List.!! (n - 1)- | otherwise = error "NonEmpty.!! negative argument"-{-# INLINE (!!) #-}---- | The 'zip' function takes two streams and returns a stream of--- corresponding pairs.-zip :: NonEmpty a -> NonEmpty b -> NonEmpty (a,b)-zip ~(x :| xs) ~(y :| ys) = (x, y) :| List.zip xs ys-{-# INLINE zip #-}---- | The 'zipWith' function generalizes 'zip'. Rather than tupling--- the elements, the elements are combined using the function--- passed as the first argument.-zipWith :: (a -> b -> c) -> NonEmpty a -> NonEmpty b -> NonEmpty c-zipWith f ~(x :| xs) ~(y :| ys) = f x y :| List.zipWith f xs ys-{-# INLINE zipWith #-}---- | The 'unzip' function is the inverse of the 'zip' function.-unzip :: Functor f => f (a,b) -> (f a, f b)-unzip xs = (fst <$> xs, snd <$> xs)-{-# INLINE unzip #-}---- | The 'words' function breaks a stream of characters into a--- stream of words, which were delimited by white space.------ /Beware/: if the input contains no words (i.e. is entirely--- whitespace), this will cause an error.-words :: NonEmpty Char -> NonEmpty String-words = lift List.words-{-# INLINE words #-}---- | The 'unwords' function is an inverse operation to 'words'. It--- joins words with separating spaces.------ /Beware/: the input @(\"\" :| [])@ will cause an error.-unwords :: NonEmpty String -> NonEmpty Char-unwords = lift List.unwords-{-# INLINE unwords #-}---- | The 'lines' function breaks a stream of characters into a stream--- of strings at newline characters. The resulting strings do not--- contain newlines.-lines :: NonEmpty Char -> NonEmpty String-lines = lift List.lines-{-# INLINE lines #-}---- | The 'unlines' function is an inverse operation to 'lines'. It--- joins lines, after appending a terminating newline to each.-unlines :: NonEmpty String -> NonEmpty Char-unlines = lift List.unlines-{-# INLINE unlines #-}
− Data/Semigroup.hs
@@ -1,345 +0,0 @@-{-# LANGUAGE CPP #-}-#ifdef LANGUAGE_DeriveDataTypeable-{-# LANGUAGE DeriveDataTypeable #-}-#endif--------------------------------------------------------------------------------- |--- Module : Data.Semigroup--- Copyright : (C) 2011 Edward Kmett,--- License : BSD-style (see the file LICENSE)------ Maintainer : Edward Kmett <ekmett@gmail.com>--- Stability : provisional--- Portability : portable------ In mathematics, a semigroup is an algebraic structure consisting of a--- set together with an associative binary operation. A semigroup--- generalizes a monoid in that there might not exist an identity--- element. It also (originally) generalized a group (a monoid with all--- inverses) to a type where every element did not have to have an inverse,--- thus the name semigroup.------ The use of @(\<\>)@ in this module conflicts with an operator with the same--- name that is being exported by Data.Monoid. However, this package--- re-exports (most of) the contents of Data.Monoid, so to use semigroups--- and monoids in the same package just------ > import Data.Semigroup---------------------------------------------------------------------------------module Data.Semigroup (- Semigroup(..)- -- * Semigroups- , Min(..)- , Max(..)- , First(..)- , Last(..)- , WrappedMonoid(..)- -- * Re-exported monoids from Data.Monoid- , Monoid(..)- , Dual(..)- , Endo(..)- , All(..)- , Any(..)- , Sum(..)- , Product(..)- -- * A better monoid for Maybe- , Option(..)- , option- -- * Difference lists of a semigroup- , diff- , cycle1- ) where--import Prelude hiding (foldr1)-import Data.Monoid (Monoid(..),Dual(..),Endo(..),All(..),Any(..),Sum(..),Product(..),Endo(..))-import Control.Applicative-import Control.Monad-import Control.Monad.Fix-import qualified Data.Monoid as Monoid-import Data.Foldable-import Data.Traversable-import Data.List.NonEmpty--import Numeric.Natural.Internal-import Data.Sequence (Seq, (><))-import Data.Set (Set)-import Data.IntSet (IntSet)-import Data.Map (Map)-import Data.IntMap (IntMap)--#ifdef LANGUAGE_DeriveDataTypeable-import Data.Data-#endif--infixr 6 <>--class Semigroup a where- -- | An associative operation.- --- -- > (a <> b) <> c = a <> (b <> c)- (<>) :: a -> a -> a-- -- | Reduce a non-empty list with @\<\>@- --- -- The default definition should be sufficient, but this can be overridden for efficiency.- --- sconcat :: NonEmpty a -> a- sconcat (a :| as) = go a as where- go b (c:cs) = b <> go c cs- go b [] = b-- -- | Repeat a value (n + 1) times.- --- -- > times1p n a = a <> a <> ... <> a -- using <> n times- --- -- The default definition uses peasant multiplication, exploiting associativity to only- -- require /O(log n)/ uses of @\<\>@.-- times1p :: Whole n => n -> a -> a- times1p y0 x0 = f x0 (1 Prelude.+ y0)- where- f x y- | even y = f (x <> x) (y `quot` 2)- | y == 1 = x- | otherwise = g (x <> x) (unsafePred y `quot` 2) x- g x y z- | even y = g (x <> x) (y `quot` 2) z- | y == 1 = x <> z- | otherwise = g (x <> x) (unsafePred y `quot` 2) (x <> z)- {-# INLINE times1p #-}---- | A generalization of 'Data.List.cycle' to an arbitrary 'Semigroup'.--- May fail to terminate for some values in some semigroups.-cycle1 :: Semigroup m => m -> m-cycle1 xs = xs' where xs' = xs <> xs'--instance Semigroup () where- _ <> _ = ()- sconcat _ = ()- times1p _ _ = ()--instance Semigroup b => Semigroup (a -> b) where- f <> g = \a -> f a <> g a- times1p n f e = times1p n (f e)--instance Semigroup [a] where- (<>) = (++)- times1p n x = rep n where- rep 0 = x- rep i = x ++ rep (i - 1)--instance Semigroup a => Semigroup (Maybe a) where- Nothing <> b = b- a <> Nothing = a- Just a <> Just b = Just (a <> b)--instance Semigroup (Either a b) where- Left _ <> b = b- a <> _ = a--instance (Semigroup a, Semigroup b) => Semigroup (a, b) where- (a,b) <> (a',b') = (a<>a',b<>b')- times1p n (a,b) = (times1p n a, times1p n b)--instance (Semigroup a, Semigroup b, Semigroup c) => Semigroup (a, b, c) where- (a,b,c) <> (a',b',c') = (a<>a',b<>b',c<>c')- times1p n (a,b,c) = (times1p n a, times1p n b, times1p n c)--instance (Semigroup a, Semigroup b, Semigroup c, Semigroup d) => Semigroup (a, b, c, d) where- (a,b,c,d) <> (a',b',c',d') = (a<>a',b<>b',c<>c',d<>d')- times1p n (a,b,c,d) = (times1p n a, times1p n b, times1p n c, times1p n d)--instance (Semigroup a, Semigroup b, Semigroup c, Semigroup d, Semigroup e) => Semigroup (a, b, c, d, e) where- (a,b,c,d,e) <> (a',b',c',d',e') = (a<>a',b<>b',c<>c',d<>d',e<>e')- times1p n (a,b,c,d,e) = (times1p n a, times1p n b, times1p n c, times1p n d, times1p n e)--instance Semigroup a => Semigroup (Dual a) where- Dual a <> Dual b = Dual (b <> a)- times1p n (Dual a) = Dual (times1p n a)--instance Semigroup (Endo a) where- Endo f <> Endo g = Endo (f . g)--instance Semigroup All where- All a <> All b = All (a && b)- times1p _ a = a--instance Semigroup Any where- Any a <> Any b = Any (a || b)- times1p _ a = a--instance Num a => Semigroup (Sum a) where- Sum a <> Sum b = Sum (a + b)--instance Num a => Semigroup (Product a) where- Product a <> Product b = Product (a * b)--#if MIN_VERSION_base(3,0,0)-instance Semigroup (Monoid.First a) where- Monoid.First Nothing <> b = b- a <> _ = a- times1p _ a = a--instance Semigroup (Monoid.Last a) where- a <> Monoid.Last Nothing = a- _ <> b = b- times1p _ a = a-#endif--instance Semigroup (NonEmpty a) where- (a :| as) <> ~(b :| bs) = a :| (as ++ b : bs)--newtype Min a = Min { getMin :: a } deriving- ( Eq, Ord, Bounded, Show, Read-#ifdef LANGUAGE_DeriveDataTypeable- , Data, Typeable-#endif- )--instance Ord a => Semigroup (Min a) where- Min a <> Min b = Min (a `min` b)- times1p _ a = a--instance (Ord a, Bounded a) => Monoid (Min a) where- mempty = maxBound- mappend = (<>)--newtype Max a = Max { getMax :: a } deriving- ( Eq, Ord, Bounded, Show, Read-#ifdef LANGUAGE_DeriveDataTypeable- , Data, Typeable-#endif- )--instance Ord a => Semigroup (Max a) where- Max a <> Max b = Max (a `max` b)- times1p _ a = a--instance (Ord a, Bounded a) => Monoid (Max a) where- mempty = minBound- mappend = (<>)---- | Use @'Option' ('First' a)@ -- to get the behavior of 'Data.Monoid.First'-newtype First a = First { getFirst :: a } deriving- ( Eq, Ord, Bounded, Show, Read-#ifdef LANGUAGE_DeriveDataTypeable- , Data- , Typeable-#endif- )--instance Semigroup (First a) where- a <> _ = a- times1p _ a = a---- | Use @'Option' ('Last' a)@ -- to get the behavior of 'Data.Monoid.Last'-newtype Last a = Last { getLast :: a } deriving- ( Eq, Ord, Bounded, Show, Read-#ifdef LANGUAGE_DeriveDataTypeable- , Data, Typeable-#endif- )--instance Semigroup (Last a) where- _ <> b = b- times1p _ a = a---- (==)/XNOR on Bool forms a 'Semigroup', but has no good name----- | Provide a Semigroup for an arbitrary Monoid.-newtype WrappedMonoid m = WrapMonoid- { unwrapMonoid :: m } deriving- ( Eq, Ord, Bounded, Show, Read-#ifdef LANGUAGE_DeriveDataTypeable- , Data, Typeable-#endif- )--instance Monoid m => Semigroup (WrappedMonoid m) where- WrapMonoid a <> WrapMonoid b = WrapMonoid (a `mappend` b)--instance Monoid m => Monoid (WrappedMonoid m) where- mempty = WrapMonoid mempty- WrapMonoid a `mappend` WrapMonoid b = WrapMonoid (a `mappend` b)----- | Option is effectively 'Maybe' with a better instance of 'Monoid', built off of an underlying 'Semigroup'--- instead of an underlying 'Monoid'. Ideally, this type would not exist at all and we would just fix the 'Monoid' intance of 'Maybe'-newtype Option a = Option- { getOption :: Maybe a } deriving- ( Eq, Ord, Show, Read-#ifdef LANGUAGE_DeriveDataTypeable- , Data, Typeable-#endif- )--instance Functor Option where- fmap f (Option a) = Option (fmap f a)--instance Applicative Option where- pure a = Option (Just a)- Option a <*> Option b = Option (a <*> b)--instance Monad Option where- return = pure-- Option (Just a) >>= k = k a- _ >>= _ = Option Nothing-- Option Nothing >> _ = Option Nothing- _ >> b = b--instance Alternative Option where- empty = Option Nothing- Option Nothing <|> b = b- a <|> _ = a--instance MonadPlus Option where- mzero = empty- mplus = (<|>)--instance MonadFix Option where- mfix f = Option (mfix (getOption . f))--instance Foldable Option where- foldMap f (Option (Just m)) = f m- foldMap _ (Option Nothing) = mempty--instance Traversable Option where- traverse f (Option (Just a)) = Option . Just <$> f a- traverse _ (Option Nothing) = pure (Option Nothing)--option :: b -> (a -> b) -> Option a -> b-option n j (Option m) = maybe n j m--instance Semigroup a => Semigroup (Option a) where- Option a <> Option b = Option (a <> b)--instance Semigroup a => Monoid (Option a) where- mempty = empty- Option a `mappend` Option b = Option (a <> b)---- | This lets you use a difference list of a Semigroup as a Monoid.-diff :: Semigroup m => m -> Endo m-diff = Endo . (<>)--instance Semigroup (Seq a) where- (<>) = (><)--instance Semigroup IntSet where- (<>) = mappend- times1p _ a = a--instance Ord a => Semigroup (Set a) where- (<>) = mappend- times1p _ a = a--instance Semigroup (IntMap v) where- (<>) = mappend- times1p _ a = a--instance Ord k => Semigroup (Map k v) where- (<>) = mappend- times1p _ a = a
− Numeric/Natural.hs
@@ -1,19 +0,0 @@--------------------------------------------------------------------------------- |--- Module : Numeric.Natural--- Copyright : (C) 2011 Edward Kmett,--- License : BSD-style (see the file LICENSE)------ Maintainer : Edward Kmett <ekmett@gmail.com>--- Stability : provisional--- Portability : portable------ Natural numbers.---------------------------------------------------------------------------------module Numeric.Natural - ( Natural- , Whole(toNatural)- ) where--import Numeric.Natural.Internal
− Numeric/Natural/Internal.hs
@@ -1,114 +0,0 @@-{-# LANGUAGE CPP #-}--------------------------------------------------------------------------------- |--- Module : Numeric.Natural.Internal--- Copyright : (C) 2011 Edward Kmett,--- License : BSD-style (see the file LICENSE)------ Maintainer : Edward Kmett <ekmett@gmail.com>--- Stability : provisional--- Portability : portable------ This module exposes the potentially unsafe operations that are sometimes--- needed for efficiency: The Natural data constructor and unsafePred.---------------------------------------------------------------------------------module Numeric.Natural.Internal- ( Natural(..)- , Whole(..)- ) where--import Data.Word-import Data.Bits-import Data.Ix--newtype Natural = Natural { runNatural :: Integer } deriving (Eq,Ord,Ix)--instance Show Natural where- showsPrec d (Natural n) = showsPrec d n--instance Read Natural where- readsPrec d = map (\(n, s) -> (Natural n, s)) . readsPrec d--instance Num Natural where- Natural n + Natural m = Natural (n + m)- Natural n * Natural m = Natural (n * m)- Natural n - Natural m | result < 0 = error "Natural.(-): negative result"- | otherwise = Natural result- where result = n - m- abs (Natural n) = Natural n- signum (Natural n) = Natural (signum n)- fromInteger n - | n >= 0 = Natural n- | otherwise = error "Natural.fromInteger: negative"--instance Bits Natural where- Natural n .&. Natural m = Natural (n .&. m)- Natural n .|. Natural m = Natural (n .|. m)- xor (Natural n) (Natural m) = Natural (xor n m)- complement _ = error "Bits.complement: Natural complement undefined"- shift (Natural n) = Natural . shift n- rotate (Natural n) = Natural . rotate n- bit = Natural . bit- setBit (Natural n) = Natural . setBit n- clearBit (Natural n) = Natural . clearBit n- complementBit (Natural n) = Natural . complementBit n- testBit = testBit . runNatural - bitSize = bitSize . runNatural- isSigned _ = False- shiftL (Natural n) = Natural . shiftL n- shiftR (Natural n) = Natural . shiftR n- rotateL (Natural n) = Natural . rotateL n- rotateR (Natural n) = Natural . rotateR n-#if MIN_VERSION_base(4,6,0)- popCount = popCountDefault-#endif--instance Real Natural where- toRational (Natural a) = toRational a--instance Enum Natural where- pred (Natural 0) = error "Natural.pred: 0"- pred (Natural n) = Natural (pred n)- succ (Natural n) = Natural (succ n)- fromEnum (Natural n) = fromEnum n- toEnum n | n < 0 = error "Natural.toEnum: negative"- | otherwise = Natural (toEnum n)--instance Integral Natural where- quot (Natural a) (Natural b) = Natural (quot a b)- rem (Natural a) (Natural b) = Natural (rem a b)- div (Natural a) (Natural b) = Natural (div a b)- mod (Natural a) (Natural b) = Natural (mod a b)- divMod (Natural a) (Natural b) = (Natural q, Natural r) where (q,r) = divMod a b- quotRem (Natural a) (Natural b) = (Natural q, Natural r) where (q,r) = quotRem a b- toInteger = runNatural---- | A refinement of Integral to represent types that do not contain negative numbers.-class Integral n => Whole n where- toNatural :: n -> Natural- unsafePred :: n -> n--instance Whole Word where- toNatural = Natural . toInteger- unsafePred n = n - 1--instance Whole Word8 where- toNatural = Natural . toInteger- unsafePred n = n - 1--instance Whole Word16 where- toNatural = Natural . toInteger- unsafePred n = n - 1--instance Whole Word32 where- toNatural = Natural . toInteger- unsafePred n = n - 1--instance Whole Word64 where- toNatural = Natural . toInteger- unsafePred n = n - 1--instance Whole Natural where- toNatural = id- unsafePred (Natural n) = Natural (n - 1)
semigroups.cabal view
@@ -1,6 +1,6 @@ name: semigroups category: Algebra, Data, Data Structures, Math-version: 0.8.5+version: 0.9 license: BSD3 cabal-version: >= 1.10 license-file: LICENSE@@ -38,13 +38,13 @@ build-depends: base == 2.* else build-depends:- base >= 3 && < 5,- containers >= 0.3 && < 0.6+ base >= 3 && < 5,+ containers >= 0.3 && < 0.6,+ nats >= 0.1 - ghc-options: -Wall+ hs-source-dirs: src+ ghc-options: -Wall exposed-modules: Data.Semigroup Data.List.NonEmpty- Numeric.Natural- Numeric.Natural.Internal
+ src/Data/List/NonEmpty.hs view
@@ -0,0 +1,506 @@+{-# LANGUAGE CPP #-}+#ifdef LANGUAGE_DeriveDataTypeable+{-# LANGUAGE DeriveDataTypeable #-}+#endif+-----------------------------------------------------------------------------+-- |+-- Module : Data.List.NonEmpty+-- Copyright : (C) 2011 Edward Kmett,+-- (C) 2010 Tony Morris, Oliver Taylor, Eelis van der Weegen+-- License : BSD-style (see the file LICENSE)+--+-- Maintainer : Edward Kmett <ekmett@gmail.com>+-- Stability : provisional+-- Portability : portable+--+-- A NonEmpty list forms a monad as per list, but always contains at least+-- one element.+----------------------------------------------------------------------------++module Data.List.NonEmpty (+ -- * The type of non-empty streams+ NonEmpty(..)+ -- * Non-empty stream transformations+ , map -- :: (a -> b) -> NonEmpty a -> NonEmpty b+ , intersperse -- :: a -> NonEmpty a -> NonEmpty a+ , scanl -- :: Foldable f => (b -> a -> b) -> b -> f a -> NonEmpty b+ , scanr -- :: Foldable f => (a -> b -> b) -> b -> f a -> NonEmpty b+ , scanl1 -- :: (a -> a -> a) -> NonEmpty a -> NonEmpty a+ , scanr1 -- :: (a -> a -> a) -> NonEmpty a -> NonEmpty a+ --, transpose -- :: NonEmpty (NonEmpty a) -> NonEmpty (NonEmpty a)+ -- * Basic functions+ , head -- :: NonEmpty a -> a+ , tail -- :: NonEmpty a -> [a]+ , last -- :: NonEmpty a -> a+ , init -- :: NonEmpty a -> [a]+ , (<|), cons -- :: a -> NonEmpty a -> NonEmpty a+ , uncons -- :: NonEmpty a -> (a, Maybe (NonEmpty a))+ , sort -- :: NonEmpty a -> NonEmpty a+ , reverse -- :: NonEmpty a -> NonEmpty a+ , inits -- :: Foldable f => f a -> NonEmpty a+ , tails -- :: Foldable f => f a -> NonEmpty a+ -- * Building streams+ , iterate -- :: (a -> a) -> a -> NonEmpty a+ , repeat -- :: a -> NonEmpty a+ , cycle -- :: NonEmpty a -> NonEmpty a+ , unfold -- :: (a -> (b, Maybe a) -> a -> NonEmpty b+ , insert -- :: (Foldable f, Ord a) => a -> f a -> NonEmpty a+ -- * Extracting sublists+ , take -- :: Int -> NonEmpty a -> [a]+ , drop -- :: Int -> NonEmpty a -> [a]+ , splitAt -- :: Int -> NonEmpty a -> ([a], [a])+ , takeWhile -- :: Int -> NonEmpty a -> [a]+ , dropWhile -- :: Int -> NonEmpty a -> [a]+ , span -- :: Int -> NonEmpty a -> ([a],[a])+ , break -- :: Int -> NonEmpty a -> ([a],[a])+ , filter -- :: (a -> Bool) -> NonEmpty a -> [a]+ , partition -- :: (a -> Bool) -> NonEmpty a -> ([a],[a])+ , group -- :: Foldable f => Eq a => f a -> [NonEmpty a]+ , groupBy -- :: Foldable f => (a -> a -> Bool) -> f a -> [NonEmpty a]+ , group1 -- :: Eq a => NonEmpty a -> NonEmpty (NonEmpty a)+ , groupBy1 -- :: (a -> a -> Bool) -> NonEmpty a -> NonEmpty (NonEmpty a)+ -- * Sublist predicates+ , isPrefixOf -- :: Foldable f => f a -> NonEmpty a -> Bool+ -- * Indexing streams+ , (!!) -- :: NonEmpty a -> Int -> a+ -- * Zipping and unzipping streams+ , zip -- :: NonEmpty a -> NonEmpty b -> NonEmpty (a,b)+ , zipWith -- :: (a -> b -> c) -> NonEmpty a -> NonEmpty b -> NonEmpty c+ , unzip -- :: NonEmpty (a, b) -> (NonEmpty a, NonEmpty b)+ -- * Functions on streams of characters+ , words -- :: NonEmpty Char -> NonEmpty String+ , unwords -- :: NonEmpty String -> NonEmpty Char+ , lines -- :: NonEmpty Char -> NonEmpty String+ , unlines -- :: NonEmpty String -> NonEmpty Char+ -- * Converting to and from a list+ , fromList -- :: [a] -> NonEmpty a+ , toList -- :: NonEmpty a -> [a]+ , nonEmpty -- :: [a] -> Maybe (NonEmpty a)+ , xor -- :: NonEmpty a -> Bool+ ) where+++import Prelude hiding+ ( head, tail, map, reverse+ , scanl, scanl1, scanr, scanr1+ , iterate, take, drop, takeWhile+ , dropWhile, repeat, cycle, filter+ , (!!), zip, unzip, zipWith, words+ , unwords, lines, unlines, break, span+ , splitAt, foldr, foldl, last, init+ )++import Control.Applicative+-- import Control.Comonad+import Control.Monad+-- import Data.Functor.Alt+import Data.Foldable hiding (toList)+import qualified Data.Foldable as Foldable+import qualified Data.List as List+import Data.Monoid (mappend)+import Data.Traversable+-- import Data.Semigroup hiding (Last)+-- import Data.Semigroup.Foldable+-- import Data.Semigroup.Traversable++#ifdef LANGUAGE_DeriveDataTypeable+import Data.Data+#endif++infixr 5 :|, <|++data NonEmpty a = a :| [a] deriving+ ( Eq, Ord, Show, Read+#ifdef LANGUAGE_DeriveDataTypeable+ , Data, Typeable+#endif+ )++xor :: NonEmpty Bool -> Bool+xor (x :| xs) = foldr xor' x xs+ where xor' True y = not y+ xor' False y = y++-- | 'unfold' produces a new stream by repeatedly applying the unfolding+-- function to the seed value to produce an element of type @b@ and a new+-- seed value. When the unfolding function returns 'Nothing' instead of+-- a new seed value, the stream ends.+unfold :: (a -> (b, Maybe a)) -> a -> NonEmpty b+unfold f a = case f a of+ (b, Nothing) -> b :| []+ (b, Just c) -> b <| unfold f c++-- | 'nonEmpty' efficiently turns a normal list into a 'NonEmpty' stream,+-- producing 'Nothing' if the input is empty.+nonEmpty :: [a] -> Maybe (NonEmpty a)+nonEmpty [] = Nothing+nonEmpty (a:as) = Just (a :| as)+{-# INLINE nonEmpty #-}++-- | 'uncons' produces the first element of the stream, and a stream of the+-- remaining elements, if any.+uncons :: NonEmpty a -> (a, Maybe (NonEmpty a))+uncons ~(a :| as) = (a, nonEmpty as)+{-# INLINE uncons #-}++instance Functor NonEmpty where+ fmap f ~(a :| as) = f a :| fmap f as+#if MIN_VERSION_base(4,2,0)+ b <$ ~(_ :| as) = b :| (b <$ as)+#endif++{-+instance Extend NonEmpty where+ extend f w@ ~(_ :| aas) = f w :| case aas of+ [] -> []+ (a:as) -> toList (extend f (a :| as))++instance Comonad NonEmpty where+ extract ~(a :| _) = a++instance Apply NonEmpty where+ (<.>) = ap++instance Alt NonEmpty where+ (a :| as) <!> ~(b :| bs) = a :| (as ++ b : bs)+-}++instance Applicative NonEmpty where+ pure a = a :| []+ (<*>) = ap++instance Monad NonEmpty where+ return a = a :| []+ ~(a :| as) >>= f = b :| (bs ++ bs')+ where b :| bs = f a+ bs' = as >>= toList . f++instance Traversable NonEmpty where+ traverse f ~(a :| as) = (:|) <$> f a <*> traverse f as++{-+instance Traversable1 NonEmpty where+ traverse1 f (a :| []) = (:|[]) <$> f a+ traverse1 f (a :| (b: bs)) = (\a' (b':| bs') -> a' :| b': bs') <$> f a <.> traverse1 f (b :| bs)+-}++instance Foldable NonEmpty where+ foldr f z ~(a :| as) = f a (foldr f z as)+ foldl f z ~(a :| as) = foldl f (f z a) as+ foldl1 f ~(a :| as) = foldl f a as+ foldMap f ~(a :| as) = f a `mappend` foldMap f as+ fold ~(m :| ms) = m `mappend` fold ms++{-+instance Foldable1 NonEmpty where+ foldMap1 f (a :| []) = f a+ foldMap1 f (a :| b : bs) = f a <> foldMap1 f (b :| bs)++instance Semigroup (NonEmpty a) where+ (<>) = (<!>)+-}++-- | Extract the first element of the stream.+head :: NonEmpty a -> a+head ~(a :| _) = a+{-# INLINE head #-}++-- | Extract the possibly-empty tail of the stream.+tail :: NonEmpty a -> [a]+tail ~(_ :| as) = as+{-# INLINE tail #-}++-- | Extract the last element of the stream.+last :: NonEmpty a -> a+last ~(a :| as) = List.last (a : as)+{-# INLINE last #-}++-- | Extract everything except the last element of the stream.+init :: NonEmpty a -> [a]+init ~(a :| as) = List.init (a : as)+{-# INLINE init #-}++-- | Prepend an element to the stream.+(<|) :: a -> NonEmpty a -> NonEmpty a+a <| ~(b :| bs) = a :| b : bs+{-# INLINE (<|) #-}++-- | Synonym for '<|'.+cons :: a -> NonEmpty a -> NonEmpty a+cons = (<|)+{-# INLINE cons #-}++-- | Sort a stream.+sort :: Ord a => NonEmpty a -> NonEmpty a+sort = lift List.sort+{-# INLINE sort #-}++-- | Converts a normal list to a 'NonEmpty' stream.+--+-- Raises an error if given an empty list.+fromList :: [a] -> NonEmpty a+fromList (a:as) = a :| as+fromList [] = error "NonEmpty.fromList: empty list"+{-# INLINE fromList #-}++-- | Convert a stream to a normal list efficiently.+toList :: NonEmpty a -> [a]+toList ~(a :| as) = a : as+{-# INLINE toList #-}++-- | Lift list operations to work on a 'NonEmpty' stream.+--+-- /Beware/: If the provided function returns an empty list,+-- this will raise an error.+lift :: Foldable f => ([a] -> [b]) -> f a -> NonEmpty b+lift f = fromList . f . Foldable.toList+{-# INLINE lift #-}++-- | Map a function over a 'NonEmpty' stream.+map :: (a -> b) -> NonEmpty a -> NonEmpty b+map f ~(a :| as) = f a :| fmap f as+{-# INLINE map #-}++-- | The 'inits' function takes a stream @xs@ and returns all the+-- finite prefixes of @xs@.+inits :: Foldable f => f a -> NonEmpty [a]+inits = fromList . List.inits . Foldable.toList+{-# INLINE inits #-}++-- | The 'tails' function takes a stream @xs@ and returns all the+-- suffixes of @xs@.+tails :: Foldable f => f a -> NonEmpty [a]+tails = fromList . List.tails . Foldable.toList+{-# INLINE tails #-}++-- | @'insert' x xs@ inserts @x@ into the last position in @xs@ where it+-- is still less than or equal to the next element. In particular, if the+-- list is sorted beforehand, the result will also be sorted.+insert :: (Foldable f, Ord a) => a -> f a -> NonEmpty a+insert a = fromList . List.insert a . Foldable.toList+{-# INLINE insert #-}++-- | 'scanl' is similar to 'foldl', but returns a stream of successive+-- reduced values from the left:+--+-- > scanl f z [x1, x2, ...] == z :| [z `f` x1, (z `f` x1) `f` x2, ...]+--+-- Note that+--+-- > last (scanl f z xs) == foldl f z xs.+scanl :: Foldable f => (b -> a -> b) -> b -> f a -> NonEmpty b+scanl f z = fromList . List.scanl f z . Foldable.toList+{-# INLINE scanl #-}++-- | 'scanr' is the right-to-left dual of 'scanl'.+-- Note that+--+-- > head (scanr f z xs) == foldr f z xs.+scanr :: Foldable f => (a -> b -> b) -> b -> f a -> NonEmpty b+scanr f z = fromList . List.scanr f z . Foldable.toList+{-# INLINE scanr #-}++-- | 'scanl1' is a variant of 'scanl' that has no starting value argument:+--+-- > scanl1 f [x1, x2, ...] == x1 :| [x1 `f` x2, x1 `f` (x2 `f` x3), ...]+scanl1 :: (a -> a -> a) -> NonEmpty a -> NonEmpty a+scanl1 f ~(a :| as) = fromList (List.scanl f a as)+{-# INLINE scanl1 #-}++-- | 'scanr1' is a variant of 'scanr' that has no starting value argument.+scanr1 :: (a -> a -> a) -> NonEmpty a -> NonEmpty a+scanr1 f ~(a :| as) = fromList (List.scanr1 f (a:as))+{-# INLINE scanr1 #-}++-- | 'intersperse x xs' alternates elements of the list with copies of @x@.+--+-- > intersperse 0 (1 :| [2,3]) == 1 :| [0,2,0,3]+intersperse :: a -> NonEmpty a -> NonEmpty a+intersperse a ~(b :| bs) = b :| case bs of+ [] -> []+ _ -> a : List.intersperse a bs+{-# INLINE intersperse #-}++-- | @'iterate' f x@ produces the infinite sequence+-- of repeated applications of @f@ to @x@.+--+-- > iterate f x = x :| [f x, f (f x), ..]+iterate :: (a -> a) -> a -> NonEmpty a+iterate f a = a :| List.iterate f (f a)+{-# INLINE iterate #-}++-- | @'cycle' xs@ returns the infinite repetition of @xs@:+--+-- > cycle [1,2,3] = 1 :| [2,3,1,2,3,...]+cycle :: NonEmpty a -> NonEmpty a+cycle = fromList . List.cycle . toList+{-# INLINE cycle #-}++-- | 'reverse' a finite NonEmpty stream.+reverse :: NonEmpty a -> NonEmpty a+reverse = lift List.reverse+{-# INLINE reverse #-}++-- | @'repeat' x@ returns a constant stream, where all elements are+-- equal to @x@.+repeat :: a -> NonEmpty a+repeat a = a :| List.repeat a+{-# INLINE repeat #-}++-- | @'take' n xs@ returns the first @n@ elements of @xs@.+take :: Int -> NonEmpty a -> [a]+take n = List.take n . toList+{-# INLINE take #-}++-- | @'drop' n xs@ drops the first @n@ elements off the front of+-- the sequence @xs@.+drop :: Int -> NonEmpty a -> [a]+drop n = List.drop n . toList+{-# INLINE drop #-}++-- | @'splitAt' n xs@ returns a pair consisting of the prefix of @xs@+-- of length @n@ and the remaining stream immediately following this prefix.+--+-- > 'splitAt' n xs == ('take' n xs, 'drop' n xs)+-- > xs == ys ++ zs where (ys, zs) = 'splitAt' n xs+splitAt :: Int -> NonEmpty a -> ([a],[a])+splitAt n = List.splitAt n . toList+{-# INLINE splitAt #-}++-- | @'takeWhile' p xs@ returns the longest prefix of the stream+-- @xs@ for which the predicate @p@ holds.+takeWhile :: (a -> Bool) -> NonEmpty a -> [a]+takeWhile p = List.takeWhile p . toList+{-# INLINE takeWhile #-}++-- | @'dropWhile' p xs@ returns the suffix remaining after+-- @'takeWhile' p xs@.+dropWhile :: (a -> Bool) -> NonEmpty a -> [a]+dropWhile p = List.dropWhile p . toList+{-# INLINE dropWhile #-}++-- | @'span' p xs@ returns the longest prefix of @xs@ that satisfies+-- @p@, together with the remainder of the stream.+--+-- > 'span' p xs == ('takeWhile' p xs, 'dropWhile' p xs)+-- > xs == ys ++ zs where (ys, zs) = 'span' p xs+span :: (a -> Bool) -> NonEmpty a -> ([a], [a])+span p = List.span p . toList+{-# INLINE span #-}++-- | The @'break' p@ function is equivalent to @'span' (not . p)@.+break :: (a -> Bool) -> NonEmpty a -> ([a], [a])+break p = span (not . p)+{-# INLINE break #-}++-- | @'filter' p xs@ removes any elements from @xs@ that do not satisfy @p@.+filter :: (a -> Bool) -> NonEmpty a -> [a]+filter p = List.filter p . toList+{-# INLINE filter #-}++-- | The 'partition' function takes a predicate @p@ and a stream+-- @xs@, and returns a pair of lists. The first list corresponds to the+-- elements of @xs@ for which @p@ holds; the second corresponds to the+-- elements of @xs@ for which @p@ does not hold.+--+-- > 'partition' p xs = ('filter' p xs, 'filter' (not . p) xs)+partition :: (a -> Bool) -> NonEmpty a -> ([a], [a])+partition p = List.partition p . toList+{-# INLINE partition #-}++-- | The 'group' function takes a stream and returns a list of+-- streams such that flattening the resulting list is equal to the+-- argument. Moreover, each stream in the resulting list+-- contains only equal elements. For example, in list notation:+--+-- > 'group' $ 'cycle' "Mississippi" = "M" : "i" : "ss" : "i" : "ss" : "i" : "pp" : "i" : "M" : "i" : ...+group :: (Foldable f, Eq a) => f a -> [NonEmpty a]+group = groupBy (==)+{-# INLINE group #-}++-- | 'groupBy' operates like 'group', but uses the provided equality+-- predicate instead of `==`.+groupBy :: Foldable f => (a -> a -> Bool) -> f a -> [NonEmpty a]+groupBy eq0 = go eq0 . Foldable.toList+ where+ go _ [] = []+ go eq (x : xs) = (x :| ys) : groupBy eq zs+ where (ys, zs) = List.span (eq x) xs++-- | 'group1' operates like 'group', but uses the knowledge that its+-- input is non-empty to produce guaranteed non-empty output.+group1 :: Eq a => NonEmpty a -> NonEmpty (NonEmpty a)+group1 = groupBy1 (==)+{-# INLINE group1 #-}++-- | 'groupBy1' is to 'group1' as 'groupBy' is to 'group'.+groupBy1 :: (a -> a -> Bool) -> NonEmpty a -> NonEmpty (NonEmpty a)+groupBy1 eq (x :| xs) = (x :| ys) :| groupBy eq zs+ where (ys, zs) = List.span (eq x) xs+{-# INLINE groupBy1 #-}++-- | The 'isPrefix' function returns @True@ if the first argument is+-- a prefix of the second.+isPrefixOf :: Eq a => [a] -> NonEmpty a -> Bool+isPrefixOf [] _ = True+isPrefixOf (y:ys) (x :| xs) = (y == x) && List.isPrefixOf ys xs+{-# INLINE isPrefixOf #-}++-- | @xs !! n@ returns the element of the stream @xs@ at index+-- @n@. Note that the head of the stream has index 0.+--+-- /Beware/: a negative or out-of-bounds index will cause an error.+(!!) :: NonEmpty a -> Int -> a+(!!) ~(x :| xs) n+ | n == 0 = x+ | n > 0 = xs List.!! (n - 1)+ | otherwise = error "NonEmpty.!! negative argument"+{-# INLINE (!!) #-}++-- | The 'zip' function takes two streams and returns a stream of+-- corresponding pairs.+zip :: NonEmpty a -> NonEmpty b -> NonEmpty (a,b)+zip ~(x :| xs) ~(y :| ys) = (x, y) :| List.zip xs ys+{-# INLINE zip #-}++-- | The 'zipWith' function generalizes 'zip'. Rather than tupling+-- the elements, the elements are combined using the function+-- passed as the first argument.+zipWith :: (a -> b -> c) -> NonEmpty a -> NonEmpty b -> NonEmpty c+zipWith f ~(x :| xs) ~(y :| ys) = f x y :| List.zipWith f xs ys+{-# INLINE zipWith #-}++-- | The 'unzip' function is the inverse of the 'zip' function.+unzip :: Functor f => f (a,b) -> (f a, f b)+unzip xs = (fst <$> xs, snd <$> xs)+{-# INLINE unzip #-}++-- | The 'words' function breaks a stream of characters into a+-- stream of words, which were delimited by white space.+--+-- /Beware/: if the input contains no words (i.e. is entirely+-- whitespace), this will cause an error.+words :: NonEmpty Char -> NonEmpty String+words = lift List.words+{-# INLINE words #-}++-- | The 'unwords' function is an inverse operation to 'words'. It+-- joins words with separating spaces.+--+-- /Beware/: the input @(\"\" :| [])@ will cause an error.+unwords :: NonEmpty String -> NonEmpty Char+unwords = lift List.unwords+{-# INLINE unwords #-}++-- | The 'lines' function breaks a stream of characters into a stream+-- of strings at newline characters. The resulting strings do not+-- contain newlines.+lines :: NonEmpty Char -> NonEmpty String+lines = lift List.lines+{-# INLINE lines #-}++-- | The 'unlines' function is an inverse operation to 'lines'. It+-- joins lines, after appending a terminating newline to each.+unlines :: NonEmpty String -> NonEmpty Char+unlines = lift List.unlines+{-# INLINE unlines #-}
+ src/Data/Semigroup.hs view
@@ -0,0 +1,350 @@+{-# LANGUAGE CPP #-}+#ifdef LANGUAGE_DeriveDataTypeable+{-# LANGUAGE DeriveDataTypeable #-}+#endif+-----------------------------------------------------------------------------+-- |+-- Module : Data.Semigroup+-- Copyright : (C) 2011 Edward Kmett,+-- License : BSD-style (see the file LICENSE)+--+-- Maintainer : Edward Kmett <ekmett@gmail.com>+-- Stability : provisional+-- Portability : portable+--+-- In mathematics, a semigroup is an algebraic structure consisting of a+-- set together with an associative binary operation. A semigroup+-- generalizes a monoid in that there might not exist an identity+-- element. It also (originally) generalized a group (a monoid with all+-- inverses) to a type where every element did not have to have an inverse,+-- thus the name semigroup.+--+-- The use of @(\<\>)@ in this module conflicts with an operator with the same+-- name that is being exported by Data.Monoid. However, this package+-- re-exports (most of) the contents of Data.Monoid, so to use semigroups+-- and monoids in the same package just+--+-- > import Data.Semigroup+--+----------------------------------------------------------------------------+module Data.Semigroup (+ Semigroup(..)+ -- * Semigroups+ , Min(..)+ , Max(..)+ , First(..)+ , Last(..)+ , WrappedMonoid(..)+ -- * Re-exported monoids from Data.Monoid+ , Monoid(..)+ , Dual(..)+ , Endo(..)+ , All(..)+ , Any(..)+ , Sum(..)+ , Product(..)+ -- * A better monoid for Maybe+ , Option(..)+ , option+ -- * Difference lists of a semigroup+ , diff+ , cycle1+ ) where++import Prelude hiding (foldr1)+import Data.Monoid (Monoid(..),Dual(..),Endo(..),All(..),Any(..),Sum(..),Product(..),Endo(..))+import Control.Applicative+import Control.Monad+import Control.Monad.Fix+import qualified Data.Monoid as Monoid+import Data.Foldable+import Data.Traversable+import Data.List.NonEmpty++import Numeric.Natural.Internal+import Data.Sequence (Seq, (><))+import Data.Set (Set)+import Data.IntSet (IntSet)+import Data.Map (Map)+import Data.IntMap (IntMap)++#ifdef LANGUAGE_DeriveDataTypeable+import Data.Data+#endif++infixr 6 <>++class Semigroup a where+ -- | An associative operation.+ --+ -- > (a <> b) <> c = a <> (b <> c)+ (<>) :: a -> a -> a++ -- | Reduce a non-empty list with @\<\>@+ --+ -- The default definition should be sufficient, but this can be overridden for efficiency.+ --+ sconcat :: NonEmpty a -> a+ sconcat (a :| as) = go a as where+ go b (c:cs) = b <> go c cs+ go b [] = b++ -- | Repeat a value (n + 1) times.+ --+ -- > times1p n a = a <> a <> ... <> a -- using <> n times+ --+ -- The default definition uses peasant multiplication, exploiting associativity to only+ -- require /O(log n)/ uses of @\<\>@.++ times1p :: Whole n => n -> a -> a+ times1p y0 x0 = f x0 (1 Prelude.+ y0)+ where+ f x y+ | even y = f (x <> x) (y `quot` 2)+ | y == 1 = x+ | otherwise = g (x <> x) (unsafePred y `quot` 2) x+ g x y z+ | even y = g (x <> x) (y `quot` 2) z+ | y == 1 = x <> z+ | otherwise = g (x <> x) (unsafePred y `quot` 2) (x <> z)+ {-# INLINE times1p #-}++-- | A generalization of 'Data.List.cycle' to an arbitrary 'Semigroup'.+-- May fail to terminate for some values in some semigroups.+cycle1 :: Semigroup m => m -> m+cycle1 xs = xs' where xs' = xs <> xs'++instance Semigroup () where+ _ <> _ = ()+ sconcat _ = ()+ times1p _ _ = ()++instance Semigroup b => Semigroup (a -> b) where+ f <> g = \a -> f a <> g a+ times1p n f e = times1p n (f e)++instance Semigroup [a] where+ (<>) = (++)+ times1p n x = rep n where+ rep 0 = x+ rep i = x ++ rep (i - 1)++instance Semigroup a => Semigroup (Maybe a) where+ Nothing <> b = b+ a <> Nothing = a+ Just a <> Just b = Just (a <> b)++instance Semigroup (Either a b) where+ Left _ <> b = b+ a <> _ = a++instance (Semigroup a, Semigroup b) => Semigroup (a, b) where+ (a,b) <> (a',b') = (a<>a',b<>b')+ times1p n (a,b) = (times1p n a, times1p n b)++instance (Semigroup a, Semigroup b, Semigroup c) => Semigroup (a, b, c) where+ (a,b,c) <> (a',b',c') = (a<>a',b<>b',c<>c')+ times1p n (a,b,c) = (times1p n a, times1p n b, times1p n c)++instance (Semigroup a, Semigroup b, Semigroup c, Semigroup d) => Semigroup (a, b, c, d) where+ (a,b,c,d) <> (a',b',c',d') = (a<>a',b<>b',c<>c',d<>d')+ times1p n (a,b,c,d) = (times1p n a, times1p n b, times1p n c, times1p n d)++instance (Semigroup a, Semigroup b, Semigroup c, Semigroup d, Semigroup e) => Semigroup (a, b, c, d, e) where+ (a,b,c,d,e) <> (a',b',c',d',e') = (a<>a',b<>b',c<>c',d<>d',e<>e')+ times1p n (a,b,c,d,e) = (times1p n a, times1p n b, times1p n c, times1p n d, times1p n e)++instance Semigroup Ordering where+ LT <> _ = LT+ EQ <> y = y+ GT <> _ = GT++instance Semigroup a => Semigroup (Dual a) where+ Dual a <> Dual b = Dual (b <> a)+ times1p n (Dual a) = Dual (times1p n a)++instance Semigroup (Endo a) where+ Endo f <> Endo g = Endo (f . g)++instance Semigroup All where+ All a <> All b = All (a && b)+ times1p _ a = a++instance Semigroup Any where+ Any a <> Any b = Any (a || b)+ times1p _ a = a++instance Num a => Semigroup (Sum a) where+ Sum a <> Sum b = Sum (a + b)++instance Num a => Semigroup (Product a) where+ Product a <> Product b = Product (a * b)++#if MIN_VERSION_base(3,0,0)+instance Semigroup (Monoid.First a) where+ Monoid.First Nothing <> b = b+ a <> _ = a+ times1p _ a = a++instance Semigroup (Monoid.Last a) where+ a <> Monoid.Last Nothing = a+ _ <> b = b+ times1p _ a = a+#endif++instance Semigroup (NonEmpty a) where+ (a :| as) <> ~(b :| bs) = a :| (as ++ b : bs)++newtype Min a = Min { getMin :: a } deriving+ ( Eq, Ord, Bounded, Show, Read+#ifdef LANGUAGE_DeriveDataTypeable+ , Data, Typeable+#endif+ )++instance Ord a => Semigroup (Min a) where+ Min a <> Min b = Min (a `min` b)+ times1p _ a = a++instance (Ord a, Bounded a) => Monoid (Min a) where+ mempty = maxBound+ mappend = (<>)++newtype Max a = Max { getMax :: a } deriving+ ( Eq, Ord, Bounded, Show, Read+#ifdef LANGUAGE_DeriveDataTypeable+ , Data, Typeable+#endif+ )++instance Ord a => Semigroup (Max a) where+ Max a <> Max b = Max (a `max` b)+ times1p _ a = a++instance (Ord a, Bounded a) => Monoid (Max a) where+ mempty = minBound+ mappend = (<>)++-- | Use @'Option' ('First' a)@ -- to get the behavior of 'Data.Monoid.First'+newtype First a = First { getFirst :: a } deriving+ ( Eq, Ord, Bounded, Show, Read+#ifdef LANGUAGE_DeriveDataTypeable+ , Data+ , Typeable+#endif+ )++instance Semigroup (First a) where+ a <> _ = a+ times1p _ a = a++-- | Use @'Option' ('Last' a)@ -- to get the behavior of 'Data.Monoid.Last'+newtype Last a = Last { getLast :: a } deriving+ ( Eq, Ord, Bounded, Show, Read+#ifdef LANGUAGE_DeriveDataTypeable+ , Data, Typeable+#endif+ )++instance Semigroup (Last a) where+ _ <> b = b+ times1p _ a = a++-- (==)/XNOR on Bool forms a 'Semigroup', but has no good name+++-- | Provide a Semigroup for an arbitrary Monoid.+newtype WrappedMonoid m = WrapMonoid+ { unwrapMonoid :: m } deriving+ ( Eq, Ord, Bounded, Show, Read+#ifdef LANGUAGE_DeriveDataTypeable+ , Data, Typeable+#endif+ )++instance Monoid m => Semigroup (WrappedMonoid m) where+ WrapMonoid a <> WrapMonoid b = WrapMonoid (a `mappend` b)++instance Monoid m => Monoid (WrappedMonoid m) where+ mempty = WrapMonoid mempty+ WrapMonoid a `mappend` WrapMonoid b = WrapMonoid (a `mappend` b)+++-- | Option is effectively 'Maybe' with a better instance of 'Monoid', built off of an underlying 'Semigroup'+-- instead of an underlying 'Monoid'. Ideally, this type would not exist at all and we would just fix the 'Monoid' intance of 'Maybe'+newtype Option a = Option+ { getOption :: Maybe a } deriving+ ( Eq, Ord, Show, Read+#ifdef LANGUAGE_DeriveDataTypeable+ , Data, Typeable+#endif+ )++instance Functor Option where+ fmap f (Option a) = Option (fmap f a)++instance Applicative Option where+ pure a = Option (Just a)+ Option a <*> Option b = Option (a <*> b)++instance Monad Option where+ return = pure++ Option (Just a) >>= k = k a+ _ >>= _ = Option Nothing++ Option Nothing >> _ = Option Nothing+ _ >> b = b++instance Alternative Option where+ empty = Option Nothing+ Option Nothing <|> b = b+ a <|> _ = a++instance MonadPlus Option where+ mzero = empty+ mplus = (<|>)++instance MonadFix Option where+ mfix f = Option (mfix (getOption . f))++instance Foldable Option where+ foldMap f (Option (Just m)) = f m+ foldMap _ (Option Nothing) = mempty++instance Traversable Option where+ traverse f (Option (Just a)) = Option . Just <$> f a+ traverse _ (Option Nothing) = pure (Option Nothing)++option :: b -> (a -> b) -> Option a -> b+option n j (Option m) = maybe n j m++instance Semigroup a => Semigroup (Option a) where+ Option a <> Option b = Option (a <> b)++instance Semigroup a => Monoid (Option a) where+ mempty = empty+ Option a `mappend` Option b = Option (a <> b)++-- | This lets you use a difference list of a Semigroup as a Monoid.+diff :: Semigroup m => m -> Endo m+diff = Endo . (<>)++instance Semigroup (Seq a) where+ (<>) = (><)++instance Semigroup IntSet where+ (<>) = mappend+ times1p _ a = a++instance Ord a => Semigroup (Set a) where+ (<>) = mappend+ times1p _ a = a++instance Semigroup (IntMap v) where+ (<>) = mappend+ times1p _ a = a++instance Ord k => Semigroup (Map k v) where+ (<>) = mappend+ times1p _ a = a