File: decf.htm

package info (click to toggle)
nyquist 3.20%2Bds-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 58,008 kB
  • sloc: ansic: 74,743; lisp: 17,929; java: 10,723; cpp: 6,690; sh: 171; xml: 58; makefile: 40; python: 15
file content (88 lines) | stat: -rw-r--r-- 2,268 bytes parent folder | download | duplicates (7)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
<html><head><title>XLISP decf</title>

<link rel="stylesheet" type="text/css" href="reference.css">

</head>

<body>

<a href="../start.htm">Nyquist / XLISP 2.0</a>&nbsp; -&nbsp;
<a href="../manual/contents.htm">Contents</a> |
<a href="../tutorials/tutorials.htm">Tutorials</a> |
<a href="../examples/examples.htm">Examples</a> |
<a href="reference-index.htm">Reference</a>

<hr>

<h1>decf</h1>

<hr>

<p><table cellpadding="0" cellspacing="0" style="margin-left:10px"><tbody>
<tr valign="top">
  <td><nobr>Type:</nobr></td>
  <td><nobr>&nbsp;&nbsp;-&nbsp;&nbsp;</nobr></td>
  <td width="100%"><nobr>Lisp macro (closure)</nobr></td>
</tr>
<tr valign="top">
  <td><nobr>Source:</nobr></td>
  <td><nobr>&nbsp;&nbsp;-&nbsp;&nbsp;</nobr></td>
  <td width="100%"><nobr>misc.lsp</nobr></td>
</tr>
</tbody></table></p>

<h2>Syntax</h2>

<p><div class="box">

<dl>
<dt><nobr>(<b>decf</b> <i>symbol</i>)</nobr></dt>
<dd><i>symbol</i> - a symbol with numerical value bound to it<br>
returns - the new value of the symbol</dd>
</dl>

</div></p>

<p>In Nyquist, 'decf' is implemented as a Lisp macro:</p>

<pre class="example">
(defmacro <font color="#0000CC">decf</font> (symbol)
  `(setf ,symbol (1- ,symbol)))
</pre>

<h2>Description</h2>

<p>The 'decf' macro is used for decrementing a numerical value of a variable.
<nobr>1 is</nobr> substracted to the number and the result is stored in the
variable. <nobr>An error</nobr> is signalled if the variable doesn't hold a
number.</p>

<h2>Examples</h2>

<pre class="example">
(setq n 3)    =&gt; 3
(decf n)      =&gt; 2
n             =&gt; 2
(decf n)      =&gt; 1

(setq n 1.8)  =&gt; 1.8
(decf n)      =&gt; 0.8
(decf n)      =&gt; -0.2
(decf n)      =&gt; -1.2
n             =&gt; -1.2

(setq n #\a)  =&gt; #\a
(decf a)      =&gt; <font color="#AA0000">error: bad argument type - #\a</font>
</pre>

<p><nobr>&nbsp;&nbsp;<a href="#top">Back to Top</nobr></a></p>

<hr>

<a href="../start.htm">Nyquist / XLISP 2.0</a>&nbsp; -&nbsp;
<a href="../manual/contents.htm">Contents</a> |
<a href="../tutorials/tutorials.htm">Tutorials</a> |
<a href="../examples/examples.htm">Examples</a> |
<a href="reference-index.htm">Reference</a>

</body></html>