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
|
<!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>Variable</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="Variable";
}
}
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};
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/Util.html" title="class in org.jpl7"><span class="typeNameLink">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../index.html?org/jpl7/Variable.html" target="_top">Frames</a></li>
<li><a href="Variable.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 Variable" class="title">Class Variable</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.Variable</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">Variable</span>
extends <a href="../../org/jpl7/Term.html" title="class in org.jpl7">Term</a></pre>
<div class="block">This class supports Java representations of Prolog variables.
<p>
A jpl.Variable instance is equivalent to a variable in a fragment of Prolog
source text: it is *not* a "live" variable within a Prolog stack or heap. A
corresponding Prolog variable is created only upon opening a Query whose goal
refers to a Variable (and then only temporarily).
<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>
</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 int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/jpl7/Variable.html#index">index</a></span></code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/jpl7/Variable.html#name">name</a></span></code>
<div class="block">the name of this Variable (may be changed as of April 2020)</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="../../org/jpl7/fli/term_t.html" title="class in org.jpl7.fli">term_t</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/jpl7/Variable.html#term_">term_</a></span></code>
<div class="block">defined between Query.open() and Query.get2()</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="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../org/jpl7/Variable.html#Variable--">Variable</a></span>()</code>
<div class="block">Create a new don't tell Variable with new sequential name of the form "_261".</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../org/jpl7/Variable.html#Variable-java.lang.String-">Variable</a></span>(java.lang.String name)</code>
<div class="block">Create a new Variable with 'name' (which must not be null or ""), and may
one day be constrained to comply with traditional Prolog syntax.</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/Variable.html#args--">args</a></span>()</code>
<div class="block">The arguments of this Term.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/jpl7/Variable.html#arity--">arity</a></span>()</code>
<div class="block">returns, as an int, the arity of a Term</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/jpl7/Variable.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object o)</code>
<div class="block">A Variable is equal to another if their names are the same
Totally lexical textual interpretation of vars, not related to bindings
Anonymous var _ is always different (including to itsef)</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/jpl7/Variable.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">This can be used to get the **current** solution binding of the Variable instance.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/jpl7/Variable.html#hasFunctor-java.math.BigInteger-int-">hasFunctor</a></span>(java.math.BigInteger value,
int arity)</code>
<div class="block">Tests whether this Term's functor has 'name' and 'arity'</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/Variable.html#hasFunctor-double-int-">hasFunctor</a></span>(double value,
int arity)</code>
<div class="block">Tests whether this Term's functor has 'name' and 'arity'</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/jpl7/Variable.html#hasFunctor-long-int-">hasFunctor</a></span>(long value,
int arity)</code>
<div class="block">Tests whether this Term's functor has 'name' and 'arity'</div>
</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/Variable.html#hasFunctor-java.lang.String-int-">hasFunctor</a></span>(java.lang.String name,
int arity)</code>
<div class="block">Whether this Term's functor has 'name' and 'arity' (c.f.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/jpl7/Variable.html#hashCode--">hashCode</a></span>()</code> </td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/jpl7/Variable.html#name--">name</a></span>()</code>
<div class="block">the lexical name of this Variable</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/jpl7/Variable.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 Variable, we must check whether a (non-anonymous) variable with
the same name has already been put in the Term.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/jpl7/Variable.html#setName-java.lang.String-">setName</a></span>(java.lang.String name)</code> </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/Variable.html#toString--">toString</a></span>()</code>
<div class="block">Returns a Prolog source text representation of this Variable</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/jpl7/Variable.html#type--">type</a></span>()</code>
<div class="block">returns the type of this subclass of Term, i.e.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/jpl7/Variable.html#typeName--">typeName</a></span>()</code>
<div class="block">returns the typeName of this subclass of Term, i.e.</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#arg-int-">arg</a>, <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#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#isJFalse--">isJFalse</a>, <a href="../../org/jpl7/Term.html#isJNull--">isJNull</a>, <a href="../../org/jpl7/Term.html#isJRef--">isJRef</a>, <a href="../../org/jpl7/Term.html#isJTrue--">isJTrue</a>, <a href="../../org/jpl7/Term.html#isJVoid--">isJVoid</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#isListPair--">isListPair</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#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="index">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>index</h4>
<pre>protected transient int index</pre>
</li>
</ul>
<a name="name">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>name</h4>
<pre>public java.lang.String name</pre>
<div class="block">the name of this Variable (may be changed as of April 2020)</div>
</li>
</ul>
<a name="term_">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>term_</h4>
<pre>protected transient <a href="../../org/jpl7/fli/term_t.html" title="class in org.jpl7.fli">term_t</a> term_</pre>
<div class="block">defined between Query.open() and Query.get2()</div>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="Variable--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Variable</h4>
<pre>public Variable()</pre>
<div class="block">Create a new don't tell Variable with new sequential name of the form "_261".</div>
</li>
</ul>
<a name="Variable-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Variable</h4>
<pre>public Variable(java.lang.String name)</pre>
<div class="block">Create a new Variable with 'name' (which must not be null or ""), and may
one day be constrained to comply with traditional Prolog syntax.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - the source name of this Variable</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="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"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../org/jpl7/Term.html#args--">Term</a></code></span></div>
<div class="block">The arguments of this Term.
<p>
Note that a SWI Prolog 7.x compound term can have zero arguments.
<p>
This method returns an empty Term[] from an Atom, Float, Integer or JRef,
approximating the behaviour of SWI Prolog's =../2</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 a Compound</dd>
</dl>
</li>
</ul>
<a name="arity--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>arity</h4>
<pre>public int arity()</pre>
<div class="block">returns, as an int, the arity of a Term</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 of a Term</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">A Variable is equal to another if their names are the same
Totally lexical textual interpretation of vars, not related to bindings
Anonymous var _ is always different (including to itsef)</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.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if the Object is a Variable and the above condition apply.</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">This can be used to get the **current** solution binding of the Variable instance.
So we are calling when the goal is in a solution
This method returns nothing but modifies the argument mappings, by filling
them with the current solution binding of the Variable instance.
If Variable instance is anonymous or a dont-tell-me variable, then do nothing
Otherwise, if the Variable instance is not already in the varnames_to_Terms Map,
put the result of converting the term_t to which this variable has been unified
(in the current solution) to a Term in the Map, keyed on this Variable's name.
In binding the Variable instance to the Term (in the current solution), such Term
may also refer to free variables, whose maps are stores in vars_to_Vars</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 of bindings 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.math.BigInteger-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasFunctor</h4>
<pre>public boolean hasFunctor(java.math.BigInteger value,
int arity)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../org/jpl7/Term.html#hasFunctor-java.math.BigInteger-int-">Term</a></code></span></div>
<div class="block">Tests whether this Term's functor has 'name' and 'arity'
<p>
For Float and Integer, mimics behaviour of SWI Prolog's functor/3</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../org/jpl7/Term.html#hasFunctor-java.math.BigInteger-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>value</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 Term's functor has 'name' and 'arity'</dd>
</dl>
</li>
</ul>
<a name="hasFunctor-java.lang.String-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasFunctor</h4>
<pre>public boolean hasFunctor(java.lang.String name,
int arity)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../org/jpl7/Term.html#hasFunctor-java.lang.String-int-">Term</a></code></span></div>
<div class="block">Whether this Term's functor has 'name' and 'arity' (c.f. behaviour of SWI Prolog's functor/3)</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 Term's functor has 'name' and 'arity'</dd>
</dl>
</li>
</ul>
<a name="hasFunctor-long-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasFunctor</h4>
<pre>public boolean hasFunctor(long value,
int arity)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../org/jpl7/Term.html#hasFunctor-long-int-">Term</a></code></span></div>
<div class="block">Tests whether this Term's functor has 'name' and 'arity'
<p>
For Float and Integer, mimics behaviour of SWI Prolog's functor/3</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../org/jpl7/Term.html#hasFunctor-long-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>value</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 Term's functor has 'name' and 'arity'</dd>
</dl>
</li>
</ul>
<a name="hasFunctor-double-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasFunctor</h4>
<pre>public boolean hasFunctor(double value,
int arity)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../org/jpl7/Term.html#hasFunctor-double-int-">Term</a></code></span></div>
<div class="block">Tests whether this Term's functor has 'name' and 'arity'
<p>
For Float and Integer, mimics behaviour of SWI Prolog's functor/3</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../org/jpl7/Term.html#hasFunctor-double-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>value</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 Term's functor has 'name' and 'arity'</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 lexical name of this Variable</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 lexical name of this Variable</dd>
</dl>
</li>
</ul>
<a name="setName-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setName</h4>
<pre>public void setName(java.lang.String name)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../org/jpl7/Term.html#setName-java.lang.String-">setName</a></code> in class <code><a href="../../org/jpl7/Term.html" title="class in org.jpl7">Term</a></code></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 final 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 Variable, we must check whether a (non-anonymous) variable with
the same name has already been put in the Term. If one has, then the
corresponding Prolog variable has been stashed in the varnames_to_vars
Map, keyed by the Variable name, so we can look it up and reuse it (this
way, the sharing of variables in the Prolog term reflects the sharing of
Variable names in the Term. Otherwise, if this Variable name has not
already been seen in the Term, then we put a new Prolog variable and add
it into the Map (keyed by this Variable name).</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 (new or
reused) Prolog variable.</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">Returns a Prolog source text representation of this Variable</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>a Prolog source text representation of this Variable</dd>
</dl>
</li>
</ul>
<a name="type--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>type</h4>
<pre>public final int type()</pre>
<div class="block">returns the type of this subclass of Term, i.e. Prolog.VARIABLE</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 subclass of Term, i.e. Prolog.VARIABLE</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">returns the typeName of this subclass of Term, i.e. "Variable"</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 typeName of this subclass of Term, i.e. "Variable"</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/Util.html" title="class in org.jpl7"><span class="typeNameLink">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../index.html?org/jpl7/Variable.html" target="_top">Frames</a></li>
<li><a href="Variable.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>
|
