Logtalk APIs
3.44.0
Contents
Libraries
Directories
Entities
Predicates
Core diagram
Libraries diagram
Tools diagram
Ports diagram
Contributions diagram
Index
External Contents
Handbook
Logtalk website
GitHub repo
Logtalk APIs
»
Index
Index
Symbols
|
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
J
|
K
|
L
|
M
|
N
|
O
|
P
|
Q
|
R
|
S
|
T
|
U
|
V
|
W
|
X
|
Z
Symbols
(/)/2
(//)/2
(<)/2
(<=)/2
,
[1]
(=:=)/2
(=<)/2
(=>)/2
,
[1]
(=\=)/2
(>)/2
(>=)/2
=~= / 2
,
[1]
A
a_star_interpreter(W)
absolute_file_name/2
acc_info/5
acc_info/7
activate_monitor/0
add/3
add_directive_/2
add_directive_/3
add_directive_before_entity_/2
add_library_documentation_url/4
add_link_options/3
add_node_zoom_option/4
addDependent/1
after/2
after/3
after_event_registry
all/0
,
[1]
,
[2]
all/1
all_files/0
,
[1]
all_files/1
,
[1]
all_libraries/0
,
[1]
all_libraries/1
,
[1]
all_score/1
ancestor/1
ancestor/4
ancestors/1
append/2
append/3
,
[1]
,
[2]
apply/2
apply/4
approximately_equal/3
,
[1]
arbitrary
arbitrary/1
arbitrary/2
arithmetic_mean/2
arithmetic_mean/5
array_list/2
array_to_terms/2
array_to_terms/3
as_dictionary/2
as_difflist/2
as_heap/2
as_list/2
,
[1]
,
[2]
,
[3]
,
[4]
as_set/2
ask_question/5
assertion/1
,
[1]
assertion/2
,
[1]
assertions
assertions(Mode)
assertions_messages
assignable/1
assignable/2
assignvars
assignvarsp
atom
atomic
automation_report
auxiliary_predicate_counter_/1
average/2
average_deviation/3
avltree
B
backend_adapter_hook
backend_random
base_/2
before/2
before/3
before_event_registry
bench_goal/1
benchmark/2
benchmark/3
benchmark/4
benchmark_generators
benchmark_reified/3
best_first
between/3
,
[1]
bfs_interpreter
binary_input_assertion/2
binary_input_assertion/3
binary_output_assertion/2
binary_output_assertion/3
bintree
body_pred/1
body_pred_call/2
branch/2
built_in_directive/4
built_in_flag/2
built_in_method/4
built_in_non_terminal/4
built_in_predicate/4
bup_interpreter
C
c/1
calendar_month/3
call_with_timeout/2
call_with_timeout/3
callable
cat/2
cc_metric
cdata_generation//1
change_directory/1
changed/0
changed/1
character
character_data_format/3
characterp
chebyshev_distance/3
chebyshev_norm/2
check/1
,
[1]
check/2
check/3
check_binary_file/2
check_binary_input/1
check_binary_input/2
check_binary_output/1
check_binary_output/2
check_option/1
check_options/1
check_text_file/2
check_text_input/1
check_text_input/2
check_text_output/1
check_text_output/2
chr_is/2
chr_next_state/1
chr_no_spy/1
chr_nospy/0
chr_notrace/0
chr_option/2
chr_option_allow_deep_guards/0
chr_option_optimization_level/1
chr_option_print_trace/0
chr_option_show_history/0
chr_option_show_id/0
chr_option_show_stack/0
chr_option_show_store/0
chr_option_trace_interactive/0
chr_rule_/1
chr_spy/1
chr_spy_point/1
chr_trace/0
class/1
class_hierarchy
class_hierarchyp
classes/1
clean_binary_input/0
clean_binary_output/0
clean_file/1
clean_text_input/0
clean_text_output/0
cleanup/0
clone/1
clone/3
clone/4
cloning
closed_input_stream/2
closed_output_stream/2
code_metric
code_metrics
code_metrics_messages
code_metrics_utilities
coefficient_of_variation/2
command_line_arguments/1
commit_author/2
commit_date/2
commit_hash/2
commit_hash_abbreviated/2
commit_log/3
commit_message/2
comparingp
compile_aux_clauses/1
compile_predicate_heads/4
compile_predicate_indicators/3
compiled_pred_call/2
completion/2
completions/2
compound
condition/0
connect/1
connect/3
console/1
contains/2
control_construct/4
core_messages
coroutining
counter
counter/2
counter_/2
counters
coupling_metric
cover/1
coverage_report
covered_/4
cpu_time/1
,
[1]
create_binary_file/2
create_text_file/2
csv
csv(Header,Separator,IgnoreQuotes)
csv_guess_questions
csv_protocol
current/2
current_entity/1
current_prog/1
D
data/0
data/1
databasep
date
date/4
date/5
date/6
date/7
date_string/3
date_time/7
datep
days_in_month/3
dead_code_scanner
dead_code_scanner_messages
debug/0
debug_expansion(Mode)
debug_handler/2
debug_handler_provider/1
debug_messages
debugger
debugger_messages
debuggerp
debugging/0
debugging/1
debugging_/0
declares_predicate/2
decode_exception/2
decode_exception/3
decompile_predicate_heads/4
decompile_predicate_indicators/4
decompose_file_name/3
decompose_file_name/4
decrement_counter/1
default_option/1
,
[1]
default_options/1
,
[1]
default_workflow_hook
define_flag/1
define_flag/2
define_log_file/2
defined_flag/6
defined_flag_/6
defines_predicate/2
defines_predicate/3
del_monitors/0
del_monitors/4
del_spy_points/4
delete/3
,
[1]
,
[2]
delete/4
,
[1]
delete_all_after/2
delete_all_after_and_unzip/2
delete_all_before/2
delete_all_before_and_unzip/2
delete_and_next/2
delete_and_previous/2
delete_and_unzip/2
delete_directory/1
delete_file/1
delete_matches/3
delete_max/4
delete_min/4
demodb
dependent_/1
dependents/1
depth/2
descendant/1
descendant_class/1
descendant_classes/1
descendant_instance/1
descendant_instances/1
descendants/1
deterministic/1
deterministic/2
dfs_interpreter
diagram(Format)
diagram_caption/3
diagram_description/1
diagram_name_suffix/1
diagrams
diagrams(Format)
dictionaryp
dif/1
dif/2
difflist
directories/1
directories/2
,
[1]
,
[2]
directories/3
,
[1]
directory/1
,
[1]
,
[2]
,
[3]
,
[4]
,
[5]
directory/2
,
[1]
,
[2]
,
[3]
directory/3
,
[1]
directory_dependency_diagram
directory_dependency_diagram(Format)
directory_diagram(Format)
directory_entity_/4
directory_exists/1
directory_files/2
directory_files/3
directory_load_diagram
directory_load_diagram(Format)
directory_score/2
disable/1
disable/2
disable_logging/1
disconnect/1
disjoint/2
dit_metric
doc_goal/1
doc_metric
doclet
document_generation//2
dot_graph_language
dowhile/2
drop/3
during/2
dynamic_directive_/3
E
easter_day/3
edcg
edge/5
edge/6
edge_/5
edge_case/2
either
either/3
empty/1
,
[1]
,
[2]
,
[3]
,
[4]
,
[5]
,
[6]
empty_map/1
enable/1
enable/2
enable_logging/1
enabled/1
enabled/2
enabled_/1
enabled_/2
ensure_directory/1
ensure_file/1
entity/1
,
[1]
,
[2]
entity/2
entity_calls/3
entity_diagram
entity_diagram(Format)
entity_info_pair_score_hook/3
entity_info_score_hook/2
entity_kind/2
entity_predicates_weights_hook/2
entity_prefix/2
entity_property/2
entity_score//2
entity_score/2
entity_updates/3
enumerate/2
environment_variable/2
epsilon/1
equal/2
,
[1]
essentially_equal/3
,
[1]
euclidean_distance/3
euclidean_norm/2
event_registry
event_registryp
exception/4
exclude/3
execution_context/7
expand_library_alias_paths
expand_library_path/2
expanding
expected
expected(Expected)
expected/1
expecteds/2
extension/1
extensions/1
external_predicate_/1
F
f/4
failed_/1
false/1
fast_random
fault/5
file/1
,
[1]
,
[2]
,
[3]
,
[4]
file/2
,
[1]
,
[2]
file_being_advised_/4
file_dependency_diagram
file_dependency_diagram(Format)
file_diagram(Format)
file_exists/1
file_footer/3
file_header/3
file_load_diagram
file_load_diagram(Format)
file_modification_time/2
file_permission/2
file_score/2
file_size/2
file_to_chars/2
file_to_chars/3
file_to_codes/2
file_to_codes/3
file_to_terms/2
file_to_terms/3
file_type_extension/2
files/1
,
[1]
,
[2]
files/2
,
[1]
,
[2]
files/3
,
[1]
filter/2
filter_file_extension/3
findall_member/4
findall_member/5
finished_by/2
finishes/2
fired_/3
fix_option/2
fix_options/2
flag_group_chk/1
flag_groups/1
flag_value_/2
flags
flags_validator
flat_map/2
,
[1]
flatten/2
,
[1]
flatten_goals//1
flatting
float
fold_left/4
fold_left_1/3
fold_right/4
fold_right_1/3
fordownto/3
fordownto/4
fordownto/5
foreach/3
foreach/4
format_object/1
format_to_atom/3
format_to_chars/3
format_to_chars/4
format_to_codes/3
format_to_codes/4
forto/3
forto/4
forto/5
forward/1
forward/2
forward/3
forwarding
freeze/2
from_generator/2
,
[1]
from_generator/3
,
[1]
from_generator/4
from_goal/2
,
[1]
from_goal/3
,
[1]
from_goal/4
frozen/2
func_test/3
functional/0
G
generated_predicate/1
generating_/0
gensym
gensym/2
geometric_mean/2
get/1
get_field/2
get_flag_value/2
get_seed/1
,
[1]
git
git_protocol
goal_expansion/2
grammar_rules_hook
graph_footer/5
graph_header/5
graph_language_protocol
graph_language_registry
ground/1
ground_entity_identifier/3
group_by_key/2
guess_arity/2
guess_separator/2
H
halstead_metric
halstead_metric(Stroud)
hamming_distance/3
harmonic_mean/2
head/2
head_pred/1
heap(Order)
heapp
help
help/0
heuristic_expansion(A)
hierarchyp
hook_pipeline(Pipeline)
hook_set(Set)
I
ibk/3
iddfs_interpreter(Increment)
identity_hook
if_empty/1
if_expected/1
if_expected_or_else/2
if_present/1
if_present_or_else/2
if_unexpected/1
include/3
included_directory_/1
included_entity_/1
included_file_/1
included_library_/2
included_module_/1
included_predicate_/1
increase/1
increment/0
increment_counter/1
inheritance_diagram
inheritance_diagram(Format)
init/0
init_log_file/2
inorder/2
insert/3
insert/4
,
[1]
insert_after/3
insert_all/3
,
[1]
insert_before/3
instance/1
instances/1
integer
interpreterp
intersect/2
intersection/3
intersection/4
interval
intervalp
invocation_number_/1
invoke/1
invoke/2
is_alpha/1
is_alphanumeric/1
is_ascii/1
is_bin_digit/1
is_control/1
is_dec_digit/1
is_empty/0
is_end_of_line/1
is_expected/0
is_false/1
is_hex_digit/1
is_layout/1
is_letter/1
is_lower_case/1
is_newline/1
is_null/1
is_object/1
is_octal_digit/1
is_period/1
is_present/0
is_punctuation/1
is_quote/1
is_true/1
is_unexpected/0
is_upper_case/1
is_validator/1
is_void/1
is_vowel/1
is_white_space/1
iso8601
iterator_element/2
J
java
java(Reference)
java(Reference,ReturnValue)
java_access_protocol
java_hook
java_utils_protocol
join/3
join_all/3
jump/3
jump_all/3
jump_all_block/3
jump_to_invocation_number_/1
K
keys/2
,
[1]
keys_values/3
keysort/2
kurtosis/2
L
language_object/2
last/2
,
[1]
leaf/1
leaf_class/1
leaf_classes/1
leaf_instance/1
leaf_instances/1
leap_year/1
,
[1]
leaping_/1
learn/0
learn/1
learn/2
learn/3
learn_seq/2
learn_with_timeout/4
leash/1
leashing/1
leashing_/1
leaves/1
length/2
,
[1]
,
[2]
lgtdoc
lgtdocp
lgtunit
lgtunit_messages
libraries/1
,
[1]
libraries/2
,
[1]
libraries/3
,
[1]
library/0
library/1
,
[1]
,
[2]
,
[3]
,
[4]
,
[5]
library/2
,
[1]
,
[2]
library_dependency_diagram
library_dependency_diagram(Format)
library_diagram(Format)
library_entity_/4
library_load_diagram
library_load_diagram(Format)
library_score/2
line_to_codes/2
line_to_codes/3
list
list(Type)
listp
loaded_file/1
loaded_file_property/2
,
[1]
locate_directory/2
locate_file/5
locate_library/2
log_event/2
log_file/2
log_file_/2
,
[1]
logger
logging
logging/1
logging_to_file_/2
,
[1]
loggingp
logtalk
lookup/2
lookup/3
loop
loopp
lower_upper/2
M
magic
magic/2
magic_expansion(A)
magicise/4
make/1
make_directory/1
make_directory_path/1
manhattan_distance/3
manhattan_norm/2
manuals/0
map/2
,
[1]
,
[2]
,
[3]
,
[4]
map/3
,
[1]
,
[2]
,
[3]
map/4
map/5
map/6
map/7
map/8
map_member/3
map_reduce/5
map_store/4
max/2
,
[1]
,
[2]
max/3
max_clauses/1
max_inv_preds/1
maxheap
maybe
maybe/0
maybe/1
maybe/2
maybe_call/1
maybe_call/2
mean_deviation/2
median/2
median_deviation/2
meets/2
member/2
,
[1]
,
[2]
memberchk/2
,
[1]
,
[2]
merge/3
merge_options/2
,
[1]
message_cache_/1
,
[1]
,
[2]
,
[3]
message_diagram_description/1
message_hook/4
message_prefix_stream/4
message_tokens//2
met_by/2
meta
meta_compiler
meta_type/3
metagol
metagol_example_protocol
metap
metarule/6
metarule_next_id/1
min/2
,
[1]
,
[2]
min/3
min_clauses/1
minheap
minimal_output
missing_predicate_directive_/3
module_predicate_called_/3
module_property/2
modules_diagram_support
monitor
monitor/1
monitor/4
monitor_activated/0
monitored/1
monitoring
monitorp
monitors/1
msort/2
msort/3
multifile_directive_/3
N
name_of_day/3
name_of_month/3
natural
new/1
,
[1]
,
[2]
new/2
,
[1]
new/3
next/2
next/3
next/4
nextto/3
,
[1]
noc_metric
node/6
node/7
node_/6
nodebug/0
non_standard_predicate_call_/2
nor_metric
normalize_range/2
normalize_range/4
normalize_scalar/2
normalize_unit/2
nospy/1
nospy/4
nospyall/0
not_excluded_file/3
note/1
notrace/0
now/3
nth0/3
,
[1]
nth0/4
,
[1]
nth1/3
,
[1]
nth1/4
,
[1]
null/1
null_device_path/1
number
number_of_tests/1
numberlist
numberlistp
O
object_predicate_called_/3
object_wrapper_hook
observer
occurs/2
of/2
of_expected/2
of_unexpected/2
omit_path_prefix/3
operating_system_type/1
optional
optional(Optional)
options
options_protocol
or/2
or_else/2
,
[1]
or_else_call/2
,
[1]
or_else_fail/1
,
[1]
or_else_get/2
,
[1]
or_else_throw/1
or_else_throw/2
os
os_types
osp
output_edges/1
output_externals/1
output_file/4
output_file_name/2
output_file_path/4
output_files/2
output_library/3
output_missing_externals/1
output_node/6
output_rdirectory/3
output_rlibrary/3
output_sub_diagrams/1
overlapped_by/2
overlaps/2
P
pairs
parent/1
parenthesis/2
parents/1
parse/2
parse/3
parse_domain/2
parse_domain/3
parse_problem/2
parse_problem/3
partial_/1
,
[1]
partial_map/4
partition/3
partition/4
partition/5
partition/6
pass_info/1
pass_info/2
passed_/1
path_concat/3
pcdata_7bit//1
pddl
permutation/2
,
[1]
,
[2]
pid/1
plus/3
population
port/5
port_/5
ports_profiler
postorder/2
powerset/2
pp/1
pp_string/1
pprint/1
pprint_clause/1
pprint_clauses/1
pred_info/3
predicate/2
predicate_called_but_not_defined_/2
predicate_entity_/4
predicate_info_pair_score_hook/4
predicate_info_score_hook/3
predicate_mode_score_hook/3
predicate_mode_score_hook/5
predicates/2
prefix/2
,
[1]
prefix/3
preorder/2
previous/2
previous/3
previous/4
print_flags/0
,
[1]
print_flags/1
print_goal_hook
print_message/3
print_message_token/4
print_message_tokens/3
process_all/0
process_directory/1
process_entity/2
process_file/1
process_library/1
process_rdirectory/1
process_rlibrary/1
product/2
,
[1]
product/3
program_to_clauses/2
prolog_module_hook(Module)
proper_prefix/2
proper_prefix/3
proper_suffix/2
proper_suffix/3
proto_hierarchy
proto_hierarchyp
prove/2
prove/3
Q
quasi_skipping_/0
question_hook/6
question_prompt_stream/4
queue
queuep
quick_check/1
quick_check/2
quick_check/3
R
random
random/1
random/3
random_tree/1
randomize/1
,
[1]
randomp
randseq/4
randset/4
range/2
rbtree
rdirectory/1
,
[1]
,
[2]
,
[3]
,
[4]
,
[5]
rdirectory/2
,
[1]
,
[2]
,
[3]
rdirectory/3
,
[1]
rdirectory_score/2
read_file
read_file/2
,
[1]
read_file/3
read_file_by_line/2
read_file_by_line/3
read_from_atom/2
read_from_chars/2
read_from_codes/2
read_term_from_atom/3
read_term_from_chars/3
read_term_from_codes/3
reader
redis
referenced_entity_/2
referenced_logtalk_directory_/1
referenced_logtalk_file_/1
referenced_logtalk_library_/2
referenced_module_/2
referenced_predicate_/1
referenced_prolog_directory_/1
referenced_prolog_file_/1
referenced_prolog_library_/2
relative_standard_deviation/2
remember_included_directory/1
remember_included_file/1
remember_included_library/2
remember_referenced_logtalk_directory/1
remember_referenced_logtalk_file/1
remember_referenced_logtalk_library/2
remember_referenced_prolog_directory/1
remember_referenced_prolog_file/1
remember_referenced_prolog_library/2
remove_directive_/2
remove_duplicates/2
,
[1]
removeDependent/1
rename_file/2
replace/3
replace_sub_atom/4
rescale/3
reset/0
,
[1]
,
[2]
,
[3]
reset/1
reset_counter/1
reset_counters/0
reset_flags/0
reset_flags/1
reset_gensym/0
reset_gensym/1
reset_monitor/0
reset_seed/0
,
[1]
reverse/2
,
[1]
rewind/2
rewind/3
rlibrary/1
,
[1]
,
[2]
,
[3]
,
[4]
rlibrary/2
,
[1]
,
[2]
rlibrary_score/2
rule/2
rule/3
rule/4
rule_expansion(A)
run/0
run/1
run/2
run_quick_check_tests/5
run_test_set/0
run_test_sets/1
run_tests/0
run_tests/2
running_test_sets_/0
S
same_length/2
,
[1]
same_length/3
sample
save/0
save/1
save_edge/5
scalar_product/3
scan_left/4
scan_left_1/3
scan_right/4
scan_right_1/3
seed_/3
,
[1]
select/3
,
[1]
,
[2]
,
[3]
select/4
selectchk/3
,
[1]
selectchk/4
send/3
sequence/3
sequence/4
serve/3
set
set(Type)
set/1
set/4
set_binary_input/1
set_binary_input/2
set_binary_input/3
set_binary_output/1
set_binary_output/2
set_binary_output/3
set_field/2
set_flag_value/2
set_flag_value/3
set_monitor/4
set_seed/1
,
[1]
set_spy_point/4
set_text_input/1
set_text_input/2
set_text_input/3
set_text_output/1
set_text_output/2
set_text_output/3
setp
setup/0
shell
shell(Interpreters)
shell/1
shell/2
shell_command/1
shell_expansion(A)
shrink/3
shrinker/1
singletons/2
size/2
,
[1]
,
[2]
size_metric
skewness/2
skipped_/1
skipping_/0
sleep/1
sort/2
sort/3
sort/4
source_file_extension/1
split/3
split/4
spy/1
spy/4
spy_point/4
spy_point_/4
spying/1
spying/4
spying_context_/4
spying_line_number_/2
spying_predicate_/3
squares_and_cubes/6
squares_and_hypers/6
standard_deviation/2
start/0
started_by/2
starts/2
statistics
statisticsp
stream_position/1
stream_to_chars/2
stream_to_chars/3
stream_to_codes/2
stream_to_codes/3
stream_to_terms/2
stream_to_terms/3
streamvars
sub_diagram_/2
,
[1]
sub_diagrams_/1
,
[1]
sub_directory/2
sub_library/2
subclass/1
subclasses/1
subject
sublist/2
,
[1]
subsequence/3
subsequence/4
subset/2
substitute/4
subsumes/2
subterm/2
,
[1]
subtract/3
,
[1]
,
[2]
succ/2
suffix/2
,
[1]
suffix/3
sum/2
,
[1]
superclass/1
superclasses/1
suppress_binary_output/0
suppress_goal_hook
suppress_text_output/0
suspend_monitor/0
symdiff/3
T
take/3
tap_output
tap_report
temporary_directory/1
temporary_file_/1
term
term_expansion/2
term_io
term_io_protocol
termp
terms_to_array/2
test/3
test_/2
test_count_/1
,
[1]
text_input_assertion/2
text_input_assertion/3
text_output_assertion/2
text_output_assertion/3
time
time_stamp/1
timeout
timeout/1
timep
timestamp_/6
today/3
tolerance_equal/4
,
[1]
top/3
top_next/5
toychrdb
trace/0
trace_event/2
tracing_/0
transpose/2
true/1
tutor
type
type/1
type/3
type_entity_/4
U
unexpected/1
unexpecteds/2
union/3
union/4
unknown_predicate_called_/2
unsafe_set_flag_value/2
unzip/2
update/0
update/1
update/3
update/4
update/5
upn_metric
user
uses_diagram
uses_diagram(Format)
V
valid/1
,
[1]
,
[2]
,
[3]
valid/2
valid/3
,
[1]
valid_date/3
valid_option/1
valid_options/1
validate/1
validate/3
validate_type/1
value/1
value_reference/2
values/2
,
[1]
variables/2
variance/2
variance/6
variant/2
,
[1]
varlist
varlistp
void/1
W
wall_time/1
welcome/0
when/2
whiledo/2
working_directory/1
wrapper
write_file/3
write_max_depth_/1
write_term_to_atom/3
write_term_to_chars/3
write_term_to_chars/4
write_term_to_codes/3
write_term_to_codes/4
write_to_atom/2
write_to_chars/2
write_to_codes/2
write_to_stream_hook(Stream)
write_to_stream_hook(Stream,Options)
X
xml
xml_to_document/3
xref_diagram
xref_diagram(Format)
xunit_net_v2_output
xunit_net_v2_report
xunit_output
xunit_report
Z
z_normalization/2
zap_to_port_/1
zip/2
zip/3
zip_at_index/4
zipperp
zlist