This repository has been archived on 2023-08-20. You can view files and clone it, but cannot push or open issues or pull requests.
yap-6.3/Logtalk/manuals/refman/methods/parameter2.html
pmoura 6b4bde14e1 Logtalk 2.30.1 files.
git-svn-id: https://yap.svn.sf.net/svnroot/yap/trunk@1903 b08c6af1-5177-4d33-ba66-4b1c6b8b522a
2007-06-12 10:39:47 +00:00

77 lines
3.0 KiB
HTML

<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="content-type" content="application/xml+xhtml; charset=utf-8" />
<title>Logtalk built-in method: parameter/2</title>
<link rel="stylesheet" href="../../screen.css" type="text/css" media="screen"/>
<link rel="stylesheet" href="../../print.css" type="text/css" media="print"/>
</head>
<body>
<div class="top-left">Logtalk reference manual</div>
<div class="top-right">Built-in method: parameter/2</div>
<div class="bottom-left"><span class="page"/></div>
<div class="bottom-right"><span class="page"/></div>
<div class="navtop"><a href="../../index.html">contents</a> &gt; <a href="../index.html">reference manual</a> &gt; <a href="../index.html#methods">built-in methods</a></div>
<h2 id="methods_parameter2" class="codenp">parameter/2</h2>
<h4>Description</h4>
<pre>parameter(Number, Term)</pre>
<p>
Normally used only in <a class="glossary" title="Go to glossary definition" href="../../glossary.html#parametric">parametric objects</a>, this method returns parameter values by using the parameter position in the object identifier. Note that this predicate implies an unification between its second argument and the corresponding implicit context argument in the predicate containing the call. This unification occurs at the clause head, not at the clause body. See also <a href="this1.html"><code>this/1</code></a>.
</p>
<h4>Template and modes</h4>
<pre>parameter(+integer, ?term)</pre>
<h4>Errors</h4>
<dl>
<dt>Number is a variable:</dt>
<dd><code>instantiation_error</code></dd>
<dt>Number is neither a variable nor an integer value:</dt>
<dd><code>type_error(integer, Number)</code></dd>
<dt>Object identifier is not a compound term:</dt>
<dd><code>type_error(compound, Object)</code></dd>
<dt>Number is a negative integer value:</dt>
<dd><code>domain_error(not_less_than_zero, Number)</code></dd>
</dl>
<h4>Examples</h4>
<pre>:- object(box(_color, _weight)).
...
color(Color) :- % this clause is translated into a fact
parameter(1, Color). % upon compilation
heavy :-
parameter(2, Weight), % after compilation, the &gt;/2 call will be
Weight &gt; 10. % the first condition on the clause body
...</pre>
<div class="footer">
<div class="copyright">
<span>Copyright &copy; <a href="mailto:pmoura@logtalk.org">Paulo Moura</a> &mdash; <a href="http://logtalk.org">Logtalk.org</a></span><br/>
<span>Last updated on: October 26, 2006</span>
</div>
<div class="navbottom">
<span><a href="../index.html#methods">previous</a> | <a href="../../glossary.html">glossary</a> | <a href="self1.html">next</a></span><br/>
<span><a href="http://validator.w3.org/check/referer">XHTML</a> + <a href="http://jigsaw.w3.org/css-validator/check/referer">CSS</a></span>
</div>
</div>
</body>
</html>