0mm

\Huge BinProlog Professional Edition\\ Predicate Cross-Reference Guide \\ \vskip 5cm

BinProlog Professional Edition
Predicate Cross-Reference Guide

Written by BinProlog Itself
under the kind regards of:

Paul Tarau
BinNet Corp.
WWW: http://www.binnetcorp.com

0.1 Undefined predicates, possibly intended to be imported

```
$hx/3
```

0.2 Unused predicates, possibly intended to be exported

0.3 Cross reference and info on predicates

0.3.1 Predicate:

# /3

INFO: bitwise XOR

EXAMPLE(S):

?-#(1,2,_A).
_A = 3;

no

0.3.2 Predicate:

(##)/1

INFO: executes arg 1 at compile time - make sure the executed code terminates

Calls:

0.3.71
```
arg/3
```
0.3.258
```
errmes/2
```
0.3.376
```
is_compiled/1
```

Is called from:

0.3.340
```
hash_clear/1
```
0.3.349
```
hash_put/2
```
0.3.350
```
hash_rm/2
```
0.3.351
```
hash_rm_one/2
```
0.3.498
```
numbervars/3
```
```
x_asserta/1
```
```
x_assertz/1
```
```
x_retractall/1
```

0.3.3 Predicate:

(#*)/3

INFO: (X): adds intuitionisic assumption *(X) to be used indefinitely by #- operation

0.3.4 Predicate:

(#+)/3

INFO: (X): adds linear assumption +(X) to be consumed at most once, by a #- operation

0.3.5 Predicate:

(#-)/3

INFO: (X): consumes +(X) linear assumption or matches *(X) intuitionistic assumption

0.3.6 Predicate:

(#:)/3

INFO: (X): matches X against current dcg token

0.3.7 Predicate:

(#<)/3

INFO: (Xs): sets the dcg token list to be Xs

0.3.8 Predicate:

(#=)/3

INFO: (X): unifies X with any matching existing or future +(X) linear assumptions

0.3.9 Predicate:

(#>)/3

INFO: (Xs): unifies current dcg token list with Xs

0.3.10 Predicate:

(#?)/3

INFO: (X): matches +(X) or *(X) assumptions without any binding

0.3.11 Predicate:

$process_catch/3

INFO: processes data sent by catch for throw

Calls:

0.3.168
```
copy_term/2
```
```
untrail_to/1
```

0.3.12 Predicate:

* /3

INFO: multiply

EXAMPLE(S):

?-*(10,3,_A).
_A = 30;

no

0.3.13 Predicate:

** /3

INFO: returns arg 1 at power arg 2, a float

EXAMPLE(S):

?-**(2,3,_A).
_A = 8;

no

0.3.14 Predicate:

(+)/2

INFO: returns 0 + arg 1

Calls:

0.3.15
```
(+)/3
```

0.3.15 Predicate:

(+)/3

INFO: add

EXAMPLE(S):

?-+(10,3,_A).
_A = 13;

no

Is called from:

0.3.14
```
(+)/2
```

0.3.16 Predicate:

(++)/3

INFO: concatenates N lists, usable in is/2

0.3.17 Predicate:

(,)/2

INFO: A,B succeeds if A suceeds and B, called after A, succeeds

0.3.18 Predicate:

(-)/2

INFO: returns 0 - arg 1

Calls:

0.3.19
```
(-)/3
```

0.3.19 Predicate:

(-)/3

INFO: subtract

EXAMPLE(S):

?--(10,3,_A).
_A = 7;

no

Is called from:

0.3.18
```
(-)/2
```

0.3.20 Predicate:

(->)/2

INFO: Cond->Then executes Cond once; if it succeeds it also executes Then

0.3.21 Predicate:

(.)/3

INFO: (Head,Tail,List) builds List=[Head|Tail]

0.3.22 Predicate:

/ /3

INFO: division

EXAMPLE(S):

?-/(10,3,_A).
_A = 3.33333333;

no

0.3.23 Predicate:

// /3

INFO: integer division

EXAMPLE(S):

?-//(10,3,_A).
_A = 3;

no

0.3.24 Predicate:

/\ /3

INFO: bitwise AND

EXAMPLE(S):

?-/\(1,2,_A).
_A = 0;

no

0.3.25 Predicate:

(::-)/2

INFO: variant of :- for hand transformed binary clauses - use with care

0.3.26 Predicate:

(;)/2

INFO: A;B succeeds if A succeeds or B, called after A, succeeds

0.3.27 Predicate:

(<)/2

INFO: numeric comparison

Calls:

0.3.392
```
less/2
```

Is called from:

0.3.247
```
dynco/1
```
0.3.308
```
get/1
```
0.3.596
```
sdebug/1
```
0.3.709
```
timed_call/4
```

0.3.28 Predicate:

<< /3

INFO: left shifts arg 1 by arg 2 bits

EXAMPLE(S):

?-<<(1,5,_A).
_A = 32;

no

0.3.29 Predicate:

(=)/2

INFO: (X,Y) true if (possibly cyclic) terms X and Y unify - cyclic terms can result from =/2, as occur check is not performed

EXAMPLE(S):

?-f(_A,s(a)) = f(_B,_B).
_A = s(a);
_B = s(a);

no

Is called from:

0.3.30 Predicate:

(=..)/2

INFO: called univ -this is bidirectional- it converts between a term and its view as a alist of components

EXAMPLE(S):

?-f(a,b) =.. _A.
_A = [f,a,b];

no

?-_A =.. [f,a,b].
_A = f(a,b);

no

Calls:

```
var/1
```

Is called from:

0.3.96
```
bagof/3
```
0.3.212
```
dcg_call/4
```
0.3.213
```
dcg_call/5
```
```
trim_term/4
```

0.3.31 Predicate:

(=:=)/2

INFO: numeric comparison

Calls:

0.3.74
```
arith_eq/2
```

Is called from:

0.3.140
```
char_of/2
```
0.3.313
```
get_char/2
```
```
unix_cat/1
```

0.3.32 Predicate:

(=<)/2

INFO: numeric comparison

Calls:

0.3.393
```
less_eq/2
```

Is called from:

0.3.297
```
free_thread_guard/1
```
0.3.448
```
min/3
```
0.3.553
```
quietmes/2
```
0.3.711
```
to_lower_char/2
```
0.3.715
```
to_upper_char/2
```

0.3.33 Predicate:

(==)/2

INFO: true if args are identical terms

Is called from:

0.3.56
```
addq/3
```
0.3.141
```
check_password/1
```
0.3.538
```
pushq/3
```
0.3.690
```
term_of/2
```

0.3.34 Predicate:

(=\=)/2

INFO: numeric comparison

Calls:

0.3.73
```
arith_dif/2
```

Is called from:

0.3.147
```
clean_up_engines/1
```

0.3.35 Predicate:

(>)/2

INFO: numeric comparison

Calls:

0.3.330
```
greater/2
```

Is called from:

0.3.228
```
default_this_port/1
```
0.3.308
```
get/1
```
0.3.338
```
has_threads/0
```
0.3.440
```
max/3
```
0.3.631
```
sign/2
```
0.3.709
```
timed_call/4
```

0.3.36 Predicate:

(>=)/2

INFO: numeric comparison

Calls:

0.3.331
```
greater_eq/2
```

Is called from:

0.3.53
```
abs/2
```
0.3.281
```
float/1
```
0.3.297
```
free_thread_guard/1
```
0.3.711
```
to_lower_char/2
```
0.3.715
```
to_upper_char/2
```

0.3.37 Predicate:

>> /3

INFO: right shifts arg 1 by arg 2 bits

EXAMPLE(S):

?->>(16,2,_A).
_A = 4;

no

0.3.38 Predicate:

@ /3

INFO: alternative form for C/3 DCG connect relation

Calls:

0.3.43
```
C/3
```

0.3.39 Predicate:

(@<)/2

INFO: instance of compare/3 with arg 1: <

0.3.40 Predicate:

(@=<)/2

INFO: instance of compare/3 with arg 1: = or <

0.3.41 Predicate:

(@>)/2

INFO: instance of compare/3 with arg 1: >

0.3.42 Predicate:

(@>=)/2

INFO: instance of compare/3 with arg 1: > or =

0.3.43 Predicate:

C/3

INFO: DCG connect predicate

Is called from:

0.3.38
```
@ /3
```
0.3.438
```
match_before/5
```
0.3.439
```
match_word/3
```

0.3.44 Predicate:

\ /2

INFO: complement

Calls:

0.3.45
```
\ /3
```

0.3.45 Predicate:

\ /3

INFO: bitwise or of first arg with bitwise complement of second

EXAMPLE(S):

?-\(0,2,_A).
_A = -3;

no

Is called from:

0.3.44
```
\ /2
```

0.3.46 Predicate:

(\+)/1

INFO: succeeds if its argument is executed and fails

Calls:

0.3.263
```
fail/0
```

0.3.47 Predicate:

\/ /3

INFO: bitwise OR

EXAMPLE(S):

?-\/(1,2,_A).
_A = 3;

no

0.3.48 Predicate:

(\=)/2

INFO: true if args fail to unify

Calls:

0.3.263
```
fail/0
```

0.3.49 Predicate:

(\==)/2

INFO: true if arg 1 is not identical to arg 2

Is called from:

0.3.56
```
addq/3
```
0.3.70
```
apropos/2
```
0.3.96
```
bagof/3
```
0.3.172
```
cpopq/3
```
0.3.336
```
has_info/1
```
0.3.538
```
pushq/3
```

0.3.50 Predicate:

^ /2

INFO: calls arg 2 and binds arg 1

EXAMPLE(S):

?-_A^eq(_A,1).
_A = 1;

no

0.3.51 Predicate:

abolish/1

INFO: abolish(F/N) deletes predicate F/N

Calls:

0.3.177
```
current_db/1
```
0.3.190
```
db_abolish/2
```
```
x_abolish/1
```

0.3.52 Predicate:

abort/0

INFO: returns to toplevel

Is called from:

0.3.401
```
load/1
```
0.3.441
```
mcompile/1
```
0.3.594
```
scompile/1
```

0.3.53 Predicate:

abs/2

INFO: int function

Calls:

0.3.29
```
(=)/2
```
0.3.36
```
(>=)/2
```
0.3.372
```
(is)/2
```

0.3.54 Predicate:

abstime/1

INFO: gets time in secs since arbitrary origin

EXAMPLE(S):

?-abstime(_A).
_A = 343415941;

no

Calls:

0.3.372
```
(is)/2
```
0.3.662
```
statistics/2
```

0.3.55 Predicate:

acos/2

INFO: float function

0.3.56 Predicate:

addq/3

INFO: adds to end of persistent queeue

EXAMPLE(S):

?-addq(key1,key2,33).

yes

Calls:

0.3.33
```
(==)/2
```
0.3.49
```
(\==)/2
```
0.3.99
```
bb_gc/0
```
0.3.148
```
clear_bp_error/0
```
0.3.265
```
fatal_error/2
```
0.3.312
```
get_bp_error/4
```

Is called from:

0.3.194
```
db_assertz/2
```
0.3.430
```
map_put/3
```
0.3.454
```
mmap_push/3
```
0.3.455
```
mmap_put/3
```

0.3.57 Predicate:

all/2

INFO: gets the list of terms matching arg 1 from Linda blackboard

Calls:

0.3.404
```
local_all/2
```

0.3.58 Predicate:

all/3

INFO: gets a selection arg 1 of terms matching arg 2 from Linda blackboard

Calls:

0.3.405
```
local_all/3
```

0.3.59 Predicate:

all_answers/3

INFO: (X,G,Xs): like findall/3, but such that if V is not common to X and G then V cannot be bound by execution of G

EXAMPLE(S):

?-all_answers(_A,member(s(_A),[_B,_C,_C,_D]),_E).
_A = _x149098;
_B = s(_x150167);
_C = s(_x150194);
_D = s(_x150248);
_E = [_x150167,_x150194,_x150194,_x150248];

no

0.3.60 Predicate:

all_but_at_least/4

INFO: (N,X,G,Xs) findall variant, computing all but the first N answers X of G

Calls:

0.3.242
```
drop_at_least/2
```

0.3.61 Predicate:

all_for/2

INFO: all_for(X,Xs) collects all constrained terms X on the blackboard to list Xs

0.3.62 Predicate:

and/2

INFO: conjunction, like comma

0.3.63 Predicate:

answer_of/2

INFO: (X,G): X is an answer for G, after finding all, sorting and removing duplicates

Calls:

0.3.442
```
member/2
```
0.3.646
```
sort/2
```

0.3.64 Predicate:

answer_one_query/2

INFO: handles a Jinni service S with password P

Is called from:

0.3.605
```
service_loop/2
```

0.3.65 Predicate:

append/3

INFO: concatenates/decomposes lists

EXAMPLE(S):

?-append([1,2],[3,4],_A).
_A = [1,2,3,4];

no

?-append(_A,_B,[1,2]).
_A = [];
_B = [1,2];

_A = [1];
_B = [2];

_A = [1,2];
_B = [];

no

Calls:

0.3.65
```
append/3
```

Is called from:

0.3.65
```
append/3
```
0.3.565
```
read_terms_from_chars/3
```
0.3.628
```
show_defaults/0
```

0.3.66 Predicate:

appendN/2

INFO: concatenates N lists

EXAMPLE(S):

?-appendN([[a,b],[],[c]],_A).
_A = [a,b,c];

no

0.3.67 Predicate:

append_conj/3

INFO: concatenates 2 conjunctions

0.3.68 Predicate:

append_disj/3

INFO: concatenates 2 disjunctions

0.3.69 Predicate:

apropos/1

INFO: prints names of predicates defined in the system

EXAMPLE(S):

?-apropos(garbage).
use info/1 to get a description of a predicate
garbage_collect/0-[built_in,performs heap gc now]

yes

Calls:

0.3.70
```
apropos/2
```
0.3.263
```
fail/0
```
0.3.442
```
member/2
```
0.3.484
```
nl/0
```
0.3.646
```
sort/2
```
```
write/1
```

Is called from:

0.3.356
```
help/1
```

0.3.70 Predicate:

apropos/2

INFO: returns names of predicates defined in the system

EXAMPLE(S):

?-apropos(retract,_A).
_A = retract/1-[built_in,backtracks over deleting matching clauses];

_A = retract1/1-[built_in,deletes first matching clause in the current database];

_A = retractall/1-[built_in,deletes all matching clauses];

_A = x_retract/1-[built_in,db hook, backtracks over deleting matching clauses];

_A = x_retractall/1-[built_in,db hook, deletes all matching clauses];

_A = db_retract/2-[built_in,does retract/1 arg 2 from database given as arg 1];

_A = db_retract/3-[built_in,db_retract(Db,H,B) retracts clause with head H and body B from database Db];

_A = db_retract1/2-[built_in,deletes from database given as arg 1 a matching clause];

_A = db_retractall/2-[built_in,removes from database given as arg 1, all matching clauses];

_A = db_retractall/3-[built_in,removes from database given as arg 1, all matching clauses seen as head + body];

_A = prolog:x_retract_each/1-[compiled];

_A = prolog:db_retractall0/3-[compiled];

_A = prolog:x_retract/2-[compiled];

_A = prolog:x_retract_args/5-[compiled];

no

Calls:

0.3.29
```
(=)/2
```
0.3.49
```
(\==)/2
```
0.3.116
```
bp_info/2
```
0.3.300
```
functor/3
```
0.3.471
```
name/2
```
0.3.473
```
near_match/2
```
0.3.525
```
predicate_property/2
```

Is called from:

0.3.69
```
apropos/1
```

0.3.71 Predicate:

arg/3

INFO: arg(I,T,X) extracts arg I of term T to be unified with X

EXAMPLE(S):

?-arg(2,f(a,b),_A).
_A = b;

no

Is called from:

0.3.72 Predicate:

argn/3

INFO: generates all n args of term

EXAMPLE(S):

?-argn(_A,f(a,b),_B).
_A = 1;
_B = a;

_A = 2;
_B = b;

no

Calls:

0.3.71
```
arg/3
```
0.3.289
```
for/3
```
0.3.300
```
functor/3
```
0.3.487
```
nonvar/1
```

0.3.73 Predicate:

arith_dif/2

INFO: arithemetic comparison

Is called from:

0.3.34
```
(=\=)/2
```

0.3.74 Predicate:

arith_eq/2

INFO: arithemetic comparison

Is called from:

0.3.31
```
(=:=)/2
```

0.3.75 Predicate:

array_get/3

INFO: gets and dereferences array element

Is called from:

0.3.136
```
cdelq/4
```
0.3.137
```
cdelq_any/3
```
0.3.157
```
cmembq/3
```
0.3.206
```
db_retract/3
```
```
vget/2
```

0.3.76 Predicate:

array_get0/3

INFO: gets  array element

Is called from:

```
vget0/2
```

0.3.77 Predicate:

array_set/3

INFO: sets array element

Is called from:

```
vset/2
```

0.3.78 Predicate:

asin/2

INFO: float function

0.3.79 Predicate:

ask/5

INFO: ask(ClientSocket,X,G,W,R): calls rpc server on on ClientSocket with query X goal G password W and gets result R back - supports socket reuse

Calls:

0.3.29
```
(=)/2
```

Is called from:

0.3.583
```
rpc/3
```

0.3.80 Predicate:

ask_engine/2

INFO: ask_engine(E,X) retrieves from engine E (a copy of) answer X

Is called from:

0.3.309
```
get/2
```

0.3.81 Predicate:

ask_thread/2

INFO: (E,R): asks an answer of engine E on a new thread R

Is called from:

0.3.114
```
bg/7
```

0.3.82 Predicate:

asm/0

INFO: shows transformations and readable BinWAM assembler for Prolog code entered at terminal

0.3.83 Predicate:

asm/1

INFO: generates readable binarized form and BinWAM assembler to a file

0.3.84 Predicate:

assert/1

INFO: adds a clause

Calls:

0.3.89
```
assertz/1
```

Is called from:

0.3.610
```
set_default/1
```

0.3.85 Predicate:

assert_from_chars/1

INFO: asserts a program from clauses in list of chars

Calls:

0.3.86
```
assert_from_chars/2
```
0.3.177
```
current_db/1
```

0.3.86 Predicate:

assert_from_chars/2

INFO: (Db,Cs) asserts to database Db, a set of clauses parsed from list of char codes Cs

Calls:

0.3.294
```
foreach/2
```

Is called from:

0.3.85
```
assert_from_chars/1
```

0.3.87 Predicate:

asserta/1

INFO: adds a clause to be first in a predicate definition

Calls:

0.3.177
```
current_db/1
```
0.3.192
```
db_asserta/2
```
```
x_asserta/1
```

0.3.88 Predicate:

asserted/1

INFO: runs a predicated if asserted

Calls:

0.3.143
```
clause/2
```
0.3.487
```
nonvar/1
```

0.3.89 Predicate:

assertz/1

INFO: adds a clause to be last in a predicate definition

Calls:

0.3.177
```
current_db/1
```
0.3.194
```
db_assertz/2
```
```
x_assertz/1
```

Is called from:

0.3.84
```
assert/1
```

0.3.90 Predicate:

atan/2

INFO: float function

0.3.91 Predicate:

atan2/3

INFO: float function

0.3.92 Predicate:

atom/1

INFO: true if symbol (functor of arity 0)

EXAMPLE(S):

?-atom(a).

yes

Calls:

0.3.95
```
atomic/1
```
0.3.263
```
fail/0
```
0.3.369
```
integer/1
```

Is called from:

0.3.94
```
atom_codes/2
```
0.3.277
```
find_file/2
```

0.3.93 Predicate:

atom_chars/2

INFO: (Atom,CharAtoms): converts between an atom and its list of char atoms representation

EXAMPLE(S):

?-atom_chars(hello,_A).
_A = [h,e,l,l,o];

no

?-atom_chars(_A,[104,101,108,108,111]).
no

Calls:

0.3.94
```
atom_codes/2
```
0.3.487
```
nonvar/1
```

0.3.94 Predicate:

atom_codes/2

INFO: (Atom,CharCodes): converts between an atom and its list of char code representation

EXAMPLE(S):

?-atom_codes(hello,_A).
_A = [104,101,108,108,111];

no

?-atom_codes(_A,[104,101,108,108,111]).
_A = hello;

no

Calls:

0.3.29
```
(=)/2
```
0.3.92
```
atom/1
```
0.3.471
```
name/2
```
0.3.495
```
number/1
```

Is called from:

0.3.93
```
atom_chars/2
```
0.3.397
```
listify/2
```
0.3.419
```
make_cmd/2
```
0.3.669
```
swrite/2
```
```
words_code/2
```

0.3.95 Predicate:

atomic/1

INFO: true if an integer or symbolic constant

Is called from:

0.3.92
```
atom/1
```
0.3.150
```
close/1
```
0.3.164
```
compound/1
```
0.3.421
```
make_compileable/2
```
0.3.498
```
numbervars/3
```
0.3.677
```
system/2
```
```
trim_term/4
```

0.3.96 Predicate:

bagof/3

INFO: all solutions predicate generating unsorted bags of possibly dupplicated answers

EXAMPLE(S):

?-bagof(_A,member(_A,[3,2,2,1]),_B).
_A = _x148833;
_B = [3,2,2,1];

no

Calls:

0.3.29
```
(=)/2
```
0.3.30
```
(=..)/2
```
0.3.49
```
(\==)/2
```
0.3.300
```
functor/3
```
0.3.390
```
keysort/2
```

0.3.97 Predicate:

bb/0

INFO: lists (long!) content of the blackboard

0.3.98 Predicate:

bb_def/3

INFO: bb_def(K1,K2,T) associates to K1 and K2 (a copy of) T on the blackboard

Is called from:

0.3.102
```
bb_let/3
```
0.3.430
```
map_put/3
```
0.3.710
```
to_engine/2
```

0.3.99 Predicate:

bb_gc/0

INFO: performs blackboard gc now, if enabled

Calls:

0.3.108
```
bbgc_status/1
```
0.3.128
```
call_ifdef/2
```
0.3.148
```
clear_bp_error/0
```
0.3.258
```
errmes/2
```
0.3.263
```
fail/0
```

Is called from:

0.3.56
```
addq/3
```
0.3.538
```
pushq/3
```

0.3.100 Predicate:

bb_gc0/0

INFO: performs blackboard gc now, in this engine

Calls:

0.3.103
```
bb_reset/1
```
0.3.168
```
copy_term/2
```
0.3.220
```
debugmes/1
```
0.3.263
```
fail/0
```
0.3.372
```
(is)/2
```
0.3.662
```
statistics/2
```

0.3.101 Predicate:

bb_get/3

INFO: bb_get(K1,K2,T) consumes the term T associated with K1 and K2

Calls:

0.3.104
```
bb_rm/2
```
0.3.106
```
bb_val/3
```

0.3.102 Predicate:

bb_let/3

INFO: bb_let(K1,K2,T) updates or defines the term associated with K1 and K2 to be T

Calls:

0.3.98
```
bb_def/3
```
0.3.105
```
bb_set/3
```

Is called from:

0.3.357
```
hide_default/1
```
0.3.367
```
init_gensym/1
```
0.3.608
```
set_c_threshold/2
```
0.3.649
```
(spy)/1
```

0.3.103 Predicate:

bb_reset/1

INFO: cleans up and resizes to at least arg 1 bytes compound term area of the blackboard

Is called from:

0.3.100
```
bb_gc0/0
```

0.3.104 Predicate:

bb_rm/2

INFO: removes the term associated with K1 and K2 from the blackboard

Is called from:

0.3.101
```
bb_get/3
```
0.3.298
```
from_engine/1
```
0.3.488
```
(nospy)/1
```

0.3.105 Predicate:

bb_set/3

INFO: bb_set(K1,K2,T) updates the term associated with K1 and K2 to be a copy of T

Is called from:

0.3.102
```
bb_let/3
```
0.3.430
```
map_put/3
```

0.3.106 Predicate:

bb_val/3

INFO: bb_val(K1,K2,T) T is (a copy of) the term associated with keys K1 and K2

Calls:

0.3.168
```
copy_term/2
```

Is called from:

0.3.101
```
bb_get/3
```
0.3.183
```
current_module/1
```
0.3.298
```
from_engine/1
```
0.3.383
```
is_module/1
```
0.3.385
```
is_prolog/1
```
0.3.427
```
map_get/3
```
0.3.627
```
show_default/1
```

0.3.107 Predicate:

bbgc/0

INFO: enables blackboard gc

0.3.108 Predicate:

bbgc_status/1

INFO: shows if blackboard gc is enabled or not

Calls:

```
vget0/2
```

Is called from:

0.3.99
```
bb_gc/0
```

0.3.109 Predicate:

begin_critical/0

INFO: begin serialized execution - enters critical region

Calls:

0.3.412
```
lock_thread_guard/1
```

Is called from:

0.3.596
```
sdebug/1
```

0.3.110 Predicate:

bg/1

INFO: runs Goal in background thread - you can set engine size like in heap(500)=>bg(...)

Calls:

0.3.111
```
bg/2
```

Is called from:

0.3.587
```
rpc_test/0
```

0.3.111 Predicate:

bg/2

INFO: runs Goal in new background thread, which is returned in second arg

Calls:

0.3.112
```
bg/3
```

Is called from:

0.3.110
```
bg/1
```

0.3.112 Predicate:

bg/3

INFO: bg(Goal,Thread,EngineAddr): runs goal in background if threads are available

Calls:

0.3.113
```
bg/4
```

Is called from:

0.3.111
```
bg/2
```
0.3.709
```
timed_call/4
```

0.3.113 Predicate:

bg/4

INFO: bg(Goal,Thread,EngineAddr,EngineID): runs goal in background on new engine - with unique EngineID

Calls:

0.3.114
```
bg/7
```

Is called from:

0.3.112
```
bg/3
```

0.3.114 Predicate:

bg/7

INFO: bg(Goal,H,S,T,-Thread,-EngineAddr,-EngineID): runs goal in background on engine with given heap,stack,trail

Calls:

0.3.81
```
ask_thread/2
```
0.3.220
```
debugmes/1
```
0.3.318
```
get_engine_id/2
```
0.3.338
```
has_threads/0
```
0.3.402
```
load_engine/3
```
```
topcall/1
```

Is called from:

0.3.113
```
bg/4
```
0.3.593
```
run_server/6
```

0.3.115 Predicate:

boot/0

INFO: regenerates file wam.bp in BinProlog src directory

Is called from:

0.3.567
```
reboot/0
```

0.3.116 Predicate:

bp_info/2

INFO: keeps basic help info on BinProlog builtins

Calls:

0.3.300
```
functor/3
```
0.3.372
```
(is)/2
```
0.3.487
```
nonvar/1
```

Is called from:

0.3.70
```
apropos/2
```

0.3.117 Predicate:

bp_only/1

INFO: runs goal only if is_prolog(binprolog) is true

Calls:

0.3.118
```
bp_only/2
```

0.3.118 Predicate:

bp_only/2

INFO: (Goal,Alternative): runs goal only if is_prolog(binprolog) is true otherwise runs Alternative

Calls:

0.3.385
```
is_prolog/1
```

Is called from:

0.3.117
```
bp_only/1
```

0.3.119 Predicate:

bp_val/3

INFO: unifies with 2 key indexed global logical variable

0.3.120 Predicate:

call/1

INFO: executes (atomic!) arg 1

0.3.121 Predicate:

call/2

INFO: efficient call/N variant

Calls:

0.3.686
```
term_append/3
```

Is called from:

0.3.364
```
include/1
```

0.3.122 Predicate:

call/3

INFO: efficient call/N variant

Calls:

0.3.686
```
term_append/3
```

0.3.123 Predicate:

call/4

INFO: efficient call/N variant

Calls:

0.3.686
```
term_append/3
```

Is called from:

0.3.165
```
compute/4
```

0.3.124 Predicate:

call/5

INFO: efficient call/N variant

Calls:

0.3.686
```
term_append/3
```

0.3.125 Predicate:

call/6

INFO: efficient call/N variant

Calls:

0.3.686
```
term_append/3
```

0.3.126 Predicate:

call/7

INFO: efficient call/N variant

Calls:

0.3.686
```
term_append/3
```

0.3.127 Predicate:

call_external/3

INFO: args: StringToStringFunctionAddress,InputChars,OuputChars - calls a C function

0.3.128 Predicate:

call_ifdef/2

INFO: calls if predicate head is defined, calls arg 2 if not

Calls:

0.3.220
```
debugmes/1
```
0.3.263
```
fail/0
```
0.3.376
```
is_compiled/1
```

Is called from:

0.3.99
```
bb_gc/0
```
0.3.533
```
prolog_load/1
```
0.3.574
```
restart/0
```
0.3.628
```
show_defaults/0
```
```
x_gc/0
```
```
xload/1
```

0.3.129 Predicate:

call_jinni/1

INFO: call_jinni(G) calls Jinni in Twin Prolog with first answer binding G and fails if no answers are found

Calls:

0.3.29
```
(=)/2
```
0.3.130
```
call_jinni/2
```

0.3.130 Predicate:

call_jinni/2

INFO: call_jinni(G,R) calls Jinni in Twin Prolog with first answer R=the(G) or R=no, without binding G

Calls:

0.3.131
```
call_jinni/3
```

Is called from:

0.3.129
```
call_jinni/1
```

0.3.131 Predicate:

call_jinni/3

INFO: call_jinni(X,G,R) calls Jinni in Twin Prolog with first answer R=the(X) or R=no, without binding G

Calls:

0.3.29
```
(=)/2
```

Is called from:

0.3.130
```
call_jinni/2
```
0.3.571
```
remote_run/6
```

0.3.132 Predicate:

callable/1

INFO: checks if predicate head is defined (callable)

Calls:

0.3.300
```
functor/3
```
0.3.376
```
is_compiled/1
```
0.3.378
```
is_dynamic/1
```
0.3.487
```
nonvar/1
```

Is called from:

0.3.222
```
default/2
```

0.3.133 Predicate:

catch/3

INFO: ISO Prolog exception operator: executes arg 1 and if it catches arg 2, it executes arg 3

Calls:

0.3.263
```
fail/0
```

0.3.134 Predicate:

cd/0

INFO: changes local dir to HOME directory or / if no such env var

0.3.135 Predicate:

cd/1

INFO: changes local dir to arg 1

Calls:

```
unix_cd/1
```

0.3.136 Predicate:

cdelq/4

INFO: deletes first matching element from a queue

EXAMPLE(S):

?-cdelq(key1,key2,_A,_B).
_A = _x148632;
_B = 33;

no

Calls:

0.3.75
```
array_get/3
```

Is called from:

0.3.190
```
db_abolish/2
```
0.3.207
```
db_retract1/2
```
0.3.426
```
map_gc/1
```
0.3.458
```
mmap_rm_one/3
```

0.3.137 Predicate:

cdelq_any/3

INFO: deletes any matching element from a queue

EXAMPLE(S):

?-cdelq_any(key1,key2,_A).
no

Calls:

0.3.75
```
array_get/3
```

Is called from:

0.3.456
```
mmap_rm/3
```

0.3.138 Predicate:

ceiling/2

INFO: float to int function

EXAMPLE(S):

?-ceiling(1.3,_A).
_A = 2;

no

Calls:

0.3.370
```
integer/2
```
0.3.372
```
(is)/2
```

0.3.139 Predicate:

change_arg/3

INFO: destructive: change_arg(I,T,X) replaces arg I of T with X

EXAMPLE(S):

?-change_arg(2,f(a,b),c).

yes

Is called from:

0.3.362
```
if_any/3
```

0.3.140 Predicate:

char_of/2

INFO: reads a Prolog file to a set of ascii codes - on backtracking

Calls:

0.3.141 Predicate:

check_password/1

INFO: checks that password matches default password

Calls:

0.3.33
```
(==)/2
```
0.3.225
```
default_password/1
```
0.3.258
```
errmes/2
```

0.3.142 Predicate:

cin/1

INFO: tries to get and remove a term from Linda blackboard

Calls:

0.3.406
```
local_cin/1
```

0.3.143 Predicate:

clause/2

INFO: clause(H,B) generates a clause with head matching H and body B

Calls:

0.3.177
```
current_db/1
```
0.3.195
```
db_clause/3
```
```
x_clause/2
```

Is called from:

0.3.88
```
asserted/1
```

0.3.144 Predicate:

clause_of/2

INFO: reads a Prolog file to a set of clauses - on backtracking

Calls:

0.3.690
```
term_of/2
```

0.3.145 Predicate:

clean_up_dead_engines/0

INFO: frees resources used by dead engines

Calls:

0.3.29
```
(=)/2
```
0.3.147
```
clean_up_engines/1
```

0.3.146 Predicate:

clean_up_engines/0

INFO: frees resources used by all engines except main

Calls:

0.3.147
```
clean_up_engines/1
```

0.3.147 Predicate:

clean_up_engines/1

INFO: internal predicate

Calls:

Is called from:

0.3.145
```
clean_up_dead_engines/0
```
0.3.146
```
clean_up_engines/0
```

0.3.148 Predicate:

clear_bp_error/0

INFO: clears errors set by various conditions

Calls:

0.3.606
```
set_bp_error/4
```

Is called from:

0.3.56
```
addq/3
```
0.3.99
```
bb_gc/0
```
0.3.538
```
pushq/3
```

0.3.149 Predicate:

clone_term/3

INFO: clone_term(Vs,T,CT) does copy_term(T,C) while keeping unchanged variables Vs - useful if doing things like setarg/3 on the new copy

EXAMPLE(S):

?-clone_term([_A,_C],f(_A,_B,_B,_C),_D).
_A = _x149609;
_B = _x148979;
_C = _x149612;
_D = f(_x149609,_x149610,_x149610,_x149612);

no

Calls:

0.3.168
```
copy_term/2
```

0.3.150 Predicate:

close/1

INFO: closes a stream opened by open/3

Calls:

0.3.95
```
atomic/1
```

0.3.151 Predicate:

close_iterator/1

INFO: (Iterator) closes an iterator

Calls:

0.3.691
```
term_store_op/4
```

Is called from:

0.3.311
```
get_all_terms/2
```

0.3.152 Predicate:

close_socket/1

INFO: closes a server, service or client

0.3.153 Predicate:

close_stream/2

INFO: (Type,StreamID) closes various streams

Is called from:

0.3.267
```
fclose/1
```

0.3.154 Predicate:

cmake/0

INFO: compiles BinProlog's Prolog components to compact C code - for packaging as standalone executable

Calls:

0.3.155
```
cmake/1
```

0.3.155 Predicate:

cmake/1

INFO: compiles a Project to compact C code - for packaging as standalone executable

Calls:

0.3.156
```
cmake/2
```

Is called from:

0.3.154
```
cmake/0
```

0.3.156 Predicate:

cmake/2

INFO: (Project,Module): compiles to C a project with all clauses belonging to Module

Is called from:

0.3.155
```
cmake/1
```
0.3.549
```
qmake/2
```

0.3.157 Predicate:

cmembq/3

INFO: generates (copies of) members of a queue

EXAMPLE(S):

?-cmembq(key1,key2,_A).
no

Calls:

0.3.75
```
array_get/3
```

Is called from:

0.3.195
```
db_clause/3
```
0.3.428
```
map_key/2
```
0.3.451
```
mmap_get/3
```
0.3.452
```
mmap_key/2
```

0.3.158 Predicate:

cnl/0

INFO: writes a new line

Is called from:

0.3.484
```
nl/0
```

0.3.159 Predicate:

co/0

INFO: reconsults/recompiles last file

Calls:

0.3.364
```
include/1
```

0.3.160 Predicate:

co/1

INFO: reconsults using fast reader

Calls:

0.3.568
```
reconsult/1
```

Is called from:

```
~ /1
```

0.3.161 Predicate:

codes_words/2

INFO: converts a list of character codes to a list of words and back

Calls:

0.3.718
```
to_words/2
```
```
var/1
```
```
words_code/2
```

Is called from:

0.3.566
```
read_words/1
```
0.3.603
```
sentence_of/2
```
0.3.719
```
token_of/2
```

0.3.162 Predicate:

compare/3

INFO: returns <,=,> in arg 1 after comparing arg 2 with arg 3

EXAMPLE(S):

?-compare(_A,1,2).
_A = (<);

no

?-compare(_A,f(b),f(a)).
_A = (>);

no

?-compare(_A,s(_B),s(_B)).
_A = (=);
_B = _x148979;

no

0.3.163 Predicate:

compile/1

INFO: applies current compilation method to the file arg 1

0.3.164 Predicate:

compound/1

INFO: true if it has arity > 0

EXAMPLE(S):

?-compound(f(a)).

yes

Calls:

0.3.95
```
atomic/1
```
0.3.487
```
nonvar/1
```

0.3.165 Predicate:

compute/4

INFO: applies Op to arg 2 and arg 3 giving a result

Calls:

0.3.123
```
call/4
```

0.3.166 Predicate:

consult/1

INFO: consults with possible duplication of clauses, allows later dynamic recompilation depending on db_ratio/1

Calls:

0.3.167
```
consult/2
```
0.3.177
```
current_db/1
```
```
x_consult/1
```

Is called from:

```
xload/1
```

0.3.167 Predicate:

consult/2

INFO: consult(File,DB) consults File into DB)

Calls:

0.3.198
```
db_consult/2
```

Is called from:

0.3.166
```
consult/1
```

0.3.168 Predicate:

copy_term/2

INFO: returns a copy of arg 1 with fresh variables

EXAMPLE(S):

?-copy_term(f(_A,_A,_B,_B),_C).
_A = _x148811;
_B = _x148813;
_C = f(_x149247,_x149247,_x149249,_x149249);

no

Is called from:

0.3.11
```
$process_catch/3
```
0.3.100
```
bb_gc0/0
```
0.3.106
```
bb_val/3
```
0.3.149
```
clone_term/3
```
0.3.695
```
the/3
```

0.3.169 Predicate:

cos/2

INFO: float function

0.3.170 Predicate:

count_terms/2

INFO: returns the number of terms attached to a key

Calls:

0.3.691
```
term_store_op/4
```

0.3.171 Predicate:

cout/1

INFO: adds a term to the blackboard, unless already a matching one is there

Calls:

0.3.407
```
local_cout/1
```

0.3.172 Predicate:

cpopq/3

INFO: pops (copy of) first element of persistent queue

EXAMPLE(S):

?-cpopq(key1,key2,_A).
no

Calls:

0.3.49
```
(\==)/2
```
0.3.258
```
errmes/2
```
0.3.312
```
get_bp_error/4
```

0.3.173 Predicate:

create_engine/1

INFO: makes a new engine or reuses a dead one

Is called from:

0.3.505
```
open_engine/3
```

0.3.174 Predicate:

create_engine/4

INFO: create_engine(Heap,Stack,Trail,IntHandle) creates an engine IntHandle

Is called from:

0.3.175
```
create_new_engine/1
```

0.3.175 Predicate:

create_new_engine/1

INFO: creates an engine as big as the current one

Calls:

0.3.174
```
create_engine/4
```

0.3.176 Predicate:

ctime/1

INFO: gets elapsed cpu time in ms

EXAMPLE(S):

?-ctime(_A).
_A = 4234;

no

Calls:

0.3.662
```
statistics/2
```

Is called from:

0.3.342
```
hash_compile/0
```
0.3.588
```
rpc_test/1
```
```
x_gc/0
```
```
x_traced_call/1
```

0.3.177 Predicate:

current_db/1

INFO: gets the name of currently active database

Calls:

```
vget0/2
```

Is called from:

0.3.178 Predicate:

current_engine/1

INFO: gets the unique id of the current engine

Calls:

0.3.180
```
current_engine_id/1
```

0.3.179 Predicate:

current_engine_addr/1

INFO: returns current engine handle

Is called from:

0.3.180
```
current_engine_id/1
```
0.3.181
```
current_engine_thread/1
```

BinProlog Professional Edition Predicate Cross-Reference Guide

Written by BinProlog Itself under the kind regards of: Paul Tarau BinNet Corp. WWW: http://www.binnetcorp.com

0.1 Undefined predicates, possibly intended to be imported

0.2 Unused predicates, possibly intended to be exported

0.3 Cross reference and info on predicates

0.3.1 Predicate:

0.3.2 Predicate:

0.3.3 Predicate:

0.3.4 Predicate:

0.3.5 Predicate:

0.3.6 Predicate:

0.3.7 Predicate:

0.3.8 Predicate:

0.3.9 Predicate:

0.3.10 Predicate:

0.3.11 Predicate:

0.3.12 Predicate:

0.3.13 Predicate:

0.3.14 Predicate:

0.3.15 Predicate:

0.3.16 Predicate:

0.3.17 Predicate:

0.3.18 Predicate:

0.3.19 Predicate:

0.3.20 Predicate:

0.3.21 Predicate:

0.3.22 Predicate:

0.3.23 Predicate:

0.3.24 Predicate:

0.3.25 Predicate:

0.3.26 Predicate:

0.3.27 Predicate:

0.3.28 Predicate:

0.3.29 Predicate:

0.3.30 Predicate:

0.3.31 Predicate:

0.3.32 Predicate:

0.3.33 Predicate:

0.3.34 Predicate:

0.3.35 Predicate:

0.3.36 Predicate:

0.3.37 Predicate:

0.3.38 Predicate:

0.3.39 Predicate:

0.3.40 Predicate:

0.3.41 Predicate:

0.3.42 Predicate:

0.3.43 Predicate:

0.3.44 Predicate:

0.3.45 Predicate:

0.3.46 Predicate:

0.3.47 Predicate:

0.3.48 Predicate:

0.3.49 Predicate:

0.3.50 Predicate:

0.3.51 Predicate:

0.3.52 Predicate:

0.3.53 Predicate:

0.3.54 Predicate:

0.3.55 Predicate:

0.3.56 Predicate:

0.3.57 Predicate:

0.3.58 Predicate:

0.3.59 Predicate:

0.3.60 Predicate:

0.3.61 Predicate:

0.3.62 Predicate:

0.3.63 Predicate:

0.3.64 Predicate:

0.3.65 Predicate:

0.3.66 Predicate:

0.3.67 Predicate:

0.3.68 Predicate:

0.3.69 Predicate:

0.3.70 Predicate:

0.3.71 Predicate:

0.3.72 Predicate:

0.3.73 Predicate:

0.3.74 Predicate:

0.3.75 Predicate:

BinProlog Professional Edition
Predicate Cross-Reference Guide

Written by BinProlog Itself
under the kind regards of:

Paul Tarau
BinNet Corp.
WWW: http://www.binnetcorp.com