package hardcaml_step_testbench
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=cfa21330796a78a457e529f6a1134147dc7b414d6aa6d30fad823f04423e87f5
doc/hardcaml_step_testbench.digital_components/Digital_components/Step_monad/index.html
Module Digital_components.Step_monadSource
val sexp_of_t :
('a -> Sexplib0.Sexp.t) ->
('i -> Sexplib0.Sexp.t) ->
('o -> Sexplib0.Sexp.t) ->
('a, 'i, 'o) t ->
Sexplib0.Sexp.tinclude Base.Monad.S3 with type ('a, 'b, 'c) t := ('a, 'b, 'c) t
Same as Infix, except the monad type has three arguments. The second and third are always just passed through.
val for_ :
Base.Int.t ->
Base.Int.t ->
(Base.Int.t -> (Base.Unit.t, 'i, 'o) t) ->
(Base.Unit.t, 'i, 'o) tfor_ i j f does f i, f (i+1), ... f j in sequence. If j < i, then for_ i j immediately returns unit.
delay o ~num_steps outputs o for num_steps and then returns unit. delay raises if num_steps < 0.
val repeat :
count:Base.Int.t ->
(Base.Unit.t -> (Base.Unit.t, 'i, 'o) t) ->
(Base.Unit.t, 'i, 'o) trepeat ~count f does f () count times. repeat raises if count < 0.
An event is a value that will at some point in time (possibly the past, possibly the future) transition from "undetermined" to "determined", with some value. One can wait_for an event in a computation.
wait_for event ~output outputs output until the step at which event becomes determined, at which point the wait_for proceeds.
val spawn :
?update_children_after_finish:Base.Bool.t ->
Base.Source_code_position.t ->
start:('i_c -> (('a, 'o_c) Component_finished.t, 'i_c, 'o_c) t) ->
input:'i_c Data.t ->
output:'o_c Data.t ->
child_input:(parent:'i -> 'i_c) ->
include_child_output:(parent:'o -> child:'o_c -> 'o) ->
(('a, 'o_c) Component_finished.t Event.t, 'i, 'o) tspawn creates a child computation that runs start. spawn returns on the current step, and the child starts on the next step. The parent computation uses child_input to adjust its input into the form that the child computation sees, and include_child_output to incorporate the child's output into its output.
When update_children_after_finish, unfinished tasks spawned from within start will be executed even after start completes.
val create_component :
created_at:Base.Source_code_position.t ->
update_children_after_finish:Base.Bool.t ->
start:('i -> (('a, 'o) Component_finished.t, 'i, 'o) t) ->
input:'i Data.t ->
output:'o Data.t ->
('i, 'o) Component.t * ('a, 'o) Component_finished.t Event.tcreate_component creates a Component.t that runs the computation described by start. When update_children_after_finish is set to true, all component's children will be updated even after the child terminates. This will result in tasks spawned from within the child task to execute even after the child terminates.