Module `Digital_components.Component`Source

Sourcemodule type S = sig ... end

Sourcetype ('i, 'o) t_

t is mostly abstract, but we expose is as a constructor so that the type checker knows that t is injective.

Sourcetype ('i, 'o) t =

| T of ('i, 'o) t_

val sexp_of_t : 
  ('i -> Sexplib0.Sexp.t) ->
  ('o -> Sexplib0.Sexp.t) ->
  ('i, 'o) t ->
  Sexplib0.Sexp.t

Source

type ('i, 'o) t_module =
  (module S
  with type Input.t = 'i
   and type Output.t = 'o)

Sourceval sexp_of_input : ('i, _) t -> 'i -> Base.Sexp.t

Sourceval sexp_of_output : (_, 'o) t -> 'o -> Base.Sexp.t

Sourceval input_module : ('i, _) t -> 'i Data.t

Sourceval output_module : (_, 'o) t -> 'o Data.t

Sourceval create : ('i, 'o) t_module -> ('i, 'o) t

Sourceval output : ('i, 'o) t -> 'i -> 'o

output returns the output based on an input and its current state, but does not update the state. A component is called "combinational" if output t i ignores t. A component is called "sequential" if output t i uses t. A sequential component is called a "moore machine" if it ignores i and a "mealy machine" if it uses i.

Sourceval update_state : ('i, _) t -> 'i -> Base.Unit.t

update_state updates t's state based on an input and its current state

Sourceval run_with_inputs : ('i, 'o) t -> 'i Base.List.t -> ('i * 'o) Base.List.t

run_with_inputs t is runs length is steps with t, on each step calling update_state and then output, pairing the input of that step with the output.

Sourcemodule Next_input : sig ... end

Source

val run_until_finished : 
  ?show_steps:Base.Bool.t ->
  ('i, 'o) t ->
  first_input:'i ->
  next_input:('o -> 'i Next_input.t) ->
  Base.Unit.t

Component combinators

Sourceval sequence : ('a, 'b) t -> ('b, 'c) t -> ('a, 'c) t

Sourceval map_input : ('i2, 'o) t -> 'i1 Data.t -> f:('i1 -> 'i2) -> ('i1, 'o) t

Sourceval map_output : ('i, 'o1) t -> 'o2 Data.t -> f:('o1 -> 'o2) -> ('i, 'o2) t

Combinational components

Sourcemodule Combinational : sig ... end

Sourceval create_combinational : ('i, 'o) Combinational.t -> ('i, 'o) t

Sourceval and_ : (Base.Bool.t * Base.Bool.t, Base.Bool.t) t

Sourceval or_ : (Base.Bool.t * Base.Bool.t, Base.Bool.t) t

Sourceval not_ : (Base.Bool.t, Base.Bool.t) t

Sequential components

Sourceval flip_flop : Base.Unit.t -> (Base.Bool.t, Base.Bool.t) t

Sourcemodule Flip_flop_with_load_enable : sig ... end

Sourcemodule Flip_flop_with_load_enable_and_reset : sig ... end

Install

Dune Dependency

Authors

Maintainers

Sources

doc/hardcaml_step_testbench.digital_components/Digital_components/Component/index.html

Module `Digital_components.Component`Source

Component combinators

Combinational components

Sequential components

package hardcaml_step_testbench

Install

Dune Dependency

Authors

Maintainers

Sources

doc/hardcaml_step_testbench.digital_components/Digital_components/Component/index.html

Module Digital_components.ComponentSource

Component combinators

Combinational components

Sequential components

Module `Digital_components.Component`Source