Modulevortex-journal-0.1.0GHC2024

Vortex.Journal.Marking

A marking: a finite multiset of resource tokens. Markings are the linear part of a journal: a token is never copied or dropped, only consumed by one operation and produced by another, so the multiset operations here are the whole of the arithmetic a state is allowed.

1 type
15 values

Packagevortex-journal-0.1.0
Exports16
LanguageGHC2024
LicenceMIT
SourceMarking.hs

newtypenewtype Marking tok

A multiset of tokens. The invariant, kept by every function here, is that no token is held with a count of zero, so two markings with the same tokens are equal as values.

Instances5Eq, Ord, Show, Semigroup, Monoid

Eq tok => Eq (Marking tok)Defined in vortex-journal-0.1.0 · Vortex.Journal.Marking
Ord tok => Ord (Marking tok)Defined in vortex-journal-0.1.0 · Vortex.Journal.Marking
Show tok => Show (Marking tok)Defined in vortex-journal-0.1.0 · Vortex.Journal.Marking
Ord tok => Semigroup (Marking tok)Defined in vortex-journal-0.1.0 · Vortex.Journal.Marking
Ord tok => Monoid (Marking tok)Defined in vortex-journal-0.1.0 · Vortex.Journal.Marking

valuenone :: Marking tok

The empty marking.

valuetoken :: tok -> Marking tok

One token.

valuetokens :: Ord tok => [tok] -> Marking tok

The marking holding each listed token once per mention.

valuefromCounts :: Ord tok => [(tok, Natural)] -> Marking tok

The marking holding each token as many times as the counts say, summed over repeats.

valueplus :: Ord tok => Marking tok -> Marking tok -> Marking tok

Multiset sum: every token of both.

valueminus :: Ord tok => Marking tok -> Marking tok -> Marking tok

Multiset difference, truncated at zero. Where contains m n holds it is exact: plus (minus m n) n == m.

valuecontains :: Ord tok => Marking tok -> Marking tok -> Bool

Inclusion: contains m n when m holds every token of n at least as often.

valuecount :: Ord tok => tok -> Marking tok -> Natural

How many times a token is held.

valuetoList :: Marking tok -> [tok]

Every token, repeated by its count, in token order.

valuetoCounts :: Marking tok -> [(tok, Natural)]

Each token with its count, in token order.

valuesupport :: Marking tok -> Set tok

The tokens held at least once.

valuesize :: Marking tok -> Natural

The number of tokens, counted with multiplicity.

valuefilterTokens :: (tok -> Bool) -> Marking tok -> Marking tok

The tokens a predicate keeps, with their counts.

valuebind :: Ord tok' => (tok -> Marking tok') -> Marking tok -> Marking tok'

The monoid homomorphism a map on tokens extends to: each token is replaced by its image, counts multiplying. Markings are the free commutative monoid on tokens, so every homomorphism is one of these.

valuedisjoint :: Ord tok => Marking tok -> Marking tok -> Bool

Do two markings share no token?