Skip to content
GitLab
Projects
Groups
Snippets
Help
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
why3
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
124
Issues
124
List
Boards
Labels
Service Desk
Milestones
Merge Requests
15
Merge Requests
15
Operations
Operations
Incidents
Packages & Registries
Packages & Registries
Container Registry
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
Why3
why3
Commits
33ececbc
Commit
33ececbc
authored
Aug 20, 2014
by
MARCHE Claude
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
fix API doc
parent
0e6b3e63
Changes
3
Hide whitespace changes
Inline
Side-by-side
Showing
3 changed files
with
31 additions
and
21 deletions
+31
-21
Makefile.in
Makefile.in
+1
-1
src/core/term.mli
src/core/term.mli
+20
-15
src/core/ty.mli
src/core/ty.mli
+10
-5
No files found.
Makefile.in
View file @
33ececbc
...
...
@@ -1689,7 +1689,7 @@ doc/apidoc:
apidoc
:
doc/apidoc $(FILESTODOC)
$(OCAMLDOC)
-d
doc/apidoc
-html
-t
"Why3 API documentation"
\
-keep-code
$(INCLUDES)
\
$(LIBINCLUDES)
-I
lib/why3
$(FILESTODOC)
$(LIBINCLUDES)
$(LIBSESSIONINCLUDES)
-I
lib/why3
$(FILESTODOC)
# could we include also the dependency graph ? -- someone
# At least we can give a way to create it -- francois
...
...
src/core/term.mli
View file @
33ececbc
...
...
@@ -9,11 +9,11 @@
(* *)
(********************************************************************)
(** Terms and Formulas *)
open
Ident
open
Ty
(** Terms and Formulas *)
(** {2 Variable symbols} *)
type
vsymbol
=
private
{
...
...
@@ -145,13 +145,13 @@ module Mterm : Extmap.S with type key = term
module
Sterm
:
Extset
.
S
with
module
M
=
Mterm
module
Hterm
:
Exthtbl
.
S
with
type
key
=
term
(**
term equality modulo alpha-equivalence and location
*)
(**
{2 term equality modulo alpha-equivalence and location}
*)
val
t_compare
:
term
->
term
->
int
val
t_equal
:
term
->
term
->
bool
val
t_hash
:
term
->
int
(**
Bindings
*)
(**
{2 Bindings}
*)
(** close bindings *)
...
...
@@ -177,7 +177,7 @@ val t_open_quant_cb :
term_quant
->
vsymbol
list
*
trigger
*
term
*
(
vsymbol
list
->
trigger
->
term
->
term_quant
)
(**
Type checking
*)
(**
{2 Type checking}
*)
exception
TermExpected
of
term
exception
FmlaExpected
of
term
...
...
@@ -191,7 +191,7 @@ val t_prop : term -> term
val
t_ty_check
:
term
->
ty
option
->
unit
(** [t_ty_check t ty] checks that the type of [t] is [ty] *)
(**
Smart constructors for terms and formulas
*)
(**
{2 Smart constructors for terms and formulas}
*)
val
t_app
:
lsymbol
->
term
list
->
ty
option
->
term
val
fs_app
:
lsymbol
->
term
list
->
ty
->
term
...
...
@@ -274,9 +274,10 @@ val t_forall_close_merge : vsymbol list -> term -> term
merges variable lists if [f] is already universally quantified;
reuses triggers of [f], if any, otherwise puts no triggers. *)
(**
Built-in symbols
*)
(**
{2 Built-in symbols}
*)
val
ps_equ
:
lsymbol
(* equality predicate *)
val
ps_equ
:
lsymbol
(** equality predicate *)
val
t_equ
:
term
->
term
->
term
val
t_neq
:
term
->
term
->
term
...
...
@@ -373,7 +374,7 @@ module TermTF : sig
(
'
a
->
term
->
'
a
*
term
)
->
'
a
->
trigger
->
'
a
*
trigger
end
(**
Map/fold over free variables
*)
(**
{2 Map/fold over free variables}
*)
val
t_v_map
:
(
vsymbol
->
term
)
->
term
->
term
val
t_v_fold
:
(
'
a
->
vsymbol
->
'
a
)
->
'
a
->
term
->
'
a
...
...
@@ -384,14 +385,18 @@ val t_v_count : ('a -> vsymbol -> int -> 'a) -> 'a -> term -> 'a
val
t_v_occurs
:
vsymbol
->
term
->
int
(**
Variable substitution
*)
(**
{2 Variable substitution}
*)
val
t_subst
:
term
Mvs
.
t
->
term
->
term
val
t_subst_single
:
vsymbol
->
term
->
term
->
term
(** [t_subst_single v t1 t2] substitutes variable [v] in [t2] by [t1] *)
val
t_subst
:
term
Mvs
.
t
->
term
->
term
(** [t_subst m t] substitutes variables in [t] by the variable mapping [m] *)
val
t_ty_subst
:
ty
Mtv
.
t
->
term
Mvs
.
t
->
term
->
term
(** [t_ty_subst mt mv t] substitutes simultaneously type variables by
mapping [mt] and term variables by mapping [mv] in term [t] *)
(**
Find free variables and type variables
*)
(**
{2 Find free variables and type variables}
*)
val
t_closed
:
term
->
bool
...
...
@@ -401,7 +406,7 @@ val t_freevars : int Mvs.t -> term -> int Mvs.t
val
t_ty_freevars
:
Stv
.
t
->
term
->
Stv
.
t
(**
Map/fold over types and logical symbols in terms and patterns
*)
(**
{2 Map/fold over types and logical symbols in terms and patterns}
*)
val
t_gen_map
:
(
ty
->
ty
)
->
(
lsymbol
->
lsymbol
)
->
vsymbol
Mvs
.
t
->
term
->
term
...
...
@@ -415,7 +420,7 @@ val t_s_any : (ty -> bool) -> (lsymbol -> bool) -> term -> bool
val
t_ty_map
:
(
ty
->
ty
)
->
term
->
term
val
t_ty_fold
:
(
'
a
->
ty
->
'
a
)
->
'
a
->
term
->
'
a
(* Map/fold over applications in terms (but not in patterns!) *)
(*
*
Map/fold over applications in terms (but not in patterns!) *)
val
t_app_map
:
(
lsymbol
->
ty
list
->
ty
option
->
lsymbol
)
->
term
->
term
...
...
@@ -423,7 +428,7 @@ val t_app_map :
val
t_app_fold
:
(
'
a
->
lsymbol
->
ty
list
->
ty
option
->
'
a
)
->
'
a
->
term
->
'
a
(**
Subterm occurrence check and replacement
*)
(**
{2 Subterm occurrence check and replacement}
*)
val
t_occurs
:
term
->
term
->
bool
val
t_replace
:
term
->
term
->
term
->
term
src/core/ty.mli
View file @
33ececbc
...
...
@@ -9,9 +9,11 @@
(* *)
(********************************************************************)
(** Types *)
open
Ident
(**
Types
*)
(**
{2 Type variables}
*)
type
tvsymbol
=
private
{
tv_name
:
ident
;
...
...
@@ -29,7 +31,7 @@ val create_tvsymbol : preid -> tvsymbol
val
tv_of_string
:
string
->
tvsymbol
(*
type symbols and types
*)
(*
* {2 Type symbols and types}
*)
type
tysymbol
=
private
{
ts_name
:
ident
;
...
...
@@ -74,7 +76,8 @@ val create_tysymbol : preid -> tvsymbol list -> ty option -> tysymbol
val
ty_var
:
tvsymbol
->
ty
val
ty_app
:
tysymbol
->
ty
list
->
ty
(** {3 generic traversal functions} *)
(** {2 Generic traversal functions} *)
(** traverse only one level of constructor, if you want full traversal
you need to call those function inside your function *)
val
ty_map
:
(
ty
->
ty
)
->
ty
->
ty
...
...
@@ -82,14 +85,16 @@ val ty_fold : ('a -> ty -> 'a) -> 'a -> ty -> 'a
val
ty_all
:
(
ty
->
bool
)
->
ty
->
bool
val
ty_any
:
(
ty
->
bool
)
->
ty
->
bool
(** {3 variable-wise map/fold} *)
(** {2 Variable-wise map/fold} *)
(** visits every variable of the type *)
val
ty_v_map
:
(
tvsymbol
->
ty
)
->
ty
->
ty
val
ty_v_fold
:
(
'
a
->
tvsymbol
->
'
a
)
->
'
a
->
ty
->
'
a
val
ty_v_all
:
(
tvsymbol
->
bool
)
->
ty
->
bool
val
ty_v_any
:
(
tvsymbol
->
bool
)
->
ty
->
bool
(** {3 symbol-wise map/fold} *)
(** {2 Symbol-wise map/fold} *)
(** visits every symbol of the type *)
val
ty_s_map
:
(
tysymbol
->
tysymbol
)
->
ty
->
ty
val
ty_s_fold
:
(
'
a
->
tysymbol
->
'
a
)
->
'
a
->
ty
->
'
a
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment