package olmi

You can search for identifiers within the package.

in-package search v0.2.0

package olmi

olmi
- Olmi
- OlmiInterfaces
  - BASIC_INTERFACE
  - BIND
  - COMMON
  - INFIX
  - INTERFACE
  - JOIN
  - LIFT
  - PLUS
  - PLUS_INTERFACE
- OlmiMake
  - Monad
    
    M
  - Plus
    
    M
    
    P
  - WithBind
    
    M
  - WithJoin
    
    M

Legend:
Library
Module
Module type
Parameter
Class
Class type

Provide the complete interface of monadic operations

include BASIC_INTERFACE

include COMMON

type 'a 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 INFIX with type 'a t := 'a t

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

Sequential application.

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

infix alias of fmap

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

Replace all locations in the input with the same value.

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

Sequence actions, discarding the value of the first argument.

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

Sequence actions, discarding the value of the second argument.

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

A variant of <*> with the arguments reversed.

val (>>=) : '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 (>|=) : 'a t -> ('a -> 'b) -> 'b t

infix alias of fmap

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

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

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

Left-to-right Kleisli composition of monads.

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

Flipped version of >>=

val (>>) : '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 LIFT with type 'a t := 'a t

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

Promote a function to a monad.

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

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

val 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

val 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

val 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

val void : 'a t -> unit t

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