@ciao-lang/ts-ciao-interface

<!DOCTYPE HTML><html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"/><meta name="viewport" content="width=device-width, initial-scale=1"/><meta name="theme-color" content="#273f79"/><link rel="stylesheet" href="lpdoc.css" type="text/css"/><script type="text/javascript" src="lpdoc.js"></script><title>Runtime system control and flags — The Ciao System v1.22</title></head><body><div class="lpdoc-page fixleftbar"><a href="#" id="sidebar-toggle-button" class="lpdoc-navbutton">☰</a><div id="sidebar" class="lpdoc-sidebar"><div style="height: 40px; margin-left: auto; margin-right: auto"><img src="ciao-logo_autofig.png" width=auto height=100%></div><div class="lpdoc-nav"><a class="lpdoc-navbutton" href="StdLibs.html">↑</a><a class="lpdoc-navbutton" href="messages_basic.html">←</a><a class="lpdoc-navbutton" href="system_info.html">→</a><a class="lpdoc-navbutton" href="ciaosearch.html">🔍</a><a href="ciaofulltoc.html">TOC</a></div><hr></hr><ul class="lpdoc-itemize-sectpath"><li><a href="ciao.html">The Ciao System</a> » </li><li><a href="StdLibs.html">PART VII - Standard libraries</a> » </li><li><a href="">Runtime system control and flags</a></li></ul><hr></hr>ON THIS PAGE<ul><li><a href="#Usage and interface">Usage and interface</a></li><li><a href="#Documentation on exports">Documentation on exports</a></li><li><a href="#Documentation on multifiles">Documentation on multifiles</a></li><li><a href="#Documentation on imports">Documentation on imports</a></li></ul></div><div class="lpdoc-main"><div id=""><h1>Runtime system control and flags</h1><a class="lpdoc-idx-anchor" href="ciaosearch.html#runtime_control"></a> Author(s): <a class="lpdoc-idx-anchor" id="Manuel Carro" href="ciaosearch.html#Manuel Carro">Manuel Carro</a>, <a class="lpdoc-idx-anchor" id="Daniel Cabeza" href="ciaosearch.html#Daniel Cabeza">Daniel Cabeza</a>, <a class="lpdoc-idx-anchor" id="Jose F. Morales" href="ciaosearch.html#Jose F. Morales">Jose F. Morales</a>, <a class="lpdoc-idx-anchor" id="Manuel Hermenegildo" href="ciaosearch.html#Manuel Hermenegildo">Manuel Hermenegildo (improved documentation)</a>, <a class="lpdoc-idx-anchor" id="Mats Carlsson" href="ciaosearch.html#Mats Carlsson">Mats Carlsson (original author)</a>. This module implements some predicates which provide access to and control of many parameters of the Ciao runtime, including internal statistics, loaded modules, special properties of the predicates, garbage collection, etc.Some of these facilities are accessed or controlled via specific predicates (see later) while in other cases such access and control is preformed through the mechanism of <a class="lpdoc-idx-anchor" id="0" href="ciaosearch.html#flags">flags</a>. <a class="lpdoc-idx-anchor" id="1" href="ciaosearch.html#Prolog flag"></a> Such flags contain values for some global parameters of the system and also control the behavior of some system or library predicates. Each flag has a name and an associated predefined value, and except some system flags which are fixed, in general their associated value is changeable.Flags can be given values at compile time, via declarations, and then the changes affect only the module being processed. Predicates are also available to consult and change flag values at run time, in which case their effect is global from that moment on in the execution (see <a class="lpdoc-idx-anchor" id="2" href="#prolog_flag/3"><tt>prolog_flag/3</tt></a> and related predicates below). Note that corresponding flag-processing declarations and predicates have the same predicate name; only the run-time version is documented.Some flags are pre-defined in the system. In addition, new flags can be also be defined. The mechanism to do this is described in <a class="lpdoc-idx-anchor" id="3" href="tokenize.html#define_flag/3"><tt>define_flag/3</tt></a>. Through this mechanism, many Ciao modules and language extensions define additional flags. Flags that are predefined in the system (engine) are documented here and the rest are generally documented in the modules/libraries that define them.The <a class="lpdoc-idx-anchor" id="4" href="ciaosearch.html#predefined flags">predefined flags</a> in the system are the following:<dl> <dt><tt>version</tt><dd> The Ciao version, as a term <tt>ciao</tt>(Version,Patch,CommitInfo). Version and Patch are atoms. CommitInfo is a structure describing the commit information (branch, id, date, description). Unchangeable.<dt><tt>dialect</tt><dd> Value set to <tt>ciao</tt>. Used for compatibility with other systems when in Prolog mode. Unchangeable.<dt><tt>argv</tt><dd> Its value is a list of atoms representing the program arguments supplied when the current executable was invoked. This is the value to which the argument of the <a class="lpdoc-idx-anchor" id="5" href="ciaosearch.html#main/1"><tt>main/1</tt></a> predicate is instantiated at executable startup (which is the usual way to access the list of arguments). Unchangeable.<dt><tt>bounded</tt><dd> It is <tt>false</tt>, to denote that the range of integers can be considered infinite (but see <a class="lpdoc-idx-anchor" id="6" href="basic_props.html#int/1"><tt>int/1</tt></a>). Unchangeable. ISO <dt><tt>fileerrors</tt><dd> If <tt>on</tt>, predicates handling files produce errors (throw exceptions) when a file is non-existent or an operation is not allowed. If <tt>off</tt>, a failure will occur instead for those conditions. Initially <tt>on</tt>.<dt><tt>gc</tt><dd> Controls whether garbage collection is performed. May be <tt>on</tt> (default) or <tt>off</tt>.<dt><tt>gc_margin</tt><dd> Margin is an integer so that, if less than Margin kilobytes are reclaimed in a garbage collection, then the size of the garbage-collected area should be increased. Also, no garbage collection is attempted unless the garbage-collected area has at least Margin kilobytes. Initially set to <tt>500</tt>.<dt><tt>gc_trace</tt><dd> Governs garbage collection trace messages. An element of <tt>[on,off,terse,verbose]</tt>. Initially <tt>off</tt>.<dt><tt>integer_rounding_function</tt><dd> It is <tt>toward_zero</tt>, so that <tt>-1 =:= -3//2</tt> succeeds. Unchangeable. ISO <dt><tt>max_arity</tt><dd> It is 255, so that no compound term (or predicate) can have more than this number of arguments. Unchangeable. ISO <dt><tt>quiet</tt><dd> Controls which messages issued using the <a class="lpdoc-idx-anchor" id="7" href="messages_basic.html"><tt>messages_basic</tt></a> library are actually written. As the system uses that library to emit its messages, this flag controls the verbosity of the system. Possible states of the flag are:<dl> <dt><tt>on</tt><dd> No messages are reported.<dt><tt>error</tt><dd> Only error messages are reported.<dt><tt>warning</tt><dd> Only error and warning messages are reported.<dt><tt>off</tt><dd> All messages are reported, except debug messages. This is the default state.<dt><tt>debug</tt><dd> All messages, including debug messages, are reported. This is only intended for the system implementors.</dl> <dt><tt>unknown</tt><dd> Controls the action to be taken when an <a class="lpdoc-idx-anchor" id="8" href="ciaosearch.html#undefined predicate">undefined predicate</a> is called. The possible states of the flag are:<dl> <dt><tt>error</tt><dd> An error is thrown with the <a class="lpdoc-idx-anchor" id="9" href="ciaosearch.html#error term">error term</a> <tt>existence_error(procedure, F/A)</tt>.<dt><tt>fail</tt><dd> The call simply fails.<dt><tt>warning</tt><dd> A warning is written and the call fails.</dl> The state is initially <tt>error</tt>. ISO </dl> <div id="Usage and interface"><h2>Usage and interface</h2><div class="lpdoc-cartouche"><ul><li>Library usage: <tt>:- use_module(engine(runtime_control)).</tt><li>Exports: <ul class="lpdoc-itemize-minus"><li>Predicates: <a class="lpdoc-idx-anchor" id="10" href="#statistics/0"><tt>statistics/0</tt></a>, <a class="lpdoc-idx-anchor" id="11" href="#statistics/2"><tt>statistics/2</tt></a>, <a class="lpdoc-idx-anchor" id="12" href="#time/1"><tt>time/1</tt></a>, <a class="lpdoc-idx-anchor" id="13" href="#current_atom/1"><tt>current_atom/1</tt></a>, <a class="lpdoc-idx-anchor" id="14" href="#new_atom/1"><tt>new_atom/1</tt></a>, <a class="lpdoc-idx-anchor" id="15" href="#current_module/1"><tt>current_module/1</tt></a>, <a class="lpdoc-idx-anchor" id="16" href="#module_split/3"><tt>module_split/3</tt></a>, <a class="lpdoc-idx-anchor" id="17" href="#predicate_property/2"><tt>predicate_property/2</tt></a>, <a class="lpdoc-idx-anchor" id="18" href="#predicate_property/3"><tt>predicate_property/3</tt></a>, <a class="lpdoc-idx-anchor" id="19" href="#garbage_collect/0"><tt>garbage_collect/0</tt></a>, <a class="lpdoc-idx-anchor" id="20" href="#set_prolog_flag/2"><tt>set_prolog_flag/2</tt></a>, <a class="lpdoc-idx-anchor" id="21" href="#current_prolog_flag/2"><tt>current_prolog_flag/2</tt></a>, <a class="lpdoc-idx-anchor" id="22" href="#prolog_flag/3"><tt>prolog_flag/3</tt></a>, <a class="lpdoc-idx-anchor" id="23" href="#push_prolog_flag/2"><tt>push_prolog_flag/2</tt></a>, <a class="lpdoc-idx-anchor" id="24" href="#pop_prolog_flag/1"><tt>pop_prolog_flag/1</tt></a>, <a class="lpdoc-idx-anchor" id="25" href="#prompt/2"><tt>prompt/2</tt></a>, <a class="lpdoc-idx-anchor" id="26" href="#fileerrors/0"><tt>fileerrors/0</tt></a>, <a class="lpdoc-idx-anchor" id="27" href="#nofileerrors/0"><tt>nofileerrors/0</tt></a>, <a class="lpdoc-idx-anchor" id="28" href="#gc/0"><tt>gc/0</tt></a>, <a class="lpdoc-idx-anchor" id="29" href="#nogc/0"><tt>nogc/0</tt></a>. <li>Regular Types: <a class="lpdoc-idx-anchor" id="30" href="#time_option/1"><tt>time_option/1</tt></a>, <a class="lpdoc-idx-anchor" id="31" href="#tick_option/1"><tt>tick_option/1</tt></a>, <a class="lpdoc-idx-anchor" id="32" href="#clockfreq_option/1"><tt>clockfreq_option/1</tt></a>, <a class="lpdoc-idx-anchor" id="33" href="#memory_option/1"><tt>memory_option/1</tt></a>, <a class="lpdoc-idx-anchor" id="34" href="#gc_option/1"><tt>gc_option/1</tt></a>, <a class="lpdoc-idx-anchor" id="35" href="#symbol_option/1"><tt>symbol_option/1</tt></a>, <a class="lpdoc-idx-anchor" id="36" href="#time_result/1"><tt>time_result/1</tt></a>, <a class="lpdoc-idx-anchor" id="37" href="#tick_result/1"><tt>tick_result/1</tt></a>, <a class="lpdoc-idx-anchor" id="38" href="#clockfreq_result/1"><tt>clockfreq_result/1</tt></a>, <a class="lpdoc-idx-anchor" id="39" href="#memory_result/1"><tt>memory_result/1</tt></a>, <a class="lpdoc-idx-anchor" id="40" href="#gc_result/1"><tt>gc_result/1</tt></a>, <a class="lpdoc-idx-anchor" id="41" href="#symbol_result/1"><tt>symbol_result/1</tt></a>. <li>Multifiles: <a class="lpdoc-idx-anchor" id="42" href="tokenize.html#define_flag/3"><tt>define_flag/3</tt></a>. </ul></ul></div></div><div id="Documentation on exports"><h2>Documentation on exports</h2><div><div class="lpdoc-defname">PREDICATE<a class="lpdoc-idx-anchor" id="statistics/0" href="ciaosearch.html#statistics/0">statistics/0</a></div><div class="lpdoc-deftext">Usage:Prints statistics about the system.<ul class="lpdoc-itemize-minus"></ul></div></div> <div><div class="lpdoc-defname">PREDICATE<a class="lpdoc-idx-anchor" id="statistics/2" href="ciaosearch.html#statistics/2">statistics/2</a></div><div class="lpdoc-deftext">Usage 1:<tt>statistics(Tick_option,Tick_result)</tt> Gather information about clock ticks (either run, user, system or wall tick) since the last consultation or since the start of the program. A tick is the smallest amount of time that the clock can measure.<ul class="lpdoc-itemize-minus"><li>The following properties should hold at call time: (<a class="lpdoc-idx-anchor" id="43" href="#tick_option/1"><tt>runtime_control:tick_option/1</tt></a>)Tick_option is an option to get information about execution ticks. <pre class="lpdoc-codeblock">tick_option(runtick). tick_option(usertick). tick_option(systemtick). tick_option(walltick). </pre> <li>The following properties should hold upon exit: (<a class="lpdoc-idx-anchor" id="44" href="#tick_option/1"><tt>runtime_control:tick_option/1</tt></a>)Tick_option is an option to get information about execution ticks. <pre class="lpdoc-codeblock">tick_option(runtick). tick_option(usertick). tick_option(systemtick). tick_option(walltick). </pre> (<a class="lpdoc-idx-anchor" id="45" href="#tick_result/1"><tt>runtime_control:tick_result/1</tt></a>)Tick_result is a two-element list of numbers. The first number is the number of ticks since the start of the execution; the second number is the number of ticks since the previous consultation to tick. </ul>Usage 2:<tt>statistics(Clockfreq_option,Clockfreq_result)</tt> Gather information about frequency of the clocks used to measure the ticks (either run-user, system or wall clock). Results are returned in Hertz. This value also can be defined as the amount of ticks that a clock can measure in one second.<ul class="lpdoc-itemize-minus"><li>The following properties should hold at call time: (<a class="lpdoc-idx-anchor" id="46" href="#clockfreq_option/1"><tt>runtime_control:clockfreq_option/1</tt></a>)Clockfreq_option is and option to get information about the frequency of clocks used to get the ticks. <pre class="lpdoc-codeblock">clockfreq_option(runclockfreq). clockfreq_option(userclockfreq). clockfreq_option(systemclockfreq). clockfreq_option(wallclockfreq). </pre> <li>The following properties should hold upon exit: (<a class="lpdoc-idx-anchor" id="47" href="#clockfreq_option/1"><tt>runtime_control:clockfreq_option/1</tt></a>)Clockfreq_option is and option to get information about the frequency of clocks used to get the ticks. <pre class="lpdoc-codeblock">clockfreq_option(runclockfreq). clockfreq_option(userclockfreq). clockfreq_option(systemclockfreq). clockfreq_option(wallclockfreq). </pre> (<a class="lpdoc-idx-anchor" id="48" href="#clockfreq_result/1"><tt>runtime_control:clockfreq_result/1</tt></a>)Clockfreq_result is a number which gives the frequency in Hertz used by the clock get the ticks. </ul>Usage 3:<tt>statistics(Time_option,Time_result)</tt> Gather information about time (either process time or wall time) since the last consultation or since start of program. Results are returned in milliseconds. Note that internally, time is calculated as:<pre class="lpdoc-codeblock"> Time_result = (Tick_result / Clockfreq_result) * 1000 </pre> <ul class="lpdoc-itemize-minus"><li>The following properties should hold at call time: (<a class="lpdoc-idx-anchor" id="49" href="#time_option/1"><tt>runtime_control:time_option/1</tt></a>)Time_option is an option to get information about execution time. <pre class="lpdoc-codeblock">time_option(runtime). time_option(usertime). time_option(systemtime). time_option(walltime). </pre> <li>The following properties should hold upon exit: (<a class="lpdoc-idx-anchor" id="50" href="#time_option/1"><tt>runtime_control:time_option/1</tt></a>)Time_option is an option to get information about execution time. <pre class="lpdoc-codeblock">time_option(runtime). time_option(usertime). time_option(systemtime). time_option(walltime). </pre> (<a class="lpdoc-idx-anchor" id="51" href="#time_result/1"><tt>runtime_control:time_result/1</tt></a>)Time_result is a two-element list of numbers. The first number is the time since the start of the execution; the second number is the time since the previous time consultation to time. </ul>Usage 4:<tt>statistics(Memory_option,Memory_result)</tt> Gather information about memory consumption.<ul class="lpdoc-itemize-minus"><li>The following properties should hold at call time: (<a class="lpdoc-idx-anchor" id="52" href="#memory_option/1"><tt>runtime_control:memory_option/1</tt></a>)Memory_option is an option to get information about memory usage. <pre class="lpdoc-codeblock">memory_option(memory). memory_option(symbols). memory_option(program). memory_option(global_stack). memory_option(local_stack). memory_option(trail). memory_option(choice). </pre> <li>The following properties should hold upon exit: (<a class="lpdoc-idx-anchor" id="53" href="#memory_option/1"><tt>runtime_control:memory_option/1</tt></a>)Memory_option is an option to get information about memory usage. <pre class="lpdoc-codeblock">memory_option(memory). memory_option(symbols). memory_option(program). memory_option(global_stack). memory_option(local_stack). memory_option(trail). memory_option(choice). </pre> (<a class="lpdoc-idx-anchor" id="54" href="#memory_result/1"><tt>runtime_control:memory_result/1</tt></a>)Memory_result is a two-element list of integers. The first element is the space taken up by the option selected, measured in bytes; the second integer is zero for program space (which grows as necessary), and the amount of free space otherwise. </ul>Usage 5:<tt>statistics(GC_option,GC_result)</tt> Gather information about garbage collection.<ul class="lpdoc-itemize-minus"><li>The following properties should hold at call time: (<a class="lpdoc-idx-anchor" id="55" href="#gc_option/1"><tt>runtime_control:gc_option/1</tt></a>)GC_option is an option to get information about garbage collection. <pre class="lpdoc-codeblock">gc_option(garbage_collection). gc_option(stack_shifts). </pre> <li>The following properties should hold upon exit: (<a class="lpdoc-idx-anchor" id="56" href="#gc_option/1"><tt>runtime_control:gc_option/1</tt></a>)GC_option is an option to get information about garbage collection. <pre class="lpdoc-codeblock">gc_option(garbage_collection). gc_option(stack_shifts). </pre> (<a class="lpdoc-idx-anchor" id="59" href="#gc_result/1"><tt>runtime_control:gc_result/1</tt></a>)GC_result is a tree-element list of integers, related to <a class="lpdoc-idx-anchor" id="57" href="ciaosearch.html#garbage collection">garbage collection</a> and <a class="lpdoc-idx-anchor" id="58" href="ciaosearch.html#memory management">memory management</a>. When <tt>stack_shifts</tt> is selected, the first one is the number of shifts (reallocations) of the local stack; the second is the number of shifts of the trail; and the third is the time spent in these shifts. When <tt>garbage_collection</tt> is selected, the numbers are, respectively, the number of garbage collections performed, the number of bytes freed, and the time spent in garbage collection. </ul>Usage 6:<tt>statistics(Symbol_option,Symbol_result)</tt> Gather information about number of symbols and predicates.<ul class="lpdoc-itemize-minus"><li>The following properties should hold at call time: (<a class="lpdoc-idx-anchor" id="60" href="#symbol_option/1"><tt>runtime_control:symbol_option/1</tt></a>)Symbol_option is an option to get information about the number of symbols in the program. <pre class="lpdoc-codeblock">symbol_option(symbols). </pre> <li>The following properties should hold upon exit: (<a class="lpdoc-idx-anchor" id="61" href="#symbol_option/1"><tt>runtime_control:symbol_option/1</tt></a>)Symbol_option is an option to get information about the number of symbols in the program. <pre class="lpdoc-codeblock">symbol_option(symbols). </pre> (<a class="lpdoc-idx-anchor" id="62" href="#symbol_result/1"><tt>runtime_control:symbol_result/1</tt></a>)Symbol_result is a two-element list of integers. The first one is the number of atom, functor, and predicate names in the symbol table. The second is the number of predicates known to be defined (although maybe without clauses). </ul>Usage 7:<tt>statistics(Option,Arg2)</tt> If Option is unbound, it is bound by backtracking to the values of all the other cases.<ul class="lpdoc-itemize-minus"><li>Call and exit should be compatible with: (<a class="lpdoc-idx-anchor" id="63" href="basic_props.html#term/1"><tt>basic_props:term/1</tt></a>)Arg2 is any term. <li>The following properties should hold at call time: (<a class="lpdoc-idx-anchor" id="64" href="term_typing.html#var/1"><tt>term_typing:var/1</tt></a>)Option is a free variable. <li>The following properties should hold upon exit: (<a class="lpdoc-idx-anchor" id="65" href="basic_props.html#term/1"><tt>basic_props:term/1</tt></a>)Arg2 is any term. </ul></div></div> <div><div class="lpdoc-defname">REGTYPE<a class="lpdoc-idx-anchor" id="time_option/1" href="ciaosearch.html#time_option/1">time_option/1</a></div><div class="lpdoc-deftext">Usage:<tt>time_option(M)</tt> M is an option to get information about execution time. <pre class="lpdoc-codeblock">time_option(runtime). time_option(usertime). time_option(systemtime). time_option(walltime). </pre><ul class="lpdoc-itemize-minus"></ul></div></div> <div><div class="lpdoc-defname">REGTYPE<a class="lpdoc-idx-anchor" id="tick_option/1" href="ciaosearch.html#tick_option/1">tick_option/1</a></div><div class="lpdoc-deftext">Usage:<tt>tick_option(M)</tt> M is an option to get information about execution ticks. <pre class="lpdoc-codeblock">tick_option(runtick). tick_option(usertick). tick_option(systemtick). tick_option(walltick). </pre><ul class="lpdoc-itemize-minus"></ul></div></div> <div><div class="lpdoc-defname">REGTYPE<a class="lpdoc-idx-anchor" id="clockfreq_option/1" href="ciaosearch.html#clockfreq_option/1">clockfreq_option/1</a></div><div class="lpdoc-deftext">Usage:<tt>clockfreq_option(M)</tt> M is and option to get information about the frequency of clocks used to get the ticks. <pre class="lpdoc-codeblock">clockfreq_option(runclockfreq). clockfreq_option(userclockfreq). clockfreq_option(systemclockfreq). clockfreq_option(wallclockfreq). </pre><ul class="lpdoc-itemize-minus"></ul></div></div> <div><div class="lpdoc-defname">REGTYPE<a class="lpdoc-idx-anchor" id="memory_option/1" href="ciaosearch.html#memory_option/1">memory_option/1</a></div><div class="lpdoc-deftext">Usage:<tt>memory_option(M)</tt> M is an option to get information about memory usage. <pre class="lpdoc-codeblock">memory_option(memory). memory_option(symbols). memory_option(program). memory_option(global_stack). memory_option(local_stack). memory_option(trail). memory_option(choice). </pre><ul class="lpdoc-itemize-minus"></ul></div></div> <div><div class="lpdoc-defname">REGTYPE<a class="lpdoc-idx-anchor" id="gc_option/1" href="ciaosearch.html#gc_option/1">gc_option/1</a></div><div class="lpdoc-deftext">Usage:<tt>gc_option(M)</tt> M is an option to get information about garbage collection. <pre class="lpdoc-codeblock">gc_option(garbage_collection). gc_option(stack_shifts). </pre><ul class="lpdoc-itemize-minus"></ul></div></div> <div><div class="lpdoc-defname">REGTYPE<a class="lpdoc-idx-anchor" id="symbol_option/1" href="ciaosearch.html#symbol_option/1">symbol_option/1</a></div><div class="lpdoc-deftext">Usage:<tt>symbol_option(M)</tt> M is an option to get information about the number of symbols in the program. <pre class="lpdoc-codeblock">symbol_option(symbols). </pre><ul class="lpdoc-itemize-minus"></ul></div></div> <div><div class="lpdoc-defname">REGTYPE<a class="lpdoc-idx-anchor" id="time_result/1" href="ciaosearch.html#time_result/1">time_result/1</a></div><div class="lpdoc-deftext">Usage:<tt>time_result(Result)</tt> Result is a two-element list of numbers. The first number is the time since the start of the execution; the second number is the time since the previous time consultation to time.<ul class="lpdoc-itemize-minus"></ul></div></div> <div><div class="lpdoc-defname">REGTYPE<a class="lpdoc-idx-anchor" id="tick_result/1" href="ciaosearch.html#tick_result/1">tick_result/1</a></div><div class="lpdoc-deftext">Usage:<tt>tick_result(Result)</tt> Result is a two-element list of numbers. The first number is the number of ticks since the start of the execution; the second number is the number of ticks since the previous consultation to tick.<ul class="lpdoc-itemize-minus"></ul></div></div> <div><div class="lpdoc-defname">REGTYPE<a class="lpdoc-idx-anchor" id="clockfreq_result/1" href="ciaosearch.html#clockfreq_result/1">clockfreq_result/1</a></div><div class="lpdoc-deftext">Usage:<tt>clockfreq_result(Result)</tt> Result is a number which gives the frequency in Hertz used by the clock get the ticks.<ul class="lpdoc-itemize-minus"></ul></div></div> <div><div class="lpdoc-defname">REGTYPE<a class="lpdoc-idx-anchor" id="memory_result/1" href="ciaosearch.html#memory_result/1">memory_result/1</a></div><div class="lpdoc-deftext">Usage:<tt>memory_result(Result)</tt> Result is a two-element list of integers. The first element is the space taken up by the option selected, measured in bytes; the second integer is zero for program space (which grows as necessary), and the amount of free space otherwise.<ul class="lpdoc-itemize-minus"></ul></div></div> <div><div class="lpdoc-defname">REGTYPE<a class="lpdoc-idx-anchor" id="gc_result/1" href="ciaosearch.html#gc_result/1">gc_result/1</a></div><div class="lpdoc-deftext">Usage:<tt>gc_result(Result)</tt> Result is a tree-element list of integers, related to <a class="lpdoc-idx-anchor" id="66" href="ciaosearch.html#garbage collection">garbage collection</a> and <a class="lpdoc-idx-anchor" id="67" href="ciaosearch.html#memory management">memory management</a>. When <tt>stack_shifts</tt> is selected, the first one is the number of shifts (reallocations) of the local stack; the second is the number of shifts of the trail; and the third is the time spent in these shifts. When <tt>garbage_collection</tt> is selected, the numbers are, respectively, the number of garbage collections performed, the number of bytes freed, and the time spent in garbage collection.<ul class="lpdoc-itemize-minus"></ul></div></div> <div><div class="lpdoc-defname">REGTYPE<a class="lpdoc-idx-anchor" id="symbol_result/1" href="ciaosearch.html#symbol_result/1">symbol_result/1</a></div><div class="lpdoc-deftext">Usage:<tt>symbol_result(Result)</tt> Result is a two-element list of integers. The first one is the number of atom, functor, and predicate names in the symbol table. The second is the number of predicates known to be defined (although maybe without clauses).<ul class="lpdoc-itemize-minus"></ul></div></div> <div><div class="lpdoc-defname">PREDICATE<a class="lpdoc-idx-anchor" id="time/1" href="ciaosearch.html#time/1">time/1</a></div><div class="lpdoc-deftext">Usage:<tt>time(G)</tt> Execute G and print runtime statistics to the user, for each solution.<ul class="lpdoc-itemize-minus"></ul> Meta-predicate with arguments: <tt>time(goal)</tt>. </div></div> <div><div class="lpdoc-defname">PREDICATE<a class="lpdoc-idx-anchor" id="current_atom/1" href="ciaosearch.html#current_atom/1">current_atom/1</a></div><div class="lpdoc-deftext">Usage:<tt>current_atom(Atom)</tt> Enumerates on backtracking all the existing atoms in the system.<ul class="lpdoc-itemize-minus"><li>The following properties should hold at call time: (<a class="lpdoc-idx-anchor" id="68" href="term_typing.html#var/1"><tt>term_typing:var/1</tt></a>)Atom is a free variable. <li>The following properties hold upon exit: (<a class="lpdoc-idx-anchor" id="69" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)Atom is an atom. </ul></div></div> <div><div class="lpdoc-defname">PREDICATE<a class="lpdoc-idx-anchor" id="new_atom/1" href="ciaosearch.html#new_atom/1">new_atom/1</a></div><div class="lpdoc-deftext">Usage:<tt>new_atom(Atom)</tt> Returns, on success, in Atom a new atom, not existing before in the system. The entry argument must be a variable. The idea behind this atom generation is to provide a fast source of identifiers for new objects, concurrent predicates, etc. on the fly.<ul class="lpdoc-itemize-minus"><li>The following properties should hold at call time: (<a class="lpdoc-idx-anchor" id="70" href="term_typing.html#var/1"><tt>term_typing:var/1</tt></a>)Atom is a free variable. <li>The following properties hold upon exit: (<a class="lpdoc-idx-anchor" id="71" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)Atom is an atom. </ul></div></div> <div><div class="lpdoc-defname">PREDICATE<a class="lpdoc-idx-anchor" id="current_module/1" href="ciaosearch.html#current_module/1">current_module/1</a></div><div class="lpdoc-deftext">This predicate will successively unify its argument with all module names currently loaded. Module names will be simple atoms.When called using a free variable as argument, it will retrieve on backtracking all modules currently loaded. This is useful when called from the Ciao <a class="lpdoc-idx-anchor" id="72" href="toplevel_doc.html"><tt>toplevel</tt></a>.When called using a module name as argument it will check whether the given module is loaded or not. This is useful when called from user programs. Usage 1:<tt>current_module(Module)</tt> Retrieves (on backtracking) in Module all the loaded modules (either statically or dynamically).<ul class="lpdoc-itemize-minus"><li>The following properties should hold at call time: (<a class="lpdoc-idx-anchor" id="73" href="term_typing.html#var/1"><tt>term_typing:var/1</tt></a>)Module is a free variable. <li>The following properties should hold upon exit: (<a class="lpdoc-idx-anchor" id="74" href="basic_props.html#internal_module_id/1"><tt>basic_props:internal_module_id/1</tt></a>)Module is an internal module identifier <li>The following properties should hold globally: (<a class="lpdoc-idx-anchor" id="75" href="basic_props.html#native/1"><tt>basic_props:native/1</tt></a>)This predicate is understood natively by CiaoPP. </ul>Usage 2:<tt>current_module(Module)</tt> Checks whether module Module is loaded or not (either statically or dynamically).<ul class="lpdoc-itemize-minus"><li>The following properties should hold at call time: (<a class="lpdoc-idx-anchor" id="76" href="term_typing.html#var/1"><tt>term_typing:var/1</tt></a>)Module is a free variable. <li>The following properties should hold upon exit: (<a class="lpdoc-idx-anchor" id="77" href="basic_props.html#internal_module_id/1"><tt>basic_props:internal_module_id/1</tt></a>)Module is an internal module identifier <li>The following properties should hold globally: (<a class="lpdoc-idx-anchor" id="78" href="basic_props.html#native/1"><tt>basic_props:native/1</tt></a>)This predicate is understood natively by CiaoPP. </ul></div></div> <div><div class="lpdoc-defname">PREDICATE<a class="lpdoc-idx-anchor" id="module_split/3" href="ciaosearch.html#module_split/3">module_split/3</a></div><div class="lpdoc-deftext">No further documentation available for this predicate.</div></div> <div><div class="lpdoc-defname">PREDICATE<a class="lpdoc-idx-anchor" id="predicate_property/2" href="ciaosearch.html#predicate_property/2">predicate_property/2</a></div><div class="lpdoc-deftext">Usage:<tt>predicate_property(Head,Property)</tt> The predicate Head, visible from the current module, (a goal) has the property Property.<ul class="lpdoc-itemize-minus"><li>The following properties should hold upon exit: (<a class="lpdoc-idx-anchor" id="79" href="basic_props.html#cgoal/1"><tt>basic_props:cgoal/1</tt></a>)Head is a term which represents a goal, i.e., an atom or a structure. (<a class="lpdoc-idx-anchor" id="80" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)Property is an atom. </ul></div></div> <div><div class="lpdoc-defname">PREDICATE<a class="lpdoc-idx-anchor" id="predicate_property/3" href="ciaosearch.html#predicate_property/3">predicate_property/3</a></div><div class="lpdoc-deftext">No further documentation available for this predicate.</div></div> <div><div class="lpdoc-defname">PREDICATE<a class="lpdoc-idx-anchor" id="garbage_collect/0" href="ciaosearch.html#garbage_collect/0">garbage_collect/0</a></div><div class="lpdoc-deftext">Usage:Forces garbage collection when called.<ul class="lpdoc-itemize-minus"></ul></div></div> <div><div class="lpdoc-defname">PREDICATE<a class="lpdoc-idx-anchor" id="set_prolog_flag/2" href="ciaosearch.html#set_prolog_flag/2">set_prolog_flag/2</a></div><div class="lpdoc-deftext"><tt>set_prolog_flag(FlagName,Value)</tt> Set existing flag FlagName to Value. Can also be a declaration (which is then compile-time and module-local).Usage:ISO <ul class="lpdoc-itemize-minus"><li>The following properties should hold at call time: (<a class="lpdoc-idx-anchor" id="81" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)FlagName is an atom. (<a class="lpdoc-idx-anchor" id="82" href="basic_props.html#term/1"><tt>basic_props:term/1</tt></a>)Value is any term. <li>The following properties should hold upon exit: (<a class="lpdoc-idx-anchor" id="83" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)FlagName is an atom. (<a class="lpdoc-idx-anchor" id="84" href="basic_props.html#term/1"><tt>basic_props:term/1</tt></a>)Value is any term. </ul></div></div> <div><div class="lpdoc-defname">PREDICATE<a class="lpdoc-idx-anchor" id="current_prolog_flag/2" href="ciaosearch.html#current_prolog_flag/2">current_prolog_flag/2</a></div><div class="lpdoc-deftext"><tt>current_prolog_flag(FlagName,Value)</tt> FlagName is an existing flag and Value is the value currently associated with it.Usage:<ul class="lpdoc-itemize-minus"><li>The following properties should hold upon exit: (<a class="lpdoc-idx-anchor" id="85" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)FlagName is an atom. (<a class="lpdoc-idx-anchor" id="86" href="basic_props.html#term/1"><tt>basic_props:term/1</tt></a>)Value is any term. </ul></div></div> <div><div class="lpdoc-defname">PREDICATE<a class="lpdoc-idx-anchor" id="prolog_flag/3" href="ciaosearch.html#prolog_flag/3">prolog_flag/3</a></div><div class="lpdoc-deftext"><tt>prolog_flag(FlagName,OldValue,NewValue)</tt> FlagName is an existing flag. Unify OldValue with the value associated with it, and set it to new value NewValue. Can also be a declaration (which is then compile-time and module-local).Usage 1:<tt>prolog_flag(FlagName,OldValue,NewValue)</tt> <ul class="lpdoc-itemize-minus"><li>The following properties should hold at call time: (<a class="lpdoc-idx-anchor" id="87" href="term_typing.html#nonvar/1"><tt>term_typing:nonvar/1</tt></a>)NewValue is currently a term which is not a free variable. <li>The following properties should hold upon exit: (<a class="lpdoc-idx-anchor" id="88" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)FlagName is an atom. (<a class="lpdoc-idx-anchor" id="89" href="term_typing.html#nonvar/1"><tt>term_typing:nonvar/1</tt></a>)OldValue is currently a term which is not a free variable. (<a class="lpdoc-idx-anchor" id="90" href="term_typing.html#nonvar/1"><tt>term_typing:nonvar/1</tt></a>)NewValue is currently a term which is not a free variable. </ul>Usage 2:<tt>prolog_flag(FlagName,OldValue,NewValue)</tt> Same as <tt>current_prolog_flag(FlagName, OldValue)</tt>. OldValue and NewValue must be strictly identical variables.<ul class="lpdoc-itemize-minus"><li>The following properties should hold at call time: (<a class="lpdoc-idx-anchor" id="91" href="term_typing.html#var/1"><tt>term_typing:var/1</tt></a>)OldValue is a free variable. (<a class="lpdoc-idx-anchor" id="92" href="term_typing.html#var/1"><tt>term_typing:var/1</tt></a>)NewValue is a free variable. (<a class="lpdoc-idx-anchor" id="93" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)FlagName is an atom. <li>The following properties should hold upon exit: (<a class="lpdoc-idx-anchor" id="94" href="term_typing.html#nonvar/1"><tt>term_typing:nonvar/1</tt></a>)OldValue is currently a term which is not a free variable. (<a class="lpdoc-idx-anchor" id="95" href="term_typing.html#nonvar/1"><tt>term_typing:nonvar/1</tt></a>)NewValue is currently a term which is not a free variable. </ul></div></div> <div><div class="lpdoc-defname">PREDICATE<a class="lpdoc-idx-anchor" id="push_prolog_flag/2" href="ciaosearch.html#push_prolog_flag/2">push_prolog_flag/2</a></div><div class="lpdoc-deftext"><tt>push_prolog_flag(Flag,NewValue)</tt> Same as <a class="lpdoc-idx-anchor" id="96" href="#set_prolog_flag/2"><tt>set_prolog_flag/2</tt></a>, but storing the current value of Flag to restore it with <a class="lpdoc-idx-anchor" id="97" href="#pop_prolog_flag/1"><tt>pop_prolog_flag/1</tt></a>. Can also be a declaration (which is then compile-time and module-local).Usage:<ul class="lpdoc-itemize-minus"><li>The following properties should hold at call time: (<a class="lpdoc-idx-anchor" id="98" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)Flag is an atom. (<a class="lpdoc-idx-anchor" id="99" href="basic_props.html#term/1"><tt>basic_props:term/1</tt></a>)NewValue is any term. <li>The following properties should hold upon exit: (<a class="lpdoc-idx-anchor" id="100" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)Flag is an atom. (<a class="lpdoc-idx-anchor" id="101" href="basic_props.html#term/1"><tt>basic_props:term/1</tt></a>)NewValue is any term. </ul></div></div> <div><div class="lpdoc-defname">PREDICATE<a class="lpdoc-idx-anchor" id="pop_prolog_flag/1" href="ciaosearch.html#pop_prolog_flag/1">pop_prolog_flag/1</a></div><div class="lpdoc-deftext"><tt>pop_prolog_flag(Flag)</tt> Restore the value of Flag previous to the last non-canceled <a class="lpdoc-idx-anchor" id="102" href="#push_prolog_flag/2"><tt>push_prolog_flag/2</tt></a> on it. Can also be a declaration (which is then compile-time and module-local).Usage:<ul class="lpdoc-itemize-minus"><li>The following properties should hold at call time: (<a class="lpdoc-idx-anchor" id="103" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)Flag is an atom. <li>The following properties should hold upon exit: (<a class="lpdoc-idx-anchor" id="104" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)Flag is an atom. </ul></div></div> <div><div class="lpdoc-defname">PREDICATE<a class="lpdoc-idx-anchor" id="prompt/2" href="ciaosearch.html#prompt/2">prompt/2</a></div><div class="lpdoc-deftext"><tt>prompt(Old,New)</tt> Allows reading or changing the prompt used for reading in terms.Usage 1:<tt>prompt(Old,New)</tt> Unify Old with the current prompt for reading, change it to New. To read the current prompt just call <tt>prompt(X,X)</tt>.<ul class="lpdoc-itemize-minus"><li>The following properties should hold at call time: (<a class="lpdoc-idx-anchor" id="105" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)New is an atom. <li>The following properties should hold upon exit: (<a class="lpdoc-idx-anchor" id="106" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)Old is an atom. </ul>Usage 2:<tt>prompt(Old,New)</tt> Unify Old with the current prompt for reading without changing it. On calls, Old and New must be strictly identical variables.<ul class="lpdoc-itemize-minus"><li>The following properties should hold at call time: (<a class="lpdoc-idx-anchor" id="107" href="term_typing.html#var/1"><tt>term_typing:var/1</tt></a>)Old</spa