Author(s): Alan Robinson, David H.D. Warren.
Version: 0.1#3 (2001/1/2)
This is where general comments on the file go. In this case the file is a library which contains some assertion examples for testing the automatic documentation system.
example_module
):- use_module(library(example_module)).
bar
.
user
:
foo
.
assertions/native_props
,
engine/basic_props
.
hiord_rt
,
arithmetic
,
atomic_basic
,
attributes
,
basic_props
,
basiccontrol
,
data_facts
,
exceptions
,
io_aux
,
io_basic
,
prolog_flags
,
streams_basic
,
system_info
,
term_basic
,
term_compare
,
term_typing
.
example_module
)
Usage: bar(X)
X
is an acceptable kind of bar.
A regular type, defined as follows:
baz(a). baz(b).
A regular type, defined as follows:
aorb(a). aorb(b).
A regular type, defined as follows:
tree_of(_1,void). tree_of(T,tree(_1,_2,_3)) :- call(T,_1), tree_of(T,_2), tree_of(T,_3).
A regular type, defined as follows:
list_or_aorb(T,_1) :- list(T,_1). list_or_aorb(_T,_1) :- aorb(_1).
Usage 1: list(L)
L
is a list.
Usage 2: list(L)
L
is a list.
Usage 1: q(A)
A
is a list.
(list/1
)
A
is a list.
(list/1
)
A
is ground.
(gnd/1
)
q(A)
do not fail.
(not_fails/1
)
Usage 2: q(A)
The predicate is of type dynamic.
Usage 1:
Arg1
is a free variable.
(var/1
)
Arg2
is ground.
(gnd/1
)
Arg2
is an integer.
(int/1
)
Arg1
is ground.
(gnd/1
)
Arg1
is an integer.
(int/1
)
Arg2
is an integer.
(int/1
)
Usage 2:
Arg1
is an integer.
(int/1
)
Arg2
is a list.
(list/1
)
The predicate is of type data.
Usage: r(A)
A
is a list.
(list/1
)
A
is a list of int
s.
(list/2
)
A
is ground.
(gnd/1
)
r(A)
do not fail.
(not_fails/1
)
No further documentation available for this predicate.
Usage: t(+A,-B,?(C),@(D),og(E))
+A
is a list.
(list/1
)
-B
is a list.
(list/1
)
?(C)
is an integer.
(int/1
)
@(D)
is an integer.
(int/1
)
og(E)
is a list.
(list/1
)
B
is rather long.
(long/1
)
C
is ground.
(gnd/1
)
A
is ground.
(gnd/1
)
t(+A,-B,?(C),@(D),og(E))
do not fail.
(not_fails/1
)
Usage 2:
Arg1
is an integer.
(int/1
)
Arg2
is a list of mytype
s.
(list/2
)
Arg3
is an integer.
(int/1
)
Usage: p(og(int),in,@(list(int)),-,+A)
1+length(A)
is a lower bound on the cost of any call of the form p(og(int),in,@(list(int)),-,+A)
.
(steps_lb/2
)
This is a property, describing a list that is longish. The definition is:
long(L) :- length(L,N), N>100.
Usage: long(L)
L
is rather long.
Usage 1: list(L)
L
is a list.
Usage 2: list(L)
L
is a list.
example_module
)A general comment on the predicate.
The predicate is multifile.
The predicate is of type dynamic.
General properties:
Arg1
is ground.
(gnd/1
)
Arg2
is a free variable.
(var/1
)
Arg3
is a free variable.
(var/1
)
foo(Arg1)
(undefined property)
Arg2
is an acceptable kind of bar.
(bar/1
)
baz(Arg3)
(baz/1
)
Arg1
is an integer.
(int/1
)
Arg2
is an integer.
(int/1
)
Arg3
is a free variable.
(var/1
)
then the following properties should hold upon exit:
Arg1
is an integer.
(int/1
)
Arg2
is an integer.
(int/1
)
Arg3
is ground.
(gnd/1
)
Arg1
is an integer.
(int/1
)
Arg2
is an integer.
(int/1
)
Arg3
is a free variable.
(var/1
)
then the following properties should hold globally:
All the calls of the form p(Arg1,Arg2,Arg3)
do not fail.
(not_fails/1
)
Usage 1: * ISO *
Arg1
is an integer.
(int/1
)
Arg2
is an integer.
(int/1
)
Arg3
is a free variable.
(var/1
)
Arg1
is an integer.
(int/1
)
Arg2
is an integer.
(int/1
)
Arg3
is a list.
(list/1
)
iso/1
)
All the calls of the form p(Arg1,Arg2,Arg3)
do not fail.
(not_fails/1
)
Usage 2: p(Preds,Value,Assoc)
Preds
is a free variable.
(var/1
)
Value
is a free variable.
(var/1
)
Assoc
is a list.
(list/1
)
Preds
is an integer.
(int/1
)
Value
is an integer.
(int/1
)
Assoc
is a list.
(list/1
)
p(Preds,Value,Assoc)
do not fail.
(not_fails/1
)
Usage 3:
Arg1
is a list.
(list/1
)
Arg2
is an integer.
(int/1
)
Arg3
is a list.
(list/1
)
p(Arg1,Arg2,Arg3)
do not fail.
(not_fails/1
)
All the calls of the form p(Arg1,Arg2,Arg3)
do not fail.
(not_fails/1
)
example_module
)
Usage: s(A)
A
is a list.
(list/1
)
A
is a list.
(list/1
)
A
is ground.
(gnd/1
)
s(A)
do not fail.
(not_fails/1
)
Usage 1: list(L,T)
L
is a list of T
s.
Usage 2: list(L,T)
L
is a list of T
s.
Usage: og(A,T)
call(T,A)
(undefined property)
A
is ground.
(gnd/1
)
Usage: Num is Expr
Expr
is an arithmetic expression.
(arithexpression/1
)
Num
is a number.
(num/1
)
Go to the first, previous, next, last section, table of contents.