Index of values

one task is stopped with information

add x s returns a set containing the same elements as s, plus x.

add x y m returns a map containing the same bindings as m, plus a binding of x to y.

add_builtin lang builtin adds new builtin libraries to lang.

add_file es f adds the file with filename f in the proof session, the file name must be given relatively to the session dir given to open_session

Add a real file by its filename.

keys are normally generated

add_new e x s adds x to s if s does not contain x, and raises e otherwise.

add_new e x v m binds x to v in m if x is not bound, and raises e otherwise.

add_pdecl ~wp m d adds declaration d in module m.

Metas

Apply a real transformation by its why3 name, raise Session.NoTask if the goal doesn't contain a task.

Add a transformation by its subgoals

all2_fn pr z a b return true if pr a b is true, otherwise raise FoldSkip

all_fn pr z a return true if pr a is true, otherwise raise FoldSkip

any2_fn pr z a b return false if pr a b is false, otherwise raise FoldSkip

any_fn pr z a return false if pr a is false, otherwise raise FoldSkip

The returned set of labels will contain the same set of labels as argument labels except that a label of the form "model_trace:*@*" will be "model_trace:*to_append@*".

The returned set of labels will contain the same set of labels as argument labels except that a label of the form "model_trace:*" will be "model_trace:*to_append".

apply f [a1;..;an] returns (f a1)@...@(f an)

apply a function specification to a variable argument

remove from the given arrow every effect that is covered neither by the arrow's arguments nor by the given pvset

the substitution must cover not only aty_vars aty but also every type variable and every region in aty_spec

raises Not_found if the spec contains non-pv variables

this only compares the types of arguments and results, and ignores the spec.

base_language is the root of the tree of supported languages.

Return the list of all bindings of the given map.

bounded_split c s n do the same as split c s but splits into n substring at most.

Call a prover on the task printed in the Buffer.t given.

cancel a marks all proofs under a as obsolete

cancels all currently scheduled proof attempts.

Return the number of elements in a set.

Return the number of bindings of a map.

change f x s returns a set containing the same elements as s, except x which is added to s if f (mem x s) returns true and removed otherwise.

change f x m returns a map containing the same bindings as m, except the binding of x in m is changed from y to f (Some y) if m contains a binding of x, otherwise the binding of x becomes f None.

check_all session callback reruns all the proofs of the session, and reports for all proofs the current result and the new one (does not change the session state).

check_exhaustive section keys check that only the keys in keys appear inside the section section

Return one element of the given set, or raise Not_found if the set is empty.

Return one binding of the given map, or raise Not_found if the map is empty.

removes the first n elements of a list; raises Invalid_argument if the list is not long enough

removes (and returns) the last element of a list

clean a removes failed attempts below a where there at least one successful attempt or transformation

clone_meta td_meta sm produces from td_meta a new Meta tdecl instantiated with respect to sm.

Total ordering between sets.

Total ordering between maps.

Same as Session_tools.convert_unknown_prover

try to add new proof_attempt with known provers for all proof attempt with unknown provers

copy an external proof.

keys are copied

returns a fresh key, a new child of the given parent if any

create init step callback

creates an environment from a "loadpath", a list of directories containing loadable Why3/WhyML/etc files

start a new printer with a sanitizing function and a blacklist

creation of a symbol for type in programs

create a new session in the given directory.

The debug flag "session"

debug flag for the calling procedure (option "--debug call_prover") If set call_on_buffer prints on stderr the commandline called and the output of the prover.

default_config filename create a default configuration which is going to be saved in filename

Option for specifying a debug flag to set

Option for setting all info flags

Option for printing the list of debug flags

Option for setting a specific flag

diff f s1 s2 computes the difference of two sets

diff f m1 m2 computes a map whose keys is a subset of keys of m1.

disjoint s1 s2 tests whether the sets s1 and s2 are disjoint.

disjoint pr m1 m2 verifies that for every common key in m1 and m2, pr is verified.

domain m returns the set of keys of binding m

Print only if the flag is set

e_app e el builds the application of e to arguments el.

e_arrow p argl res instantiates the program function symbol p into a program expression having the given types of the arguments and the result.

e_find pr e returns a sub-expression of e satisfying pr.

edits the given proof attempt using the appropriate editor

edits the given proof attempt using the appropriate editor but don't modify the session

return the configuration of the editor if found, otherwise return Not_found

Return the list of all elements of the given set.

An empty Rc

The empty set.

The empty map.

An empty section

test if a string ends with another

equal s1 s2 tests whether the sets s1 and s2 are equal.

equal cmp m1 m2 tests whether the maps m1 and m2 are equal, that is, contain equal keys and associate them with equal data.

exists p s checks if at least one element of s satisfies the predicate p.

exists p m checks if at least one binding of the map satisfy the predicate p.

ffalse constant function false

file_of_task d f th t produces a filename for the prover of driver d, for a task t generated from a goal in theory named th of filename f

file_of_theory d f th produces a filename for the prover of driver d, for a theory th from filename f

filter p s returns the set with all the elements of s that satisfy predicate p.

filter p m returns the map with all the bindings in m that satisfy predicate p.

find the uniq prover that verify the filter.

remove all the proof attempts that do not satisfy the given predicate

test if the prover match the filter prover

resolve prover shortcut in filter

Get all the provers that match this filter

Same as Hashtbl.find

find x m returns the current binding of x in m, or raises Not_found if no such binding exists.

return the first binding or the given value if none found

return the first binding or the given value if none found

find_def x d m returns the current binding of x in m, or return d if no such binding exists.

return the first binding or raise the given exception if none found

return the first binding or raise the given exception if none found

find_exn exn x d m returns the current binding of x in m, or raise exn if no such binding exists.

find_nth p l returns the index of the first element that satifies the predicate p.

return the first binding or None if none found

return the first binding or None if none found

find_opt x m returns the Some of the current binding of x in m, or return None if no such binding exists.

first f l returns the first result of the application of f to an element of l which doesn't return None.

The combinaison of list_first and list_find_nth.

get the description of the flag

Same as Hashtbl.fold

fold f s a computes (f eN ... (f e1 a)...), where e1 ... eN are the element of s in increasing order.

fold f m a computes (f kN dN ... (f k1 d1 a)...), where k1 ... kN are the keys of all bindings in m (in increasing order), and d1 ... dN are the associated data.

fold f d o returns d if o is None, and f d x if o is Some x

fold2_inter f s1 s2 a computes (f eN ... (f e1 a) ...), where e1 ... eN are the elements of inter s1 s2 in increasing order.

fold the common keys of two map at the same time

fold2_union f s1 s2 a computes (f eN ... (f e1 a) ...), where e1 ... eN are the elements of union s1 s2 in increasing order.

fold the keys which appear in one of the two maps

same as Extset.S.fold but in the order of List.fold_left

same as Extmap.S.fold but in the order of List.fold_left

similar to List.map, List.iter and List.fold_left, but with element index passed as extra argument (in 0..len-1)

fold_product f acc l1 l2 apply the function f with the accumulator acc on all the pair of elements of l1 and l2 tail-recursive

generalisation of Lists.fold_product; not tail-recursive

for_all p s checks if all the elements of s satisfy the predicate p.

for_all p m checks if all the bindings of the map satisfy the predicate p.

forget all idents

forget an ident

from_channel cin returns the Rc of the input channel cin

from_file filename returns the Rc of the file filename

Same as Rc.get_int but on bool

Same as Rc.get_intl but on bool

add the extra_options to the command

get_conf_file config get the rc file corresponding to this configuration

Get the formatter used when printing debug material

return the edited filename after concatenation to session_dir

returns the set of editors

get_family config name Same as Rc.get_family except name must not be prover

