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
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
|
<html><head><title>XLISP sublis</title>
<link rel="stylesheet" type="text/css" href="reference.css">
</head>
<body>
<a href="../start.htm">Nyquist / XLISP 2.0</a> -
<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>sublis</h1>
<hr>
<p><table cellpadding="0" cellspacing="0" style="margin-left:10px"><tbody>
<tr valign="top">
<td><nobr>Type:</nobr></td>
<td><nobr> - </nobr></td>
<td width="100%"><nobr>function (subr)</nobr></td>
</tr>
<tr valign="top">
<td><nobr>Source:</nobr></td>
<td><nobr> - </nobr></td>
<td width="100%"><nobr>xllist.c</nobr></td>
</tr>
</tbody></table></p>
<h2>Syntax</h2>
<dl>
<dt>(sublis <i>a-list expr</i> [{:test | :test-not} <i>test</i>])</dt>
<dd><i>expr</i> - the expression to substitute within, an atom<br>
<i>a-list</i> - the association list to search<br>
test - optional test function, default is <a href="eql.htm">eql</a><br>
returns - the expression with substitutions</dd>
</dl>
<h2>Description</h2>
<p>The 'sublis' function searches through an 'expr' and replaces each of the
elements in the 'expr' that match the <a href="car.htm">car</a>
of the elements of the association list 'a-list' with the
<a href="cdr.htm">cdr</a> of elements of the 'a-list'. The 'expr'
with the substitutions, if any, is returned. You may specify your own test
with the ':test' and ':test-not' keywords followed by the 'test' you wish to
perform. The 'sublis' function is normally used with a dotted pair <nobr>(A
. B)</nobr> association list. It is possible to use a normal list pair
<nobr>(A B)</nobr> or a list of the form <nobr>(A (B C)).</nobr></p>
<h2>Examples</h2>
<pre class="example">
(sublis '((a . b)) '(a a)) <font color="#008844">; returns (B B)</font>
(sublis '((a b)) '(a a)) <font color="#008844">; returns ((B) (B))</font>
(sublis '((a (b c))) '(a a)) <font color="#008844">; returns (((B C)) ((B C)))</font>
(setq newlist '((a . 1) <font color="#008844">; set up an association list</font>
(b . 2)
(c . 3)))
(sublis newlist '(a b c d e f b a c)) <font color="#008844">; returns (1 2 3 D E F 2 1 3)</font>
(sublis newlist 'a) <font color="#008844">; returns 1</font>
(setq mylist '((a my-a) (b his-b) <font color="#008844">; set up a non-dotted pair assoc list</font>
(c her-c) (d end)))
(sublis mylist '(a b c d e f g)) <font color="#008844">; returns ((MY-A) (HIS-B)</font>
<font color="#008844">; (HER-C) (END) E F G)</font>
(sublis mylist 'a) <font color="#008844">; returns (MY-A)</font>
(setq numlist '((1 . a) (2 . b)) ) <font color="#008844">; set up a new assoc list</font>
(defun mytest (x y) (princ ": ") <font color="#008844">; set up my own test function with 2 parameters</font>
(princ x) <font color="#008844">; to see what SUBLIS does</font>
(princ " ")
(princ y) (terpri)
t) <font color="#008844">; always return T</font>
(sublis numlist '(3 1) :test mytest) <font color="#008844">; prints : (3 1) 1</font>
<font color="#008844">; returns A - because the entire list succeeds</font>
<font color="#008844">; with the test and so (1 . A) produces the</font>
<font color="#008844">; returned value</font>
(sublis numlist '(1) :test-not mytest) <font color="#008844">; prints : (1) 1</font>
<font color="#008844">; : (1) 2</font>
<font color="#008844">; : 1 1</font>
<font color="#008844">; : 1 2</font>
<font color="#008844">; : NIL 1</font>
<font color="#008844">; : NIL 2</font>
<font color="#008844">; returns (1) - because SUBLIS tried to match</font>
<font color="#008844">; every list/sublist against each entry in the</font>
<font color="#008844">; assoc list and failed because of the :TEST-NOT</font>
<font color="#008844">; and so returned the original list unaltered</font>
</pre>
<p><b>Note:</b> The SUBLIS function can work with a list or string as the
'expr'. However, the default <a href="eql.htm">eql</a> test does
not work with lists or strings, only symbols and numbers. To make this work,
you need to use the ':test' keyword along with
<a href="equal.htm">equal</a> for 'test'.</p>
<p><b>Common Lisp:</b> Common LISP supports the use of the ':key' keyword
which specifies a function that is applied to each element of 'a-list'
before it is tested. XLISP does not support this.</p>
<p>See the
<a href="../manual/xlisp-man-016.htm#sublis">sublis</a>
function in the <nobr>XLISP 2.0</nobr> manual.</p>
<p><nobr> <a href="#top">Back to Top</nobr></a></p>
<hr>
<a href="../start.htm">Nyquist / XLISP 2.0</a> -
<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>
|
