package arrayjit

You can search for identifiers within the package.

in-package search v0.2.0

package arrayjit

arrayjit
- Arrayjit
arrayjit.ppx_arrayjit
- Ppx_arrayjit
  - Ppx_helper

Legend:
Library
Module
Module type
Parameter
Class
Class type

include module type of struct include Base.Lazy end

type 'a t = 'a lazy_t

val compare : ('a -> 'a -> int) -> 'a t -> 'a t -> int

val compare__local : ('a -> 'a -> int) -> 'a t -> 'a t -> int

val equal : ('a -> 'a -> bool) -> 'a t -> 'a t -> bool

val equal__local : ('a -> 'a -> bool) -> 'a t -> 'a t -> bool

val globalize : ('a -> 'a) -> 'a t -> 'a t

val hash_fold_t : 
  (Base.Hash.state -> 'a -> Base.Hash.state) ->
  Base.Hash.state ->
  'a t ->
  Base.Hash.state

include Sexplib0.Sexpable.S1 with type 'a t := 'a t

val t_of_sexp : (Sexplib0.Sexp.t -> 'a) -> Sexplib0.Sexp.t -> 'a t

val t_sexp_grammar : 'a Sexplib0.Sexp_grammar.t -> 'a t Sexplib0.Sexp_grammar.t

include Base.Monad.S with type 'a t := 'a t

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

t >>= f returns a computation that sequences the computations represented by two monad elements. The resulting computation first does t to yield a value v, and then runs the computation returned by f v.

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

t >>| f is t >>= (fun a -> return (f a)).

module Monad_infix = Base.Lazy.Monad_infix

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

bind t ~f = t >>= f

val return : 'a -> 'a t

return v returns the (trivial) computation that returns v.

val map : 'a t -> f:('a -> 'b) -> 'b t

map t ~f is t >>| f.

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

join t is t >>= (fun t' -> t').

val ignore_m : 'a t -> unit t

ignore_m t is map t ~f:(fun _ -> ()). ignore_m used to be called ignore, but we decided that was a bad name, because it shadowed the widely used Stdlib.ignore. Some monads still do let ignore = ignore_m for historical reasons.

val all : 'a t list -> 'a list t

val all_unit : unit t list -> unit t

Like all, but ensures that every monadic value in the list produces a unit value, all of which are discarded rather than being collected into a list.

module Let_syntax = Base.Lazy.Let_syntax

exception Undefined

val force : 'a t -> 'a

force x forces the suspension x and returns its result. If x has already been forced, Lazy.force x returns the same value again without recomputing it. If it raised an exception, the same exception is raised again. Raise Undefined if the forcing of x tries to force x itself recursively.

val force_val : 'a t -> 'a

Like force except that force_val x does not use an exception handler, so it may be more efficient. However, if the computation of x raises an exception, it is unspecified whether force_val x raises the same exception or Undefined.

val from_fun : (unit -> 'a) -> 'a t

from_fun f is the same as lazy (f ()) but slightly more efficient if f is a variable. from_fun should only be used if the function f is already defined. In particular it is always less efficient to write from_fun (fun () -> expr) than lazy expr.

val from_val : 'a -> 'a t

from_val v returns an already-forced suspension of v (where v can be any expression). Essentially, from_val expr is the same as let var = expr in lazy var.

val is_val : 'a t -> bool

is_val x returns true if x has already been forced and did not raise an exception.

val peek : 'a t -> 'a option

peek x returns None if x has never been forced or Some v if x was forced to value v

module T_unforcing = Base.Lazy.T_unforcing

This type offers a serialization function sexp_of_t that won't force its argument. Instead, it will serialize the 'a if it is available, or just use a custom string indicating it is not forced. Note that this is not a round-trippable type, thus the type does not expose of_sexp. To be used in debug code, while tracking a Heisenbug, etc.

val sexp_of_t : ('a -> Sexplib0.Sexp.t) -> 'a lazy_t -> Sexplib0.Sexp.t

val sexp_of_lazy_t : ('a -> Sexplib0.Sexp.t) -> 'a lazy_t -> Sexplib0.Sexp.t