library

Prolog files

aggregate.pl  -- Aggregation operators on backtrackable predicates
ansi_term.pl
ansi_format/3	Format text with ANSI attributes.
ansi_get_color/2	Obtain the RGB color for an ANSI color parameter.
ansi_hyperlink/2	Create a hyperlink for a terminal emulator.
ansi_hyperlink/3	Create a hyperlink for a terminal emulator.
tty_url_hook/2	Hook for location_url/2.
console_color/2	Hook that allows for mapping abstract terms to concrete ANSI attributes.
message_line_element/2	Hook implementation that deals with ansi(+Attr, +Fmt, +Args) in message specifications.
apply.pl  -- Apply predicates on a list
apply_macros.pl  -- Goal expansion rules to avoid meta-calling
apply_macros_sentinel/0	Used to detect that library(apply_macros) is loaded into the current context explicitly.
expand_phrase/2	Provide goal-expansion for PhraseGoal.
expand_phrase/4	Provide goal-expansion for PhraseGoal.
arithmetic.pl  -- Extensible arithmetic
assoc.pl  -- Binary associations
atom.pl  -- Operations on atoms
backcomp.pl  -- Backward compatibility
base32.pl
base32/2	Translates between plaintext and base32 encoded atom or string.
base32/3	Encode/decode list of character codes using base32.
base64.pl  -- Base64 encoding and decoding
broadcast.pl  -- Event service
charsio.pl  -- I/O on Lists of Character Codes
check.pl  -- Consistency checking
codesio.pl
format_to_codes/3	Use format/2 to write to a list of character codes.
format_to_codes/4	Use format/2 to write to a difference list of character codes.
open_codes_stream/2	Open Codes as an input stream.
read_from_codes/2	Read Codes into Term.
read_term_from_codes/3	Read Codes into Term.
with_output_to_codes/2	Run Goal with as once/1.
with_output_to_codes/3	Run Goal with as once/1.
with_output_to_codes/4	As with_output_to_codes/3, but Stream is unified with the temporary stream.
write_term_to_codes/3	True when Codes is a string that matches the output of write_term/3 using Options.
write_term_to_codes/4	True when Codes\Tail is a difference list containing the character codes that matches the output of write_term/3 using Options.
write_to_codes/2	Codes is a list of character codes produced by write/1 on Term.
write_to_codes/3	Codes is a difference-list of character codes produced by write/1 on Term.
coinduction.pl
coinductive/1	The declaration :- coinductive name/arity, ... defines predicates as coinductive.
csv.pl  -- Process CSV (Comma-Separated Values) data
ctypes.pl  -- Character code classification
is_digit/3	Succeeds if `C' is a digit using `Base' as base and `Weight' represents its value.
is_paren/2	True if Open is the open-parenthesis of Close.
to_lower/2	Downcase a character code.
to_upper/2	Upcase a character code.
upper_lower/2	True when U is the character code of an uppercase character and L is the character code of the corresponding lowercase character.
date.pl  -- Process dates and times
debug.pl  -- Print debug messages and test assertions
dialect.pl  -- Support multiple Prolog dialects
dicts.pl  -- Dict utilities
dif.pl  -- The dif/2 constraint
edinburgh.pl  -- Some traditional Edinburgh predicates
edit.pl
edit/0	Edit associated or script file.
edit/1	Edit indicated object.
edit_command/2	This predicate should specify the shell-command called to invoke the user's editor.
locate/2	Locate object from the specified location.
locate/3
select_location/3
error.pl
exceptions.pl
catch/4	As catch/3, only catching exceptions for which exception(ErrorType,Ball) is true.
error_term/2	Describe the formal part of error(Formal,ImplDefined) exceptions.
exception/2	If Ball is unbound, adds a delayed goal that tests the error belongs to Type when Ball is instantiated (by catch/3).
exception_term/2	Describe exceptions that are not error(Formal, _) terms.
exception_type/2	Declare all exceptions subsumed by Term to be an exception of Type.
explain.pl
explain/1	Give an explanation on Term.
explain/2	True when Explanation is an explanation of Term.
fastrw.pl
fast_read/1	The next term is read from current standard input and is unified with Term.
fast_write/1	Output Term in a way that fast_read/1 and fast_read/2 will be able to read it back.
fast_write_to_string/3	Perform a fast-write to the difference-slist String\Tail.
files.pl
can_open_file/2	Succeeds if the user has access to `File' in mode `Mode'.
chdir/1	Change Working Directory.
gensym.pl
gensym/2	Generate <Base>1, <Base>2, etc atoms on each subsequent call.
reset_gensym/0	Reset gensym for all registered keys.
reset_gensym/1	Restart generation of identifiers from Base at <Base>1.
git.pl  -- Run GIT commands
hashtable.pl
ht_del/3	Delete Key-Value from HT.
ht_gen/3	True when Key-Value is in HT.
ht_get/3	True when Key is in HT and associated with Value.
ht_is_hashtable/1	True when HT is a hash table.
ht_keys/2	True when Keys is an ordered set of all keys in HT.
ht_new/1	Create a new hash table.
ht_pairs/2	True when Pairs and HT represent the same association.
ht_put/3	Add a Key-Value to HT.
ht_put/5	Add Key-Value to HT.
ht_put_new/3	As ht_put/3, but fails if Key is already in HT instead of updating the associated value.
ht_size/2	True when Size is the number of key-value pairs in HT.
ht_update/4	True when HT holds Key-Old before and Key-New after this call.
heaps.pl
add_to_heap/4	Adds Key with priority Priority to Heap0, constructing a new heap in Heap.
delete_from_heap/4	Deletes Key from Heap0, leaving its priority in Priority and the resulting data structure in Heap.
empty_heap/1	True if Heap is an empty heap.
get_from_heap/4	Retrieves the minimum-priority pair Priority-Key from Heap0.
heap_size/2	Determines the number of elements in Heap.
heap_to_list/2	Constructs a list List of Priority-Element terms, ordered by (ascending) priority.
is_heap/1	Returns true if X is a heap.
list_to_heap/2	If List is a list of Priority-Element terms, constructs a heap out of List.
merge_heaps/3	Merge the two heaps Heap0 and Heap1 in Heap.
min_of_heap/3	Unifies Key with the minimum-priority element of Heap and Priority with its priority value.
min_of_heap/5	Gets the two minimum-priority elements from Heap.
singleton_heap/3	True if Heap is a heap with the single element Priority-Key.
help.pl
apropos/1	Print objects from the manual whose name or summary match with Query.
help/0	Show help for What.
help/1	Show help for What.
help_text/2	When Predicate is a term of the form Name/Arity for which documentation exists, HelpText is the documentation in textual format (parsed from the HTML help).
show_html_hook/1	Hook called to display the extracted HTML document.
increval.pl
incr_directly_depends/2	True if Goal1 depends on Goal2 in the IDG.
incr_invalid_subgoals/1	List is a sorted list (set) of the incremental subgoals that are currently invalid.
incr_invalidate_call/1	This is the XSB name, but the manual says incr_invalidate_calls/1 and the comment with the code suggests this is misnamed.
incr_invalidate_calls/1	Invalidate all tables for subgoals of Goal as well as tables that are affected by these.
incr_is_invalid/1	True when Subgoal's table is marked as invalid.
incr_propagate_calls/1	Activate the monotonic answer propagation similarly to when a new fact is asserted for a monotonic dynamic predicate.
incr_table_update/0	Updated all invalid tables.
incr_trans_depends/2	True for each pair in the transitive closure of incr_directly_depends(G1, G2).
is_incremental_subgoal/1	This predicate non-deterministically unifies Subgoal with incrementally tabled subgoals that are currently table entries.
intercept.pl  -- Intercept and signal interface
iostream.pl  -- Utilities to deal with streams
lazy_lists.pl  -- Lazy list handling
listing.pl  -- List programs and pretty print clauses
lists.pl
append/2	Concatenate a list of lists.
append/3	List1AndList2 is the concatenation of List1 and List2.
clumped/2	Pairs is a list of Item-Count pairs that represents the run length encoding of Items.
delete/3	Delete matching elements from a list.
flatten/2	Is true if FlatList is a non-nested version of NestedList.
intersection/3	True if Set3 unifies with the intersection of Set1 and Set2.
is_set/1	True if Set is a proper list without duplicates.
last/2	Succeeds when Last is the last element of List.
list_to_set/2	True when Set has the same elements as List in the same order.
max_list/2	True if Max is the largest number in List.
max_member/2	True when Max is the largest member in the standard order of terms.
max_member/3	True when Max is the largest member according to Pred, which must be a 2-argument callable that behaves like (@=<)/2.
member/2	True if Elem is a member of List.
min_list/2	True if Min is the smallest number in List.
min_member/2	True when Min is the smallest member in the standard order of terms.
min_member/3	True when Min is the smallest member according to Pred, which must be a 2-argument callable that behaves like (@=<)/2.
nextto/3	True if Y directly follows X in List.
nth0/3	True when Elem is the Index'th element of List.
nth0/4	Select/insert element at index.
nth1/3	Is true when Elem is the Index'th element of List.
nth1/4	As nth0/4, but counting starts at 1.
numlist/3	List is a list [Low, Low+1, ... High].
permutation/2	True when Xs is a permutation of Ys.
prefix/2	True iff Part is a leading substring of Whole.
proper_length/2	True when Length is the number of elements in the proper list List.
reverse/2	Is true when the elements of List2 are in reverse order compared to List1.
same_length/2	Is true when List1 and List2 are lists with the same number of elements.
select/3	Is true when List1, with Elem removed, results in List2.
select/4	Select from two lists at the same position.
selectchk/3	Semi-deterministic removal of first element in List that unifies with Elem.
selectchk/4	Semi-deterministic version of select/4.
subseq/3	Is true when SubList contains a subset of the elements of List in the same order and Complement contains all elements of List not in SubList, also in the order they appear in List.
subset/2	True if all elements of SubSet belong to Set as well.
subtract/3	Delete all elements in Delete from Set.
sum_list/2	Sum is the result of adding all numbers in List.
union/3	True if Set3 unifies with the union of the lists Set1 and Set2.
macros.pl
expand_macros/5	Perform macro expansion on TermIn with layout PosIn to produce TermOut with layout PosOut.
include_macros/3	Include macros from another module.
macro_position/1	True when Position is the position of the macro.
main.pl  -- Provide entry point for scripts
make.pl  -- Reload modified source files
modules.pl
current_temporary_module/1	True when we are executing in the given temporary module context.
in_temporary_module/3	Run Goal on temporary loaded sources and discard the module and loaded predicates after completion.
nb_set.pl
add_nb_set/2	Insert Key into the set.
add_nb_set/3	Insert Key into the set.
empty_nb_set/1	Create an empty non-backtrackable set.
gen_nb_set/2	Enumerate the members of a set in the standard order of terms.
nb_set_to_list/2	Get the elements of a an nb_set.
size_nb_set/2	Unify Size with the number of elements in the set.
occurs.pl
contains_term/2	Succeeds if Sub is contained in Term (=, deterministically).
contains_var/2	Succeeds if Sub is contained in Term (==, deterministically).
free_of_term/2	Succeeds of Sub does not unify to any subterm of Term.
free_of_var/2	Succeeds of Sub is not equal (==) to any subterm of Term.
occurrences_of_term/3	Count the number of SubTerms in Term that unify with SubTerm.
occurrences_of_var/3	Count the number of SubTerms in Term that are equal to SubTerm.
sub_term/2	Generates (on backtracking) all subterms of Term.
sub_term_shared_variables/3	If Sub is a sub term of Term, Vars is bound to the list of variables in Sub that also appear outside Sub in Term.
sub_var/2	Generates (on backtracking) all subterms (==) of Term.
operators.pl
pop_operators/0	Revert all changes to the operator table realised since the last push_operators/1.
pop_operators/1	Reset operators as pushed by push_operators/2.
push_op/3	As op/3, but this call must appear between push_operators/1 and pop_operators/0.
push_operators/1	Installs the operators from New, where New is a list of op(Prec, Type, :Name).
push_operators/2	Installs the operators from New, where New is a list of op(Prec, Type, :Name).
option.pl  -- Option list processing
optparse.pl  -- command line parsing
ordsets.pl  -- Ordered set manipulation
oset.pl  -- Ordered set manipulation
pairs.pl
group_pairs_by_key/2	Group values with equivalent (==/2) consecutive keys.
map_list_to_pairs/3	Create a Key-Value list by mapping each element of List.
pairs_keys/2	Remove the values from a list of Key-Value pairs.
pairs_keys_values/3	True if Keys holds the keys of Pairs and Values the values.
pairs_values/2	Remove the keys from a list of Key-Value pairs.
transpose_pairs/2	Swap Key-Value to Value-Key.
persistency.pl
current_persistent_predicate/1	True if PI is a predicate that provides access to the persistent database DB.
db_assert/1	Assert Term into the database and record it for persistency.
db_attach/2	Use File as persistent database for the calling module.
db_attached/1	True if the context module attached to the persistent database File.
db_detach/0	Detach persistency from the calling module and delete all persistent clauses from the Prolog database.
db_retract/1	Retract terms from the database one-by-one.
db_retractall/1	Retract all matching facts and do the same in the database.
db_sync/1	Synchronise database with the associated file.
db_sync_all/1	Sync all registered databases.
persistent/1	Declare dynamic database terms.
pio.pl  -- Pure I/O
pprint.pl  -- Pretty Print Prolog terms
predicate_options.pl  -- Access and analyse predicate options
prolog_autoload.pl  -- Autoload all dependencies
prolog_breakpoints.pl
breakpoint_property/2	True when Property is a property of the breakpoint Id.
delete_breakpoint/1	Delete breakpoint with given Id.
set_breakpoint/4	Put a breakpoint at the indicated source-location.
set_breakpoint/5	Put a breakpoint at the indicated source-location.
set_breakpoint_condition/2	Set a condition for of the breakpoint with given Id.
prolog_clause.pl
clause_info/4	Fetches source information for the given clause.
clause_info/5	Fetches source information for the given clause.
clause_name/2	Provide a suitable description of the indicated clause.
initialization_layout/4	Find term-layout of :- initialization directives.
make_varnames/5	Create a Term varnames(...) where each argument contains the name of the variable at that offset.
open_source/2	Hook into clause_info/5 that opens the stream holding the source for a specific clause.
predicate_name/2	Describe a predicate as [Module:]Name/Arity.
unify_goal/5	This hook is called to fix up source code manipulations that result from goal expansions.
unify_term/2	Unify the two terms, where T2 is created by writing the term and reading it back in, but be aware that rounding problems may cause floating point numbers not to unify.
prolog_code.pl
body_term_calls/2	True when BodyTerm calls Goal.
comma_list/2	True if CommaList is a nested term over the ','/2 (';'/2) functor and List is a list expressing the elements of the conjunction.
extend_goal/3	Extend the possibly qualified Goal0 with additional arguments from Extra.
head_name_arity/3	Similar to functor/3, but deals with SWI-Prolog's zero-argument callable terms and avoids creating a non-callable term if Name is not an atom and Arity is zero.
is_control_goal/1	True if Goal is a compiled Prolog control structure.
is_predicate_indicator/1	True when Term is a predicate indicator.
mkconj/3	Create a conjunction or disjunction from two terms.
mkdisj/3	Create a conjunction or disjunction from two terms.
most_general_goal/2	General is the most general version of Goal.
pi_head/2	Translate between a PredicateIndicator and a Goal term.
predicate_label/2	Create a human-readable label for the given predicate indicator.
predicate_sort_key/2	Key is the (module-free) name of the predicate for sorting purposes.
semicolon_list/2	True if CommaList is a nested term over the ','/2 (';'/2) functor and List is a list expressing the elements of the conjunction.
prolog_codewalk.pl
prolog_program_clause/2	True when ClauseRef is a reference for clause in the program.
prolog_walk_code/1	Walk over all loaded (user) Prolog code.
subterm_pos/5	True when SubTerm is a sub term of Term, compared using Cmp, TermPosition describes the term layout of Term and SubTermPos describes the term layout of SubTerm.
prolog_colour.pl  -- Prolog syntax colouring support.
prolog_config.pl  -- Provide configuration information
prolog_coverage.pl  -- Coverage analysis tool
prolog_debug.pl  -- User level debugging tools
prolog_format.pl  -- Analyse format specifications
prolog_history.pl
prolog_history/1	Execute Action on the history.
prolog_jiti.pl
jiti_list/0	List the JITI (Just In Time Indexes) of selected predicates.
jiti_list/1	List the JITI (Just In Time Indexes) of selected predicates.
jiti_suggest_modes/0	Propose modes for the predicates referenced by Spec.
jiti_suggest_modes/1	Propose modes for the predicates referenced by Spec.
prolog_metainference.pl
infer_meta_predicate/2	True when MetaSpec is a meta-predicate specifier for the predicate Head.
inferred_meta_predicate/2	True when MetaSpec is an inferred meta-predicate specification for Head.
prolog_pack.pl  -- A package manager for Prolog
prolog_profile.pl
profile/1	Run once(Goal) under the execution profiler.
profile/2	Run once(Goal) under the execution profiler.
profile_data/1	Gather all relevant data from profiler.
profile_procedure_data/2	Collect data for Pred.
show_profile/1	Display last collected profiling data.
prolog_source.pl  -- Examine Prolog source-files
prolog_stack.pl  -- Examine the Prolog stack
prolog_trace.pl  -- Print access to predicates
prolog_versions.pl
cmp_versions/3	Compare to versions.
require_prolog_version/2	Claim that the running Prolog version is at least version Required and provides the requested Features.
require_version/3	Require Component to have version CmpRequired, while Component is know to have version Available.
prolog_wrap.pl
current_predicate_wrapper/4	True if Head is wrapped with Body.
unwrap_predicate/2	Remove the outermost wrapper whose name unifies with Name.
wrap_predicate/4	Wrap the predicate referenced by Head using Body.
prolog_xref.pl  -- Prolog cross-referencer data collection
pure_input.pl  -- Pure Input from files and streams
qsave.pl  -- Save current program as a state or executable
quasi_quotations.pl  -- Define Quasi Quotation syntax
quintus.pl  -- Quintus compatibility
random.pl
getrand/1	Query/set the state of the random generator.
maybe/0	Succeed/fail with equal probability (variant of maybe/1).
maybe/1	Succeed with probability P, fail with probability 1-P.
maybe/2	Succeed with probability K/N (variant of maybe/1).
random/1	Binds R to a new random float in the open interval (0.0,1.0).
random/3	Generate a random integer or float in a range.
random_between/3	Binds R to a random integer in [L,U] (i.e., including both L and U).
random_member/2	X is a random member of List.
random_numlist/4	Unify List with an ascending list of integers between L and U (inclusive).
random_perm2/4	Does X=A,Y=B or X=B,Y=A with equal probability.
random_permutation/2	Permutation is a random permutation of List.
random_select/3	Randomly select or insert an element.
random_subseq/3	Selects a random subsequence Subseq of List, with Complement containing all elements of List that were not selected.
randseq/3	S is a list of K unique random integers in the range 1..N.
randset/3	S is a sorted list of K unique random integers in the range 1..N.
setrand/1	Query/set the state of the random generator.
rbtrees.pl  -- Red black trees
readutil.pl  -- Read utilities
record.pl  -- Access compound arguments by name
sandbox.pl  -- Sandboxed Prolog code
settings.pl  -- Setting management
shell.pl  -- Elementary shell commands
shlib.pl  -- Utility library for loading foreign objects (DLLs, shared objects)
solution_sequences.pl
call_nth/2	True when Goal succeeded for the Nth time.
distinct/1	True if Goal is true and no previous solution of Goal bound Witness to the same value.
distinct/2	True if Goal is true and no previous solution of Goal bound Witness to the same value.
group_by/4	Group bindings of Template that have the same value for By.
limit/2	Limit the number of solutions.
offset/2	Ignore the first Count solutions.
order_by/2	Order solutions according to Spec.
reduced/1	Similar to distinct/1, but does not guarantee unique results in return for using a limited amount of memory.
reduced/3	Similar to distinct/1, but does not guarantee unique results in return for using a limited amount of memory.
sort.pl
locale_sort/2	Sort a list of atoms using the current locale.
predsort/3	Sorts similar to sort/2, but determines the order of two terms by calling Compare(-Delta, +E1, +E2).
statistics.pl  -- Get information about resource usage
streams.pl
with_output_to/3	Run Goal and once/1 while capturing all output to all streams (current_output, user_output and user_error) in the string Output.
strings.pl
dedent_lines/3	Remove shared indentation for all lines in a string.
indent_lines/3	Add Prefix to the beginning of lines in In.
indent_lines/4	Similar to indent_lines/3, but only adds Prefix to lines for which call(Filter, Line) succeeds.
interpolate_string/4	Establish a string from a template by replacing patterns.
string/4	Implements the quasi quotation syntax string.
string_lines/2	True when String represents Lines.
system.pl  -- System utilities
tables.pl
abolish_table_call/1	Same as abolish_table_subgoals/1.
abolish_table_call/2	Same as abolish_table_subgoals/1.
abolish_table_pred/1	Invalidates all tabled subgoals for the predicate denoted by the predicate or term indicator Pred.
abolish_table_subgoals/2	Behaves as abolish_table_subgoals/1, but allows the default table_gc_action to be over-ridden with a flag, which can be either abolish_tables_transitively or abolish_tables_singly.
get_call/3	True when Trie is an answer trie for a variant of CallTerm.
get_calls/3	True when Trie is an answer trie for a variant that unifies with CallTerm and Skeleton is the answer skeleton.
get_residual/2	True if CallTerm appears in a table and has DelayList.
get_returns/2	True when Return is an answer template for the AnswerTrie.
get_returns/3	True when Return is an answer template for the AnswerTrie and the answer is represented by the trie node NodeID.
get_returns_and_dls/3	True when Return appears in AnswerTrie with the given DelayLists.
get_returns_and_tvs/3	Identical to get_returns/2, but also obtains the truth value of a given answer, setting TruthValue to t if the answer is unconditional and to u if it is conditional.
get_returns_for_call/2	True if AnswerTerm appears in the tables for the variant CallTerm.
set_pil_off/0	Dummy predicates for XSB compatibility.
set_pil_on/0	Dummy predicates for XSB compatibility.
t not/1	Tabled negation.
tfindall/3	This predicate emerged in XSB in an attempt to provide a safer alternative to findall/3.
terms.pl  -- Term manipulation
thread.pl  -- High level thread primitives
thread_pool.pl  -- Resource bounded thread management
threadutil.pl  -- Interactive thread utilities
tty.pl  -- Terminal operations
ugraphs.pl  -- Graph manipulation library
url.pl
file_name_to_url/2	Translate between a filename and a file:// URL.
global_url/3	Translate a possibly relative URL into an absolute one.
http_location/2	Construct or analyze an HTTP location.
is_absolute_url/1	True if URL is an absolute URL.
parse_url/2	Construct or analyse a URL.
parse_url/3	Similar to parse_url/2 for relative URLs.
parse_url_search/2	Construct or analyze an HTTP search specification.
set_url_encoding/2	Query and set the encoding for URLs.
url_iri/2	Convert between a URL, encoding in US-ASCII and an IRI.
www_form_encode/2	En/decode to/from application/x-www-form-encoded.
utf8.pl  -- UTF-8 encoding/decoding on lists of character codes.
varnumbers.pl  -- Utilities for numbered terms
wfs.pl  -- Well Founded Semantics interface
when.pl
when/2	Execute Goal when Condition is satisfied.
writef.pl
swritef/2	Use writef/1 or writef/2 and write the result to a string.
swritef/3	Use writef/1 or writef/2 and write the result to a string.
writef/1	Formatted write to the current_output.
writef/2	Formatted write to the current_output.
www_browser.pl  -- Open a URL in the users browser
yall.pl  -- Lambda expressions
zip.pl  -- Access resource ZIP archives