library

Prolog files

aggregate.pl  -- Aggregation operators on backtrackable predicates
ansi_term.pl  -- Print decorated text to ANSI consoles
apply.pl  -- Apply predicates on a list
apply_macros.pl  -- Goal expansion rules to avoid meta-calling
arithmetic.pl  -- Extensible arithmetic
assoc.pl  -- Binary associations
atom.pl  -- Operations on atoms
backcomp.pl  -- Backward compatibility
base32.pl  -- Base32 encoding and decoding
base64.pl  -- Base64 encoding and decoding
broadcast.pl
broadcast/1	Broadcast given event.
broadcast_request/1	Broadcast given event till accepted.
listen/2	Open a channel for listening for events of the given `Templ'.
listen/3	Open a channel for listening for events of the given `Templ'.
listening/3	returns currently open channels.
unlisten/1	Destroy a channel.
unlisten/2	Destroy a channel.
unlisten/3	Destroy a channel.
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  -- Co-Logic Programming
csv.pl
csv/3	Prolog DCG to `read/write' CSV data.
csv/4	Prolog DCG to `read/write' CSV data.
csv_options/2	Compiled is the compiled representation of the CSV processing options as they may be passed into csv//2, etc.
csv_read_file/2	Read a CSV file into a list of rows.
csv_read_file/3	Read a CSV file into a list of rows.
csv_read_file_row/3	True when Row is a row in File.
csv_read_row/3	Read the next CSV record from Stream and unify the result with Row.
csv_read_stream/3	Read CSV data from Stream.
csv_write_file/2	Write a list of Prolog terms to a CSV file.
csv_write_file/3	Write a list of Prolog terms to a CSV file.
csv_write_stream/3	Write the rows in Data to Stream.
ctypes.pl  -- Character code classification
date.pl
date_time_value/3	Extract values from a date-time structure.
day_of_the_week/2	Computes the day of the week for a given date.
day_of_the_year/2	Computes the day of the year for a given date.
parse_time/2	Stamp is a timestamp created from parsing Text using the representation Format.
parse_time/3	Stamp is a timestamp created from parsing Text using the representation Format.
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
fastrw.pl  -- Fast reading and writing of terms
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  -- heaps/priority queues
help.pl  -- Text based manual
intercept.pl  -- Intercept and signal interface
iostream.pl  -- Utilities to deal with streams
close_any/1	Execute the Close closure returned by open_any/5.
open_any/5	Establish a stream from Specification that should be closed using Close, which can either be called or passed to close_any/1.
lazy_lists.pl  -- Lazy list handling
listing.pl
listing/0	Lists all predicates defined in the calling module.
listing/1	List matching clauses.
listing/2	List matching clauses.
portray_clause/1	Portray `Clause' on the current output stream.
portray_clause/2	Portray `Clause' on the current output stream.
portray_clause/3	Portray `Clause' on the current output stream.
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  -- Module utility predicates
nb_set.pl  -- Non-backtrackable sets
occurs.pl  -- Finding and counting sub-terms
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
dict_options/2	Convert between an option list and a dictionary.
merge_options/3	Merge two option sets.
meta_options/3	Perform meta-expansion on options that are module-sensitive.
option/2	Get an Option from Options.
option/3	Get an Option from Options.
select_option/3	Get and remove Option from Options.
select_option/4	Get and remove Option with default value.
optparse.pl  -- command line parsing
ordsets.pl  -- Ordered set manipulation
pairs.pl  -- Operations on key-value lists
persistency.pl  -- Provide persistent dynamic predicates
pio.pl  -- Pure I/O
portray_text.pl  -- Portray text
pprint.pl  -- Pretty Print Prolog terms
predicate_options.pl  -- Access and analyse predicate options
prolog_autoload.pl  -- Autoload all dependencies
prolog_breakpoints.pl  -- Manage Prolog break-points
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_colour.pl
prolog_colourise_query/3	Colourise a query, to be executed in the context of SourceId.
prolog_colourise_stream/3	Determine colour fragments for the data on Stream.
prolog_colourise_stream/4	Determine colour fragments for the data on Stream.
prolog_colourise_term/4	Colourise the next term on Stream.
syntax_colour/2	True when a range classified Class must be coloured using Attributes.
vararg_goal_classification/3	Multifile hookable classification for vararg predicates.
prolog_coverage.pl
cov_load_data/2	Reload coverage data from File.
cov_property/1	True when coverage analysis satisfies Property.
cov_reset/0	Discard all collected coverage data.
cov_save_data/2	Save the coverage information to File.
coverage/1	As call(Goal), collecting coverage information while Goal is running.
coverage/2	Collect and optionally report coverage by Goal.
report_hook/2	This hook is called after the data collection.
show_coverage/1	Show collected coverage data.
prolog_debug.pl  -- User level debugging tools
prolog_format.pl
format_spec/2	Parse a format string.
format_spec/3	DCG for parsing format strings.
format_types/2	True when Format requires an argument list with terms of the type specified by Types.
prolog_pack.pl
pack_info/1	Print more detailed information about Pack.
pack_install/1	Install one or more packs from SpecOrList.
pack_install/2	Install one or more packs from SpecOrList.
pack_install_local/3	Install a number of packages in a local directory.
pack_list/1	Query package server and installed packages and display results.
pack_list/2	Query package server and installed packages and display results.
pack_list_installed/0	List currently installed packages and report possible dependency issues.
pack_property/2	True when Property is a property of an installed Pack.
pack_publish/2	Publish a package.
pack_rebuild/0	Rebuild possible foreign components of Pack.
pack_rebuild/1	Rebuild possible foreign components of Pack.
pack_remove/1	Remove the indicated package.
pack_remove/2	Remove the indicated package.
pack_search/1	Query package server and installed packages and display results.
pack_upgrade/1	Upgrade Pack.
pack_url_file/2	True if File is a unique id for the referenced pack and version.
prolog_profile.pl  -- Execution profiler
prolog_source.pl
quasi_quotation_syntax/2	True when the quasi quotation syntax Syntax can be loaded from Library.
xref_close_source/2	Called by prolog_close_source/1 to close a source previously opened by the hook prolog:xref_open_source/2.
xref_open_source/2	Hook to open an xref SourceID.
directory_source_files/3	True when Files is a sorted list of Prolog source files in Dir.
file_alias_path/2	True if file Alias points to Dir.
file_name_on_path/2	True if OnPath a description of File based on the file search path.
load_quasi_quotation_syntax/2	Import quasi quotation syntax Syntax from Path into the module specified by the first argument.
path_segments_atom/2	Translate between a path represented as a/b/c and an atom representing the same path.
prolog_canonical_source/2	Given a user-specification of a source, generate a unique and indexable identifier for it.
prolog_close_source/1	Close a stream opened using prolog_open_source/2.
prolog_file_directives/3	True when Directives is a list of directives that appear in the source file File.
prolog_open_source/2	Open source with given canonical id (see prolog_canonical_source/2) and remove the #!
prolog_read_source_term/4	Read a term from a Prolog source-file.
read_source_term_at_location/3	Try to read a Prolog term form an arbitrary location inside a file.
requires_library/2	known expansion hooks.
valid_term_position/2	Check that a Term has an appropriate TermPos layout.
prolog_stack.pl
backtrace/1	Get and print a stacktrace to the user_error stream.
get_prolog_backtrace/2	Obtain a backtrace from the current location.
get_prolog_backtrace/3	Obtain a backtrace from the current location.
print_last_choicepoint/0	Print details on the last open choice point.
print_last_choicepoint/2
print_prolog_backtrace/2	Print a stacktrace in human readable form to Stream.
print_prolog_backtrace/3	Print a stacktrace in human readable form to Stream.
prolog_stack_frame_property/2	True when Property is a property of Frame.
stack_guard/1	Dynamic multifile hook that is normally not defined.
stack_guard/1	Dynamic multifile predicate.
prolog_versions.pl  -- Demand specific (Prolog) versions
prolog_xref.pl  -- Prolog cross-referencer data collection
pure_input.pl
lazy_list_character_count/3	True when CharCount is the current character count in the Lazy list.
lazy_list_location/3	Determine current (error) location in a lazy list.
phrase_from_file/2	Process the content of File using the DCG rule Grammar.
phrase_from_file/3	As phrase_from_file/2, providing additional Options.
phrase_from_stream/2	Run Grammer against the character codes on Stream.
stream_to_lazy_list/2	Create a lazy list representing the character codes in Stream.
syntax_error/3	Throw the syntax error Error at the current location of the input.
qsave.pl
arch_shlib/3	This is a user defined hook called by qsave_program/2.
qsave_program/1	Make a saved state in file `File'.
qsave_program/2	Make a saved state in file `File'.
qsave_toplevel/0	Called to handle `-c file` compilaton.
quasi_quotations.pl  -- Define Quasi Quotation syntax
quintus.pl  -- Quintus compatibility
random.pl  -- Random numbers
rbtrees.pl  -- Red black trees
readln.pl
readutil.pl  -- Read utilities
record.pl  -- Access compound arguments by name
sandbox.pl
sandbox_allowed_directive/1	Throws an exception if G is not considered a safe directive.
sandbox_allowed_expansion/1	Throws an exception if G is not considered a safe expansion goal.
sandbox_allowed_goal/1	Throw an exception if it is not safe to call G.
format_calls/3	Find ~@ calls from Format and Args.
safe_call/1	Call Goal if it complies with the sandboxing rules.
safe_directive/1	Hook to declare additional directives as safe.
safe_global_variable/1	Declare the given global variable safe to write to.
safe_goal/1	True if calling Goal provides no security risc.
safe_meta/2	Hook.
safe_primitive/1	True if Goal is safe to call (i.e., cannot access dangerous system-resources and cannot upset other parts of the Prolog process).
safe_prolog_flag/2	True if it is safe to set the flag Flag to Value.
settings.pl  -- Setting management
shell.pl
cd/0	Change working directory.
cd/1	Change working directory.
dirs/0	Manage the directory stack:.
file_style/2	True when File should be listed as a terminal hyperlink.
ls/0	Listing similar to Unix =ls -F=, flagging directories with =/=.
ls/1	Listing similar to Unix =ls -F=, flagging directories with =/=.
mv/2	Move (Rename) a file.
popd/0	Manage the directory stack:.
pushd/0	Manage the directory stack:.
pushd/1	Manage the directory stack:.
pwd/0	Print current working directory.
rm/1	Remove (unlink) a file.
shell/0	Execute an interactive shell.
shlib.pl  -- Utility library for loading foreign objects (DLLs, shared objects)
solution_sequences.pl  -- Modify solution sequences
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
call_time/2	Call Goal as call/1, unifying Time with a dict that provides information on the resource usage.
call_time/3	Call Goal as call/1, unifying Time with a dict that provides information on the resource usage.
statistics/0	Print information about resource usage using print_message/2.
statistics/1	Stats is a dict representing the same information as statistics/0.
thread_statistics/2	Obtain statistical information about a single thread.
time/1	Execute Goal, reporting statistics to the user.
streams.pl  -- Manage Prolog streams
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  -- String utilities
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
create_pool/1	Hook to create a thread pool lazily.
current_thread_pool/1	True if Name refers to a defined thread pool.
thread_create_in_pool/4	Create a thread in Pool.
thread_pool_create/3	Create a pool of threads.
thread_pool_destroy/1	Destroy the thread pool named Name.
thread_pool_property/2	True if Property is a property of thread pool Name.
worker_exitted/3	It is possible that '__thread_pool_manager' no longer exists while closing down the process because the manager was killed before the worker.
threadutil.pl  -- Interactive thread utilities
attach_console/0	Create a new console and make the standard Prolog streams point to it.
attach_console/1	Create a new console and make the standard Prolog streams point to it.
join_threads/0	Join all terminated threads.
tbacktrace/1	Print a backtrace for Thread to the stream user_error of the calling thread.
tbacktrace/2	Print a backtrace for Thread to the stream user_error of the calling thread.
tdebug/0	Enable debug-mode, trapping the graphical debugger on reaching spy-points or errors.
tdebug/1	Enable debug-mode, trapping the graphical debugger on reaching spy-points or errors.
thread_has_console/0	True when the calling thread has an attached console.
threads/0	List currently known threads with their status.
tnodebug/0	Disable debug-mode in all threads or the specified Thread.
tnodebug/1	Disable debug-mode in all threads or the specified Thread.
tprofile/1	Profile the operation of Thread until the user hits a key.
tspy/1	Trap the graphical debugger on reaching Spec in the specified or any thread.
tspy/2	Trap the graphical debugger on reaching Spec in the specified or any thread.
with_stopped_threads/2	Stop all threads except the caller while running once(Goal).
ugraphs.pl
add_edges/3	Unify NewGraph with a new graph obtained by adding the list of Edges to Graph.
add_vertices/3	Unify NewGraph with a new graph obtained by adding the list of Vertices to Graph.
complement/2	UGraphOut is a ugraph with an edge between all vertices that are not connected in UGraphIn and all edges from UGraphIn removed.
compose/3	Compose NewGraph by connecting the drains of LeftGraph to the sources of RightGraph.
connect_ugraph/3	Adds Start as an additional vertex that is connected to all vertices in UGraphIn.
del_edges/3	Unify NewGraph with a new graph obtained by removing the list of Edges from Graph.
del_vertices/3	Unify NewGraph with a new graph obtained by deleting the list of Vertices and all the edges that start from or go to a vertex in Vertices to the Graph.
edges/2	Unify Edges with all edges appearing in Graph.
neighbors/3	Neigbours is a sorted list of the neighbours of Vertex in Graph.
neighbours/3	Neigbours is a sorted list of the neighbours of Vertex in Graph.
reachable/3	True when Vertices is an ordered set of vertices reachable in UGraph, including Vertex.
top_sort/2	Sort vertices topologically.
transitive_closure/2	Generate the graph Closure as the transitive closure of Graph.
transpose_ugraph/2	Unify NewGraph with a new graph obtained from Graph by replacing all edges of the form V1-V2 by edges of the form V2-V1.
ugraph_layers/2	Sort vertices topologically.
ugraph_union/3	NewGraph is the union of Graph1 and Graph2.
vertices/2	Unify Vertices with all vertices appearing in Graph.
vertices_edges_to_ugraph/3	Create a UGraph from Vertices and Edges.
url.pl  -- Analysing and constructing URL
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  -- Conditional coroutining
www_browser.pl  -- Open a URL in the users browser
yall.pl  -- Lambda expressions
zip.pl
with_zipper/2	Run Goal while holding ownership over Zipper.
zip_close/1	Close a zipper.
zip_close/2	Close a zipper.
zip_open/4	Create a Zipper, providing access to File.
zipper_file_info/3	Obtain information about the current zip entry.
zipper_goto/2	Seek Zipper to a specified entry.
zipper_members/2	True when Members is the list of file names in the Zipper.
zipper_open_current/3	Open the current entry as an input stream.