aboutsummaryrefslogtreecommitdiffstats
path: root/doc/jcgp/backend/population/Mutable.html
blob: c02cff07f7968c44230f5b42837ed53560b6e71b (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
<!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:32 BST 2014 -->
<title>Mutable</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="Mutable";
        }
    }
    catch(err) {
    }
//-->
var methods = {"i0":6,"i1":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/Mutable.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/population/Input.html" title="class in jcgp.backend.population"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../jcgp/backend/population/Node.html" title="class in jcgp.backend.population"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?jcgp/backend/population/Mutable.html" target="_top">Frames</a></li>
<li><a href="Mutable.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>Nested&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.population</div>
<h2 title="Interface Mutable" class="title">Interface Mutable</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../jcgp/backend/population/Node.html" title="class in jcgp.backend.population">Node</a>, <a href="../../../jcgp/backend/population/Output.html" title="class in jcgp.backend.population">Output</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">Mutable</span></pre>
<div class="block"><code>Mutable</code> declares the expected behaviour of any
 part of a chromosome that is mutable, more specifically
 nodes or outputs. Inputs are not mutable since they don't have
 connections or functions.
 <br><br>
 This interface provides a way to deal with mutable elements
 generically without having to specify whether they are nodes
 or outputs. When mutating a mutable, <code>mutate()</code> is guaranteed
 to perform a fair mutation.</div>
<dl>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Eduardo Pedroni</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">&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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jcgp/backend/population/Mutable.html#copyOf-jcgp.backend.population.Mutable-">copyOf</a></span>(<a href="../../../jcgp/backend/population/Mutable.html" title="interface in jcgp.backend.population">Mutable</a>&nbsp;element)</code>
<div class="block">Asserts if the specified element is a copy of the elements
 this is called on.<br>
 This method returns true if and only if:
 
 the elements being compared are not the same instance;
 the connections of the compared elements are not the same instance;
 the elements have the same function (in the case of Node);
 the grid position of the elements themselves are the same;
 the grid position of all equivalent connections are the same;
 
 <br><br>
 The relationship computed by this method is:
 
 symmetric: a.copyOf(b) == b.copyOf(a);
 not reflexive: a.copyOf(a) returns false;
 not transitive: if a.copyOf(b) is true and b.copyOf(c) is true, a.copyOf(c) is
    not necessarily true since it is possible that a == c.
 </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/population/Mutable.html#mutate--">mutate</a></span>()</code>
<div class="block">This method performs an arbitrary mutation on the <code>Mutable</code>.</div>
</td>
</tr>
</table>
</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="mutate--">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>mutate</h4>
<pre>void&nbsp;mutate()</pre>
<div class="block">This method performs an arbitrary mutation on the <code>Mutable</code>.
 <br><br>
 In the case of nodes, this chooses to mutate a function or connection
 fairly, and carries out the required mutation by using the node's own
 reference to chromosome.
 <br><br>
 In the case of outputs, this simply picks a random connection to serve
 as the source - any connection is allowed.</div>
</li>
</ul>
<a name="copyOf-jcgp.backend.population.Mutable-">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>copyOf</h4>
<pre>boolean&nbsp;copyOf(<a href="../../../jcgp/backend/population/Mutable.html" title="interface in jcgp.backend.population">Mutable</a>&nbsp;element)</pre>
<div class="block">Asserts if the specified element is a copy of the elements
 this is called on.<br>
 This method returns true if and only if:
 <ul>
 <li>the elements being compared are not the same instance;</li>
 <li>the connections of the compared elements are not the same instance;</li>
 <li>the elements have the same function (in the case of Node);</li>
 <li>the grid position of the elements themselves are the same;</li>
 <li>the grid position of all equivalent connections are the same;</li>
 </ul>
 <br><br>
 The relationship computed by this method is:
 <ul>
 <li>symmetric: a.copyOf(b) == b.copyOf(a);</li>
 <li>not reflexive: a.copyOf(a) returns false;</li>
 <li>not transitive: if a.copyOf(b) is true and b.copyOf(c) is true, a.copyOf(c) is
    not necessarily true since it is possible that a == c.</li>
 </ul></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>element</code> - the mutable element to compare to.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if <code>element</code> is a copy of this element.</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/Mutable.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/population/Input.html" title="class in jcgp.backend.population"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../jcgp/backend/population/Node.html" title="class in jcgp.backend.population"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?jcgp/backend/population/Mutable.html" target="_top">Frames</a></li>
<li><a href="Mutable.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>Nested&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>