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
|
<!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>Problem</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="Problem";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":10,"i2":10,"i3":10,"i4":10,"i5":6,"i6":6,"i7":6,"i8":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/Problem.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/DigitalCircuitProblem.html" title="class in jcgp.backend.modules.problem"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../jcgp/backend/modules/problem/SymbolicRegressionProblem.html" title="class in jcgp.backend.modules.problem"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?jcgp/backend/modules/problem/Problem.html" target="_top">Frames</a></li>
<li><a href="Problem.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>Field | </li>
<li>Constr | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </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 Problem" class="title">Class Problem</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>jcgp.backend.modules.problem.Problem</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../jcgp/backend/modules/problem/TestCaseProblem.html" title="class in jcgp.backend.modules.problem">TestCaseProblem</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="typeNameLabel">Problem</span>
extends <a href="../../../../jcgp/backend/modules/Module.html" title="class in jcgp.backend.modules">Module</a></pre>
<div class="block">Defines the general behaviour of a CGP problem. The primary function of <code>Problem</code>
is to evaluate a population and assign a fitness value to each chromosome.
<br>
Problems are free to define whether better fitness means a higher or lower fitness value.
In some problem types, it is more convenient to treat fitness 0 as the best possible value.
This can be done by changing the fitness orientation to <code>BestFitness.HIGH</code> or <code>BestFitness.LOW</code> as appropriate.
Fitness orientation is set to high by default.
<br><br>
When extending this class, the constructor should call a few methods in order to
properly construct the problem type: <code>setFunctionSet()</code>, <code>setFileExtension()</code> and <code>setFitnessOrientation()</code>,
with the respective arguments. As with all subclasses of <code>Module</code>, <code>setName()</code> and
<code>registerParameters()</code> should be used where appropriate as well.
<br><br>
It is advisable to use <code>Resources.reportln()</code> and <code>Resources.report()</code>
to print any relevant information. Note that reportln() and report() are affected
by the report interval base parameter. Use <code>Resources.println()</code> and
<code>Resources.print()</code> to print information regardless of the current generation.
See <a href="../../../../jcgp/backend/resources/Resources.html" title="class in jcgp.backend.resources"><code>Resources</code></a> for more information.</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/Module.html" title="class in jcgp.backend.modules"><code>Module</code></a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== 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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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>abstract void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jcgp/backend/modules/problem/Problem.html#evaluate-jcgp.backend.population.Population-">evaluate</a></span>(<a href="../../../../jcgp/backend/population/Population.html" title="class in jcgp.backend.population">Population</a> population)</code>
<div class="block">The most important method of the problem type.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jcgp/backend/modules/problem/Problem.html#getBestFitness--">getBestFitness</a></span>()</code> </td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jcgp/backend/modules/problem/Problem.html#getFileExtension--">getFileExtension</a></span>()</code> </td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../jcgp/backend/modules/problem/BestFitness.html" title="enum in jcgp.backend.modules.problem">BestFitness</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jcgp/backend/modules/problem/Problem.html#getFitnessOrientation--">getFitnessOrientation</a></span>()</code> </td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../../jcgp/backend/function/FunctionSet.html" title="class in jcgp.backend.function">FunctionSet</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jcgp/backend/modules/problem/Problem.html#getFunctionSet--">getFunctionSet</a></span>()</code> </td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>abstract int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jcgp/backend/modules/problem/Problem.html#hasImprovement-jcgp.backend.population.Population-">hasImprovement</a></span>(<a href="../../../../jcgp/backend/population/Population.html" title="class in jcgp.backend.population">Population</a> 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="i6" class="altColor">
<td class="colFirst"><code>abstract int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jcgp/backend/modules/problem/Problem.html#hasPerfectSolution-jcgp.backend.population.Population-">hasPerfectSolution</a></span>(<a href="../../../../jcgp/backend/population/Population.html" title="class in jcgp.backend.population">Population</a> population)</code>
<div class="block">Used to assert whether a given population contains a perfect solution
to the problem.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>abstract void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jcgp/backend/modules/problem/Problem.html#parseProblemData-java.io.File-jcgp.backend.resources.ModifiableResources-">parseProblemData</a></span>(java.io.File file,
<a href="../../../../jcgp/backend/resources/ModifiableResources.html" title="class in jcgp.backend.resources">ModifiableResources</a> 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>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jcgp/backend/modules/problem/Problem.html#reset--">reset</a></span>()</code>
<div class="block">Resets the bestFitness parameter.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.jcgp.backend.modules.Module">
<!-- -->
</a>
<h3>Methods inherited from class 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 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="evaluate-jcgp.backend.population.Population-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>evaluate</h4>
<pre>public abstract void evaluate(<a href="../../../../jcgp/backend/population/Population.html" title="class in jcgp.backend.population">Population</a> population)</pre>
<div class="block">The most important method of the problem type. This is called once
per generation, when the new population has been generated.
<br><br>
The basic functionality of this method is to loop through all chromosomes
in the population and decode them according to the problem type. The
fitness of each chromosome is then calculated using the problem data
or otherwise (subjective problem types such as art generation might
leave fitness evaluations up to the user) and assigned to the appropriate
chromosome.
<br><br>
In addition, realisations of this method should update the value of
bestFitness as appropriate, since the value of this parameter is displayed
if a GUI is in use.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>population</code> - the population to be evaluated.</dd>
</dl>
</li>
</ul>
<a name="hasPerfectSolution-jcgp.backend.population.Population-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasPerfectSolution</h4>
<pre>public abstract int hasPerfectSolution(<a href="../../../../jcgp/backend/population/Population.html" title="class in jcgp.backend.population">Population</a> population)</pre>
<div class="block">Used to assert whether a given population contains a perfect solution
to the problem. It is up to the problem to define what qualifies
a perfect solution, as some problems (subject ones such as music and
art evolution, for example) might not have perfect solutions at all.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>population</code> - the population to search through for a perfect chromosome.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the perfect solution index, if one exits, -1 if no perfect solution was found.</dd>
</dl>
</li>
</ul>
<a name="hasImprovement-jcgp.backend.population.Population-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasImprovement</h4>
<pre>public abstract int hasImprovement(<a href="../../../../jcgp/backend/population/Population.html" title="class in jcgp.backend.population">Population</a> population)</pre>
<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="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>
<a name="parseProblemData-java.io.File-jcgp.backend.resources.ModifiableResources-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>parseProblemData</h4>
<pre>public abstract void parseProblemData(java.io.File file,
<a href="../../../../jcgp/backend/resources/ModifiableResources.html" title="class in jcgp.backend.resources">ModifiableResources</a> resources)</pre>
<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="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="getFunctionSet--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFunctionSet</h4>
<pre>public <a href="../../../../jcgp/backend/function/FunctionSet.html" title="class in jcgp.backend.function">FunctionSet</a> getFunctionSet()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the FunctionSet object used by this problem type.</dd>
</dl>
</li>
</ul>
<a name="getFileExtension--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFileExtension</h4>
<pre>public java.lang.String getFileExtension()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the file extension accepted by this problem type for problem data files.</dd>
</dl>
</li>
</ul>
<a name="getFitnessOrientation--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFitnessOrientation</h4>
<pre>public <a href="../../../../jcgp/backend/modules/problem/BestFitness.html" title="enum in jcgp.backend.modules.problem">BestFitness</a> getFitnessOrientation()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the fitness orientation of this particular problem.</dd>
</dl>
</li>
</ul>
<a name="getBestFitness--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBestFitness</h4>
<pre>public double getBestFitness()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the current best fitness, in other words, the fitness
value of the fittest chromosome in the current generation.</dd>
</dl>
</li>
</ul>
<a name="reset--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>reset</h4>
<pre>public void reset()</pre>
<div class="block">Resets the bestFitness parameter.</div>
</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/Problem.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/DigitalCircuitProblem.html" title="class in jcgp.backend.modules.problem"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../jcgp/backend/modules/problem/SymbolicRegressionProblem.html" title="class in jcgp.backend.modules.problem"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?jcgp/backend/modules/problem/Problem.html" target="_top">Frames</a></li>
<li><a href="Problem.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>Field | </li>
<li>Constr | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
|