get_family rc name return all the sections of the family name in rc

get_home_dir () returns the home dir of the user

get_int ~default section key one key to one value

get_intl ~default section key one key to many value

returns the loadpath of a given environment

get_main config get the main section stored in the Rc file

If labels contain a label of the form "model_trace:name@*", return "name".

Return a label of the form "model_trace:*".

If labels contain a label of the form "model_trace:mt_string", return "mt_string".

returns new results from why3server, in an unordered fashion.

find the session which corresponds to the given file or return directly the given directory; return Not_found if the file or the directory doesn't exists

return the prover shortcuts

get_prover_upgrade config returns a map providing the policy to follow for each absent prover (if it has already been decided by the user and thus stored in the config)

get_provers config get the prover family stored in the Rc file.

Access to the Rc.t

get_section rc name

get_simple_family rc name return all the sections of the simple family name in rc

Same as Rc.get_int but on string

Same as Rc.get_intl but on string

Get the set of provers which appear in the session

iter all the goals which are a leaf (no transformations are applied on it)

Return the task of a goal.

Return the task of a goal.

same as goal_task but recover the task goal and all the one of this theory if this goal task have been released

Return a user-friendly name for a goal, derived from its name, its number in a sequence of sub-goals, and/or its explanation

has_prefix pref s returns true if s s starts with prefix pref

the same as Hashtbl.hash

create a duplicate pre-ident

create a derived pre-ident (inherit labels and location)

create a fresh pre-ident

create a duplicate pre-ident with given labels

register a pre-ident (you should never use this function)

use ident_printer to generate a unique name for ident an optional sanitizer is applied over the printer's sanitizer

create a localized pre-ident

a handler for a delayed function, that can be called when there is nothing else to do.

run after the creation

init max

inter f s1 s2 computes the intersection of two sets

inter f m1 m2 computes a map whose keys is a subset of the intersection of keys of m1 and of m2.

test if the hashtbl is empty

test if the hashtbl is empty

Test whether a set is empty or not.

Test whether a map is empty or not.

test if the flag is an info flag

check if the map has the given number of elements

check if the map has the given number of elements

test if a prover is detected

Same as Hashtbl.iter

iter f s applies f to all elements of s.

iter f m applies f to all bindings in map m.

iter_theory f th applies f to all root goals of theory th

iterf f min max step

replaces every Tyapp with Itypur

join sep l joins all the strings in l together, in the same order, separating them by sep

return the key of an element of the tree

Return the list of all keys of the given map.

Same as Hashtbl.length

list the known flags

list_formats lang returns the list of registered formats that can be translated to lang.

wrapper for loading a driver from a file that may be relative to the datadir.

loads a driver from a file

load a prover

takes the result of used_symbols and returns the list of declarations that are not imported with those theories or derived thereof

locate_library env path returns the location of the library file specified by path.

get the flag

ls_defn_decrease ld returns a list of argument positions (numbered from 0) that ensures a lexicographical structural descent for every recursive call.

tries to reconstruct a definition from a defining axiom.

main_loop () run the main loop.

a shortcut less efficient than possible

a shortcut less efficient than possible

map f m returns a map with same domain as m, where the associated value a of all bindings of m has been replaced by the result of the application of f to a.

Same as Extmap.S.map, but may remove bindings.

Same as Extmap.S.map, but the function receives as arguments both the key and the associated value for each binding of the map.

Same as Extmap.S.mapi, but may remove bindings.

Same as Extmap.S.mapi_fold, but may remove bindings.

fold and map at the same time

Same as Extmap.S.min_binding, but returns the largest binding of the given map.

Return the largest element of the given set or raise Not_found if the set is empty.

Same as Hashtbl.mem

mem x s returns true if s contains x, and false otherwise.

mem x m returns true if m contains a binding for x, and false otherwise.

convenience function, memoize a function

