@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>Conversion between constants and strings — 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="BasicLang.html">↑</a><a class="lpdoc-navbutton" href="term_compare.html">←</a><a class="lpdoc-navbutton" href="arithmetic.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="BasicLang.html">PART II - The Ciao basic language</a> » </li><li><a href="">Conversion between constants and strings</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 imports">Documentation on imports</a></li></ul></div><div class="lpdoc-main"><div id=""><h1>Conversion between constants and strings</h1><a class="lpdoc-idx-anchor" href="ciaosearch.html#atomic_basic"></a> Author(s): <a class="lpdoc-idx-anchor" id="The Ciao Development Team" href="ciaosearch.html#The Ciao Development Team">The Ciao Development Team</a>. The Ciao system provides builtin predicates which allow conversions between constants (atomic terms, i.e., atoms or numbers) and their string representation (character code lists). Note that sometimes strings are more suitable to handle sequences of characters. <div id="Usage and interface"><h2>Usage and interface</h2><div class="lpdoc-cartouche"><ul><li>Library usage: This module is imported by default (unless the <a class="lpdoc-idx-anchor" id="0" href="noprelude_doc.html"><tt>noprelude</tt></a> or <a class="lpdoc-idx-anchor" id="1" href="pure_doc.html"><tt>pure</tt></a> packages are used). <li>Exports: <ul class="lpdoc-itemize-minus"><li>Predicates: <a class="lpdoc-idx-anchor" id="2" href="#name/2"><tt>name/2</tt></a>, <a class="lpdoc-idx-anchor" id="3" href="#atom_codes/2"><tt>atom_codes/2</tt></a>, <a class="lpdoc-idx-anchor" id="4" href="#number_codes/2"><tt>number_codes/2</tt></a>, <a class="lpdoc-idx-anchor" id="5" href="#number_codes/3"><tt>number_codes/3</tt></a>, <a class="lpdoc-idx-anchor" id="6" href="#atom_number/2"><tt>atom_number/2</tt></a>, <a class="lpdoc-idx-anchor" id="7" href="#atom_number/3"><tt>atom_number/3</tt></a>, <a class="lpdoc-idx-anchor" id="8" href="#atom_length/2"><tt>atom_length/2</tt></a>, <a class="lpdoc-idx-anchor" id="9" href="#atom_concat/3"><tt>atom_concat/3</tt></a>, <a class="lpdoc-idx-anchor" id="10" href="#sub_atom/4"><tt>sub_atom/4</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="name/2" href="ciaosearch.html#name/2">name/2</a></div><div class="lpdoc-deftext"><tt>name(Const,String)</tt> String is the list of the ASCII codes of the characters comprising the name of Const. Note that if Const is an atom whose name can be interpreted as a number (e.g. '96'), the predicate is not reversible, as that atom will not be constructed when Const is uninstantiated. Thus it is recommended that new programs use the ISO-compliant predicates <a class="lpdoc-idx-anchor" id="11" href="#atom_codes/2"><tt>atom_codes/2</tt></a> or <a class="lpdoc-idx-anchor" id="12" href="#number_codes/2"><tt>number_codes/2</tt></a>, as these predicates do not have this inconsistency.Usage 1:<ul class="lpdoc-itemize-minus"><li>Calls should, and exit will be compatible with: (<a class="lpdoc-idx-anchor" id="13" href="basic_props.html#string/1"><tt>basic_props:string/1</tt></a>)String is a string (a list of character codes). <li>The following properties should hold at call time: (<a class="lpdoc-idx-anchor" id="14" href="basic_props.html#constant/1"><tt>basic_props:constant/1</tt></a>)Const is an atomic term (an atom or a number). <li>The following properties hold upon exit: (<a class="lpdoc-idx-anchor" id="15" href="basic_props.html#string/1"><tt>basic_props:string/1</tt></a>)String is a string (a list of character codes). <li>The following properties hold globally: (<a class="lpdoc-idx-anchor" id="16" href="basic_props.html#eval/1"><tt>basic_props:eval/1</tt></a>)name(Const,String) is evaluable at compile-time. </ul>Usage 2:If String can be interpreted as a number, Const is unified with that number, otherwise with the atom whose name is String.<ul class="lpdoc-itemize-minus"><li>The following properties should hold at call time: (<a class="lpdoc-idx-anchor" id="17" href="term_typing.html#var/1"><tt>term_typing:var/1</tt></a>)Const is a free variable. (<a class="lpdoc-idx-anchor" id="18" href="basic_props.html#string/1"><tt>basic_props:string/1</tt></a>)String is a string (a list of character codes). <li>The following properties hold upon exit: (<a class="lpdoc-idx-anchor" id="19" href="basic_props.html#constant/1"><tt>basic_props:constant/1</tt></a>)Const is an atomic term (an atom or a number). <li>The following properties hold globally: (<a class="lpdoc-idx-anchor" id="20" href="basic_props.html#eval/1"><tt>basic_props:eval/1</tt></a>)name(Const,String) is evaluable at compile-time. </ul> Other properties: <ul class="lpdoc-itemize-minus"><li>The following properties hold globally: (<a class="lpdoc-idx-anchor" id="21" href="basic_props.html#sideff/2"><tt>basic_props:sideff/2</tt></a>)name(Const,String) is side-effect free. (<a class="lpdoc-idx-anchor" id="22" 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="atom_codes/2" href="ciaosearch.html#atom_codes/2">atom_codes/2</a></div><div class="lpdoc-deftext">ISO<tt>atom_codes(Atom,String)</tt> String is the list of the ASCII codes of the characters comprising the name of Atom.Usage 1:<ul class="lpdoc-itemize-minus"><li>Calls should, and exit will be compatible with: (<a class="lpdoc-idx-anchor" id="23" href="basic_props.html#string/1"><tt>basic_props:string/1</tt></a>)String is a string (a list of character codes). <li>The following properties should hold at call time: (<a class="lpdoc-idx-anchor" id="24" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)Atom is an atom. <li>The following properties hold upon exit: (<a class="lpdoc-idx-anchor" id="25" href="basic_props.html#string/1"><tt>basic_props:string/1</tt></a>)String is a string (a list of character codes). <li>The following properties hold globally: (<a class="lpdoc-idx-anchor" id="26" href="basic_props.html#eval/1"><tt>basic_props:eval/1</tt></a>)atom_codes(Atom,String) is evaluable at compile-time. </ul>Usage 2:<ul class="lpdoc-itemize-minus"><li>Calls should, and exit will be compatible with: (<a class="lpdoc-idx-anchor" id="27" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)Atom is an atom. <li>The following properties should hold at call time: (<a class="lpdoc-idx-anchor" id="28" href="basic_props.html#string/1"><tt>basic_props:string/1</tt></a>)String is a string (a list of character codes). <li>The following properties hold upon exit: (<a class="lpdoc-idx-anchor" id="29" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)Atom is an atom. <li>The following properties hold globally: (<a class="lpdoc-idx-anchor" id="30" href="basic_props.html#eval/1"><tt>basic_props:eval/1</tt></a>)atom_codes(Atom,String) is evaluable at compile-time. </ul> Other properties: <ul class="lpdoc-itemize-minus"><li>The following properties hold globally: (<a class="lpdoc-idx-anchor" id="31" href="basic_props.html#sideff/2"><tt>basic_props:sideff/2</tt></a>)atom_codes(Atom,String) is side-effect free. (<a class="lpdoc-idx-anchor" id="32" href="basic_props.html#native/1"><tt>basic_props:native/1</tt></a>)This predicate is understood natively by CiaoPP. (<a class="lpdoc-idx-anchor" id="33" href="native_props_nfdet_doc.html#is_det/1"><tt>native_props:is_det/1</tt></a>)All calls of the form atom_codes(Atom,String) are deterministic. </ul></div></div> <div><div class="lpdoc-defname">PREDICATE<a class="lpdoc-idx-anchor" id="number_codes/2" href="ciaosearch.html#number_codes/2">number_codes/2</a></div><div class="lpdoc-deftext">ISO<tt>number_codes(Number,String)</tt> String is the list of the ASCII codes of the characters comprising a representation of Number.Usage 1:<ul class="lpdoc-itemize-minus"><li>Calls should, and exit will be compatible with: (<a class="lpdoc-idx-anchor" id="34" href="basic_props.html#string/1"><tt>basic_props:string/1</tt></a>)String is a string (a list of character codes). <li>The following properties should hold at call time: (<a class="lpdoc-idx-anchor" id="35" href="basic_props.html#num/1"><tt>basic_props:num/1</tt></a>)Number is a number. <li>The following properties hold upon exit: (<a class="lpdoc-idx-anchor" id="36" href="basic_props.html#string/1"><tt>basic_props:string/1</tt></a>)String is a string (a list of character codes). <li>The following properties hold globally: (<a class="lpdoc-idx-anchor" id="37" href="basic_props.html#eval/1"><tt>basic_props:eval/1</tt></a>)number_codes(Number,String) is evaluable at compile-time. </ul>Usage 2:<ul class="lpdoc-itemize-minus"><li>The following properties should hold at call time: (<a class="lpdoc-idx-anchor" id="38" href="term_typing.html#var/1"><tt>term_typing:var/1</tt></a>)Number is a free variable. (<a class="lpdoc-idx-anchor" id="39" href="basic_props.html#string/1"><tt>basic_props:string/1</tt></a>)String is a string (a list of character codes). <li>The following properties hold upon exit: (<a class="lpdoc-idx-anchor" id="40" href="basic_props.html#num/1"><tt>basic_props:num/1</tt></a>)Number is a number. <li>The following properties hold globally: (<a class="lpdoc-idx-anchor" id="41" href="basic_props.html#eval/1"><tt>basic_props:eval/1</tt></a>)number_codes(Number,String) is evaluable at compile-time. </ul> Other properties: <ul class="lpdoc-itemize-minus"><li>The following properties hold globally: (<a class="lpdoc-idx-anchor" id="42" href="basic_props.html#sideff/2"><tt>basic_props:sideff/2</tt></a>)number_codes(Number,String) is side-effect free. (<a class="lpdoc-idx-anchor" id="43" href="basic_props.html#native/1"><tt>basic_props:native/1</tt></a>)This predicate is understood natively by CiaoPP. </ul><tt>number_codes(A,B)</tt> <ul class="lpdoc-itemize-minus"><li>If the following properties hold at call time: (<a class="lpdoc-idx-anchor" id="44" href="basic_props.html#int/1"><tt>basic_props:int/1</tt></a>)A is an integer. then the following properties hold upon exit: (<a class="lpdoc-idx-anchor" id="45" href="basic_props.html#string/1"><tt>basic_props:string/1</tt></a>)B is a string (a list of character codes). </ul></div></div> <div><div class="lpdoc-defname">PREDICATE<a class="lpdoc-idx-anchor" id="number_codes/3" href="ciaosearch.html#number_codes/3">number_codes/3</a></div><div class="lpdoc-deftext"><tt>number_codes(Number,Base,String)</tt> String is the list of the ASCII codes of the characters comprising a representation of Number in base Base.Usage 1:<ul class="lpdoc-itemize-minus"><li>Calls should, and exit will be compatible with: (<a class="lpdoc-idx-anchor" id="46" href="basic_props.html#string/1"><tt>basic_props:string/1</tt></a>)String is a string (a list of character codes). <li>The following properties should hold at call time: (<a class="lpdoc-idx-anchor" id="47" href="basic_props.html#num/1"><tt>basic_props:num/1</tt></a>)Number is a number. (<a class="lpdoc-idx-anchor" id="48" href="basic_props.html#int/1"><tt>basic_props:int/1</tt></a>)Base is an integer. <li>The following properties hold upon exit: (<a class="lpdoc-idx-anchor" id="49" href="basic_props.html#string/1"><tt>basic_props:string/1</tt></a>)String is a string (a list of character codes). <li>The following properties hold globally: (<a class="lpdoc-idx-anchor" id="50" href="basic_props.html#eval/1"><tt>basic_props:eval/1</tt></a>)number_codes(Number,Base,String) is evaluable at compile-time. </ul>Usage 2:<ul class="lpdoc-itemize-minus"><li>The following properties should hold at call time: (<a class="lpdoc-idx-anchor" id="51" href="term_typing.html#var/1"><tt>term_typing:var/1</tt></a>)Number is a free variable. (<a class="lpdoc-idx-anchor" id="52" href="basic_props.html#int/1"><tt>basic_props:int/1</tt></a>)Base is an integer. (<a class="lpdoc-idx-anchor" id="53" href="basic_props.html#string/1"><tt>basic_props:string/1</tt></a>)String is a string (a list of character codes). <li>The following properties hold upon exit: (<a class="lpdoc-idx-anchor" id="54" href="basic_props.html#num/1"><tt>basic_props:num/1</tt></a>)Number is a number. <li>The following properties hold globally: (<a class="lpdoc-idx-anchor" id="55" href="basic_props.html#eval/1"><tt>basic_props:eval/1</tt></a>)number_codes(Number,Base,String) is evaluable at compile-time. </ul> Other properties: <ul class="lpdoc-itemize-minus"><li>The following properties hold globally: (<a class="lpdoc-idx-anchor" id="56" href="basic_props.html#sideff/2"><tt>basic_props:sideff/2</tt></a>)number_codes(Number,Base,String) is side-effect free. (<a class="lpdoc-idx-anchor" id="57" 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="atom_number/2" href="ciaosearch.html#atom_number/2">atom_number/2</a></div><div class="lpdoc-deftext"><tt>atom_number(Atom,Number)</tt> Atom can be read as a representation of Number.Usage 1:<ul class="lpdoc-itemize-minus"><li>Call and exit should be compatible with: (<a class="lpdoc-idx-anchor" id="58" href="basic_props.html#num/1"><tt>basic_props:num/1</tt></a>)Number is a number. <li>The following properties should hold at call time: (<a class="lpdoc-idx-anchor" id="59" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)Atom is an atom. <li>The following properties should hold upon exit: (<a class="lpdoc-idx-anchor" id="60" href="basic_props.html#num/1"><tt>basic_props:num/1</tt></a>)Number is a number. (<a class="lpdoc-idx-anchor" id="61" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)Atom is an atom. (<a class="lpdoc-idx-anchor" id="62" href="basic_props.html#num/1"><tt>basic_props:num/1</tt></a>)Number is a number. <li>The following properties should hold globally: (<a class="lpdoc-idx-anchor" id="63" href="basic_props.html#eval/1"><tt>basic_props:eval/1</tt></a>)atom_number(Atom,Number) is evaluable at compile-time. </ul>Usage 2:<ul class="lpdoc-itemize-minus"><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>)Atom is a free variable. (<a class="lpdoc-idx-anchor" id="65" href="basic_props.html#num/1"><tt>basic_props:num/1</tt></a>)Number is a number. <li>The following properties should hold upon exit: (<a class="lpdoc-idx-anchor" id="66" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)Atom is an atom. (<a class="lpdoc-idx-anchor" id="67" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)Atom is an atom. (<a class="lpdoc-idx-anchor" id="68" href="basic_props.html#num/1"><tt>basic_props:num/1</tt></a>)Number is a number. <li>The following properties should hold globally: (<a class="lpdoc-idx-anchor" id="69" href="basic_props.html#eval/1"><tt>basic_props:eval/1</tt></a>)atom_number(Atom,Number) is evaluable at compile-time. </ul> Other properties: <ul class="lpdoc-itemize-minus"><li>The following properties hold globally: (<a class="lpdoc-idx-anchor" id="70" href="basic_props.html#sideff/2"><tt>basic_props:sideff/2</tt></a>)atom_number(Atom,Number) is side-effect free. (<a class="lpdoc-idx-anchor" id="71" href="basic_props.html#native/1"><tt>basic_props:native/1</tt></a>)This predicate is understood natively by CiaoPP. (<a class="lpdoc-idx-anchor" id="72" href="native_props_nfdet_doc.html#is_det/1"><tt>native_props:is_det/1</tt></a>)All calls of the form atom_number(Atom,Number) are deterministic. </ul></div></div> <div><div class="lpdoc-defname">PREDICATE<a class="lpdoc-idx-anchor" id="atom_number/3" href="ciaosearch.html#atom_number/3">atom_number/3</a></div><div class="lpdoc-deftext"><tt>atom_number(Atom,Base,Number)</tt> Atom can be read as a representation of Number in base Base.Usage 1:<ul class="lpdoc-itemize-minus"><li>Call and exit should be compatible with: (<a class="lpdoc-idx-anchor" id="73" href="basic_props.html#num/1"><tt>basic_props:num/1</tt></a>)Base is a number. <li>The following properties should hold at call time: (<a class="lpdoc-idx-anchor" id="74" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)Atom is an atom. (<a class="lpdoc-idx-anchor" id="75" href="basic_props.html#num/1"><tt>basic_props:num/1</tt></a>)Number is a number. <li>The following properties should hold upon exit: (<a class="lpdoc-idx-anchor" id="76" href="basic_props.html#num/1"><tt>basic_props:num/1</tt></a>)Base is a number. </ul>Usage 2:<ul class="lpdoc-itemize-minus"><li>The following properties should hold at call time: (<a class="lpdoc-idx-anchor" id="77" href="term_typing.html#var/1"><tt>term_typing:var/1</tt></a>)Atom is a free variable. (<a class="lpdoc-idx-anchor" id="78" href="basic_props.html#num/1"><tt>basic_props:num/1</tt></a>)Base is a number. (<a class="lpdoc-idx-anchor" id="79" href="basic_props.html#num/1"><tt>basic_props:num/1</tt></a>)Number is a number. <li>The following properties should hold upon exit: (<a class="lpdoc-idx-anchor" id="80" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)Atom is an atom. </ul> Other properties: <ul class="lpdoc-itemize-minus"><li>The following properties hold globally: (<a class="lpdoc-idx-anchor" id="81" href="basic_props.html#sideff/2"><tt>basic_props:sideff/2</tt></a>)atom_number(Atom,Base,Number) is side-effect free. (<a class="lpdoc-idx-anchor" id="82" href="basic_props.html#native/1"><tt>basic_props:native/1</tt></a>)This predicate is understood natively by CiaoPP. (<a class="lpdoc-idx-anchor" id="83" href="native_props_nfdet_doc.html#is_det/1"><tt>native_props:is_det/1</tt></a>)All calls of the form atom_number(Atom,Base,Number) are deterministic. </ul></div></div> <div><div class="lpdoc-defname">PREDICATE<a class="lpdoc-idx-anchor" id="atom_length/2" href="ciaosearch.html#atom_length/2">atom_length/2</a></div><div class="lpdoc-deftext">ISO<tt>atom_length(Atom,Length)</tt> Length is the number of characters forming the name of Atom.Usage:<ul class="lpdoc-itemize-minus"><li>Calls should, and exit will be compatible with: (<a class="lpdoc-idx-anchor" id="84" href="basic_props.html#int/1"><tt>basic_props:int/1</tt></a>)Length is an integer. <li>The following properties should hold at call time: (<a class="lpdoc-idx-anchor" id="85" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)Atom is an atom. <li>The following properties hold upon exit: (<a class="lpdoc-idx-anchor" id="86" href="basic_props.html#int/1"><tt>basic_props:int/1</tt></a>)Length is an integer. <li>The following properties hold globally: (<a class="lpdoc-idx-anchor" id="87" href="basic_props.html#eval/1"><tt>basic_props:eval/1</tt></a>)atom_length(Atom,Length) is evaluable at compile-time. </ul> Other properties: <ul class="lpdoc-itemize-minus"><li>The following properties hold globally: (<a class="lpdoc-idx-anchor" id="88" href="basic_props.html#sideff/2"><tt>basic_props:sideff/2</tt></a>)atom_length(Atom,Length) is side-effect free. (<a class="lpdoc-idx-anchor" id="89" href="basic_props.html#native/1"><tt>basic_props:native/1</tt></a>)This predicate is understood natively by CiaoPP. (<a class="lpdoc-idx-anchor" id="90" href="native_props_nfdet_doc.html#is_det/1"><tt>native_props:is_det/1</tt></a>)All calls of the form atom_length(Atom,Length) are deterministic. </ul></div></div> <div><div class="lpdoc-defname">PREDICATE<a class="lpdoc-idx-anchor" id="atom_concat/3" href="ciaosearch.html#atom_concat/3">atom_concat/3</a></div><div class="lpdoc-deftext">ISO<tt>atom_concat(Atom_1,Atom_2,Atom_12)</tt> Atom_12 is the result of concatenating Atom_1 followed by Atom_2.Usage 1:Concatenate two atoms.<ul class="lpdoc-itemize-minus"><li>Calls should, and exit will be compatible with: (<a class="lpdoc-idx-anchor" id="91" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)Atom_12 is an atom. <li>The following properties should hold at call time: (<a class="lpdoc-idx-anchor" id="92" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)Atom_1 is an atom. (<a class="lpdoc-idx-anchor" id="93" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)Atom_2 is an atom. <li>The following properties hold upon exit: (<a class="lpdoc-idx-anchor" id="94" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)Atom_12 is an atom. (<a class="lpdoc-idx-anchor" id="95" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)Atom_1 is an atom. (<a class="lpdoc-idx-anchor" id="96" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)Atom_2 is an atom. (<a class="lpdoc-idx-anchor" id="97" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)Atom_12 is an atom. <li>The following properties hold globally: (<a class="lpdoc-idx-anchor" id="98" href="basic_props.html#eval/1"><tt>basic_props:eval/1</tt></a>)atom_concat(Atom_1,Atom_2,Atom_12) is evaluable at compile-time. </ul>Usage 2:Non-deterministically split an atom.<ul class="lpdoc-itemize-minus"><li>The following properties should hold at call time: (<a class="lpdoc-idx-anchor" id="99" href="term_typing.html#var/1"><tt>term_typing:var/1</tt></a>)Atom_1 is a free variable. (<a class="lpdoc-idx-anchor" id="100" href="term_typing.html#var/1"><tt>term_typing:var/1</tt></a>)Atom_2 is a free variable. (<a class="lpdoc-idx-anchor" id="101" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)Atom_12 is an atom. <li>The following properties hold upon exit: (<a class="lpdoc-idx-anchor" id="102" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)Atom_1 is an atom. (<a class="lpdoc-idx-anchor" id="103" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)Atom_2 is an atom. (<a class="lpdoc-idx-anchor" id="104" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)Atom_1 is an atom. (<a class="lpdoc-idx-anchor" id="105" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)Atom_2 is an atom. (<a class="lpdoc-idx-anchor" id="106" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)Atom_12 is an atom. <li>The following properties hold globally: (<a class="lpdoc-idx-anchor" id="107" href="basic_props.html#eval/1"><tt>basic_props:eval/1</tt></a>)atom_concat(Atom_1,Atom_2,Atom_12) is evaluable at compile-time. </ul>Usage 3:Take out of an atom a certain suffix (or fail if it cannot be done).<ul class="lpdoc-itemize-minus"><li>The following properties should hold at call time: (<a class="lpdoc-idx-anchor" id="108" href="term_typing.html#var/1"><tt>term_typing:var/1</tt></a>)Atom_1 is a free variable. (<a class="lpdoc-idx-anchor" id="109" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)Atom_2 is an atom. (<a class="lpdoc-idx-anchor" id="110" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)Atom_12 is an atom. <li>The following properties hold upon exit: (<a class="lpdoc-idx-anchor" id="111" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)Atom_1 is an atom. (<a class="lpdoc-idx-anchor" id="112" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)Atom_1 is an atom. (<a class="lpdoc-idx-anchor" id="113" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)Atom_2 is an atom. (<a class="lpdoc-idx-anchor" id="114" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)Atom_12 is an atom. <li>The following properties hold globally: (<a class="lpdoc-idx-anchor" id="115" href="basic_props.html#eval/1"><tt>basic_props:eval/1</tt></a>)atom_concat(Atom_1,Atom_2,Atom_12) is evaluable at compile-time. </ul>Usage 4:Take out of an atom a certain prefix (or fail if it cannot be done).<ul class="lpdoc-itemize-minus"><li>The following properties should hold at call time: (<a class="lpdoc-idx-anchor" id="116" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)Atom_1 is an atom. (<a class="lpdoc-idx-anchor" id="117" href="term_typing.html#var/1"><tt>term_typing:var/1</tt></a>)Atom_2 is a free variable. (<a class="lpdoc-idx-anchor" id="118" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)Atom_12 is an atom. <li>The following properties hold upon exit: (<a class="lpdoc-idx-anchor" id="119" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)Atom_2 is an atom. (<a class="lpdoc-idx-anchor" id="120" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)Atom_1 is an atom. (<a class="lpdoc-idx-anchor" id="121" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)Atom_2 is an atom. (<a class="lpdoc-idx-anchor" id="122" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)Atom_12 is an atom. <li>The following properties hold globally: (<a class="lpdoc-idx-anchor" id="123" href="basic_props.html#eval/1"><tt>basic_props:eval/1</tt></a>)atom_concat(Atom_1,Atom_2,Atom_12) is evaluable at compile-time. </ul> Other properties: <ul class="lpdoc-itemize-minus"><li>The following properties hold globally: (<a class="lpdoc-idx-anchor" id="124" href="basic_props.html#sideff/2"><tt>basic_props:sideff/2</tt></a>)atom_concat(Atom_1,Atom_2,Atom_12) is side-effect free. (<a class="lpdoc-idx-anchor" id="125" href="basic_props.html#native/1"><tt>basic_props:native/1</tt></a>)This predicate is understood natively by CiaoPP. (<a class="lpdoc-idx-anchor" id="126" href="native_props_nfdet_doc.html#is_det/1"><tt>native_props:is_det/1</tt></a>)All calls of the form atom_concat(Atom_1,Atom_2,Atom_12) are deterministic. </ul></div></div> <div><div class="lpdoc-defname">PREDICATE<a class="lpdoc-idx-anchor" id="sub_atom/4" href="ciaosearch.html#sub_atom/4">sub_atom/4</a></div><div class="lpdoc-deftext"><tt>sub_atom(Atom,Before,Length,Sub_atom)</tt> Sub_atom is formed with Length consecutive characters of Atom after the Before character. For example, the goal <tt>sub_atom(summer,1,4,umme)</tt> succeeds.Usage:<ul class="lpdoc-itemize-minus"><li>Calls should, and exit will be compatible with: (<a class="lpdoc-idx-anchor" id="127" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)Sub_atom is an atom. <li>The following properties should hold at call time: (<a class="lpdoc-idx-anchor" id="128" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)Atom is an atom. (<a class="lpdoc-idx-anchor" id="129" href="basic_props.html#int/1"><tt>basic_props:int/1</tt></a>)Before is an integer. (<a class="lpdoc-idx-anchor" id="130" href="basic_props.html#int/1"><tt>basic_props:int/1</tt></a>)Length is an integer. <li>The following properties hold upon exit: (<a class="lpdoc-idx-anchor" id="131" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)Sub_atom is an atom. <li>The following properties hold globally: (<a class="lpdoc-idx-anchor" id="132" href="basic_props.html#eval/1"><tt>basic_props:eval/1</tt></a>)sub_atom(Atom,Before,Length,Sub_atom) is evaluable at compile-time. </ul> Other properties: <ul class="lpdoc-itemize-minus"><li>The following properties hold globally: (<a class="lpdoc-idx-anchor" id="133" href="basic_props.html#sideff/2"><tt>basic_props:sideff/2</tt></a>)sub_atom(Atom,Before,Length,Sub_atom) is side-effect free. (<a class="lpdoc-idx-anchor" id="134" 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 id="Documentation on imports"><h2>Documentation on imports</h2>This module has the following direct dependencies:<ul class="lpdoc-itemize-minus"><li>System library modules: <a class="lpdoc-idx-anchor" id="135" href="ciaosearch.html#native_props"><tt>native_props</tt></a>. <li>Packages: <a class="lpdoc-idx-anchor" id="136" href="noprelude_doc.html"><tt>noprelude</tt></a>, <a class="lpdoc-idx-anchor" id="137" href="ciaosearch.html#initial"><tt>initial</tt></a>, <a class="lpdoc-idx-anchor" id="138" href="condcomp_doc.html"><tt>condcomp</tt></a>, <a class="lpdoc-idx-anchor" id="139" href="assertions_doc.html"><tt>assertions</tt></a>, <a class="lpdoc-idx-anchor" id="140" href="ciaosearch.html#assertions/assertions_basic"><tt>assertions/assertions_basic</tt></a>, <a class="lpdoc-idx-anchor" id="141" href="ciaosearch.html#nortchecks"><tt>nortchecks</tt></a>, <a class="lpdoc-idx-anchor" id="142" href="isomodes_doc.html"><tt>isomodes</tt></a>, <a class="lpdoc-idx-anchor" id="143" href="ciaosearch.html#nativeprops"><tt>nativeprops</tt></a>. </ul></div></div><div class="lpdoc-footer">Generated with LPdoc using Ciao</div></div><div class="lpdoc-clearer"></div></div></body></html>