package olmi

  1. Overview
  2. Docs

Module OlmiMake.MonadSource

Parameters

Signature

include OlmiInterfaces.BASIC_INTERFACE with type 'a t = 'a M.t
include OlmiInterfaces.COMMON with type 'a t = 'a M.t
type 'a t = 'a M.t
val return : 'a -> 'a t

Place a value in a minimal monadic context

val join : 'a t t -> 'a t

The join function is the conventional monad join operator. It is used to remove one level of monadic structure, projecting its bound argument into the outer level.

val bind : 'a t -> ('a -> 'b t) -> 'b t

Sequentially compose two actions, passing any value produced by the first as an argument to the second.

val fmap : ('a -> 'b) -> 'a t -> 'b t

Sequential application

include OlmiInterfaces.INFIX with type 'a t := 'a t
Sourceval (<*>) : ('a -> 'b) t -> 'a t -> 'b t

Sequential application.

Sourceval (<$>) : ('a -> 'b) -> 'a t -> 'b t

infix alias of fmap

Sourceval (<$) : 'a -> 'b t -> 'a t

Replace all locations in the input with the same value.

Sourceval (*>) : 'a t -> 'b t -> 'b t

Sequence actions, discarding the value of the first argument.

Sourceval (<*) : 'a t -> 'b t -> 'a t

Sequence actions, discarding the value of the second argument.

Sourceval (<**>) : 'a t -> ('a -> 'b) t -> 'b t

A variant of <*> with the arguments reversed.

Sourceval (>>=) : 'a t -> ('a -> 'b t) -> 'b t

Sequentially compose two actions, passing any value produced by the first as an argument to the second.

Sourceval (>|=) : 'a t -> ('a -> 'b) -> 'b t

infix alias of fmap

Sourceval (<=<) : ('b -> 'c t) -> ('a -> 'b t) -> 'a -> 'c t

Right-to-left Kleisli composition of monads. (>=>), with the arguments flipped

Sourceval (>=>) : ('a -> 'b t) -> ('b -> 'c t) -> 'a -> 'c t

Left-to-right Kleisli composition of monads.

Sourceval (=<<) : ('a -> 'b t) -> 'a t -> 'b t

Flipped version of >>=

Sourceval (>>) : 'a t -> 'b t -> 'b t

Sequentially compose two actions, discarding any value produced by the first, like sequencing operators (such as the semicolon) in imperative languages.

include OlmiInterfaces.LIFT with type 'a t := 'a t
Sourceval liftM : ('a -> 'b) -> 'a t -> 'b t

Promote a function to a monad.

Sourceval liftM2 : ('a -> 'b -> 'c) -> 'a t -> 'b t -> 'c t

Promote a function to a monad, scanning the monadic arguments from left to right

Sourceval liftM3 : ('a -> 'b -> 'c -> 'd) -> 'a t -> 'b t -> 'c t -> 'd t

Promote a function to a monad, scanning the monadic arguments from left to right

Sourceval liftM4 : ('a -> 'b -> 'c -> 'd -> 'e) -> 'a t -> 'b t -> 'c t -> 'd t -> 'e t

Promote a function to a monad, scanning the monadic arguments from left to right

Sourceval liftM5 : ('a -> 'b -> 'c -> 'd -> 'e -> 'f) -> 'a t -> 'b t -> 'c t -> 'd t -> 'e t -> 'f t

Promote a function to a monad, scanning the monadic arguments from left to right

Sourceval void : 'a t -> unit t

void value discards or ignores the result of evaluation, such as the return value of an IO action.