Data.Multiset

This modules provides a strict multiset implementation. To avoid collision with Prelude functions, it is recommended to import this module qualified:

import qualified Data.Multiset as Mset

All complexities below use m for the number of distinct elements and n for the total number of elements.

Documentation

data Multiset v

A strict implementation of a multiset. It is backed by a Map and inherits several of its properties and operation's complexities. In particular, the number of elements in a multiset must not exceed maxBound :: Int.

Instances

Foldable Multiset

Defined in Data.Multiset

Methods

fold :: Monoid m => Multiset m -> m

foldMap :: Monoid m => (a -> m) -> Multiset a -> m

foldr :: (a -> b -> b) -> b -> Multiset a -> b

foldr' :: (a -> b -> b) -> b -> Multiset a -> b

foldl :: (b -> a -> b) -> b -> Multiset a -> b

foldl' :: (b -> a -> b) -> b -> Multiset a -> b

foldr1 :: (a -> a -> a) -> Multiset a -> a

foldl1 :: (a -> a -> a) -> Multiset a -> a

toList :: Multiset a -> [a]

null :: Multiset a -> Bool

length :: Multiset a -> Int

elem :: Eq a => a -> Multiset a -> Bool

maximum :: Ord a => Multiset a -> a

minimum :: Ord a => Multiset a -> a

sum :: Num a => Multiset a -> a

product :: Num a => Multiset a -> a

Ord v => IsList (Multiset v)

Defined in Data.Multiset

Associated Types

type Item (Multiset v) :: Type

Methods

fromList :: [Item (Multiset v)] -> Multiset v

fromListN :: Int -> [Item (Multiset v)] -> Multiset v

toList :: Multiset v -> [Item (Multiset v)]

Eq v => Eq (Multiset v)

Defined in Data.Multiset

Methods

(==) :: Multiset v -> Multiset v -> Bool

(/=) :: Multiset v -> Multiset v -> Bool

(Data v, Ord v) => Data (Multiset v)

Since: 0.2.1.1

Defined in Data.Multiset

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Multiset v -> c (Multiset v)

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c (Multiset v)

toConstr :: Multiset v -> Constr

dataTypeOf :: Multiset v -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c (Multiset v))

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c (Multiset v))

gmapT :: (forall b. Data b => b -> b) -> Multiset v -> Multiset v

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Multiset v -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Multiset v -> r

gmapQ :: (forall d. Data d => d -> u) -> Multiset v -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Multiset v -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Multiset v -> m (Multiset v)

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Multiset v -> m (Multiset v)

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Multiset v -> m (Multiset v)

Ord v => Ord (Multiset v)

Defined in Data.Multiset

Methods

compare :: Multiset v -> Multiset v -> Ordering

(<) :: Multiset v -> Multiset v -> Bool

(<=) :: Multiset v -> Multiset v -> Bool

(>) :: Multiset v -> Multiset v -> Bool

(>=) :: Multiset v -> Multiset v -> Bool

max :: Multiset v -> Multiset v -> Multiset v

min :: Multiset v -> Multiset v -> Multiset v

(Ord v, Read v) => Read (Multiset v)

Defined in Data.Multiset

Methods

readsPrec :: Int -> ReadS (Multiset v)

readList :: ReadS [Multiset v]

readPrec :: ReadPrec (Multiset v)

readListPrec :: ReadPrec [Multiset v]

Show v => Show (Multiset v)

Defined in Data.Multiset

Methods

showsPrec :: Int -> Multiset v -> ShowS

show :: Multiset v -> String

showList :: [Multiset v] -> ShowS

Ord v => Semigroup (Multiset v)

Defined in Data.Multiset

Methods

(<>) :: Multiset v -> Multiset v -> Multiset v

sconcat :: NonEmpty (Multiset v) -> Multiset v

stimes :: Integral b => b -> Multiset v -> Multiset v

Ord v => Monoid (Multiset v)

Defined in Data.Multiset

Methods

mempty :: Multiset v

mappend :: Multiset v -> Multiset v -> Multiset v

mconcat :: [Multiset v] -> Multiset v

Binary v => Binary (Multiset v)

Since: 0.2.1.0

Defined in Data.Multiset

Methods

put :: Multiset v -> Put

get :: Get (Multiset v)

putList :: [Multiset v] -> Put

type Item (Multiset v)

Defined in Data.Multiset

type Item (Multiset v) = v

type Group v = (v, Int)

A group of values of a given size.

Construction

empty :: Multiset v

O(1) Returns an empty multiset.

singleton :: v -> Multiset v

O(1) Returns a multiset with a single element.

replicate :: Int -> v -> Multiset v

O(1) Returns a multiset with the same element repeated. If n is zero or negative, replicate returns an empty multiset.

fromList :: Ord v => [v] -> Multiset v

O(n * log n) Builds a multiset from values.

fromGroupList :: Ord v => [Group v] -> Multiset v

