package libzipperposition

  1. Overview
  2. Docs
package libzipperposition
Legend:
Library
Module
Module type
Parameter
Class
Class type

Phases of the Prover

To process a file, the prover goes through a sequence of phases that are used to build values. This module reifies the phases.

type filename = string
type 'a or_error = ('a, string) CCResult.t

Phases

type env_with_clauses =
  1. | Env_clauses : 'c Libzipperposition.Env.packed * 'c Libzipperposition.Clause.sets -> env_with_clauses
type errcode = int
type ('ret, 'before, 'after) phase =
  1. | Init : (unit, _, [ `Init ]) phase
  2. | Setup_gc : (unit, [ `Init ], [ `Init ]) phase
  3. | Setup_signal : (unit, [ `Init ], [ `Init ]) phase
  4. | Parse_CLI : (filename list * Libzipperposition.Params.t, [ `Init ], [ `Parse_cli ]) phase
  5. | LoadExtensions : (Libzipperposition.Extensions.t list, [ `Parse_cli ], [ `LoadExtensions ]) phase
  6. | Parse_prelude : (prelude, [ `LoadExtensions ], [ `Parse_prelude ]) phase
  7. | Start_file : (filename, [ `Parse_prelude ], [ `Start_file ]) phase
  8. | Parse_file : (Logtk.Input_format.t * Logtk.UntypedAST.statement Iter.t, [ `Start_file ], [ `Parse_file ]) phase
  9. | Typing : (Logtk.TypeInference.typed_statement CCVector.ro_vector, [ `Parse_file ], [ `Typing ]) phase
  10. | CNF : (Logtk.Statement.clause_t CCVector.ro_vector, [ `Typing ], [ `CNF ]) phase
  11. | Compute_prec : (Logtk.Precedence.t, [ `CNF ], [ `Precedence ]) phase
  12. | Compute_ord_select : (Logtk.Ordering.t * Libzipperposition.Selection.t * Libzipperposition.Bool_selection.t, [ `Precedence ], [ `Compute_ord_select ]) phase
  13. | MakeCtx : ((module Libzipperposition.Ctx.S), [ `Compute_ord_select ], [ `MakeCtx ]) phase
  14. | MakeEnv : (env_with_clauses, [ `MakeCtx ], [ `MakeEnv ]) phase
  15. | Pre_saturate : ('c Libzipperposition.Env.packed * Libzipperposition.Saturate.szs_status * 'c Libzipperposition.Clause.sets, [ `MakeEnv ], [ `Pre_saturate ]) phase
  16. | Saturate : (env_with_result, [ `Pre_saturate ], [ `Saturate ]) phase
  17. | Print_result : (unit, [ `Saturate ], [ `Print_result ]) phase
  18. | Print_dot : (unit, [ `Print_result ], [ `Print_dot ]) phase
  19. | Check_proof : (errcode, [ `Print_dot ], [ `Check_proof ]) phase
  20. | Print_stats : (unit, [ `Check_proof ], [ `Print_stats ]) phase
  21. | Exit : (unit, _, [ `Exit ]) phase
type any_phase =
  1. | Any_phase : (_, _, _) phase -> any_phase
    (*

    A phase hidden in an existential type

    *)

Main Type

type (+'a, 'p1, 'p2) t

Monad type, representing an action starting at phase 'p1 and stopping at phase 'p2

val string_of_phase : (_, _, _) phase -> string
val string_of_any_phase : any_phase -> string
val return : 'a -> ('a, 'p, 'p) t

Return a value into the monad

val fail : string -> (_, _, _) t

Fail with the given error message

val return_err : 'a or_error -> ('a, 'p, 'p) t
val exit : (unit, _, [ `Exit ]) t

Exit

val start_phase : (_, 'p1, 'p2) phase -> (unit, 'p1, [ `InPhase of 'p2 ]) t

Start the given phase

val return_phase : 'a -> ('a, [ `InPhase of 'p2 ], 'p2) t

Finish the given phase

val return_phase_err : 'a or_error -> ('a, [ `InPhase of 'p2 ], 'p2) t
val current_phase : (any_phase, _, 'p2) t

Get the current phase

val with_phase : ('a, 'p1, 'p2) phase -> f:(unit -> 'a) -> ('a, 'p1, 'p2) t

Start phase, call f () to get the result, return its result using return_phase

val with_phase1 : ('b, 'p1, 'p2) phase -> f:('a -> 'b) -> 'a -> ('b, 'p1, 'p2) t
val with_phase2 : ('c, 'p1, 'p2) phase -> f:('a -> 'b -> 'c) -> 'a -> 'b -> ('c, 'p1, 'p2) t
val bind : ('a, 'p_before, 'p_middle) t -> f:('a -> ('b, 'p_middle, 'p_after) t) -> ('b, 'p_before, 'p_after) t

bind state f calls f to go one step further from state

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

Map the current value

val fold_l : f:('a -> 'b -> ('a, 'p, 'p) t) -> x:'a -> 'b list -> ('a, 'p, 'p) t
val run_parallel : (errcode, 'p1, 'p2) t list -> (errcode, 'p1, 'p2) t

run_sequentiel l runs each action of the list in succession, restarting every time with the initial state (once an action has finished, its state is discarded). Only the very last state is kept. If any errcode is non-zero, then the evaluation stops with this errcode

module Infix : sig ... end
include module type of Infix
val (>>=) : ('a, 'p1, 'p2) t -> ('a -> ('b, 'p2, 'p3) t) -> ('b, 'p1, 'p3) t
val (>>?=) : 'a or_error -> ('a -> ('b, 'p1, 'p2) t) -> ('b, 'p1, 'p2) t
val (>|=) : ('a, 'p1, 'p2) t -> ('a -> 'b) -> ('b, 'p1, 'p2) t
val empty_state : Logtk.Flex_state.t
val get : (Logtk.Flex_state.t, 'a, 'a) t
val set : Logtk.Flex_state.t -> (unit, 'a, 'a) t
val get_key : 'a Logtk.Flex_state.key -> ('a, 'b, 'b) t

get_key k returns the value associated with k in the state

val set_key : 'a Logtk.Flex_state.key -> 'a -> (unit, 'b, 'b) t
val update : f:(Logtk.Flex_state.t -> Logtk.Flex_state.t) -> (unit, 'a, 'a) t

update ~f changes the state using f

val run_with : Logtk.Flex_state.t -> ('a, [ `Init ], [ `Exit ]) t -> (Logtk.Flex_state.t * 'a) or_error

run_with state m executes the actions in m starting with state, returning some value (or error) and the final state.

val run : ('a, [ `Init ], [ `Exit ]) t -> (Logtk.Flex_state.t * 'a) or_error

run m is run_with empty_state m

module Key : sig ... end
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct