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
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_201) on Tue Jun 16 07:41:33 AEST 2020 -->
<title>Compound</title>
<meta name="date" content="2020-06-16">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Compound";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-all.html">Index</a></li>
<li><a href="../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../org/jpl7/Atom.html" title="class in org.jpl7"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../org/jpl7/Dict.html" title="class in org.jpl7"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?org/jpl7/Compound.html" target="_top">Frames</a></li>
<li><a href="Compound.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li><a href="#field.summary">Field</a> | </li>
<li><a href="#constructor.summary">Constr</a> | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field.detail">Field</a> | </li>
<li><a href="#constructor.detail">Constr</a> | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.jpl7</div>
<h2 title="Class Compound" class="title">Class Compound</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../org/jpl7/Term.html" title="class in org.jpl7">org.jpl7.Term</a></li>
<li>
<ul class="inheritance">
<li>org.jpl7.Compound</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">Compound</span>
extends <a href="../../org/jpl7/Term.html" title="class in org.jpl7">Term</a></pre>
<div class="block">A Compound represents a structured term, comprising a functor and one or more arguments (Terms). Direct instances of
Compound must have one or more arguments (it is an error to attempt to construct a Compound with zero args; a
JPLException will be thrown). For example, this Java expression yields a representation of the term f(a):
<pre>
new Compound("f", new Term[] { new Atom("a") })
</pre>
Note the use of the "anonymous array" notation to denote the arguments (an anonymous array of Term). <br>
Alternatively, construct the Term from Prolog source syntax:
<pre>
Term.textToTerm("f(a)")
</pre>
The <i>arity</i> of a Compound is the quantity of its arguments. Once constructed, neither the name nor the arity of
a Compound can be altered. An argument of a Compound can be replaced with the setArg() method.
<hr>
Copyright (C) 2004 Paul Singleton
<p>
Copyright (C) 1998 Fred Dushin
<p>
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
following conditions are met:
<ol>
<li>Redistributions of source code must retain the above copyright notice, this list of conditions and the following
disclaimer.
<li>Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
following disclaimer in the documentation and/or other materials provided with the distribution.
</ol>
<p>
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
<hr></div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../org/jpl7/Term.html" title="class in org.jpl7"><code>Term</code></a>,
<a href="../../org/jpl7/Atom.html" title="class in org.jpl7"><code>Atom</code></a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="../../org/jpl7/Term.html" title="class in org.jpl7">Term</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/jpl7/Compound.html#args">args</a></span></code>
<div class="block">The (zero or more) arguments of this Compound.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/jpl7/Compound.html#name">name</a></span></code>
<div class="block">The name of (the functor of) this Compound.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier</th>
<th class="colLast" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code> </code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/jpl7/Compound.html#Compound-java.lang.String-">Compound</a></span>(java.lang.String name)</code>
<div class="block">Creates a Compound with name and no args (which in SWI Prolog V7 is distinct from a text atom of the same name).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected </code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/jpl7/Compound.html#Compound-java.lang.String-int-">Compound</a></span>(java.lang.String name,
int arity)</code>
<div class="block">Creates a Compound with name and arity.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code> </code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/jpl7/Compound.html#Compound-java.lang.String-org.jpl7.Term:A-">Compound</a></span>(java.lang.String name,
<a href="../../org/jpl7/Term.html" title="class in org.jpl7">Term</a>[] args)</code>
<div class="block">Creates a Compound with name and (zero or more) args.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../../org/jpl7/Term.html" title="class in org.jpl7">Term</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/jpl7/Compound.html#arg-int-">arg</a></span>(int i)</code>
<div class="block">Returns the ith argument (counting from 1) of this Compound.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../org/jpl7/Term.html" title="class in org.jpl7">Term</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/jpl7/Compound.html#args--">args</a></span>()</code>
<div class="block">Returns the arguments of this Compound as a Term[0..arity-1] array.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/jpl7/Compound.html#arity--">arity</a></span>()</code>
<div class="block">Returns the arity (0+) of this Compound.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/jpl7/Compound.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object o)</code>
<div class="block">Two Compounds are equal if they are identical (same object) or their names and arities are equal and their
respective arguments are equal.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/jpl7/Compound.html#getSubst-java.util.Map-java.util.Map-">getSubst</a></span>(java.util.Map<java.lang.String,<a href="../../org/jpl7/Term.html" title="class in org.jpl7">Term</a>> varnames_to_Terms,
java.util.Map<<a href="../../org/jpl7/fli/term_t.html" title="class in org.jpl7.fli">term_t</a>,<a href="../../org/jpl7/Variable.html" title="class in org.jpl7">Variable</a>> vars_to_Vars)</code>
<div class="block">Nothing needs to be done except to pass the buck to this Compound's args.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/jpl7/Compound.html#hasFunctor-java.lang.String-int-">hasFunctor</a></span>(java.lang.String name,
int arity)</code>
<div class="block">Tests whether this Compound's functor has (String) 'name' and 'arity'.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/jpl7/Compound.html#hashCode--">hashCode</a></span>()</code> </td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/jpl7/Compound.html#isJFalse--">isJFalse</a></span>()</code>
<div class="block">whether this Term is a 'jboolean' structure denoting Java's false, i.e.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/jpl7/Compound.html#isJNull--">isJNull</a></span>()</code>
<div class="block">whether this Term is a 'jnull' structure, i.e.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/jpl7/Compound.html#isJTrue--">isJTrue</a></span>()</code>
<div class="block">whether this Term is a 'jboolean' structure denoting Java's true, i.e.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/jpl7/Compound.html#isJVoid--">isJVoid</a></span>()</code>
<div class="block">whether this Term is a 'jvoid' structure, i.e.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/jpl7/Compound.html#isListPair--">isListPair</a></span>()</code>
<div class="block">whether this Term denotes (syntax-specifically) a list cell
see this does not check the shape of the second argument to check if it is a list
So a list pair may not be a list itself and hence isList() will return false
as the second argument many not be a list</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/jpl7/Compound.html#name--">name</a></span>()</code>
<div class="block">the name (unquoted) of this Compound</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/jpl7/Compound.html#put-java.util.Map-org.jpl7.fli.term_t-">put</a></span>(java.util.Map<java.lang.String,<a href="../../org/jpl7/fli/term_t.html" title="class in org.jpl7.fli">term_t</a>> varnames_to_vars,
<a href="../../org/jpl7/fli/term_t.html" title="class in org.jpl7.fli">term_t</a> term)</code>
<div class="block">To put a Compound in a term, we create a sequence of term_t references from the Term.terms_to_term_ts() method,
and then use the Prolog.cons_functor_v() method to create a Prolog compound term.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/jpl7/Compound.html#setArg-int-org.jpl7.Term-">setArg</a></span>(int i,
<a href="../../org/jpl7/Term.html" title="class in org.jpl7">Term</a> arg)</code>
<div class="block">Sets the i-th (from 1) arg of this Compound to the given Term instance.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/jpl7/Compound.html#toString--">toString</a></span>()</code>
<div class="block">a prefix functional representation of a Compound of the form name(arg1,...),
where 'name' is quoted iff necessary
(to be valid Prolog source text) and each argument is represented according to its
toString() method.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/jpl7/Compound.html#type--">type</a></span>()</code>
<div class="block">the type of this term, as jpl.fli.Prolog.COMPOUND</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/jpl7/Compound.html#typeName--">typeName</a></span>()</code>
<div class="block">the name of the type of this term, as "Compound"</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.jpl7.Term">
<!-- -->
</a>
<h3>Methods inherited from class org.jpl7.<a href="../../org/jpl7/Term.html" title="class in org.jpl7">Term</a></h3>
<code><a href="../../org/jpl7/Term.html#atomListToStringArray-org.jpl7.Term-">atomListToStringArray</a>, <a href="../../org/jpl7/Term.html#atomType--">atomType</a>, <a href="../../org/jpl7/Term.html#bigValue--">bigValue</a>, <a href="../../org/jpl7/Term.html#doubleValue--">doubleValue</a>, <a href="../../org/jpl7/Term.html#floatValue--">floatValue</a>, <a href="../../org/jpl7/Term.html#getSubsts-java.util.Map-java.util.Map-org.jpl7.Term:A-">getSubsts</a>, <a href="../../org/jpl7/Term.html#getTerm-java.util.Map-org.jpl7.fli.term_t-">getTerm</a>, <a href="../../org/jpl7/Term.html#getTerm-org.jpl7.fli.term_t-">getTerm</a>, <a href="../../org/jpl7/Term.html#hasFunctor-java.math.BigInteger-int-">hasFunctor</a>, <a href="../../org/jpl7/Term.html#hasFunctor-double-int-">hasFunctor</a>, <a href="../../org/jpl7/Term.html#hasFunctor-long-int-">hasFunctor</a>, <a href="../../org/jpl7/Term.html#intArrayArrayToList-int:A:A-">intArrayArrayToList</a>, <a href="../../org/jpl7/Term.html#intArrayToList-int:A-">intArrayToList</a>, <a href="../../org/jpl7/Term.html#intValue--">intValue</a>, <a href="../../org/jpl7/Term.html#isAtom--">isAtom</a>, <a href="../../org/jpl7/Term.html#isAtomOfNameType-java.lang.String-java.lang.String-">isAtomOfNameType</a>, <a href="../../org/jpl7/Term.html#isBig--">isBig</a>, <a href="../../org/jpl7/Term.html#isBigInteger--">isBigInteger</a>, <a href="../../org/jpl7/Term.html#isCompound--">isCompound</a>, <a href="../../org/jpl7/Term.html#isFloat--">isFloat</a>, <a href="../../org/jpl7/Term.html#isInteger--">isInteger</a>, <a href="../../org/jpl7/Term.html#isJRef--">isJRef</a>, <a href="../../org/jpl7/Term.html#isList--">isList</a>, <a href="../../org/jpl7/Term.html#isList-org.jpl7.Term-">isList</a>, <a href="../../org/jpl7/Term.html#isListNil--">isListNil</a>, <a href="../../org/jpl7/Term.html#isVariable--">isVariable</a>, <a href="../../org/jpl7/Term.html#jrefToObject--">jrefToObject</a>, <a href="../../org/jpl7/Term.html#listLength--">listLength</a>, <a href="../../org/jpl7/Term.html#listLength-org.jpl7.Term-">listLength</a>, <a href="../../org/jpl7/Term.html#listToTermArray--">listToTermArray</a>, <a href="../../org/jpl7/Term.html#listToTermArray-org.jpl7.Term-">listToTermArray</a>, <a href="../../org/jpl7/Term.html#longValue--">longValue</a>, <a href="../../org/jpl7/Term.html#object--">object</a>, <a href="../../org/jpl7/Term.html#objectToJRef-java.lang.Object-">objectToJRef</a>, <a href="../../org/jpl7/Term.html#put-org.jpl7.fli.term_t-">put</a>, <a href="../../org/jpl7/Term.html#putParams-org.jpl7.Term-">putParams</a>, <a href="../../org/jpl7/Term.html#putParams-org.jpl7.Term:A-">putParams</a>, <a href="../../org/jpl7/Term.html#putParams1-org.jpl7.fli.IntHolder-org.jpl7.Term:A-">putParams1</a>, <a href="../../org/jpl7/Term.html#putParams2-org.jpl7.Term:A-org.jpl7.fli.IntHolder-org.jpl7.Term:A-">putParams2</a>, <a href="../../org/jpl7/Term.html#putTerm-java.lang.Object-org.jpl7.fli.term_t-">putTerm</a>, <a href="../../org/jpl7/Term.html#putTerms-java.util.Map-org.jpl7.Term:A-">putTerms</a>, <a href="../../org/jpl7/Term.html#ref--">ref</a>, <a href="../../org/jpl7/Term.html#setName-java.lang.String-">setName</a>, <a href="../../org/jpl7/Term.html#stringArrayToList-java.lang.String:A-">stringArrayToList</a>, <a href="../../org/jpl7/Term.html#termArrayToList-org.jpl7.Term:A-">termArrayToList</a>, <a href="../../org/jpl7/Term.html#textParamsToTerm-java.lang.String-org.jpl7.Term:A-">textParamsToTerm</a>, <a href="../../org/jpl7/Term.html#textToTerm-java.lang.String-">textToTerm</a>, <a href="../../org/jpl7/Term.html#toString-org.jpl7.Term:A-">toString</a>, <a href="../../org/jpl7/Term.html#toTermArray--">toTermArray</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.Object</h3>
<code>clone, finalize, getClass, notify, notifyAll, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="args">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>args</h4>
<pre>protected final <a href="../../org/jpl7/Term.html" title="class in org.jpl7">Term</a>[] args</pre>
<div class="block">The (zero or more) arguments of this Compound.</div>
</li>
</ul>
<a name="name">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>name</h4>
<pre>protected final java.lang.String name</pre>
<div class="block">The name of (the functor of) this Compound.</div>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="Compound-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Compound</h4>
<pre>public Compound(java.lang.String name)</pre>
<div class="block">Creates a Compound with name and no args (which in SWI Prolog V7 is distinct from a text atom of the same name).</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - the name of this Compound</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../org/jpl7/JPLException.html" title="class in org.jpl7">JPLException</a></code> - if name is null</dd>
</dl>
</li>
</ul>
<a name="Compound-java.lang.String-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Compound</h4>
<pre>protected Compound(java.lang.String name,
int arity)</pre>
<div class="block">Creates a Compound with name and arity. This constructor, along with the setArg method, serves the new, native
Prolog-term-to-Java-term routine, and is public only so as to be accessible via JNI: it is not intended for
general use.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - the name of this Compound</dd>
<dd><code>arity</code> - the arity of this Compound</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../org/jpl7/JPLException.html" title="class in org.jpl7">JPLException</a></code> - if name is null or arity is negative</dd>
</dl>
</li>
</ul>
<a name="Compound-java.lang.String-org.jpl7.Term:A-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Compound</h4>
<pre>public Compound(java.lang.String name,
<a href="../../org/jpl7/Term.html" title="class in org.jpl7">Term</a>[] args)</pre>
<div class="block">Creates a Compound with name and (zero or more) args.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - the name of this Compound</dd>
<dd><code>args</code> - the (zero or more) arguments of this Compound</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../org/jpl7/JPLException.html" title="class in org.jpl7">JPLException</a></code> - if name is null or args is null</dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="arg-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>arg</h4>
<pre>public final <a href="../../org/jpl7/Term.html" title="class in org.jpl7">Term</a> arg(int i)</pre>
<div class="block">Returns the ith argument (counting from 1) of this Compound.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../org/jpl7/Term.html#arg-int-">arg</a></code> in class <code><a href="../../org/jpl7/Term.html" title="class in org.jpl7">Term</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>i</code> - the ordinal number of the required arg (1 denotes the first arg etc.)</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the ith argument (counting from 1) of this Compound</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.ArrayIndexOutOfBoundsException</code> - if i is inappropriate</dd>
</dl>
</li>
</ul>
<a name="args--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>args</h4>
<pre>public final <a href="../../org/jpl7/Term.html" title="class in org.jpl7">Term</a>[] args()</pre>
<div class="block">Returns the arguments of this Compound as a Term[0..arity-1] array.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../org/jpl7/Term.html#args--">args</a></code> in class <code><a href="../../org/jpl7/Term.html" title="class in org.jpl7">Term</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the arguments of this Compound as a Term[0..arity-1] array.</dd>
</dl>
</li>
</ul>
<a name="arity--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>arity</h4>
<pre>public final int arity()</pre>
<div class="block">Returns the arity (0+) of this Compound.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../org/jpl7/Term.html#arity--">arity</a></code> in class <code><a href="../../org/jpl7/Term.html" title="class in org.jpl7">Term</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the arity (0+) of this Compound</dd>
</dl>
</li>
</ul>
<a name="equals-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>equals</h4>
<pre>public boolean equals(java.lang.Object o)</pre>
<div class="block">Two Compounds are equal if they are identical (same object) or their names and arities are equal and their
respective arguments are equal.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>equals</code> in class <code>java.lang.Object</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>o</code> - the Object to compare (not necessarily another Compound)</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if the Object satisfies the above condition</dd>
</dl>
</li>
</ul>
<a name="hashCode--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hashCode</h4>
<pre>public int hashCode()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>hashCode</code> in class <code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
<a name="getSubst-java.util.Map-java.util.Map-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSubst</h4>
<pre>protected final void getSubst(java.util.Map<java.lang.String,<a href="../../org/jpl7/Term.html" title="class in org.jpl7">Term</a>> varnames_to_Terms,
java.util.Map<<a href="../../org/jpl7/fli/term_t.html" title="class in org.jpl7.fli">term_t</a>,<a href="../../org/jpl7/Variable.html" title="class in org.jpl7">Variable</a>> vars_to_Vars)</pre>
<div class="block">Nothing needs to be done except to pass the buck to this Compound's args.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../org/jpl7/Term.html#getSubst-java.util.Map-java.util.Map-">getSubst</a></code> in class <code><a href="../../org/jpl7/Term.html" title="class in org.jpl7">Term</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>varnames_to_Terms</code> - A Map from variable names to JPL Terms</dd>
<dd><code>vars_to_Vars</code> - A Map from Prolog variables to JPL Variables</dd>
</dl>
</li>
</ul>
<a name="hasFunctor-java.lang.String-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasFunctor</h4>
<pre>public final boolean hasFunctor(java.lang.String name,
int arity)</pre>
<div class="block">Tests whether this Compound's functor has (String) 'name' and 'arity'.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../org/jpl7/Term.html#hasFunctor-java.lang.String-int-">hasFunctor</a></code> in class <code><a href="../../org/jpl7/Term.html" title="class in org.jpl7">Term</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - a possible name for the functor of a term</dd>
<dd><code>arity</code> - an arity 0+</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether this Compound's functor has (String) 'name' and 'arity'</dd>
</dl>
</li>
</ul>
<a name="isJFalse--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isJFalse</h4>
<pre>public boolean isJFalse()</pre>
<div class="block">whether this Term is a 'jboolean' structure denoting Java's false, i.e. @(false)</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../org/jpl7/Term.html#isJFalse--">isJFalse</a></code> in class <code><a href="../../org/jpl7/Term.html" title="class in org.jpl7">Term</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether this Term is a 'jboolean' structure denoting Java's false, i.e. @(false)</dd>
</dl>
</li>
</ul>
<a name="isJNull--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isJNull</h4>
<pre>public boolean isJNull()</pre>
<div class="block">whether this Term is a 'jnull' structure, i.e. @(null)</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../org/jpl7/Term.html#isJNull--">isJNull</a></code> in class <code><a href="../../org/jpl7/Term.html" title="class in org.jpl7">Term</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether this Term is a 'jnull' structure, i.e. @(null)</dd>
</dl>
</li>
</ul>
<a name="isJTrue--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isJTrue</h4>
<pre>public boolean isJTrue()</pre>
<div class="block">whether this Term is a 'jboolean' structure denoting Java's true, i.e. @(true)</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../org/jpl7/Term.html#isJTrue--">isJTrue</a></code> in class <code><a href="../../org/jpl7/Term.html" title="class in org.jpl7">Term</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether this Term is a 'jboolean' structure denoting Java's true, i.e. @(true)</dd>
</dl>
</li>
</ul>
<a name="isJVoid--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isJVoid</h4>
<pre>public boolean isJVoid()</pre>
<div class="block">whether this Term is a 'jvoid' structure, i.e. @(void)</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../org/jpl7/Term.html#isJVoid--">isJVoid</a></code> in class <code><a href="../../org/jpl7/Term.html" title="class in org.jpl7">Term</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether this Term is a 'jvoid' structure, i.e. @(void)</dd>
</dl>
</li>
</ul>
<a name="isListPair--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isListPair</h4>
<pre>public final boolean isListPair()</pre>
<div class="block">whether this Term denotes (syntax-specifically) a list cell
see this does not check the shape of the second argument to check if it is a list
So a list pair may not be a list itself and hence isList() will return false
as the second argument many not be a list</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../org/jpl7/Term.html#isListPair--">isListPair</a></code> in class <code><a href="../../org/jpl7/Term.html" title="class in org.jpl7">Term</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether this Term denotes (syntax-specifically) a list cell</dd>
</dl>
</li>
</ul>
<a name="name--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>name</h4>
<pre>public final java.lang.String name()</pre>
<div class="block">the name (unquoted) of this Compound</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../org/jpl7/Term.html#name--">name</a></code> in class <code><a href="../../org/jpl7/Term.html" title="class in org.jpl7">Term</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the name (unquoted) of this Compound</dd>
</dl>
</li>
</ul>
<a name="put-java.util.Map-org.jpl7.fli.term_t-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>put</h4>
<pre>protected void put(java.util.Map<java.lang.String,<a href="../../org/jpl7/fli/term_t.html" title="class in org.jpl7.fli">term_t</a>> varnames_to_vars,
<a href="../../org/jpl7/fli/term_t.html" title="class in org.jpl7.fli">term_t</a> term)</pre>
<div class="block">To put a Compound in a term, we create a sequence of term_t references from the Term.terms_to_term_ts() method,
and then use the Prolog.cons_functor_v() method to create a Prolog compound term.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../org/jpl7/Term.html#put-java.util.Map-org.jpl7.fli.term_t-">put</a></code> in class <code><a href="../../org/jpl7/Term.html" title="class in org.jpl7">Term</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>varnames_to_vars</code> - A Map from variable names to Prolog variables</dd>
<dd><code>term</code> - A (previously created) term_t which is to be set to a Prolog term corresponding to the Term subtype
(Atom, Variable, Compound, etc.) on which the method is invoked.</dd>
</dl>
</li>
</ul>
<a name="setArg-int-org.jpl7.Term-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setArg</h4>
<pre>public void setArg(int i,
<a href="../../org/jpl7/Term.html" title="class in org.jpl7">Term</a> arg)</pre>
<div class="block">Sets the i-th (from 1) arg of this Compound to the given Term instance. This method, along with the
Compound(name,arity) constructor, serves the new, native Prolog-term-to-Java-term routine, and is public only so
as to be accessible via JNI: it is not intended for general use.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>i</code> - the index (1+) of the arg to be set</dd>
<dd><code>arg</code> - the Term which is to become the i-th (from 1) arg of this Compound</dd>
</dl>
</li>
</ul>
<a name="toString--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toString</h4>
<pre>public java.lang.String toString()</pre>
<div class="block">a prefix functional representation of a Compound of the form name(arg1,...),
where 'name' is quoted iff necessary
(to be valid Prolog source text) and each argument is represented according to its
toString() method.
Lists are represented depending on JPL.LIST_TOSTRING_TEXTUAL</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>toString</code> in class <code>java.lang.Object</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>string representation of an Compound</dd>
</dl>
</li>
</ul>
<a name="type--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>type</h4>
<pre>public int type()</pre>
<div class="block">the type of this term, as jpl.fli.Prolog.COMPOUND</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../org/jpl7/Term.html#type--">type</a></code> in class <code><a href="../../org/jpl7/Term.html" title="class in org.jpl7">Term</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the type of this term, as jpl.fli.Prolog.COMPOUND</dd>
</dl>
</li>
</ul>
<a name="typeName--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>typeName</h4>
<pre>public java.lang.String typeName()</pre>
<div class="block">the name of the type of this term, as "Compound"</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../org/jpl7/Term.html#typeName--">typeName</a></code> in class <code><a href="../../org/jpl7/Term.html" title="class in org.jpl7">Term</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the name of the type of this term, as "Compound"</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-all.html">Index</a></li>
<li><a href="../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../org/jpl7/Atom.html" title="class in org.jpl7"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../org/jpl7/Dict.html" title="class in org.jpl7"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?org/jpl7/Compound.html" target="_top">Frames</a></li>
<li><a href="Compound.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li><a href="#field.summary">Field</a> | </li>
<li><a href="#constructor.summary">Constr</a> | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field.detail">Field</a> | </li>
<li><a href="#constructor.detail">Constr</a> | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
|