merge f s1 s2 computes a set whose elts is a subset of elts of s1 and of s2.

merge f m1 m2 computes a map whose keys is a subset of keys of m1 and of m2.

merge_config config filename merge the content of filename into config

Return the smallest binding of the given map (with respect to the Ord.compare ordering), or raise Not_found if the map is empty.

Return the smallest element of the given set or raise Not_found if the set is empty.

By default all optional arguments are false.

get the next step of the enumeration

get the next (or same) step of the enumeration which key is greater or equal to the given key

notify modification of node of the session

this function is called when timer state changes.

These functions have the properties required by OBSERVER

construct a set from a list of elements

construct a map from a pair of bindings

Print the list of flags if requested (in this case return true).

chop or pad the given string on the right up to the given length

parse the string representing a filter_prover: "name,version,altern", "name,version" -> "name,version,^.*", "name,,altern" -> "name,^.*,altern", "name" -> "name,^.*,^.*" regexp must start with ^.

parse_record kn field_list takes a list of record field assignments, checks it for well-formedness and returns the corresponding constructor, the full list of projection symbols, and the map from projection symbols to assigned values.

part cmp l returns the list of the congruence classes with respect to cmp.

partition p s returns a pair of sets (s1, s2), where s1 contains all the elements of s that satisfy the predicate p, and s2 is the map with all the elements of s that do not satisfy p.

partition p m returns a pair of maps (m1, m2), where m1 contains all the bindings of s that satisfy the predicate p, and m2 is the map with all the bindings of s that do not satisfy p.

play_all es sched l runs every prover of list l on all goals and sub-goals of the session, with the given time limit.

the first n elements of a list

Split the previous function in two simpler functions

Print a subtree with a pstree format (cf Tree module)

Pretty-print a Call_provers.prover_answer

Pretty-print a prover_result.

Print a session with a pstree format (cf Tree module)

produce a realization of the given theory using the given driver

Return Some t if the proof is not obsolete and the result is valid.

prover_on_goal es sched ?cntexample ?timelimit p g same as redo_external_proof but creates or reuses existing proof_attempt

equality predicate

non-blocking function that reports any new updates from the server related to a given prover call.

read_channel ?format lang env file ch returns the contents of ch in language lang.

read_config conf_file : If conf_file is given, then, if it is an empty string, an empty config is loaded,, if the file doesn't exist, Rc.CannotOpen is raised,, otherwise the content of the file is parsed and returned., If conf_file is None and the WHY3CONFIG environment variable exists, then the above steps are executed with the content of the variable (possibly empty)., If neither conf_file nor WHY3CONFIG are present, the file "$HOME/.why3.conf" (or "$USERPROFILE/.why3.conf" under Windows) is checked for existence:, if present, the content is parsed and returned,, otherwise, we return the built-in default_config with a default configuration filename.

an open-close wrapper around read_channel

read_library lang env path returns the contents of the library file specified by path.

Read a session stored on the disk.

read_theory env path th returns the theory path.th from the library.

Recover all the sub-goal (not only strict) of this theory

register a new flag.

register_format ~desc lang fname exts parser registers a new format fname for files with extensions from the string list exts (without the separating dot).

register a new info flag.

register_language parent convert adds a leaf to the language tree.

With exclusive metas, each new meta cancels the previous one.

apply the previous function on this goal and its its sub-goal

remove the task stored in this goal

removes a key

remove x s returns a set containing the same elements as s, except for x.

remove x m returns a map containing the same bindings as m, except for x which is unbound in the returned map.

Remove a file

Remove the addition of metas

Returns a copy of labels without labels "model" and "model_projected".

remove_prefix pref s removes the prefix pref from s.

Remove a transformation

replace e x v m binds x to v in m if x is already bound, and raises e otherwise.

replay es sched ~obsolete_only ~context_unproved_goals_only a reruns proofs under a if obsolete_only is set then does not rerun non-obsolete proofs if context_unproved_goals_only is set then only rerun proofs whose previous answer was 'valid'

