Commit 9b1d9d4

authored

Document Semigroup and Monoid instances (#1050)

Add Haddocks showing the definitions of (<>) and mempty.

1 parent 7c437d5 commit 9b1d9d4Copy full SHA for 9b1d9d4

File tree

+20

-9

lines changed

+20

-9

lines changed

Lines changed: 4 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -440,12 +440,15 @@ infixl 9 !?,\\{-This comment teaches CPP correct behaviour -}`
`440`	`440`	`Types`
`441`	`441`	`--------------------------------------------------------------------}`
`442`	`442`
	`443`	`+-- \| @mempty@ = 'empty'`
`443`	`444`	`instance Monoid (IntMap a) where`
`444`	`445`	`mempty = empty`
`445`	`446`	`mconcat = unions`
`446`	`447`	`mappend = (<>)`
`447`	`448`
`448`		`--- \| @since 0.5.7`
	`449`	`+-- \| @(<>)@ = 'union'`
	`450`	`+--`
	`451`	`+-- @since 0.5.7`
`449`	`452`	`instance Semigroup (IntMap a) where`
`450`	`453`	`(<>) = union`
`451`	`454`	`stimes = stimesIdempotentMonoid`

Lines changed: 4 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -326,12 +326,15 @@ type BitMap = Word`
`326`	`326`	`deriving instance Lift IntSet`
`327`	`327`	`#endif`
`328`	`328`
	`329`	`+-- \| @mempty@ = 'empty'`
`329`	`330`	`instance Monoid IntSet where`
`330`	`331`	`mempty = empty`
`331`	`332`	`mconcat = unions`
`332`	`333`	`mappend = (<>)`
`333`	`334`
`334`		`--- \| @since 0.5.7`
	`335`	`+-- \| @(<>)@ = 'union'`
	`336`	`+--`
	`337`	`+-- @since 0.5.7`
`335`	`338`	`instance Semigroup IntSet where`
`336`	`339`	`(<>) = union`
`337`	`340`	`stimes = stimesIdempotentMonoid`

Lines changed: 4 additions & 5 deletions

Original file line number	Diff line number	Diff line change
`@@ -464,11 +464,6 @@ m1 \\ m2 = difference m1 m2`
`464`	`464`	`Size balanced trees.`
`465`	`465`	`--------------------------------------------------------------------}`
`466`	`466`	`-- \| A Map from keys @k@ to values @a@.`
`467`		`---`
`468`		`--- The 'Semigroup' operation for 'Map' is 'union', which prefers`
`469`		`--- values from the left operand. If @m1@ maps a key @k@ to a value`
`470`		`--- @a1@, and @m2@ maps the same key to a different value @a2@, then`
`471`		`--- their union @m1 <> m2@ maps @k@ to @a1@.`
`472`	`467`
`473`	`468`	`-- See Note: Order of constructors`
`474`	`469`	`data Map k a = Bin {-# UNPACK #-} !Size !k a !(Map k a) !(Map k a)`
`@@ -485,11 +480,15 @@ type role Map nominal representational`
`485`	`480`	`deriving instance (Lift k, Lift a) => Lift (Map k a)`
`486`	`481`	`#endif`
`487`	`482`
	`483`	`+-- \| @mempty@ = 'empty'`
`488`	`484`	`instance (Ord k) => Monoid (Map k v) where`
`489`	`485`	`mempty = empty`
`490`	`486`	`mconcat = unions`
`491`	`487`	`mappend = (<>)`
`492`	`488`
	`489`	`+-- \| @(<>)@ = 'union'`
	`490`	`+--`
	`491`	`+-- @since 0.5.7`
`493`	`492`	`instance (Ord k) => Semigroup (Map k v) where`
`494`	`493`	`(<>) = union`
`495`	`494`	`stimes = stimesIdempotentMonoid`

Lines changed: 4 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -1000,11 +1000,14 @@ instance Read1 Seq where`
`1000`	`1000`	`(xs,t) <- readLst s`
`1001`	`1001`	`pure (fromList xs, t)`
`1002`	`1002`
	`1003`	`+-- \| @mempty@ = 'empty'`
`1003`	`1004`	`instance Monoid (Seq a) where`
`1004`	`1005`	`mempty = empty`
`1005`	`1006`	`mappend = (Semigroup.<>)`
`1006`	`1007`
`1007`		`--- \| @since 0.5.7`
	`1008`	`+-- \| @(<>)@ = '(><)'`
	`1009`	`+--`
	`1010`	`+-- @since 0.5.7`
`1008`	`1011`	`instance Semigroup.Semigroup (Seq a) where`
`1009`	`1012`	`(<>) = (><)`
`1010`	`1013`	`stimes = cycleNTimes . fromIntegral`

Lines changed: 4 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -303,12 +303,15 @@ type role Set nominal`
`303`	`303`	`deriving instance Lift a => Lift (Set a)`
`304`	`304`	`#endif`
`305`	`305`
	`306`	`+-- \| @mempty@ = 'empty'`
`306`	`307`	`instance Ord a => Monoid (Set a) where`
`307`	`308`	`mempty = empty`
`308`	`309`	`mconcat = unions`
`309`	`310`	`mappend = (<>)`
`310`	`311`
`311`		`--- \| @since 0.5.7`
	`312`	`+-- \| @(<>)@ = 'union'`
	`313`	`+--`
	`314`	`+-- @since 0.5.7`
`312`	`315`	`instance Ord a => Semigroup (Set a) where`
`313`	`316`	`(<>) = union`
`314`	`317`	`stimes = stimesIdempotentMonoid`

Comments

(0)