The BinProlog API: Prolog built-ins and their descriptions

Total number of documented built-ins: 817

!/0 : succeeds like true/0, but removes pending choices in calls at its LEFT and makes things look as if this were the LAST clause of the predicate
# /3 : bitwise XOR
```
EXAMPLE(S): 
?-#(1,2,_A).
_A = 3;

no
```
(##)/1 : executes arg 1 at compile time - make sure the executed code terminates
(#*)/3 : (X): adds intuitionisic assumption *(X) to be used indefinitely by #- operation
(#+)/3 : (X): adds linear assumption +(X) to be consumed at most once, by a #- operation
(#-)/3 : (X): consumes +(X) linear assumption or matches *(X) intuitionistic assumption
(#:)/3 : (X): matches X against current dcg token
(#<)/3 : (Xs): sets the dcg token list to be Xs
(#=)/3 : (X): unifies X with any matching existing or future +(X) linear assumptions
(#>)/3 : (Xs): unifies current dcg token list with Xs
(#?)/3 : (X): matches +(X) or *(X) assumptions without any binding
$catch_looking_for_throw/1 : (CatchThrowData): continuation marker used by catch/throw
$hx/3 : hidden compiled hashed database predicate
$process_catch/3 : processes data sent by catch for throw

* /3 : multiply

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

no

** /3 : returns arg 1 at power arg 2, a float
```
EXAMPLE(S): 
?-**(2,3,_A).
_A = 8;

no
```
(+)/2 : returns 0 + arg 1

(+)/3 : add

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

no

(++)/3 : concatenates N lists, usable in is/2
(,)/2 : A,B succeeds if A suceeds and B, called after A, succeeds
(-)/2 : returns 0 - arg 1
(-)/3 : subtract
```
EXAMPLE(S): 
?--(10,3,_A).
_A = 7;

no
```
(->)/2 : Cond->Then executes Cond once; if it succeeds it also executes Then
(.)/3 : (Head,Tail,List) builds List=[Head|Tail]

/ /3 : division

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

no

// /3 : integer division

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

no

/\ /3 : bitwise AND
```
EXAMPLE(S): 
?-/\(1,2,_A).
_A = 0;

no
```
: /2 : M:P calls predicate P hidden in module M
(::-)/2 : variant of :- for hand transformed binary clauses - use with care
(;)/2 : A;B succeeds if A succeeds or B, called after A, succeeds
(<)/2 : numeric comparison

<< /3 : left shifts arg 1 by arg 2 bits

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

no

(=)/2 : (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
```
(=..)/2 : 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
```
(=:=)/2 : numeric comparison
(=<)/2 : numeric comparison
(==)/2 : true if args are identical terms
(=\=)/2 : numeric comparison
(>)/2 : numeric comparison
(>=)/2 : numeric comparison

>> /3 : right shifts arg 1 by arg 2 bits

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

no

@ /3 : alternative form for C/3 DCG connect relation
(@<)/2 : instance of compare/3 with arg 1: <
(@=<)/2 : instance of compare/3 with arg 1: = or <
(@>)/2 : instance of compare/3 with arg 1: >
(@>=)/2 : instance of compare/3 with arg 1: > or =
C/3 : DCG connect predicate
\ /2 : complement
\ /3 : bitwise or of first arg with bitwise complement of second
```
EXAMPLE(S): 
?-\(0,2,_A).
_A = -3;

no
```
(\+)/1 : succeeds if its argument is executed and fails
\/ /3 : bitwise OR
```
EXAMPLE(S): 
?-\/(1,2,_A).
_A = 3;

no
```
(\=)/2 : true if args fail to unify
(\==)/2 : true if arg 1 is not identical to arg 2

^ /2 : calls arg 2 and binds arg 1

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

no

abolish/1 : abolish(F/N) deletes predicate F/N
abort/0 : returns to toplevel
abs/2 : int function

abstime/1 : gets time in secs since arbitrary origin

EXAMPLE(S): 
?-abstime(_A).
_A = 343416141;

no

acos/2 : float function

addq/3 : adds to end of persistent queeue

EXAMPLE(S): 
?-addq(key1,key2,33).

yes

all/2 : gets the list of terms matching arg 1 from Linda blackboard
all/3 : gets a selection arg 1 of terms matching arg 2 from Linda blackboard

all_answers/3 : (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 = _x61091;
_B = s(_x62212);
_C = s(_x62239);
_D = s(_x62293);
_E = [_x62212,_x62239,_x62239,_x62293];

no

all_but_at_least/4 : (N,X,G,Xs) findall variant, computing all but the first N answers X of G
all_for/2 : all_for(X,Xs) collects all constrained terms X on the blackboard to list Xs
and/2 : conjunction, like comma
answer_of/2 : (X,G): X is an answer for G, after finding all, sorting and removing duplicates
answer_one_query/2 : handles a Jinni service S with password P

append/3 : 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

appendN/2 : concatenates N lists

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

no

append_conj/3 : concatenates 2 conjunctions
append_disj/3 : concatenates 2 disjunctions

apropos/1 : 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

apropos/2 : 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

arg/3 : 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
```

argn/3 : generates all n args of term

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

_A = 2;
_B = b;

no

arith_dif/2 : arithemetic comparison
arith_eq/2 : arithemetic comparison
array_get/3 : gets and dereferences array element
array_get0/3 : gets array element
array_set/3 : sets array element
asin/2 : float function
ask/5 : 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
ask_engine/2 : ask_engine(E,X) retrieves from engine E (a copy of) answer X
ask_thread/2 : (E,R): asks an answer of engine E on a new thread R
asm/0 : shows transformations and readable BinWAM assembler for Prolog code entered at terminal
asm/1 : generates readable binarized form and BinWAM assembler to a file
assert/1 : adds a clause
assert_from_chars/1 : asserts a program from clauses in list of chars
assert_from_chars/2 : (Db,Cs) asserts to database Db, a set of clauses parsed from list of char codes Cs
asserta/1 : adds a clause to be first in a predicate definition
asserted/1 : runs a predicated if asserted
assertz/1 : adds a clause to be last in a predicate definition
atan/2 : float function
atan2/3 : float function
atom/1 : true if symbol (functor of arity 0)
```
EXAMPLE(S): 
?-atom(a).

yes
```

atom_chars/2 : (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

atom_codes/2 : (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

atomic/1 : true if an integer or symbolic constant
bagof/3 : all solutions predicate generating unsorted bags of possibly dupplicated answers
```
EXAMPLE(S): 
?-bagof(_A,member(_A,[3,2,2,1]),_B).
_A = _x61091;
_B = [3,2,2,1];

no
```
bb/0 : lists (long!) content of the blackboard
bb_def/3 : bb_def(K1,K2,T) associates to K1 and K2 (a copy of) T on the blackboard
bb_gc/0 : performs blackboard gc now, if enabled
bb_gc0/0 : performs blackboard gc now, in this engine
bb_get/3 : bb_get(K1,K2,T) consumes the term T associated with K1 and K2
bb_let/3 : bb_let(K1,K2,T) updates or defines the term associated with K1 and K2 to be T
bb_reset/1 : cleans up and resizes to at least arg 1 bytes compound term area of the blackboard
bb_rm/2 : removes the term associated with K1 and K2 from the blackboard
bb_set/3 : bb_set(K1,K2,T) updates the term associated with K1 and K2 to be a copy of T
bb_val/3 : bb_val(K1,K2,T) T is (a copy of) the term associated with keys K1 and K2
bbgc/0 : enables blackboard gc
bbgc_status/1 : shows if blackboard gc is enabled or not
begin_critical/0 : begin serialized execution - enters critical region
bg/1 : runs Goal in background thread - you can set engine size like in heap(500)=>bg(...)
bg/2 : runs Goal in new background thread, which is returned in second arg
bg/3 : bg(Goal,Thread,EngineAddr): runs goal in background if threads are available
bg/4 : bg(Goal,Thread,EngineAddr,EngineID): runs goal in background on new engine - with unique EngineID
bg/7 : bg(Goal,H,S,T,-Thread,-EngineAddr,-EngineID): runs goal in background on engine with given heap,stack,trail
bincall/2 : call binary predicate with given continuation
boot/0 : regenerates file wam.bp in BinProlog src directory
bp_info/2 : keeps basic help info on BinProlog builtins
bp_only/1 : runs goal only if is_prolog(binprolog) is true
bp_only/2 : (Goal,Alternative): runs goal only if is_prolog(binprolog) is true otherwise runs Alternative
bp_val/3 : unifies with 2 key indexed global logical variable
call/1 : executes (atomic!) arg 1
call/2 : efficient call/N variant
call/3 : efficient call/N variant
call/4 : efficient call/N variant
call/5 : efficient call/N variant
call/6 : efficient call/N variant
call/7 : efficient call/N variant
call_cont/1 : calls arg 1 as current continuation
call_external/3 : args: StringToStringFunctionAddress,InputChars,OuputChars - calls a C function
call_ifdef/2 : calls if predicate head is defined, calls arg 2 if not
call_jinni/1 : call_jinni(G) calls Jinni in Twin Prolog with first answer binding G and fails if no answers are found
call_jinni/2 : call_jinni(G,R) calls Jinni in Twin Prolog with first answer R=the(G) or R=no, without binding G
call_jinni/3 : call_jinni(X,G,R) calls Jinni in Twin Prolog with first answer R=the(X) or R=no, without binding G
callable/1 : checks if predicate head is defined (callable)
catch/3 : ISO Prolog exception operator: executes arg 1 and if it catches arg 2, it executes arg 3
cd/0 : changes local dir to HOME directory or / if no such env var
cd/1 : changes local dir to arg 1

cdelq/4 : deletes first matching element from a queue

EXAMPLE(S): 
?-cdelq(key1,key2,_A,_B).
_A = _x61095;
_B = 33;

no

cdelq_any/3 : deletes any matching element from a queue
```
EXAMPLE(S): 
?-cdelq_any(key1,key2,_A).
no
```

ceiling/2 : float to int function

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

no

change_arg/3 : destructive: change_arg(I,T,X) replaces arg I of T with X
```
EXAMPLE(S): 
?-change_arg(2,f(a,b),c).

yes
```
char_of/2 : reads a Prolog file to a set of ascii codes - on backtracking
check_password/1 : checks that password matches default password
cin/1 : tries to get and remove a term from Linda blackboard
clause/2 : clause(H,B) generates a clause with head matching H and body B
clause_of/2 : reads a Prolog file to a set of clauses - on backtracking
clean_up_dead_engines/0 : frees resources used by dead engines
clean_up_engines/0 : frees resources used by all engines except main
clean_up_engines/1 : internal predicate
clear_bp_error/0 : clears errors set by various conditions

clone_term/3 : 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 = _x61783;
_B = _x61101;
_C = _x61786;
_D = f(_x61783,_x61784,_x61784,_x61786);

no

close/1 : closes a stream opened by open/3
close_iterator/1 : (Iterator) closes an iterator
close_socket/1 : closes a server, service or client
close_stream/2 : (Type,StreamID) closes various streams
cmake/0 : compiles BinProlog's Prolog components to compact C code - for packaging as standalone executable
cmake/1 : compiles a Project to compact C code - for packaging as standalone executable
cmake/2 : (Project,Module): compiles to C a project with all clauses belonging to Module
cmembq/3 : generates (copies of) members of a queue
```
EXAMPLE(S): 
?-cmembq(key1,key2,_A).
no
```
cnl/0 : writes a new line
co/0 : reconsults/recompiles last file
co/1 : reconsults using fast reader
codes_words/2 : converts a list of character codes to a list of words and back

compare/3 : 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 = _x61101;

no

compile/1 : applies current compilation method to the file arg 1
compound/1 : true if it has arity > 0
```
EXAMPLE(S): 
?-compound(f(a)).

yes
```
compute/4 : applies Op to arg 2 and arg 3 giving a result
consult/1 : consults with possible duplication of clauses, allows later dynamic recompilation depending on db_ratio/1
consult/2 : consult(File,DB) consults File into DB)

copy_term/2 : returns a copy of arg 1 with fresh variables

EXAMPLE(S): 
?-copy_term(f(_A,_A,_B,_B),_C).
_A = _x61092;
_B = _x61094;
_C = f(_x61580,_x61580,_x61582,_x61582);

no

cos/2 : float function
count_terms/2 : returns the number of terms attached to a key
cout/1 : adds a term to the blackboard, unless already a matching one is there
cpopq/3 : pops (copy of) first element of persistent queue
```
EXAMPLE(S): 
?-cpopq(key1,key2,_A).
no
```
create_engine/1 : makes a new engine or reuses a dead one
create_engine/4 : create_engine(Heap,Stack,Trail,IntHandle) creates an engine IntHandle
create_new_engine/1 : creates an engine as big as the current one

ctime/1 : gets elapsed cpu time in ms

EXAMPLE(S): 
?-ctime(_A).
_A = 265;

no

current_db/1 : gets the name of currently active database
current_engine/1 : gets the unique id of the current engine
current_engine_addr/1 : returns current engine handle
current_engine_id/1 : returns a unique id associated to an engine at creation time
current_engine_thread/1 : gets from the current Engine the thread it is running on
current_input/1 : gets current input stream
current_module/1 : gets name of current module
current_op/3 : generates/check current op/3 operator definition(s)
current_output/1 : gets current output stream
current_predicate/1 : generates/checks the head of an existing predicate
current_predicate/2 : generates/checks name and head of a currently defined predicate
current_thread/1 : gets thread id number of current thread
cut_to/1 : cuts to an int in arg 1, a choicepoint address
cwrite/1 : basic but quick C-version of write/1
db_abolish/2 : db_abolish(DB,F/N) removes predicate F/N from DB
db_assert/2 : does assert/1 arg 2 into database given as arg 1
db_asserta/2 : does asserta/1 arg 2 into database given as arg 1
db_asserted/2 : runs predicate arg 2 if asserted in database arg 1
db_assertz/2 : does assertz/1 arg 2 into database given as arg 1
db_clause/3 : clause(DB,H,B) generates a clause found in database DB with head matching H and body B
db_clean/0 : abolishes all predicates in currently active database
db_clean/1 : db_clean(DB) abolishes all predicates in DB
db_consult/2 : db_consult(File,Db) consults a file to a database Db
db_head/2 : generates/checks a predicate head in database (arg 1)
db_is_dynamic/2 : checks if dynamic in a given database
db_listing/1 : lists caluses given database
db_listing/2 : lists predicate F/N in given database
db_move/2 : db_move(FromDB,ToDB) moves the content of database FromDB over database ToDB while replacing similar predicates
db_ratio/1 : sets/gets call/assert ratio which triggers dynamic recompilation
db_retract/2 : does retract/1 arg 2 from database given as arg 1
db_retract/3 : db_retract(Db,H,B) retracts clause with head H and body B from database Db
db_retract1/2 : deletes from database given as arg 1 a matching clause
db_retractall/2 : removes from database given as arg 1, all matching clauses
db_retractall/3 : removes from database given as arg 1, all matching clauses seen as head + body
db_save/1 : db_save(File) saves all the clauses of the current database to File
db_save/2 : db_save(Db,File) saves using qprint/1 all the clauses of Db to File
dcg_call/4 : (F,X,I,O): DCG metacall for star,plus,one
dcg_call/5 : (F,X,Y,I,O): DCG metacall for star,plus,one
dcg_connect/1 : handles a terminal symbol in HAGs, as [a] in DCGs
dcg_def/1 : backtrackable: sets current Assumption Grammar stream - usually a hidden DCG list
dcg_tell/1 : switches to hidden DCG-stream number K (form 0 to MAXDCG=255)
dcg_telling/1 : retrieves which hidden DCG-stream we a re processing
```
EXAMPLE(S): 
?-dcg_telling(_A).
_A = 1;

no
```
dcg_val/1 : backtrackable: retrieves current Assumption Grammar stream - usually a hidden DCG list
dconsult/1 : reconsult/1 variant: cleans up data areas, consults/compiles based on db_ratio/1
debugmes/1 : writes message in debug mode (low quietness)

deep_hash/4 : (Key,Depth,Mod) computes hashvalue of Key modulo Mod, up to max recursion Depth

EXAMPLE(S): 
?-deep_hash(f(a),5,0,_A).
_A = 23114257;

no
?-deep_hash(f(b),1,32,_A).
_A = 18;

no

default/2 : default that can be overriden if asserted

EXAMPLE(S): 
?-default(host(_A),_A = localhost).
_A = localhost;

no

default_host/1 : returns default host for remote Linda server
default_login/1 : returns default (nick)name for user
default_password/1 : returns default password for user
default_port/1 : returns default port for remote Linda server
default_this_host/1 : returns default IP address or hostname this machine
default_this_port/1 : returns default port to work as a server on
default_timeout/1 : returns default timeout
delete_all_terms/1 : (GroundKey) removes all terms attached to a key
destroy_array/1 : frees an array
destroy_engine/1 : destroy_engine(E) frees memory of engine E (an integer)
det_call/1 : calls a Goal and warns if it was not deterministic
detect_ip_addr/1 : the ip address of current host, if detected, that of localhost if not
detect_user/1 : guesses the user from environment information
dir/0 : lists files under DOS
dir2dirs/2 : (Dir,Dirs): converts dir cmd output to list of sub directories of Dir
dir2files/2 : (Dir,Files): converts dir cmd output to list of files (which are not dirs) contained in Dir
dir2list/3 : (DirListerCmd,DirName,Files): converts OS specific DirLister output to list of files and/or directories
(discontiguous)/1 : states that clauses of a predicate can be in different places
display/1 : writes to terminal while ignoring operator definitions
drop_at_least/2 : (N,Goal) drops at least N answers of Goal G
dyn2stat/1 : dyn2stat(H): compiles at runtime a predicate with head H
dyn2stat/2 : dyn2stat(Db,H): compiles at a predicate from database Db with head H
(dynamic)/1 : states that a predicate can be updated
dynbbgc/0 : makes blackboard dynamic with gc on
dynco/1 : yes/no: activates/desactivates dynamic recompilation
ed/0 : edits last compiled/consulted file with default editor and refreshes it in memory
edit/0 : calls DOS editor edit on last compiled file
edit/2 : edit(E,F) edits with editor E, file F
element_of/2 : (Engine,Answer: backtracks over the answers of a fluent (usually an engine)
emacs/0 : calls emacs editor on last compiled file
end_critical/0 : ends serialized execution - exits critical region
end_module/0 : ends current module
end_module/1 : ends module if current, signals erro if not
end_of_file/0 : Prolog atom returned by read when at the end of a file
eq/2 : unifies arg 1 and arg 2, like =
errmes/2 : writes error message and fails
exists_file/1 : true if file exists
exit/0 : same as halt
exp/2 : float function
expand_term/2 : expands a term according to DCG expansion rules
fail/0 : always fails
false/0 : always fails
fatal_error/2 : writes error message and aborts
fcall/3 : calls a list to list function: to be implemented
fclose/1 : closes the C-stream specifiend as an integer handle
fcompile/1 : compiles a *.pl file to a *.wam bytecode file
fflush/1 : fflush(IntegerStreamNo) flushes a C-stream
fgetc/2 : fgetc(IntegerStreamNo,CharCode) inputs a char code from a C stream
file2chars/2 : reads a file to a list of ascii codes
file2sock/2 : writes to a socket, from a file
file_cmd_hook/2 : file_cmd_hook(Cmd,Db): allows defining user actions on commands read from files
file_extension_list/1 : defines default file extensions for find_file
file_search_path/1 : defines search path relative to BP_PATH (home of BinProlog) and PROLOG_PATH (home of user files)
file_size/2 : returns the size of a file, in bytes
find_at_most/4 : (N,X,G,Xs) findall variant, computing at most N answers X of G
find_file/2 : finds a file name on search path
find_while/4 : findall variant
findall/3 : findall(X,G,Xs) collects copies of all answers X of G to Xs. If less then half of the heap is free, it allocates new engine for running G
```
EXAMPLE(S): 
?-findall(s(_A),(member(_A,[1,2,3]),_A > 1),_B).
_A = _x61095;
_B = [s(2),s(3)];

no
```

findall/4 : findall(X,G,Xs,Ys) appends the list of answers X of G to Ys to obtain Xs

EXAMPLE(S): 
?-findall(s(_A),(_A = 1 ; _A = 2),_B,[3,4]).
_A = _x61102;
_B = [s(1),s(2),3,4];

no

float/1 : true if represented as a 64 bit float number (C-double)
```
EXAMPLE(S): 
?-float(3.14).

yes
```
float/2 : float function

floor/2 : float to int function

EXAMPLE(S): 
?-floor(1.3,_A).
_A = 1;

no

flush_output/0 : flushes current output stream
flush_output/1 : flushes a stream
foldl/4 : (Op,InitialValue,List,?Result) accumulates values interating over List with binary Op
```
EXAMPLE(S): 
?-foldl(+,0,[10,20,30],_A).
_A = 60;

no
```
foldr/4 : (Op,InitialValue,List,?Result) accumulates values interating over List with binary Op
```
EXAMPLE(S): 
?-foldr(+,0,[10,20,30],_A).
_A = 60;

no
```
fopen/3 : Prolog equivalent of C-function: opens a stream in a given mode and returns an integer handle to it

for/3 : generates an integer in a range

EXAMPLE(S): 
?-for(_A,1,3).
_A = 1;

_A = 2;

_A = 3;

no

for_all/2 : foreach(A,B) fails for all cases when A succeeds and B fails
forall/1 : forall(G) backtracks over all answers to G and succeeds
forall/2 : forall(G,D) executes D once for each answer of generator G
foreach/1 : foreach(G) backtracks over all answers to G and succeeds
foreach/2 : foreach(G,D) executes D once for each answer of generator G
fputc/2 : fputc(IntegerStreamNo,CharCode) outputs a char code to a C stream
free_term/1 : (Handle): frees external term given as a Handle
free_thread_guard/1 : gives back to pool thread guard in arg 1
from_engine/1 : (T) tries to take a term T from the message box of this engine and sets the message box empty
fsize/2 : returns the size of the file associated to a C stream, in bytes

functor/3 : builds or decomposes a coumpound term

EXAMPLE(S): 
?-functor(f(a,b),_A,_B).
_A = f;
_B = 2;

no
?-functor(_A,f,3).
_A = f(_x61710,_x61711,_x61712);

no
?-functor(f(a),f,1).

yes

garbage_collect/0 : performs heap gc now
gc/0 : enables heap gc
gc_call/1 : G: executes G and ensures that no more space is consumed than the total size of the terms bound to its variables
gc_status/1 : shows if heap gc is enabled or not
generic_write/1 : overridable write/1, style (writeq, write, display) given with write_style/1 assumption
gensym/2 : generates a new name based on arg 1
gensym_no/2 : generates a new number based on arg 1
get/1 : inputs the next char code after skiping over white space
get/2 : get(E,A) returns a new answer A=the(...) from engine E or returns no if no (more) answers exist
get0/1 : reads a char as an ascii code
get_all_terms/2 : (GroundKey,Ts) collects to alist all terms attached to a key
get_bp_error/4 : (Id,Mes,Arg1,Arg2): gets error sate from emulator
get_char/2 : (Stream,CharAsOneLetterConstant): inputs a char from a stream -ISO Prolog
get_code/1 : ISO char code reader
get_code/2 : inputs a char code from a stream - ISO
get_cont/1 : captures current continuation, usually an cyclic term
get_critical/2 : (Guard,Data): accesses mutex Guard protected Data on blackboard
get_deep_cut/2 : gets a choice point address, used with 1 arg only
get_engine_id/2 : (+Engine,-Id) gets the unique id associated to an engine at creation time
get_engine_prop/3 : args: Engine,PropertyNo,Val
get_engine_thread/2 : gets from an Engine the thread it is running on
get_lineno/1 : gets line number counter in current file
get_load_method/1 : gets the current load method by name
get_neck_cut/1 : gets the choice point as an integer
get_next_term/2 : (Iterator,Term) returns the next term attached to an iterator, fails if no more left
get_password/1 : gets default password for user
get_term/2 : (Iterator,Term): backtracks over terms associated to a key
global_get/3 : (A,B,X): retrieves X associated to ground keys A,B
global_rm/2 : (A,B): removes value associated to ground keys A,B
global_set/3 : (A,B,X): associates X to ground keys A,B
greater/2 : arithemetic comparison
greater_eq/2 : arithemetic comparison
ground/1 : true if arg has no free variables
```
EXAMPLE(S): 
?-ground(f(a,b)).

yes
```
halt/0 : stops BinProlog
halt/1 : stops Prolog with given return code when used in main thread- or halts current thread
handle_service/2 : handles a Jinni service S with password P - always succedes
has_info/1 : checks/generates predicates Pred/Arity for which info is available
has_terms/1 : (GroundKey) succeds if at least on term is attached to GroundKey
has_threads/0 : succeeds if threads available on this platform
hash_clear/0 : removes all terms from all hash keys
hash_clear/1 : (GroundKey) removes all terms attached to a key
hash_clear/2 : (GroundKey,Term) removes all matching terms attached to a key
hash_compile/0 : compiles the hashed map to a predicate benefiting from 1-arg indexing
hash_find_unique/3 : like findall(X,G,Xs) but uses hashing on ground term X to collect unique answers
hash_gc/0 : frees space used by hash keys and values
hash_get/2 : (GroundKey,Term) retrieves in constant time a term attached to a ground key
hash_key/1 : (IntKey) backtrack over hash keys
hash_load/1 : (File) loads the hashed map to a database
hash_push/2 : (GroundKey,Term): attaches a term to a ground key in constant time as a the first element
hash_put/2 : (GroundKey,Term): attaches a term to a ground key in constant time as the last element
hash_rm/2 : (GroundKey) removes a term attached to a key and returns it - backtracks
hash_rm_one/2 : (GroundKey) removes a term attached to a key and returns it
hash_save/1 : (File) saves the hashed map to a database ready for 1-arg indexing if compiled
hash_save/2 : (File,PredNMame) saves the hashed map to a database in predicate PredName ready for 1-arg indexing if compiled
hash_trace/2 : tracer for hash maps
help/0 : generates file help.txt with info and examples

help/1 : same as apropos/1

EXAMPLE(S): 
?-help(assert).
use info/1 to get a description of a predicate
assert/1-[built_in,adds a clause]
assert_from_chars/1-[built_in,asserts a program from clauses in list of chars]
assert_from_chars/2-[built_in,(Db,Cs) asserts to database Db, a set of clauses parsed from list of char codes Cs]
asserta/1-[built_in,adds a clause to be first in a predicate definition]
asserted/1-[built_in,runs a predicated if asserted]
assertz/1-[built_in,adds a clause to be last in a predicate definition]
db_assert/2-[built_in,does assert/1 arg 2 into database given as arg 1]
db_asserta/2-[built_in,does asserta/1 arg 2 into database given as arg 1]
db_asserted/2-[built_in,runs predicate arg 2 if asserted in database arg 1]
db_assertz/2-[built_in,does assertz/1 arg 2 into database given as arg 1]
get_asserted/2-[built_in]
is_asserted/1-[built_in,checks if currently asserted]
prolog:assert_it/2-[compiled]
prolog:db_is_asserted/2-[compiled]
prolog:is_asserted_clause/1-[compiled]
prolog:x_assert/2-[compiled]
prolog:x_assert_op/3-[compiled]
x_asserta/1-[built_in,db hook, adds a clause to be first in a predicate definition]
x_assertz/1-[built_in,db hook, adds a clause to be last in a predicate definition]

yes

hide_default/1 : makes unavailable a default value

hkey/2 : computes hash code on atomic argument; fails on variables and compound terms

EXAMPLE(S): 
?-hkey(t(a,b),_A).
_A = 236945626;

no
?-hkey(t(a,c),_A).
_A = 236945625;

no

host/1 : assumes default host for Linda server
host2ip/2 : converts a host name to an IP address
hostname/1 : the name of current host, if detected, localhost if not
hypot/3 : float function
if_any/3 : (Cond,Then,Else): executes Cond; each time when Cond succeeds it also executes Then; if Cond never succeds it executes Else
in/1 : waits to remove a term from Linda blackboard
include/1 : includes/loads a file with current load method, unless it has already been included by the same method
info/0 : generates info on predicates with examples
info/1 : generates info and examples of use for predicate Pred/Arity
init_gensym/1 : resets gensym for names based on arg 1
init_io/0 : intialises fast C-based IO routines
instance_of/2 : (Handle,Term): creates an internal instance of an external term given as a Handle
integer/1 : true if an integer
integer/2 : float to int cast
interactive/1 : toggles interactive query answering/tracing with arg 1 = yes or no
(is)/2 : calls the function evaluator, mostly for arithmetics
```
EXAMPLE(S): 
?-_A is 3+4*2.
_A = 11;

no
```
is_an/1 : true if an alphanumerical char code
is_asserted/1 : checks if currently asserted

is_builtin/1 : recognizes a predicate head as a builtin

EXAMPLE(S): 
?-is_builtin(var(_A)).
_A = _x61088;

no

is_compiled/1 : true if head of a compiled predicate
is_discontiguous/1 : checks if a predicate has been declared as discontiguous
is_dynamic/1 : checks if dynamic
is_engine/1 : recognizes and integer as an engine handle
is_interactive/0 : checks if toplevel is interactive - use interactive/1 with yes/no to set it the way you want it
is_maj/1 : true if is an upper case char code
is_min/1 : true if a lower case char code
is_module/1 : recognizes/generates a module name
is_num/1 : true if a digit char code
is_prolog/1 : recognizes binprolog - useful for portability
is_public/1 : checks predicate head if globally visible
is_spec/1 : true if a spacial character code
is_terminator/1 : true if a terminator character code

keygroup/3 : sorts while grouping similar keys

EXAMPLE(S): 
?-keygroup([3-a,1-a,2-b,1-c,2-d],_A,_B).
_A = 1;
_B = [a,c];

_A = 2;
_B = [b,d];

_A = 3;
_B = [a];

no

keysort/2 : sorts while putting similar keys one after the other in a list

EXAMPLE(S): 
?-keysort([3-a,1-a,2-b,1-c,2-d],_A).
_A = [1-a,1-c,2-b,2-d,3-a];

no

length/2 : generates/mesures length of a list
less/2 : arithemetic comparison
less_eq/2 : arithemetic comparison
line_of/2 : (File,Line) reads a file to lines ending with eol - on backtracking
list_engines/0 : prints out the list of active engines
list_engines/1 : lists available engine handles
listify/2 : (T,Cs): transforms T, unless it is already such, to list of chars
listing/0 : lists current database
listing/1 : lists given predicate if in current database
listing/2 : lists predicate F of arity N if in current database
load/1 : clean loads from a bytecode *.wam file
load_engine/3 : load_engine(E,Goal,Answer) prepares engine E to execute Goal/Answer

load_method/2 : args: Number, Name

EXAMPLE(S): 
?-load_method(_A,_B).
_A = 1;
_B = mcompile;

_A = 2;
_B = scompile;

_A = 3;
_B = oconsult;

_A = 4;
_B = dconsult;

_A = 5;
_B = sconsult;

_A = 6;
_B = load;

no

local_all/2 : local_all(X,Xs) collects all facts matching X on the blackboard
local_all/3 : local_all(X,G,Xs) collects facts X such that G on the blackboard
local_cin/1 : removes a term if available on the local blackboard
local_cout/1 : puts a term on local blackbord unless already there
local_in/1 : waits for a term produced by a matching local_out/1
local_out/1 : produces a term and possibly wakes up the thread at a matching local_in/1
local_rd/1 : tests if a term is available on the local blackboard
local_when/1 : waits until a term is available on the local blackboard
lock_thread_guard/1 : locks thread guard created with new_thread_guard
log/2 : float function
log/3 : returns log in base arg 1 of arg 2, a float
```
EXAMPLE(S): 
?-log(2,8,_A).
_A = 3;

no
```
login/1 : assumes default (nick)name for user
ls/0 : list files under Unix
ls2list/2 : (Dir,Files): converts ls cmd output to list of files and dirs
lval/3 : backtrackable: lval(K1,K2,V) associates V to keys K1 and K2
```
EXAMPLE(S): 
?-lval(a,b,f(_A)).
_A = _x61110;

no
```
main/0 : user defined optional startup predicate
main/1 : default entry predicate, does both prolog_init/1 and prolog_run/1
make_array/2 : creates an array
make_cmd/2 : concatenates a list of strings and atomic elements into an atom
make_cmd0/2 : concatenates a list of strings and atomic elements into a string
make_compileable/2 : make_compilable(Files,File) rewrites Files as a canonical File with all predicates contiguous and no operators
make_spaced_cmd/2 : concatenates a list of elements with inserted space separtors into an atom

map/2 : maps a predicate with 1 arg to a list

EXAMPLE(S): 
?-map(println,[10,20,30]).
10
20
30

yes

map/3 : maps a predicate with 2 args to a list

EXAMPLE(S): 
?-map(+1,[10,20],_A).
_A = [11,21];

no

map_clear/1 : (D): empties and cleans up D
map_gc/1 : (D): frees unused memory in D
map_get/3 : (D,K,V): gets V, given K in map D, backtracks over K if K unbound
map_key/2 : (D,K): succeds if K is known, otherwise finds V backtracks over each key K in D
map_new/1 : (D): returns a new map handle D
map_put/3 : (D,K,V): adds K,V to map D
map_rm/2 : (D,K): removes key K from map D
map_show/1 : (D): lists the content of a map
maps_clean/0 : empties and cleans up all maps created with mmap_new
maps_gc/0 : frees memory for all maps created with mmap_new
maps_iterate/1 : (D): backtracks over map handles created with mmap_new D
maps_show/0 : lists the content of all maps created with mmap_new
match_before/4 : match_before(+Stop,-Word,I,O): matches a word with DCGs until a given delimiter is hit
match_before/5 : match_before(+Stops,-Word,-Stop,I,O): matches a word with DCGs until a given delimiter set is hit, one of which is also returned
match_word/3 : match_word(+Word,I,O): matches/consumes a word, in the conext of DCGs
max/3 : (X,Y,Max): Max is the max of 2 numbers X, Y
mcompile/1 : compile/1 variant: cleans up data areas and compiles to memory
member/2 : (X,Xs): checks if an element X unifies with an element on a list Xs or generates sucessively longer lists if Xs is unbound or open ended
```
EXAMPLE(S): 
?-member(2,[1,2]).

yes
?-member(_A,[1,2]).
_A = 1;

_A = 2;

no
```
member_conj/2 : like member/2, for a comma separated conjunction, ending with true
```
EXAMPLE(S): 
?-member_conj(_A,(a,b,true)).
_A = a;

_A = b;

no
```

member_scan/3 : finds first element without unifying to it

EXAMPLE(S): 
?-member_scan(s(_A),[1,s(s(_B)),2],_C).
_A = _x61111;
_B = _x61121;
_C = [s(s(_x61121)),2];

no

memberchk/2 : (X,Xs) checks if an X is a the list Xs

merge_sort/3 : (Order,List,Sorted)

EXAMPLE(S): 
?-merge_sort(>,[1,3,2,2,4],_A).
_A = [4,3,2,2,1];

no

metacall/1 : calls the interpreter
metatrue/0 : calls the interpreter on current continuation
min/3 : (X,Y,Min): Min is the min of 2 numbers X, Y
mmap_clear/1 : (D): empties and cleans up D
mmap_gc/1 : (D): frees unused memory in D
mmap_get/3 : (D,K,V): gets V, given K in mmap D, backtracks over K if K unbound
mmap_key/2 : (D,K): succeds if K is known, otherwise finds V backtracks over each key K in D
mmap_new/1 : (D): returns a new mmap handle D - a mmap holds multiple elements for each key
mmap_push/3 : (D,K,V): adds K,V as the first element of mmap D
mmap_put/3 : (D,K,V): adds K,V as the last element of mmap D
mmap_rm/3 : (D,K,X): removes a term X attached to key K from mmap D and backtracks on each such term
mmap_rm_all/2 : (D,K): removes all terms X attached to key K from mmap D
mmap_rm_one/3 : (D,K,X): removes first term X attached to key K from mmap D
mmap_show/1 : (D): lists the content of a mmap
mmaps_clean/0 : empties and cleans up all mmaps created with mmap_new
mmaps_gc/0 : frees memory for all mmaps created with mmap_new
mmaps_iterate/1 : (D): backtracks over mmap handles created with mmap_new D
mmaps_show/0 : lists the content of all mmaps created with mmap_new

mod/3 : modulo

EXAMPLE(S): 
?-mod(10,3,_A).
_A = 1;

no

(mode)/1 : accepts mode declarations although we are not using them currently
(module)/1 : starts a module
(module)/2 : starts a module specifying a list of visible predicates
modules/1 : returns a list of existing modules

msort/2 : sorts and keeps duplicates

EXAMPLE(S): 
?-msort([2,1,3,1,4,4,2],_A).
_A = [1,1,2,2,3,4,4];

no

(multifile)/1 : states that clauses of a predicate can be in different files

name/2 : bidirectional: converts atomic to/from list of chars

EXAMPLE(S): 
?-name(hello,_A).
_A = [104,101,108,108,111];

no
?-name(_A,[98,121,101]).
_A = bye;

no

namecat/4 : concatenates 3 names

EXAMPLE(S): 
?-namecat(a,:,b,_A).
_A = a:b;

no

near_match/2 : matches 2 lists of chars
new_builtin/3 : sample 3 arg user added builtin - used for the C interface
new_client/3 : from a (host,port) to a client
new_engine/3 : new_engine(X,G,E) creates an engine E ready to execute goal G with answer X
new_iterator/2 : (GroundKey,Iterator) gets an iterator to terms attached to ground key
new_key_iterator/1 : (Iterator): returns an iterator over the set of external keys
new_name/2 : returns a new name based on arg 1
new_server/2 : opens on a port a new server
new_service/3 : from (server,timeout) to a service
new_term/2 : (Term,Handle): creates a new external Term and returns an integer Handle to it
new_thread_guard/1 : returns a new free thread guard from pool
nl/0 : writes a new line character
nobbgc/0 : disables blackboard gc
nogc/0 : disables heap gc
nonvar/1 : true if currently instantiated
(nospy)/1 : do not spy on Pred/Arity anymore
(not)/1 : sound negation
notepad/0 : calls notepad editor on last compiled file
notify_about/1 : notifies a suspended matching wait_for(Term,Contraint), if Constraint holds, that Term is available
notrace/0 : do not trace predicates when interpreted
nth_answer/2 : (N,Goal) returns only the nth answer of Goal, if such an anser exists

nth_member/3 : retrieves N-th element of a list

EXAMPLE(S): 
?-nth_member(_A,[a,b,c],_B).
_A = a;
_B = 1;

_A = b;
_B = 2;

_A = c;
_B = 3;

no

number/1 : true if integer or float
number_chars/2 : (Number,CharAtoms): converts between a number and its list of char atoms representation
```
EXAMPLE(S): 
?-number_chars(1999,_A).
_A = [1,9,9,9];

no
```

number_codes/2 : (Number,CharCodes): converts between a number and its list of char code representation

EXAMPLE(S): 
?-number_codes(1999,_A).
_A = [49,57,57,57];

no
?-number_codes(_A,[50,48,48,49]).
_A = 2001;

no

numbervars/3 : binds to $VAR(I) with I over distinct integers variables in a term
oconsult/1 : reconsult/1 variant: consults/compiles based on db_ratio and overwrites old clauses
older_file/2 : true if arg 1 is a file older than arg 2
on_undefined/1 : (Goal): defines handler for undefined predicates matching Goal
once/1 : executes once, with no backtracking
one/4 : one(Recognizer,Result): DCG based regexp processor for exactly one Recognizer
op/3 : op(Pri,A,Op) defines an operator Op of priority Pri and associativity A
open/3 : returns a stream (arg 3) on a file (arg 1) in read/write/append mode (arg 2)
open_engine/3 : open_engine(G,X,E) creates an engine E ready to execute goal G with answer X
open_stream/4 : (Type,FileOrCmd,ReadWriteAppend,?StreamID) opens various streams
otherwise/0 : always succeeds
otime/1 : gets time in secs from arbitrary origin to start
```
EXAMPLE(S): 
?-otime(_A).
_A = 343416141;

no
```
out/1 : puts a term on Linda server or trigers resumption of a matching in/1 waiting for this data
override/3 : overrides a compiled predicate - to be used with care
password/1 : assumes default password for user
pc/0 : pushes code compiled into the workspace to the persistent kernel
pclose/1 : closes a pipe generated stream
pcollect/2 : collects output from a command to a list of char codes
peer_addr/2 : gets address of peer connected to socket
peer_port/2 : gets port of peer connected to socket
phrase/2 : (Axiom, ?InputChars): DCG evaluator, starting from Axiom, consuming/producing InputChars
phrase/3 : (Axiom, ?InputChars, ?OutputChars): DCG evaluator, staring from Axiom
```
EXAMPLE(S): 
?-phrase(([a],[b]),[a,b|_A],_A).
_A = _x61093;

no
```
pico/0 : calls pico editor on last compiled file
plus/4 : plus(Recognizer,Result): DCG based plus regexp processor for (Recognizer)+
popen/3 : popen(Cmd,read/write,Stream) opens Stream using a pipe from/to process executing Cmd
port/1 : assumes default port for Linda server
portray_clause/1 : pretty prints a clause
pow/3 : (Base,Expo,Val) computes power function
```
EXAMPLE(S): 
?-pow(2,3,_A).
_A = 8;

no
```
pp_clause/1 : prints out a clause with some care on how it looks
pp_term/1 : pretty prints a term

predicate_property/2 : returns a property of a predicate

EXAMPLE(S): 
?-predicate_property(write(_A),_B).
_A = _x61092;
_B = built_in;

no

print/1 : variant of write/1
println/1 : synchronized printing of a term on a line
process_term/3 : (OpCode,Input,Output): applies various user defined C functions to external terms

prod/2 : (List, ?Result): product of a list

EXAMPLE(S): 
?-prod([10,20],_A).
_A = 200;

no

profile/0 : in specialy compiled profiler mode prints out info accumulated so far
prolog_flag/2 : (Flag,Value): retrieves the value of a Prolog flag
prolog_init/1 : runs more command line args representing prolog goals
prolog_load/1 : loads code and/or executes first command line arg
prolog_run/1 : starts main/0 if defined, otherwise toplevel/0
(public)/1 : declares globally visible predicate Name/Arity
push_code/1 : moves code compiled in workspace to kernel and returns top of code area - used by pc/0
push_term/2 : (GroundKey,Term): attaches a term to a ground key in constant time as a the first element

pushq/3 : adds to beginning of persistent queeue

EXAMPLE(S): 
?-pushq(key1,key2,f(_A,_A)).
_A = _x61094;

no

put/1 : writes and ascii code as a char
```
EXAMPLE(S): 
?-put(99).
c
yes
```
put_char/2 : (Stream,CharAsOneLetterConstant): outputs a char to a stream -ISO Prolog
put_code/1 : ISO char code writer
```
EXAMPLE(S): 
?-put_code(99).
c
yes
```
put_code/2 : outputs a char code to a stream - ISO
put_critical/2 : (Guard,Data): updates mutex Guard-protected Data on blackboard
put_term/2 : (GroundKey,Term): attaches a term to a ground key in constant time as the last element
pwd/0 : shows current dir
pwd/1 : returns current dir as a list of chars
qcompile/1 : compile/1 variant: compiles a file to memory after pushing current user code to kernel - where it becomes read only
qmake/1 : compiles Project to fast C code - for packaging as standalone executable
qmake/2 : (Project,Module): compiles to fast C code a project in Module: uses set_threshhold(12,60) before dooing cmake/2, for a good speed/code size ratio
qprint/1 : prints out a clause such that a variant of it can be always read back
quiet/1 : gets/sets level of "quietness"
quietmes/1 : writes message if in low quietness mode
quietmes/2 : writes message if quietness is lower than arg 1)
quit/0 : same as halt

random/1 : returns a random integer

EXAMPLE(S): 
?-random(_A).
_A = 1457;

no

random_seed/1 : initializes random/1 with an integer, uses clock if 0
rd/1 : reads a term matching arg 1 from Linda blackboard
read/1 : reads a term
read_chars/1 : reads to a list of ascii codes
read_line/1 : reads a line into a constant
read_term/2 : reads a term and also a list of variable-name associations

read_term_from_chars/2 : reads a term from a list of char codes

EXAMPLE(S): 
?-read_term_from_chars([102,40,88,44,88,44,89,44,89,41],_A).
_A = f(_x62944,_x62944,_x62995,_x62995);

no

read_term_from_chars/3 : reads a term with variable names from a list of char codes

EXAMPLE(S): 
?-read_term_from_chars([102,40,88,44,88,44,89,44,89,41],_A,_B).
_A = f(_x63012,_x63012,_x63063,_x63063);
_B = [X = _x63012,Y = _x63063];

no

read_terms_from_chars/2 : (Chars,Clause): backtracks over Clause(s) parsed from a list of char codes

read_terms_from_chars/3 : (Chars,Clause,VarsInClause): backtracks over Clause(s) parsed from a list of char codes

EXAMPLE(S): 
?-read_terms_from_chars([98,40,88,44,89,41,58,45,97,40,89,44,88,41,46,32,97,40,49,44,49,41,46,32,97,40,95,44,50,41,46,32],_A,_B).
_A = (b(_x64809,_x64837) :- a(_x64837,_x64809));
_B = [X = _x64809,Y = _x64837];

_A = a(1,1);
_B = [];

_A = a(_x64408,2);
_B = [_ = _x64408];

no

read_words/1 : reads a line into a list of words
reboot/0 : regenerates BinProlog from its sources
reconsult/1 : applies current consult method to file given as arg 1, set db_ratio/1 for specifying dynamic recompilation of heavily used interpreted code
remote_run/1 : runs Goal on remote server using default password
remote_run/3 : (Host,Port,Goal): runs Goal on rmote server at Host, Port with default password
remote_run/6 : (Host,Port,Answer,Goal,Password,Reply): runs Goal on server at Host, Port with given Password and returns Reply. However, if you do let(where,here) before calling it, a local goal is called instead.
remove_current_term/1 : (Iterator) removes current term attached to an iterator
repeat/0 : backtracks until its continuation succeeds; defined as repeat. repeat:-repeat.
restart/0 : cleans up data areas and reinitializes symbol tables
retract/1 : backtracks over deleting matching clauses
retract1/1 : deletes first matching clause in the current database
retractall/1 : deletes all matching clauses
return/1 : returns data from an engine as if it were an answer - such that the engine can be resumed with get/2 to execute the next goal
return0/1 : returns a term from an engine left in a state ready to resume

reverse/2 : reverses a list

EXAMPLE(S): 
?-reverse([a,b,c],_A).
_A = [c,b,a];

no

round/2 : float to int function

EXAMPLE(S): 
?-round(1.51,_A).
_A = 2;

no

rpc/1 : (Query): calls server on current local reusable socket
rpc/3 : (Answer,Goal,Result): calls server on local reusable socket and gets back Result as the(Answer) or no
rpc_handler/1 : (Goal): user-defined rpc handler - filters/calls Goal received on server
rpc_server/0 : runs Jinni compatible server with socket reuse on default port
rpc_server/2 : Port,Password: runs Jinni compatible server with socket reuse
rpc_server/3 : Port,Password,Timout: runs Jinni compatible server with socket reuse
rpc_test/0 : tests rpc server and client with socket reuse
rpc_test/1 : tests rpc client with socket reuse for a given number of operations
rtime/1 : gets elapsed real time in secs
```
EXAMPLE(S): 
?-rtime(_A).
_A = 0;

no
```
run_server/0 : runs foreground server on localhost (default port) for Jinni clients
run_server/1 : runs foreground server on Port to provide services to Jinni clients
run_server/2 : (Port,Password): runs server on Port, Password required from clients
run_server/6 : (Port,Password,Heap,Stack,Trail,Timeout): runs server with specified service parameters
scompile/1 : smart compile/1 variant: if the *.wam file is newer reloads, otherwise fcompiles first
sconsult/1 : reconsult/1 variant: cleans up data areas consults, makes all static
sdebug/1 : emits mt-safe synchronized debug message
see/1 : focuses input on a file
see_at/1 : seeks a seekable file at a give offset (in bytes)
see_or_fail/1 : opens a file if it exists, otherwise fails
seeing/1 : gets file name opened and set by see/1
seeing_at/1 : retrieves position in current file opened by see/1
seen/0 : close file opened by see/1
sentence_of/2 : reads a natural language file to a sentence built as a list of words - on backtracking
sentence_of/3 : (File,Ends,Sent) reads a file to a sentence separated by Ends - on backtracking
service_loop/2 : ServiceSocket,Password:starts service loop on reusable ServiceSocket - works on server side with server/2
set_bp_error/4 : (Id,Mes,Arg1,Arg2): notifies emulator about error condition
set_c_threshold/1 : related to C generator: sets length K of WAM instruction block such that block larger than K will get compiled to C code
set_c_threshold/2 : (Min,Max): related to C generator: sets Min,Max length of WAM instruction block such that blocks between Min and Max size will get compiled to C code
set_db/1 : sets the name of active database for dynamic code
set_default/1 : asserts arg 1 as default state for use by default/2
set_hash_max/1 : Set the range of values from -1 to -Max, that should be a prime number, defaults to 1999
set_host/1 : asserts IP adress or name of server host we want to talk to
set_input/1 : sets current input stream
set_lineno/1 : sets line number counter in current file - use with care
set_load_method/1 : sets the current load method by name
set_login/1 : asserts default (nick)name for user
set_output/1 : sets current output stream
set_password/1 : sets default password for user
set_port/1 : asserts port number of the server we want to talk to
set_prolog_flag/2 : (Flag,Value): sets the value of a Prolog flag
set_this_host/1 : asserts IP adress or name of this machine
set_this_port/1 : asserts default port for to work as a server on
set_timeout/1 : asserts default timeout
setarg/3 : backtrackable: setarg(I,T,X) replaces arg I of T with X
```
EXAMPLE(S): 
?-setarg(2,f(a,b),c).

yes
```

setof/3 : all solutions predicate generating sorted sets of unduplicated answers

EXAMPLE(S): 
?-setof(_A,member(_A,[3,2,2,1]),_B).
_A = _x61091;
_B = [1,2,3];

no

shell/1 : passes a command to the OS
show_default/1 : makes available a default value
show_defaults/0 : show default values of some system variables
show_engine/0 : if debugmes/1 is on (as with quiet(1)), shows params of current engine
show_info/2 : generates components of info/1 output
sign/2 : int function
sin/2 : float function
skip_until/2 : findall variant
skip_when/2 : findall variant
sleep/1 : waits arg 1 seconds
sock2file/2 : reads from a socket, to a file
sock_read/2 : reads from a socket when size of the data is described by int before chars to be read
sock_read/3 : reads from a socket, a string
sock_readln/2 : reads from a socket until an end of line LF (ascii 10) or char 0 is found and discards possible previous CR (ascii13)
sock_readln/3 : reads from a socket, a line
sock_write/2 : writes a string to a socket prefixed by its lenght
sock_write/3 : writes to a socket, a string
sock_writeln/2 : writes a string to a socket and adds an ascii 10 to the end
sock_writeln/3 : writes to a socket, a line
solutions/2 : (GX,Xs): adds (last) output arg X to closure G then works like findall(X,GX,Xs)
```
EXAMPLE(S): 
?-solutions(argn(_A,f(a,b,c)),_B).
_A = _x61092;
_B = [a,b,c];

no
```

sort/2 : sorts and removes duplicates

EXAMPLE(S): 
?-sort([2,1,3,1,4,4,2],_A).
_A = [1,2,3,4];

no

spawn/1 : spawns Goal in a new bp window on W95/NT PC and Unix/X
spawn/3 : spawns(Goal,Includes,TempFile): spawns a new bp window
(spy)/1 : set spy point on goal, triggering trace when interpreted
spying/1 : checks what we are spying

sqrt/2 : returns square root of arg 1, a float

EXAMPLE(S): 
?-sqrt(2,_A).
_A = 1.41421356;

no

sread/2 : reads a term from a string (atom)

sread/3 : reads a term and a list of vars from a string (atom)

EXAMPLE(S): 
?-sread(f(X,Y),_A,_B).
_A = f(_x62165,_x62193);
_B = [X = _x62165,Y = _x62193];

no

star/4 : star(Recognizer,Result): DCG based star regexp processor for (Recognizer)*
start_rpc/0 : starts rpc client on default local reusable socket and port
start_rpc/3 : (Host,Port,Password): starts rpc client on local reusable socket
stat/0 : short hand for statistics
stat2dyn/1 : stat2dyn(H): reverts to uncompiled representation for a predicate with head H
stat2dyn/2 : stat2dyn(Db,H): reverts to uncompiled representation for a predicate in database Db with head H
static_prolog_flag/2 : contains read-only Prolog flag values

statistics/0 : shows info about data areas

EXAMPLE(S): 
?-statistics.
runtime=[421,156]
global_stack=[245064,1819260]
local_stack=[244,260864]
trail=[33684,227432]
code=[260404,788156]
strings=[246,1048330]
symbols=[13028,249116]
htable=[113988,672444]
bboard=[24988,497248]
gctime=[0,0]
realtime=[0,343416141]

yes

statistics/2 : returns info about data areas

EXAMPLE(S): 
?-statistics(_A,_B).
_A = runtime;
_B = [421,0];

_A = global_stack;
_B = [245600,1818724];

_A = local_stack;
_B = [228,260880];

_A = trail;
_B = [33704,227412];

_A = code;
_B = [260404,788156];

_A = strings;
_B = [246,1048330];

_A = symbols;
_B = [13028,249116];

_A = htable;
_B = [113988,672444];

_A = bboard;
_B = [24988,497248];

_A = gctime;
_B = [0,0];

_A = realtime;
_B = [0,343416141];

no

stop/0 : exits thread or process
stop/1 : stops and frees resources held by an engine (may happen automaticaly if an engine fails)
stop_rpc/0 : stops rpc client on local reusable socket
stop_service/0 : stops server with socket reuse - acts on the server side
subsumes_chk/2 : checks if arg 1 is subsumed by arg 2, after renaming vars

sum/2 : (List,?Result): sum of a list

EXAMPLE(S): 
?-sum([10,20],_A).
_A = 30;

no

swap_cont/2 : calls arg 1 as cc and returns cc in arg 2
swrite/2 : writes a term to a string (atom)
swrite/3 : writes a term with a liste of vars to a string (atom)

symcat/3 : makes new identifier from arg 1 and arg 2

EXAMPLE(S): 
?-symcat(a,b,_A).
_A = a_b;

no
?-symcat(a,1,_A).
_A = a_1;

no

synchronize/1 : wraps Goal in arg 1 for serialized execution
synchronize/2 : wraps Goal for serialized execution and returns true or fail
synchronize_on/2 : wraps Goal for sync on given mutex for serialized execution
synchronize_on/3 : wraps Goal for sync on given mutex for serialized execution and returns true or fail
system/1 : passes a command to the OS
system/2 : passes a command to the OS and gets back return code
tab/1 : outputs N blanks
take_at_most/2 : (N,Goal) computes at most N answers of Goal
tan/2 : float function
tell/1 : focuses output on a file
tell_at/1 : moves output file pointer to a given offset (in bytes)
tell_at_end/1 : focuses output on file opened in append mode
telling/1 : gets file name opened and set by tell/1
telling_at/1 : retrieves output file position (in bytes)

term_append/3 : efficiently concatenates 2 terms

EXAMPLE(S): 
?-term_append(f(a,b),g(c,d),_A).
_A = f(a,b,c,d);

no

term_chars/2 : (Term,Chars): converts between a term and its list of char code representation

EXAMPLE(S): 
?-term_chars(f(a,b),_A).
_A = [102,40,97,44,98,41];

no
?-term_chars(_A,[102,40,97,44,98,41]).
_A = f(a,b);

no

term_codes/2 : (Term,Chars): converts between a term and its list of char code representation

EXAMPLE(S): 
?-term_codes(f(a,b),_A).
_A = [102,40,97,44,98,41];

no
?-term_codes(_A,[102,40,97,44,98,41]).
_A = f(a,b);

no

term_decoder/2 : (Encrypted,Plain): user provided encoder for secure communications - works on lists of ascii codes
term_encoder/2 : (Plain,Encrypted): user provided decoder for secure communications - works on list of ascii codes
term_expansion/2 : can be used to define a hook into the default DCG expansion mechanism
term_hash/2 : computes hash code on terms ground up to depth 64; fails if something is unbound or the limit is reached
```
EXAMPLE(S): 
?-term_hash(t(a,b),_A).
_A = 236945626;

no
?-term_hash(t(a,c),_A).
_A = 236945625;

no
```
term_of/2 : reads a Prolog file to a set of terms - on backtracking
term_store_op/4 : API for external term storage
textedit/0 : calls texedit editor on last compiled file
the/1 : defined as the(G):-the(G,G)
the/2 : defined as the(X,G):-the(X,G,the(X))
the/3 : the(X,G,R) first answer R=the(X) or R=no, without binding G
this_db/1 : same as current_db, returns the current database
this_engine/1 : gets a handle to the current engine
this_host/1 : assumes default IP adress or name this machiner
this_port/1 : assumes default port for to work as a server on
thread_cancel/1 : terminates (cancels) thread given in arg 1
thread_exit/0 : exits a thread
thread_exit/1 : exits a thread
thread_join/1 : joins thread
thread_notify/1 : notifies a thread waiting on guard with thread_wait
thread_notify_all/1 : notifies all threads waiting on guard with thread_wait
thread_resume/1 : resumes execution of suspended thread
thread_suspend/1 : suspends execution of thread
thread_timed_wait/2 : waits on first arg Guard second arg msec or until notified
thread_wait/1 : waits on guard until notified by thread_notify
throw/1 : ISO Prolog exception operator: throws a term to be caught by a matching catch
throw_with_cont/2 : works for throw/1: used to rethrow with new continuation
timed_call/4 : (Answer,Goal,Timeout,Result) - calls and possibly stops Goal after Timout secs
timeout/1 : assumes default timeout
to_engine/2 : (E,T) sends to engine E a term T, and fails if E has an empty message box
to_lower_char/2 : (Upper,Lower): converts a char to lower case
to_lower_chars/2 : converts a list of chars to lower case

to_string/2 : converts a term to a string constant (in paricular, converts numbers to strings)

EXAMPLE(S): 
?-to_string(13,_A).
_A = 13;

no
?-to_string(3.14,_A).
_A = 3.14;

no
?-to_string(f(_A,_A),_B).
_A = _x61099;
_B = f(_x61099,_x61099);

no

to_tokens/2 : to_tokens(Codes,PrologTokens)
to_upper_char/2 : (Lower,Upper): converts a char to upper case
to_upper_chars/2 : converts a list of chars to upper case
to_word_codes/2 : to_word_codes(Codes,ListOfWordCodes)
to_words/2 : to_words(Codes,NaturalLanguageWords
token_of/2 : reads a Prolog file to a set of tokens - on backtracking
tokens_of/2 : reads a Prolog file to a slist of tokens
told/0 : closes file opened by tell/1
topcall/1 : calls arg 1 as if it were entered by the user at Prolog prompt
toplevel/0 : interactive toplevel Prolog loop
topstep/1 : interactive toplevel Prolog step
trace/0 : trace all predicates when interpreted
trace/1 : traces execution of a goal
trim_term/4 : trim_term(D,Filler,T,NewT) replaces subterms of T deeper than D with Filler
true/0 : always succeeds

truncate/2 : float to int function

EXAMPLE(S): 
?-truncate(1.51,_A).
_A = 1;

no

try_unlock_thread_guard/1 : try to unlock a thread guard
try_unlock_thread_guard/2 : try to unlock a thread guard for a specified timeout
tstest/3 : (K,V,R): performs various tests with external terms
tsync_op/3 : same as thread_operation(Op, MutexOrParam, ActionOrValue) various thread synchronization operations
ttyprin/1 : writes to terminal
ttyprint/1 : writes to terminal with a new line
unix/1 : executes various Unix commands
unix_access/2 : checks if arg1 (a path+file) is accessible in arg 2 (integer) mode

unix_argc/1 : gets cmd line arg counter

EXAMPLE(S): 
?-unix_argc(_A).
_A = 2;

no

unix_argv/1 : gets the list of cmd line args from 1 to argc

EXAMPLE(S): 
?-unix_argv(_A).
_A = [helpgen.pro];

no

unix_argv/2 : gets a cmd line arg from 0 to argc

EXAMPLE(S): 
?-unix_argv(0,_A).
_A = bp;

no

unix_cat/1 : prints a file to user terminal
unix_cd/1 : changes local dir to arg 1
unix_fork/1 : starts child process with Unix fork
unix_getenv/2 : gets an environment variable
unix_kill/2 : sends signal arg 1 to process with pid arg 2
unix_pid/1 : returns process id of current process
unlock_thread_guard/1 : unlocks thread guard
untrail_to/1 : unwinds the trail up to a choice point
update_current_term/2 : (Iterator,NewTerm): replaces current term of an iterator
user_error/2 : writes basic error message and fail
var/1 : true if currently an unbound variable
variant_of/2 : checks if args are the same up to a renaming of vars

vars_of/2 : (Term,Vars): lists free vars of a term

EXAMPLE(S): 
?-vars_of(f(_A,t(_A,_B,_C),_C),_D).
_A = _x61092;
_B = _x61097;
_C = _x61094;
_D = [_x61092,_x61097,_x61094];

no

vget/2 : gets a VSHARE declared C data object in a term like int(N),F/N or var(V)
vget0/2 : gets the type and value of a C word
vget_int/2 : gets a VSHARE defined int C variable to a 28 bit int
vget_int0/2 : gets from arg 1 - an int* C variable - to a 28 bit int
vi/0 : calls vi editor on last compiled file
vread/2 : reads HDEFI or HDEFS defined C constant into a Prolog integer or atom
vset/2 : sets a VSHARE declared C data object in a term like int(N),F/N or var(V)
vset_int/2 : sets a VSHARE defined int C variable to a 28 bit int
vset_int0/2 : sets arg 1 - an int* C variable - to a 28 bit int
wait_for/2 : wait_for(Term,Constraint) waits for a term on the blackboard, such that Constraint holds
while/2 : (Cond,Goal): findall variant which explores alternative answers for Goal, while Cond holds,
words_code/2 : generates a code ready to print, one a t a time with put/1 from a list of words
write/1 : writes to current output stream set with tell/1, defaults to - Prolog's stdio

write_chars/1 : writes a list of ascii codes

EXAMPLE(S): 
?-write_chars([104,101,108,108,111]).
hello
yes

write_term_to_chars/2 : writes a term to a list of char codes

EXAMPLE(S): 
?-write_term_to_chars(f(_A,_A,_B,_B),_C).
_A = _x61095;
_B = _x61097;
_C = [102,40,95,120,54,49,48,57,53,44,95,120,54,49,48,57,53,44,95,120,54,49,48,57,55,44,95,120,54,49,48,57,55,41];

no

write_term_to_chars/3 : writes a term with variables names to a list of char codes

EXAMPLE(S): 
?-write_term_to_chars(f(_A,_B),[X = _A,Y = _B],_C).
_A = _x61098;
_B = _x61099;
_C = [102,40,39,88,39,44,39,89,39,41];

no

write_words/1 : write list of words to a space separated line
writeq/1 : variant of write which quotes if needed, so that term is read back correctly/1
x_abolish/1 : db hook, deletes all matching clauses and unmarks the clause as dynamic
x_asserta/1 : db hook, adds a clause to be first in a predicate definition
x_assertz/1 : db hook, adds a clause to be last in a predicate definition
x_clause/2 : db hook, clause(H,B) generates a clause with head matching H and body B
x_consult/1 : db hook, consults with possible duplication of clauses
x_dynamic/1 : db hook, states that a predicate can be updated
x_gc/0 : db hook, recovers memory used by the database
x_is_dynamic/1 : db hook, checks if dynamic
x_listing/0 : db hook, lists given predicate if in current database
x_listing/1 : lists predicate F of arity N if in current database
x_profile/0 : db hook, shows the result of profiling compiled predicates
x_retract/1 : db hook, backtracks over deleting matching clauses
x_retractall/1 : db hook, deletes all matching clauses
x_trace/1 : traces and profiles predicates, in combination with x_profile
x_trace/2 : db hook, internal
x_traced_call/1 : traces calls if compile-time x_trace triggers it
xload/1 : xload(File) loads clauses to the current database, from a binary File
xsave/1 : xsave(File) saves all the clauses of the current database to a binary File
~ /1 : short hand for reconsult