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  -- Event service
charsio.pl  -- I/O on Lists of Character Codes
check.pl  -- Consistency checking
check/0	Run all consistency checks defined by checker/2.
checker/2	Register code validation routines.
list_autoload/0	Report predicates that may be auto-loaded.
list_cross_module_calls/0	List calls from one module to another using Module:Goal where the callee is not defined exported, public or multifile, i.e., where the callee should be considered private.
list_format_errors/0	List argument errors for format/2,3.
list_format_errors/1	List argument errors for format/2,3.
list_rationals/0	List rational numbers that appear in clauses.
list_rationals/1	List rational numbers that appear in clauses.
list_redefined/0	Lists predicates that are defined in the global module user as well as in a normal module; that is, predicates for which the local definition overrules the global default definition.
list_strings/0	List strings that appear in clauses.
list_strings/1	List strings that appear in clauses.
list_trivial_fails/0	List goals that trivially fail because there is no matching clause.
list_trivial_fails/1	List goals that trivially fail because there is no matching clause.
list_undefined/0	Report undefined predicates.
list_undefined/1	Report undefined predicates.
list_void_declarations/0	List predicates that have declared attributes, but no clauses.
string_predicate/1	Multifile hook to disable list_strings/0 on the given predicate.
trivial_fail_goal/1	Multifile hook that tells list_trivial_fails/0 to accept Goal as valid.
valid_string_goal/1	Multifile hook that qualifies Goal as valid for list_strings/0.
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  -- 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
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
gensym.pl  -- Generate unique symbols
git.pl  -- Run GIT commands
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  -- Text based manual
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.
iostream.pl  -- Utilities to deal with streams
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  -- List Manipulation
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
make/0	Reload all source files that have been changed since they were loaded.
make_reload_file/1	Reload file into the proper module.
modules.pl  -- Module utility predicates
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  -- Manage operators
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.
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/1	Switch portraying on or off.
set_portray_text/2	Set options for portraying.
set_portray_text/3	Set options for portraying.
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
prolog_code.pl  -- Utilities for reasoning about code
prolog_codewalk.pl  -- Prolog code walker
prolog_colour.pl  -- Prolog syntax colouring support.
prolog_config.pl
prolog_config/2	Get information on the configuration of the current Prolog system.
prolog_dump_runtime_variables/0	Dump the current configuration in shell format.
prolog_coverage.pl  -- Coverage analysis tool
prolog_debug.pl
debug_control_hook/1	Allow user-hooks in the Prolog debugger interaction.
debugging/0	Report current status of the debugger.
debugging_hook/1	Multifile hook that is called as forall(debugging_hook(DebugMode), true) and that may be used to extend the information printed from other debugging libraries.
exception_hook/5	Trap exceptions and consider whether or not to start the tracer.
nospy/1	Set/clear spy-points.
nospyall/0	Set/clear spy-points.
notrap/1	Install a trap on error(Formal, Context) exceptions that unify.
spy/1	Set/clear spy-points.
trap/1	Install a trap on error(Formal, Context) exceptions that unify.
trap_alias/2	Define short hands for commonly used exceptions.
prolog_format.pl  -- Analyse format specifications
prolog_jiti.pl  -- Just In Time Indexing (JITI) utilities
prolog_metainference.pl  -- Infer meta-predicate properties
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
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_xref.pl
called_by/2	If this succeeds, the cross-referencer assumes Goal may call any of the goals in ListOfCalled.
called_by/4	True when Called is a list of callable terms called from Goal, handled by the predicate Module:Goal and executed in the context of the module Context.
hook/1	True if Goal is a hook that is called spontaneously (e.g., from foreign code).
meta_goal/2	Define meta-predicates.
xref_called/3	True when By is called from Called in Source.
xref_called/4	True when By is called from Called in Source.
xref_called/5	True when By is called from Called in Source.
xref_clean/1	Reset the database for the given source.
xref_comment/3	Is true when Source has a section comment with Title and Comment.
xref_comment/4	Is true when Head in Source has the given PlDoc comment.
xref_current_source/1	Check what sources have been analysed.
xref_defined/3	Test if Goal is accessible in Source.
xref_definition_line/2	If the 3th argument of xref_defined contains line info, return this in Line.
xref_done/2	Cross-reference executed at Time.
xref_exported/2	True when Source exports Head.
xref_hook/1	Definition of known hooks.
xref_meta/2	True when Called is a list of terms called from Head.
xref_meta/3	True when Head calls Called in Source.
xref_mode/3	Is true when Source provides a predicate with Mode and determinism.
xref_module/2	True if Module is defined in Source.
xref_op/2	Give the operators active inside the module.
xref_option/2	True when Source was processed using Option.
xref_prolog_flag/4	True when Flag is set to Value at Line in Source.
xref_public_list/3	Find meta-information about File.
xref_public_list/4	Find meta-information about File.
xref_public_list/6	Find meta-information about File.
xref_public_list/7	Find meta-information about File.
xref_source/1	Generate the cross-reference data for Source if not already done and the source is not modified.
xref_source/2	Generate the cross-reference data for Source if not already done and the source is not modified.
xref_source_file/3	Find named source file from Spec, relative to Src.
xref_source_file/4	Find named source file from Spec, relative to Src.
xref_uses_file/3	True when Source tries to load a file using Spec.
pure_input.pl  -- Pure Input from files and streams
qsave.pl
quasi_quotations.pl
phrase_from_quasi_quotation/2	Process the quasi quotation using the DCG Grammar.
quasi_quotation_syntax/1	Declare the predicate SyntaxName/4 to implement the the quasi quote syntax SyntaxName.
quasi_quotation_syntax_error/1	Report syntax_error(Error) using the current location in the quasi quoted input parser.
with_quasi_quotation_input/3	Process the quasi-quoted Content using Stream parsed by Goal.
quintus.pl  -- Quintus compatibility
random.pl  -- Random numbers
rbtrees.pl  -- Red black trees
readln.pl
readutil.pl  -- Read utilities
record.pl
current_record/2	True if Name is the name of a record defined in the module associated with Term and Term is the user-provided record declaration.
current_record_predicate/2	True if PI is the predicate indicator for an access predicate to Record.
record/1	Define access predicates for a compound-term.
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
convert_setting_text/3	Converts from textual form to Prolog Value.
current_setting/1	True if Setting is a currently defined setting.
env/2	Evaluate environment variables on behalf of arithmetic expressions.
env/3	Evaluate environment variables on behalf of arithmetic expressions.
list_settings/0	List settings to current_output.
list_settings/1	List settings to current_output.
load_settings/1	Load local settings from File.
load_settings/2	Load local settings from File.
restore_setting/1	Restore the value of setting Name to its default.
save_settings/0	Save modified settings to File.
save_settings/1	Save modified settings to File.
set_setting/2	Change a setting.
set_setting_default/2	Change the default for a setting.
setting/2	True when Name is a currently defined setting with Value.
setting/4	Define a setting.
setting_property/2	Query currently defined settings.
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  -- Get information about resource usage
strings.pl  -- String utilities
system.pl  -- System utilities
tables.pl  -- XSB interface to tables
terms.pl
foldsubterms/4	The predicate foldsubterms/5 calls call(Goal4, SubTerm1, SubTerm2, StateIn, StateOut) for each subterm, including variables, in Term1.
foldsubterms/5	The predicate foldsubterms/5 calls call(Goal4, SubTerm1, SubTerm2, StateIn, StateOut) for each subterm, including variables, in Term1.
mapargs/3	Term1 and Term2 have the same functor (name/arity) and for each matching pair of arguments call(Goal, A1, A2) is true.
mapsubterms/3	Recursively map sub terms of Term1 into subterms of Term2 for every pair for which call(Goal, ST1, ST2) succeeds.
mapsubterms_var/3	Recursively map sub terms of Term1 into subterms of Term2 for every pair for which call(Goal, ST1, ST2) succeeds.
same_functor/2	True when Term1 and Term2 are terms that have the same functor (Name/Arity).
same_functor/3	True when Term1 and Term2 are terms that have the same functor (Name/Arity).
same_functor/4	True when Term1 and Term2 are terms that have the same functor (Name/Arity).
subsumes/2	True if Generic is unified to Specific without changing Specific.
subsumes_chk/2	True if Generic can be made equivalent to Specific without changing Specific.
term_factorized/3	Is true when Skeleton is Term where all subterms that appear multiple times are replaced by a variable and Substitution is a list of Var=Value that provides the subterm at the location Var.
term_size/2	True if Size is the size in cells occupied by Term on the global (term) stack.
term_subsumer/3	General is the most specific term that is a generalisation of Special1 and Special2.
variant/2	Same as SWI-Prolog Term1 =@= Term2.
thread.pl  -- High level thread primitives
thread_pool.pl  -- Resource bounded thread management
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
when/2	Execute Goal when Condition is satisfied.
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.