library

Prolog files

aggregate.pl  -- Aggregation operators on backtrackable predicates
ansi_term.pl  -- Print decorated text to ANSI consoles
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 encoding and decoding
base64.pl  -- Base64 encoding and decoding
broadcast.pl  -- Event service
charsio.pl
atom_to_chars/2	Convert Atom into a list of character codes.
atom_to_chars/3	Convert Atom into a difference list of character codes.
format_to_chars/3	Use format/2 to write to a list of character codes.
format_to_chars/4	Use format/2 to write to a difference list of character codes.
number_to_chars/2	Convert Atom into a list of character codes.
number_to_chars/3	Convert Number into a difference list of character codes.
open_chars_stream/2	Open Codes as an input stream.
read_from_chars/2	Read Codes into Term.
read_term_from_chars/3	Read Codes into Term.
with_output_to_chars/2	Run Goal as with once/1.
with_output_to_chars/3	Run Goal as with once/1.
with_output_to_chars/4	Same as with_output_to_chars/3 using an explicit stream.
write_to_chars/2	Write a term to a code list.
write_to_chars/3	Write a term to a code list.
check.pl
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  -- I/O on Lists of Character Codes
coinduction.pl  -- Co-Logic Programming
csv.pl  -- Process CSV (Comma-Separated Values) data
ctypes.pl
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
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
dif/2	Constraint that expresses that Term1 and Term2 never become identical (==/2).
edinburgh.pl  -- Some traditional Edinburgh predicates
edit.pl  -- Editor interface
error.pl
current_encoding/1	True if Name is the name of a supported encoding.
current_type/3	True when Type is a currently defined type and Var satisfies Type of the body term Body succeeds.
domain_error/2	The argument is of the proper type, but has a value that is outside the supported values.
existence_error/2	Culprit is of the correct type and correct domain, but there is no existing (external) resource of type ObjectType that is represented by it.
existence_error/3	Culprit is of the correct type and correct domain, but there is no existing (external) resource of type ObjectType that is represented by it in the provided set.
has_type/2	True if Term satisfies Type.
instantiation_error/1	An argument is under-instantiated.
is_of_type/2	True if Term satisfies Type.
must_be/2	True if Term satisfies the type constraints for Type.
permission_error/3	It is not allowed to perform Operation on (whatever is represented by) Culprit that is of the given PermissionType (in fact, the ISO Standard is confusing and vague about these terms' meaning).
representation_error/1	A representation error indicates a limitation of the implementation.
resource_error/1	A goal cannot be completed due to lack of resources.
syntax_error/1	A text has invalid syntax.
type_error/2	Tell the user that Culprit is not of the expected ValidType.
uninstantiation_error/1	An argument is over-instantiated.
exceptions.pl  -- Exception classification
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  -- heaps/priority queues
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  -- Incremental dynamic predicate modification
intercept.pl
intercept/3	Run Goal as call/1.
intercept/4	Similar to intercept/3, but the copy of Handler is called as call(Copy,Arg), which allows passing large context arguments or arguments subject to unification or destructive assignment.
intercept_all/4	True when List contains all instances of Template that have been sent using send_signal/1 where the argument unifies with Ball.
nb_intercept_all/4	As intercept_all/4, but backtracing inside Goal does not reset List.
send_signal/1	If this predicate is called from a sub-goal of intercept/3, execute the associated Handler of the intercept/3 environment.
send_silent_signal/1	As send_signal/1, but succeed silently if there is no matching intercept environment.
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  -- 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  -- Macro expansion
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  -- Non-backtrackable sets
occurs.pl  -- Finding and counting sub-terms
operators.pl  -- Manage operators
option.pl  -- Option list processing
optparse.pl
opt_arguments/3	Extract commandline options according to a specification.
opt_help/2	True when Help is a help string synthesized from OptsSpec.
opt_parse/4	Equivalent to opt_parse(OptsSpec, ApplArgs, Opts, PositionalArgs, []).
opt_parse/5	Parse the arguments Args (as list of atoms) according to OptsSpec.
parse_type/3	Hook to parse option text Codes to an object of type Type.
ordsets.pl  -- Ordered set manipulation
oset.pl
oset_addel/3	Ordered set element addition.
oset_delel/3	Ordered set element deletion.
oset_diff/3	Ordered set difference.
oset_dint/2	Distributed intersection.
oset_dunion/2	Distributed union.
oset_int/3	ordered set intersection.
oset_is/1	check that OSet in correct format (standard order).
oset_power/2	True when PSet is the powerset of Set.
oset_union/3	Union is the union of OSet1 and OSet2.
pairs.pl  -- Operations on key-value lists
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
portray_text.pl  -- Portray text
pprint.pl  -- Pretty Print Prolog terms
predicate_options.pl  -- Access and analyse predicate options
prolog_autoload.pl
autoload_all/0	Force all necessary autoloading to be done now.
autoload_all/1	Force all necessary autoloading to be done now.
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  -- Utilities for reasoning about code
prolog_codewalk.pl  -- Prolog code walker
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
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  -- User level debugging tools
prolog_format.pl  -- Analyse format specifications
prolog_history.pl  -- Per-directory persistent commandline 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 properties
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  -- Wrapping predicates
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
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
abs/2	Unify `Absolute' with the absolute value of `Number'.
acos/2	Math library predicates.
asin/2	Math library predicates.
atan/2	Math library predicates.
atan2/3	Math library predicates.
atom_char/2	Same as ISO char_code/2.
ceiling/2	Math library predicates.
compile/1	Compile files.
cos/2	Math library predicates.
current_stream/3	SICStus/Quintus and backward compatible predicate.
date/1	Get current date as date(Y,M,D).
floor/2	Math library predicates.
genarg/3	Generalised version of ISO arg/3.
log/2	Math library predicates.
log10/2	Math library predicates.
midstring/3	Too difficult to explain.
midstring/4	Too difficult to explain.
midstring/5	Too difficult to explain.
midstring/6	Too difficult to explain.
no_style_check/1	Same as SWI-Prolog style_check(-Style).
on_exception/3
otherwise/0	For (A -> B ; otherwise -> C).
pow/3	Math library predicates.
prolog_flag/2	Same as ISO current_prolog_flag/2.
raise_exception/1	Quintus compatible exception handling.
round/2	Math library predicates.
sign/2	Math library predicates.
simple/1	Term is atomic or a variable.
sin/2	Math library predicates.
skip_line/0	Skip the rest of the current line (on Stream).
skip_line/1	Skip the rest of the current line (on Stream).
sqrt/2	Math library predicates.
stream_position/3	True when Old is the current position in Stream and the stream has been repositioned to New.
tan/2	Math library predicates.
unix/1	This predicate provides a partial emulation of the corresponding Quintus predicate.
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.
rwlocks.pl
with_rwlock/3	Run Goal, synchronized with LockId in ModeSpec.
with_rwlock/4	Run Goal, synchronized with LockId in ModeSpec.
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  -- Elementary shell commands
shlib.pl  -- Utility library for loading foreign objects (DLLs, shared objects)
solution_sequences.pl  -- Modify solution sequences
sort.pl
statistics.pl  -- Get information about resource usage
streams.pl  -- Manage Prolog streams
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
lock_predicate/1	Transform a predicate into a system predicate.
system_mode/1	Switch the system into system or user mode.
system_module/0	Any predicate defined after this declaraction uptil the end of the file will become a system predicate.
unlock_predicate/1	Transform a system predicate into a normal system predicate.
tables.pl  -- XSB interface to tables
terms.pl  -- Term manipulation
thread.pl  -- High level thread primitives
call_in_thread/2	Run Goal as an interrupt in the context of Thread.
concurrent/3	Run Goals in parallel using N threads.
concurrent_and/2	Concurrent version of (Generator,Test).
concurrent_and/3	Concurrent version of (Generator,Test).
concurrent_forall/2	True when Action is true for all solutions of Generate.
concurrent_forall/3	True when Action is true for all solutions of Generate.
concurrent_maplist/2	Concurrent version of maplist/2.
concurrent_maplist/3	Concurrent version of maplist/2.
concurrent_maplist/4	Concurrent version of maplist/2.
first_solution/3	Try alternative solvers concurrently, returning the first answer.
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).
tty.pl
menu/3	Show a menu.
tty_clear/0	Clear the display.
tty_flash/0	Give visual signal if possible, otherwise beep.
ugraphs.pl  -- Graph manipulation library
url.pl  -- Analysing and constructing URL
utf8.pl
utf8_codes/3	DCG translating between a Unicode code-list and its UTF-8 encoded byte-string.
varnumbers.pl  -- Utilities for numbered terms
wfs.pl  -- Well Founded Semantics interface
when.pl  -- Conditional coroutining
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
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.