aboutsummaryrefslogtreecommitdiffstats
path: root/doc/jcgp/backend/modules/problem/TestCaseProblem.html
blob: 584533afac7b2b8714a8ee68a45e0cb38861f6c2 (plain)
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
<!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_05) on Thu May 22 06:02:33 BST 2014 -->
<title>TestCaseProblem</title>
<meta name="date" content="2014-05-22">
<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="TestCaseProblem";
        }
    }
    catch(err) {
    }
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":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="class-use/TestCaseProblem.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../jcgp/backend/modules/problem/SymbolicRegressionProblem.html" title="class in jcgp.backend.modules.problem"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../jcgp/backend/modules/problem/TestCaseProblem.TestCase.html" title="class in jcgp.backend.modules.problem"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?jcgp/backend/modules/problem/TestCaseProblem.html" target="_top">Frames</a></li>
<li><a href="TestCaseProblem.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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">jcgp.backend.modules.problem</div>
<h2 title="Class TestCaseProblem" class="title">Class TestCaseProblem&lt;T&gt;</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../../jcgp/backend/modules/Module.html" title="class in jcgp.backend.modules">jcgp.backend.modules.Module</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../jcgp/backend/modules/problem/Problem.html" title="class in jcgp.backend.modules.problem">jcgp.backend.modules.problem.Problem</a></li>
<li>
<ul class="inheritance">
<li>jcgp.backend.modules.problem.TestCaseProblem&lt;T&gt;</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>T</code> - the data type to be used by the TestCaseProblem.</dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../jcgp/backend/modules/problem/DigitalCircuitProblem.html" title="class in jcgp.backend.modules.problem">DigitalCircuitProblem</a>, <a href="../../../../jcgp/backend/modules/problem/SymbolicRegressionProblem.html" title="class in jcgp.backend.modules.problem">SymbolicRegressionProblem</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="typeNameLabel">TestCaseProblem&lt;T&gt;</span>
extends <a href="../../../../jcgp/backend/modules/problem/Problem.html" title="class in jcgp.backend.modules.problem">Problem</a></pre>
<div class="block">Abstract model for a problem that uses test cases. A test case
 problem is any problem that compares the chromosome output to
 an expected output taken from a table of input-output mappings.
 <br><br>
 This class defines a basic data type for storing test cases, 
 TestCase, and provides core functionality to add and manipulate
 test cases in the problem. A subclass of <code>TestCaseProblem</code>
 must simply override <code>parseTestCase()</code> to convert parsed
 problem data strings into the required data type (T).</div>
<dl>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Eduardo Pedroni</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../jcgp/backend/modules/problem/Problem.html" title="class in jcgp.backend.modules.problem"><code>Problem</code></a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!--   -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Class and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jcgp/backend/modules/problem/TestCaseProblem.TestCase.html" title="class in jcgp.backend.modules.problem">TestCaseProblem.TestCase</a>&lt;<a href="../../../../jcgp/backend/modules/problem/TestCaseProblem.TestCase.html" title="type parameter in TestCaseProblem.TestCase">U</a>&gt;</span></code>
<div class="block">Basic data type for encapsulating test cases, it simply
 contains arrays of inputs and outputs and associated getters.</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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</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>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jcgp/backend/modules/problem/TestCaseProblem.html#addTestCase-java.lang.String:A-java.lang.String:A-">addTestCase</a></span>(java.lang.String[]&nbsp;inputs,
           java.lang.String[]&nbsp;outputs)</code>
<div class="block">Adds test cases to the problem instance as they get parsed from a 
 problem data file.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jcgp/backend/modules/problem/TestCaseProblem.html#clearTestCases--">clearTestCases</a></span>()</code>
<div class="block">Remove all test cases.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>javafx.collections.ObservableList&lt;<a href="../../../../jcgp/backend/modules/problem/TestCaseProblem.TestCase.html" title="class in jcgp.backend.modules.problem">TestCaseProblem.TestCase</a>&lt;<a href="../../../../jcgp/backend/modules/problem/TestCaseProblem.html" title="type parameter in TestCaseProblem">T</a>&gt;&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jcgp/backend/modules/problem/TestCaseProblem.html#getTestCases--">getTestCases</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jcgp/backend/modules/problem/TestCaseProblem.html#hasImprovement-jcgp.backend.population.Population-">hasImprovement</a></span>(<a href="../../../../jcgp/backend/population/Population.html" title="class in jcgp.backend.population">Population</a>&nbsp;population)</code>
<div class="block">Used to assert whether a given population has a chromosome that is an improvement over 
 the current best chromosome.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jcgp/backend/modules/problem/TestCaseProblem.html#parseProblemData-java.io.File-jcgp.backend.resources.ModifiableResources-">parseProblemData</a></span>(java.io.File&nbsp;file,
                <a href="../../../../jcgp/backend/resources/ModifiableResources.html" title="class in jcgp.backend.resources">ModifiableResources</a>&nbsp;resources)</code>
<div class="block">Parses the specified file and uses the parsed data to
 set up the problem type instance appropriately.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.jcgp.backend.modules.problem.Problem">
