package hardcaml

  1. Overview
  2. Docs
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module Hardcaml.AssertionsSource

Assertions within Hardcaml simulations.

There are a few steps needed to enable assertions:

1. pass trace_properties:true to Scope.create 2. enable them in the Circuit.Config (see circuit_config_with_assertions) 3. (optionally) attach assertion tracing to the simulation (see trace)

Sourcetype t
Sourceval sexp_of_t : t -> Sexplib0.Sexp.t
Sourcemodule Violated_or_not : sig ... end
Sourceval circuit_config_with_assertions : ?config:Circuit.Config.t -> Scope.t -> Circuit.Config.t

Return a circuit config with assertions enabled.

Sourceval trace : ('i, 'o) Cyclesim.t -> Hardcaml__.Assertion_manager.t Base.option -> t * ('i, 'o) Cyclesim.t

Connect to a simulator and record all assertions.

Return assertions fired during a simulation. Printing t as a sexp displays these results.

Add an assertion to the scope's assertion manager.

Sourcemodule Always : sig ... end
OCaml

Innovation. Community. Security.