deletes all keys

raises Not_found if the argument is not a its_ts

retrieves a module from its underlying theory raises Not_found if no such module exists

restore_path id returns the triple (library path, module, qualified symbol name) if the ident was ever introduced in a module declaration.

restore_path id returns the triple (library path, theory, qualified symbol name) if the ident was ever introduced in a theory declaration.

raises Not_found if the argument is not a pl_ls

raises Not_found if the argument is not a pv_vs

run_external_proof es sched ?cntexample ?callback p reruns an existing proof attempt p

run_external_proof_v3 env_session sched pa ?cntexample callback the callback is applied with callback pa p limits old_result status.

run_prover es sched p a runs prover p on all goals under a the proof attempts are only scheduled for running, and they will be started asynchronously when processors are available.

generic sanitizer taking a separate encoder for the first letter

generic sanitizer taking a separate encoder for the first and last letter

save_config config save the configuration

Save a session on disk

run it when an action slot/worker/cpu is available.

Same as Rc.set_int but on bool

Same as Rc.set_intl but on bool

set_compare = compare (fun _ _ -> 0)

Set the formatter used when printing debug material

set_diff = diff (fun _ _ _ -> None)

set_disjoint = disjoint (fun _ _ _ -> false)

replace the set of editors

set_equal = equal (fun _ _ -> true)

set_family config name Same as Rc.set_family except name must not be prover

set_family rc name family add all the section in family using the associated string as argument of the family name in rc.

open one level or close all the sub-level

Modify the state of a flag

Set the flags selected by debug_all, debug or a shortcut.

set_int ?default section key value add the association key to value in the section if value is not default.

set_inter = inter (fun _ x _ -> Some x)

set_int ?default section key lvalue add the associations key to all the lvalue in the section if value is not default.

set_main config main replace the main section by the given one

set the prover shortcuts

set_prover_upgrade c p cpu sets or updates the policy to follow if the prover p is absent from the system

set_provers config provers replace all the family prover by the one given

set_section config name Same as Rc.set_section except name must not be "main"

set_section rc name section add a section section with name name in rc.

set_simple_family rc name family add all the section in family using the associated string as argument of the family name in rc.

Same as Rc.set_int but on string

Same as Rc.set_intl but on string

set_submap = submap (fun _ _ _ -> true)

set_union = union (fun _ x _ -> Some x)

singleton x returns the one-element set that contains x.

singleton x y returns the one-element map that contains a binding y for x.

verify that the spec corresponds to the result type

raises Not_found if the spec contains non-pv variables

split x s returns a triple (l, mem, r), where l is the set with all the elements of s that are strictly less than x; r is the set with all the elements of s that are strictly greater than x; mem is true if x belongs to s and false otherwise.

split x m returns a triple (l, data, r), where l is the map with all the bindings of m whose key is strictly less than x; r is the map with all the bindings of m whose key is strictly greater than x; data is None if m contains no binding for x, or Some v if m binds v to x.

split c s splits s into substrings, taking as delimiter the character c, and returns the list of substrings.

split_theory th s t returns the tasks of th added to t that end by one of s.

stack_trace flag

one task is started

start the enumeration of the given map

start the enumeration of the given map at the first key which is greater or equal than the given one

stepregexp s n creates a regular expression to match the number of steps.

one task is stopped without information

Uniquify string

subdomain pr m returns the set of keys of bindings in m that satisfy predicate pr

submap pr m1 m2 verifies that all the keys in m1 are in m2 and that for each such binding pr is verified.

subset s1 s2 tests whether the set s1 is a subset of s2.

t_app_partial ls tl tyl oty produces a closure of ls and applies it to tl using t_func_app.

t_closure ls tyl oty returns a type-instantiated lambda-term \xx:tyl.(ls xx : oty), or ls : oty if ls is a constant.