<!--   -->
</a>
<h3>Methods inherited from class&nbsp;jcgp.backend.modules.problem.<a href="../../../../jcgp/backend/modules/problem/Problem.html" title="class in jcgp.backend.modules.problem">Problem</a></h3>
<code><a href="../../../../jcgp/backend/modules/problem/Problem.html#evaluate-jcgp.backend.population.Population-">evaluate</a>, <a href="../../../../jcgp/backend/modules/problem/Problem.html#getBestFitness--">getBestFitness</a>, <a href="../../../../jcgp/backend/modules/problem/Problem.html#getFileExtension--">getFileExtension</a>, <a href="../../../../jcgp/backend/modules/problem/Problem.html#getFitnessOrientation--">getFitnessOrientation</a>, <a href="../../../../jcgp/backend/modules/problem/Problem.html#getFunctionSet--">getFunctionSet</a>, <a href="../../../../jcgp/backend/modules/problem/Problem.html#hasPerfectSolution-jcgp.backend.population.Population-">hasPerfectSolution</a>, <a href="../../../../jcgp/backend/modules/problem/Problem.html#reset--">reset</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.jcgp.backend.modules.Module">
<!--   -->
</a>
<h3>Methods inherited from class&nbsp;jcgp.backend.modules.<a href="../../../../jcgp/backend/modules/Module.html" title="class in jcgp.backend.modules">Module</a></h3>
<code><a href="../../../../jcgp/backend/modules/Module.html#getLocalParameters--">getLocalParameters</a>, <a href="../../../../jcgp/backend/modules/Module.html#toString--">toString</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&nbsp;java.lang.Object</h3>
<code>equals, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!--   -->
</a>
<h3>Method Detail</h3>
<a name="getTestCases--">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTestCases</h4>
<pre>public&nbsp;javafx.collections.ObservableList&lt;<a href="../../../../jcgp/backend/modules/problem/TestCaseProblem.TestCase.html" title="class in jcgp.backend.modules.problem">TestCaseProblem.TestCase</a>&lt;<a href="../../../../jcgp/backend/modules/problem/TestCaseProblem.html" title="type parameter in TestCaseProblem">T</a>&gt;&gt;&nbsp;getTestCases()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a list containing the test cases.</dd>
</dl>
</li>
</ul>
<a name="addTestCase-java.lang.String:A-java.lang.String:A-">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addTestCase</h4>
<pre>public final&nbsp;void&nbsp;addTestCase(java.lang.String[]&nbsp;inputs,
                              java.lang.String[]&nbsp;outputs)</pre>
<div class="block">Adds test cases to the problem instance as they get parsed from a 
 problem data file. This template method uses <code>parseTestCase</code>, which
 must be implemented by subclasses.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>inputs</code> - the inputs represented as strings.</dd>
<dd><code>outputs</code> - the outputs represented as strings.</dd>
</dl>
</li>
</ul>
<a name="clearTestCases--">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clearTestCases</h4>
<pre>public&nbsp;void&nbsp;clearTestCases()</pre>
<div class="block">Remove all test cases.</div>
</li>
</ul>
<a name="parseProblemData-java.io.File-jcgp.backend.resources.ModifiableResources-">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>parseProblemData</h4>
<pre>public&nbsp;void&nbsp;parseProblemData(java.io.File&nbsp;file,
                             <a href="../../../../jcgp/backend/resources/ModifiableResources.html" title="class in jcgp.backend.resources">ModifiableResources</a>&nbsp;resources)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../jcgp/backend/modules/problem/Problem.html#parseProblemData-java.io.File-jcgp.backend.resources.ModifiableResources-">Problem</a></code></span></div>
<div class="block">Parses the specified file and uses the parsed data to
 set up the problem type instance appropriately. Any necessary
 resource changes can be performed using the provided <code>ModifiableResources</code>
 instance.
 <br><br>
 In addition, realisations of this method should update the value of
 maxFitness where appropriate, as this may be displayed to the user
 if a GUI is in use.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../jcgp/backend/modules/problem/Problem.html#parseProblemData-java.io.File-jcgp.backend.resources.ModifiableResources-">parseProblemData</a></code>&nbsp;in class&nbsp;<code><a href="../../../../jcgp/backend/modules/problem/Problem.html" title="class in jcgp.backend.modules.problem">Problem</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>file</code> - the data file to parse.</dd>
<dd><code>resources</code> - a modifiable reference to the experiment's resources.</dd>
</dl>
</li>
</ul>
<a name="hasImprovement-jcgp.backend.population.Population-">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>hasImprovement</h4>
<pre>public&nbsp;int&nbsp;hasImprovement(<a href="../../../../jcgp/backend/population/Population.html" title="class in jcgp.backend.population">Population</a>&nbsp;population)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../jcgp/backend/modules/problem/Problem.html#hasImprovement-jcgp.backend.population.Population-">Problem</a></code></span></div>
<div class="block">Used to assert whether a given population has a chromosome that is an improvement over 
 the current best chromosome. A typical implementation of this method
 will simply compare chromosome fitness values, though the problem type
 is free to implement this in any way.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../jcgp/backend/modules/problem/Problem.html#hasImprovement-jcgp.backend.population.Population-">hasImprovement</a></code>&nbsp;in class&nbsp;<code><a href="../../../../jcgp/backend/modules/problem/Problem.html" title="class in jcgp.backend.modules.problem">Problem</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>population</code> - the population potentially containing a fitter chromosome.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the index of the first chromosome in the population that is an improvement, -1 if none is found.</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="class-use/TestCaseProblem.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../jcgp/backend/modules/problem/SymbolicRegressionProblem.html" title="class in jcgp.backend.modules.problem"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../jcgp/backend/modules/problem/TestCaseProblem.TestCase.html" title="class in jcgp.backend.modules.problem"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?jcgp/backend/modules/problem/TestCaseProblem.html" target="_top">Frames</a></li>
<li><a href="TestCaseProblem.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!--   -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>