marcosh/crem
1
1
Fork 0
mirror of https://github.com/marcosh/crem.git synced 2024-08-16 16:00:37 +03:00
Code Issues Packages Projects Releases Wiki Activity

add documentation for maybeM and EitherM

Browse Source
This commit is contained in:
Marco Perone 2023-03-06 16:02:07 +01:00
parent 4eb63937b2
commit 86c6f32e57
1 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
src/Crem/BaseMachine.hs
View File

@ -168,6 +168,9 @@ sequence (ActionResult (Identity (outputs, state))) =
-- ** Lift machines
-- | Lift a @BaseMachineT@ to operate with `Maybe` inputs and outputs. If the
-- input is a `Nothing`, then the output will be a `Nothing`. If the input is a
-- `Just`, then the machine will be used to compute the output.
maybeM
:: Applicative m
=> BaseMachineT m topology a b
@ -180,6 +183,9 @@ maybeM (BaseMachineT initialState action) =
Just a -> Just <$> action initialState' a
}
-- | Lift a @BaseMachineT@ to operate with `Either` inputs and outputs. If the
-- input is a `Left`, then the output will be that `Left`. If the input is a
-- `Right`, then the machine will be used to compute the output.
eitherM
:: Applicative m
=> BaseMachineT m topology a b