01 /*
02 * Java Genetic Algorithm Library (jenetics-5.2.0).
03 * Copyright (c) 2007-2020 Franz Wilhelmstötter
04 *
05 * Licensed under the Apache License, Version 2.0 (the "License");
06 * you may not use this file except in compliance with the License.
07 * You may obtain a copy of the License at
08 *
09 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 *
17 * Author:
18 * Franz Wilhelmstötter (franz.wilhelmstoetter@gmail.com)
19 */
20 package io.jenetics.ext;
21
22 import io.jenetics.Gene;
23
24 import io.jenetics.ext.util.FlatTree;
25
26 /**
27 * Representation of tree shaped gene. Since the genes are part of a chromosome,
28 * they are implementing the {@link FlatTree} interface, which makes the required
29 * storage layout explicit.
30 *
31 * @author <a href="mailto:franz.wilhelmstoetter@gmail.com">Franz Wilhelmstötter</a>
32 * @version 5.2
33 * @since 3.9
34 */
35 public interface TreeGene<A, G extends TreeGene<A, G>>
36 extends
37 Gene<A, G>,
38 FlatTree<A, G>
39 {
40
41 @Override
42 @Deprecated
43 default A getValue() {
44 return allele();
45 }
46
47 /**
48 * Return a new tree gene with the given allele and the <em>local</em> tree
49 * structure.
50 *
51 * @param allele the actual gene allele
52 * @param childOffset the offset of the first node child within the
53 * chromosome
54 * @param childCount the number of children of the new tree gene
55 * @return a new tree gene with the given parameters
56 * @throws IllegalArgumentException if the {@code childCount} is smaller
57 * than zero
58 */
59 G newInstance(
60 final A allele,
61 final int childOffset,
62 final int childCount
63 );
64
65 }
|