O(m * log m) Builds a multiset from a list of groups. Counts of duplicate groups are added together and elements with negative total count are omitted.

fromCountMap :: Ord v => Map v Int -> Multiset v

O(m * log m) Builds a multiset from a map. Negative counts are ignored.

Tests and accessors

null :: Multiset v -> Bool

O(1) Checks whether a multiset is empty.

size :: Multiset v -> Int

O(1) Returns the total number of elements in the multiset. Note that this isn't the number of distinct elements, see distinctSize for that.

distinctSize :: Multiset v -> Int

O(1) Returns the number of distinct elements in the multiset.

member :: Ord v => v -> Multiset v -> Bool

O(log m) Checks whether the element is present at least once.

notMember :: Ord v => v -> Multiset v -> Bool

O(log m) Checks whether the element is not present.

isSubsetOf :: Ord v => Multiset v -> Multiset v -> Bool

O(m * log m) Checks whether the first subset is a subset of the second (potentially equal to it).

isProperSubsetOf :: Ord v => Multiset v -> Multiset v -> Bool

O(m * log m) Checks whether the first subset is a strict subset of the second.

count :: Ord v => v -> Multiset v -> Int

O(log m) Returns the number of times the element is present in the multiset, or 0 if absent.

(!) :: Ord v => Multiset v -> v -> Int

O(log m) Infix version of count.

Update

insert :: Ord v => v -> Multiset v -> Multiset v

O(log m) Inserts an element.

remove :: Ord v => v -> Multiset v -> Multiset v

O(log m) Removes a single element. Does nothing if the element isn't present.

removeAll :: Ord v => v -> Multiset v -> Multiset v

O(log m) Removes all occurrences of a given element.

modify :: Ord v => (Int -> Int) -> v -> Multiset v -> Multiset v

O(log m) Modifies the count of an element. If the resulting element's count is zero or negative, it will be removed.

Maps and filters

map :: (Ord v1, Ord v2) => (v1 -> v2) -> Multiset v1 -> Multiset v2

Maps on the multiset's values.

mapCounts :: Ord v => (Int -> Int) -> Multiset v -> Multiset v

Maps on the multiset's counts. Groups with resulting non-positive counts will be removed from the final multiset.

mapGroups :: Ord v => (Group v -> Group v) -> Multiset v -> Multiset v

Maps on the multiset's groups. Groups with resulting non-positive counts will be removed from the final multiset.

filter :: Ord v => (v -> Bool) -> Multiset v -> Multiset v

Filters a multiset by value.

filterGroups :: Ord v => (Group v -> Bool) -> Multiset v -> Multiset v

Filters a multiset by group.

Combination

max :: Ord v => Multiset v -> Multiset v -> Multiset v

Combines two multisets, returning the max count of each element.

min :: Ord v => Multiset v -> Multiset v -> Multiset v

Combines two multisets, returning the minimum count of each element (or omitting it if the element is present in only one of the two multisets).

difference :: Ord v => Multiset v -> Multiset v -> Multiset v

O(m * log m) Returns the first set minus the second. Resulting negative counts are ignored.

unionWith :: Ord v => (Int -> Int -> Int) -> Multiset v -> Multiset v -> Multiset v

Unions two multisets with a generic function. The combining function will be called with a count of 0 when an element is only present in one set.

intersectionWith :: Ord v => (Int -> Int -> Int) -> Multiset v -> Multiset v -> Multiset v

Intersects two multisets with a generic function. The combining function is guaranteed to be called only with positive counts.

Conversions

toSet :: Multiset v -> Set v

O(m) Returns the Set of all distinct elements in the multiset.

toGroupList :: Multiset v -> [Group v]

O(m) Converts the multiset to a list of values and associated counts. The groups are in undefined order; see toGrowingGroupList and toShrinkingGroupList for sorted versions.

toGrowingGroupList :: Multiset v -> [Group v]

O(m * log m) Converts the multiset into a list of values and counts, from least common to most.

toShrinkingGroupList :: Multiset v -> [Group v]

O(m * log m) Converts the multiset into a list of values and counts, from most common to least.

toCountMap :: Multiset v -> Map v Int

O(1) Converts the multiset to a map of (positive) counts.

Other

elems :: Multiset v -> [v]

O(n) Returns the multiset's elements as a list where each element is repeated as many times as its number of occurrences. This is a synonym for toList.

distinctElems :: Multiset v -> [v]

O(m) Returns a list of the distinct elements in the multiset.

maxView :: Ord v => Multiset v -> Maybe (v, Multiset v)

O(log m) Takes an element of maximum value from the multiset and the remaining multiset, or Nothing if the multiset was already empty.

Since: 0.2.1.2

minView :: Ord v => Multiset v -> Maybe (v, Multiset v)

O(log m) Takes an element of minimum value from the multiset and the remaining multiset, or Nothing if the multiset was already empty.

Since: 0.2.1.2

mostCommon :: Multiset v -> [(Int, [v])]

O(m) Returns the multiset's elements grouped by count, most common first.