lr-acts: Left and right actions, semidirect products and torsors

[ algebra, bsd3, data, library, math ] [ Propose Tags ] [ Report a vulnerability ]

Downloads

Maintainer's Corner

Package maintainers

For package maintainers and hackage trustees

Candidates

Versions [RSS] 0.0
Change log CHANGELOG.md
Dependencies base (>=4.18 && <5), data-default (>=0.7 && <0.9), groups (>=0.5 && <0.6) [details]
Tested with ghc ==9.8.2
License BSD-3-Clause
Author Alice Rixte
Maintainer alice.rixte@u-bordeaux.fr
Category Algebra, Math, Data
Home page https://github.com/AliceRixte/lr-acts#readme
Bug tracker https://github.com/AliceRixte/lr-acts/issues
Source repo head: git clone https://github.com/AliceRixte/lr-acts
Uploaded by AliceRixte at 2025-05-22T13:31:33Z
Distributions
Downloads 2 total (2 in the last 30 days)
Rating (no votes yet) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Docs uploaded by user
Build status unknown [no reports yet]

Readme for lr-acts-0.0

[back to package description]

lr-acts

Haskell Hackage BSD3 License

Features

  • Left and right actions of
    • sets
    • semigroup
    • monoids
    • groups
  • Semidirect product
  • Group torsors
  • Cyclic actions
  • Generated actions

Fine-grained class hierarchy

Left and right actions with a fine-grained class hierarchy for action properties. For left actions, here are the provided classes :

class LAct               -- Set action
 => LActSg               -- Semigroup action
     => LActMn           -- Monoid action
          => LTorsor     -- Torsor
 => LActDistrib          -- Distributive action
 => LActNeutral          -- Neutral preserving action
 => LActGen              -- Action generated by a set
     => LActCyclic       -- Cyclic action (generated by a single element)

Derive most of you action instances

The acting type is always the second parameter. Use this with DerivingVia language extension to derive action instances :

import Data.Act
import Data.Semigroup

newtype Seconds = Seconds Float
newtype Duration = Duration Seconds
  deriving (Semigroup, Monoid) via (Sum Float)

  deriving (LAct Seconds, RAct Seconds) via (ActSelf' (Sum Float))
  -- derives LAct Second  Duration

  deriving (LAct [Seconds], RAct [Seconds]) via (ActMap (ActSelf' (Sum Float)))
   -- derives LAct [Second] Duration

newtype Durations = Durations [Duration]
  deriving (LAct Seconds, RAct Seconds) via (ActFold [Duration])
  -- derives LAct Second Durations

ghci> Duration 2 `lact` Seconds 3
Seconds 5.0

ghci> Duration 2 `lact` [Seconds 3, Seconds 4]
[Seconds 5.0,Seconds 6.0]

ghci> [Duration 2, Duration 3] `lact` Seconds 4
[Seconds 5.0,Seconds 6.0]

ghci> Durations [Duration 2, Duration 3] `lact` Seconds 4
Seconds 9.0

Semidirect products

This fine-grained hierarchy allows to check for associativity and existence of neutral elements using semidirect products.

>>> import Data.Semigroup
>>> LSemidirect (Sum 1) (Product 2) <> LSemidirect (Sum (3 :: Int)) (Product (4 :: Int))
LSemidirect {lactee = Sum {getSum = 7}, lactor = Product {getProduct = 8}}

GHC will complain when using a semigroup action that is not distributive :

>>> LSemidirect (Sum 1) (Sum 2) <> LSemidirect (Sum (3 :: Int)) (Sum (4 :: Int))
No instance for `LActDistrib (Sum Int) (Sum Int)'
  arising from a use of `<>'

Comparison with other action libraries

Here is a list of action libraries on hackage :

In comparison with these libraries, lr-actsis the only library that :

  • Implements right actions
  • Implements cyclic actions and generated actions
  • Ensures the associativity and the neutrality of mempty in semidirect products
  • Proposes several newtypes for deriving instances (note that acts proposes a deriving mechanism, but centered around the actee type, not the actor type as in this library)

The main drawback of providing right actions and checking properties for semidirect products is that the number of instances can quickly be overwhelming. It can be a lot of boiler plate to declare them all, especially when the acting semigroup is commutative.