@ciao-lang/ts-ciao-interface

Version:

Simple Ciao interface for node.

82 lines • 17 kB

HTML

<!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>Defining operators — 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="write.html">←</a><a class="lpdoc-navbutton" href="format.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="">Defining operators</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>Defining operators</h1><a class="lpdoc-idx-anchor" href="ciaosearch.html#operators"></a> Author(s): <a class="lpdoc-idx-anchor" id="Daniel Cabeza" href="ciaosearch.html#Daniel Cabeza">Daniel Cabeza (modifications and documentation, adapted from SICStus 0.6 code)</a>, <a class="lpdoc-idx-anchor" id="Manuel Carro" href="ciaosearch.html#Manuel Carro">Manuel Carro (modifications and documentation)</a>. Operators allow writing terms in a more clear way than the standard functional notation. Standard operators in Ciao are defined by this predicate (but note that the compiler itself defines more operators at compile time): <pre class="lpdoc-codeblock">standard_ops :- op(1200,xfx,[:-]), op(1200,fx,[:-,?-]), op(1100,xfy,[;]), op(1050,xfy,[->]), op(1000,xfy,[',']), op(900,fy,[\+]), op(700,xfx,[=,\=,==,\==,@<,@>,@=<,@>=,=..,is,=:=,=\=,<,=<,>,>=]), op(550,xfx,[:]), op(500,yfx,[+,-,/\,\/,#]), op(500,fy,[++,--]), op(400,yfx,[*,/,//,rem,mod,<<,>>]), op(200,fy,[+,-,\]), op(200,xfx,[**]), op(200,xfy,[^]). </pre> <div id="Usage and interface"><h2>Usage and interface</h2><div class="lpdoc-cartouche"><ul><li>Library usage: <tt>:- use_module(library(operators)).</tt><li>Exports: <ul class="lpdoc-itemize-minus"><li>Predicates: <a class="lpdoc-idx-anchor" id="0" href="packages.html#op/3"><tt>op/3</tt></a>, <a class="lpdoc-idx-anchor" id="1" href="#current_op/3"><tt>current_op/3</tt></a>, <a class="lpdoc-idx-anchor" id="2" href="#current_prefixop/3"><tt>current_prefixop/3</tt></a>, <a class="lpdoc-idx-anchor" id="3" href="#current_infixop/4"><tt>current_infixop/4</tt></a>, <a class="lpdoc-idx-anchor" id="4" href="#current_postfixop/3"><tt>current_postfixop/3</tt></a>, <a class="lpdoc-idx-anchor" id="5" href="#standard_ops/0"><tt>standard_ops/0</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="op/3" href="ciaosearch.html#op/3">op/3</a></div><div class="lpdoc-deftext"><tt>op(Precedence,Type,Name)</tt> Declares the atom Name to be an operator of the stated Type and Precedence (0 =< Precedence =< 1200). Name may also be a list of atoms in which case all of them are declared to be operators. If Precedence is 0 then the operator properties of Name (if any) are cancelled. Note that, unlike in <a class="lpdoc-idx-anchor" id="6" href="ciaosearch.html#ISO-Prolog">ISO-Prolog</a>, it is allowed to define two operators with the same name, one infix and the other postfix.Usage:ISO <ul class="lpdoc-itemize-minus"><li>The following properties should hold at call time: (<a class="lpdoc-idx-anchor" id="7" href="basic_props.html#int/1"><tt>basic_props:int/1</tt></a>)Precedence is an integer. (<a class="lpdoc-idx-anchor" id="8" href="basic_props.html#operator_specifier/1"><tt>basic_props:operator_specifier/1</tt></a>)Type specifies the type and associativity of an operator. (<a class="lpdoc-idx-anchor" id="9" href="basic_props.html#atm_or_atm_list/1"><tt>basic_props:atm_or_atm_list/1</tt></a>)Name is an atom or a list of atoms. <li>The following properties should hold globally: (<a class="lpdoc-idx-anchor" id="10" 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="current_op/3" href="ciaosearch.html#current_op/3">current_op/3</a></div><div class="lpdoc-deftext"><tt>current_op(Precedence,Type,Op)</tt> The atom Op is currently an operator of type Type and precedence Precedence. Neither Op nor the other arguments need be instantiated at the time of the call; i.e., this predicate can be used to generate as well as to test.Usage:ISO <ul class="lpdoc-itemize-minus"><li>Call and exit should be compatible with: (<a class="lpdoc-idx-anchor" id="11" href="basic_props.html#int/1"><tt>basic_props:int/1</tt></a>)Precedence is an integer. (<a class="lpdoc-idx-anchor" id="12" href="basic_props.html#operator_specifier/1"><tt>basic_props:operator_specifier/1</tt></a>)Type specifies the type and associativity of an operator. (<a class="lpdoc-idx-anchor" id="13" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)Op is an atom. <li>The following properties should hold upon exit: (<a class="lpdoc-idx-anchor" id="14" href="basic_props.html#int/1"><tt>basic_props:int/1</tt></a>)Precedence is an integer. (<a class="lpdoc-idx-anchor" id="15" href="basic_props.html#operator_specifier/1"><tt>basic_props:operator_specifier/1</tt></a>)Type specifies the type and associativity of an operator. (<a class="lpdoc-idx-anchor" id="16" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)Op is an atom. <li>The following properties should hold globally: (<a class="lpdoc-idx-anchor" id="17" 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="current_prefixop/3" href="ciaosearch.html#current_prefixop/3">current_prefixop/3</a></div><div class="lpdoc-deftext"><tt>current_prefixop(Op,Less,Precedence)</tt> Similar to <a class="lpdoc-idx-anchor" id="18" href="#current_op/3"><tt>current_op/3</tt></a>, but it concerns only the prefix operators. It returns only one solution. Not a predicate for general use.Usage:<ul class="lpdoc-itemize-minus"><li>Call and exit should be compatible with: (<a class="lpdoc-idx-anchor" id="19" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)Op is an atom. (<a class="lpdoc-idx-anchor" id="20" href="basic_props.html#int/1"><tt>basic_props:int/1</tt></a>)Less is an integer. (<a class="lpdoc-idx-anchor" id="21" href="basic_props.html#int/1"><tt>basic_props:int/1</tt></a>)Precedence is an integer. <li>The following properties should hold upon exit: (<a class="lpdoc-idx-anchor" id="22" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)Op is an atom. (<a class="lpdoc-idx-anchor" id="23" href="basic_props.html#int/1"><tt>basic_props:int/1</tt></a>)Less is an integer. (<a class="lpdoc-idx-anchor" id="24" href="basic_props.html#int/1"><tt>basic_props:int/1</tt></a>)Precedence is an integer. <li>The following properties should hold globally: (<a class="lpdoc-idx-anchor" id="25" 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="current_infixop/4" href="ciaosearch.html#current_infixop/4">current_infixop/4</a></div><div class="lpdoc-deftext"><tt>current_infixop(Op,LeftLess,Prec,RightLess)</tt> Similar to <a class="lpdoc-idx-anchor" id="26" href="#current_op/3"><tt>current_op/3</tt></a>, but it concerns only infix operators. It returns only one solution. Not a predicate for general use.Usage:<ul class="lpdoc-itemize-minus"><li>Call and exit should be compatible with: (<a class="lpdoc-idx-anchor" id="27" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)Op is an atom. (<a class="lpdoc-idx-anchor" id="28" href="basic_props.html#int/1"><tt>basic_props:int/1</tt></a>)LeftLess is an integer. (<a class="lpdoc-idx-anchor" id="29" href="basic_props.html#int/1"><tt>basic_props:int/1</tt></a>)Prec is an integer. (<a class="lpdoc-idx-anchor" id="30" href="basic_props.html#int/1"><tt>basic_props:int/1</tt></a>)RightLess is an integer. <li>The following properties should hold upon exit: (<a class="lpdoc-idx-anchor" id="31" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)Op is an atom. (<a class="lpdoc-idx-anchor" id="32" href="basic_props.html#int/1"><tt>basic_props:int/1</tt></a>)LeftLess is an integer. (<a class="lpdoc-idx-anchor" id="33" href="basic_props.html#int/1"><tt>basic_props:int/1</tt></a>)Prec is an integer. (<a class="lpdoc-idx-anchor" id="34" href="basic_props.html#int/1"><tt>basic_props:int/1</tt></a>)RightLess is an integer. <li>The following properties should hold globally: (<a class="lpdoc-idx-anchor" id="35" 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="current_postfixop/3" href="ciaosearch.html#current_postfixop/3">current_postfixop/3</a></div><div class="lpdoc-deftext"><tt>current_postfixop(Op,Less,Precedence)</tt> Similar to <a class="lpdoc-idx-anchor" id="36" href="#current_op/3"><tt>current_op/3</tt></a>, but it concerns only the postfix operators. It returns only one solution. Not a predicate for general use.Usage:<ul class="lpdoc-itemize-minus"><li>Call and exit should be compatible with: (<a class="lpdoc-idx-anchor" id="37" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)Op is an atom. (<a class="lpdoc-idx-anchor" id="38" href="basic_props.html#int/1"><tt>basic_props:int/1</tt></a>)Less is an integer. (<a class="lpdoc-idx-anchor" id="39" href="basic_props.html#int/1"><tt>basic_props:int/1</tt></a>)Precedence is an integer. <li>The following properties should hold upon exit: (<a class="lpdoc-idx-anchor" id="40" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)Op is an atom. (<a class="lpdoc-idx-anchor" id="41" href="basic_props.html#int/1"><tt>basic_props:int/1</tt></a>)Less is an integer. (<a class="lpdoc-idx-anchor" id="42" href="basic_props.html#int/1"><tt>basic_props:int/1</tt></a>)Precedence is an integer. <li>The following properties should hold globally: (<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></div></div> <div><div class="lpdoc-defname">PREDICATE<a class="lpdoc-idx-anchor" id="standard_ops/0" href="ciaosearch.html#standard_ops/0">standard_ops/0</a></div><div class="lpdoc-deftext">No further documentation available for this predicate.</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="44" href="datafacts_rt.html"><tt>datafacts_rt</tt></a>. <li>Packages: <a class="lpdoc-idx-anchor" id="45" href="ciaosearch.html#prelude"><tt>prelude</tt></a>, <a class="lpdoc-idx-anchor" id="46" href="ciaosearch.html#initial"><tt>initial</tt></a>, <a class="lpdoc-idx-anchor" id="47" href="condcomp_doc.html"><tt>condcomp</tt></a>, <a class="lpdoc-idx-anchor" id="48" href="assertions_doc.html"><tt>assertions</tt></a>, <a class="lpdoc-idx-anchor" id="49" href="ciaosearch.html#assertions/assertions_basic"><tt>assertions/assertions_basic</tt></a>, <a class="lpdoc-idx-anchor" id="50" href="isomodes_doc.html"><tt>isomodes</tt></a>, <a class="lpdoc-idx-anchor" id="51" href="datafacts_doc.html"><tt>datafacts</tt></a>. </ul></div></div><div class="lpdoc-footer">Generated with LPdoc using Ciao</div></div><div class="lpdoc-clearer"></div></div></body></html>