t_forall_close_merge vs f puts a universal quantifier over f; merges variable lists if f is already universally quantified; reuses triggers of f, if any, otherwise puts no triggers.

t_fold fnT fnF = t_fold (t_selecti fnT fnF)

t_func_app_beta f a applies f to a performing beta-reduction when f is a lambda-term.

t_is_lambda t returns true if t is a lambda-term.

t_lambda vl tr e produces a term eps f. (forall vl [tr]. f@vl = e) or eps f. (forall vl [tr]. f@vl = True <-> e if e is prop-typed.

t_map fnT fnF = t_map (t_select fnT fnF)

t_map_cont is t_map in continuation-passing style

t_map_sign passes a polarity parameter, unfolds if-then-else and iff

t_map_simp reconstructs the term using simplification constructors

t_nat_const n builds the constant integer term n, n must be non-negative

t_open_lambda t returns a triple (vl,tr,e), such that t is equal to t_lambda vl tr e.

the same as t_open_lambda but returns additionally an instance of t_lambda that restores the original term if applied to the physically same arguments.

t_pred_app_beta f a applies f to a performing beta-reduction when f is a lambda-term.

t_prop t checks that t is prop-typed and returns t

raises Not_found if the term contains non-pv variables

t_select fnT fnF t is fnT t if t is a value, fnF t otherwise

t_selecti fnT fnF acc t is t_select (fnT acc) (fnF acc) t

t_subst m t substitutes variables in t by the variable mapping m

t_subst_single v t1 t2 substitutes variable v in t2 by t1

t_subst_types mt mv t substitutes type variables by mapping mt simultaneously in substitution mv and in term t.

t_ty_check t ty checks that the type of t is ty

t_ty_subst mt mv t substitutes simultaneously type variables by mapping mt and term variables by mapping mv in term t

t_type t checks that t is value-typed and returns its type

task_separate_goal t returns a pair (g,t') where g is the goal of the task t and t' is the rest.

Return the state of the flag

a handler for functions that must be called after a given time elapsed, in milliseconds.

Converts a regular expression with special markers '%h','%m', '%s','%i' (for milliseconds) into a value of type timeregexp

to_channel cout rc writes the Rc rc to the output channel out

to_file filename rc writes the Rc rc to the file filename

to_formatter fmt rc writes the Rc rc to the formatter fmt

transform es sched tr a applies registered transformation tr on all leaf goals under a.

transform es sched tr g applies registered transformation tr on the given goal.

replace all the proof attempts of the given session by the application of the given registered transformation followed by a proof_attempt with the same prover and time limit (but undone)

translate f s translates the elements in the set s by the function f.

translate f m translates the keys in the map m by the function f.

the same as Ty.ts_tuple 0

ttrue constant function true

ty_closed ty returns true when ty is not polymorphic

traverse only one level of constructor, if you want full traversal you need to call those function inside your function

ty_match sigma0 pat sub returns a type substitution sigma such that sigma pat = sub.

all aliases expanded, all regions removed

convert arrows to the unit type

visits every symbol of the type

visits every variable of the type

When a prover must be called on a task but it is currently not installed, what policy to apply

union f s1 s2 computes the union of two sets

union f m1 m2 computes a map whose keys is a subset of keys of m1 and of m2.

return others, same name, same version

forces unloading of all provers, to force reading again the configuration

return the absolute path of the edited file update with the current goal

updates the configuration

Same as Session.update_session except initialization is done.

reload the given session with the given environnement : the files are reloaded, apply again the transformation, if some goals appear try to find to which goal in the given session it corresponds. The last case meant that the session was obsolete.

takes the result of used_theories and returns a map from symbol names to their theories of origin

returns a map from theory names to theories themselves

get the current key value pair of the enumeration, return None if the enumeration reach the end

Return the list of all values of the given map.

collect the type variables and regions in arguments and values, but ignores the spec

blocking function that waits until the prover finishes.