01 /*
02 * Java Genetic Algorithm Library (jenetics-8.0.0).
03 * Copyright (c) 2007-2024 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 6.0
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 default A value() {
43 return allele();
44 }
45
46 /**
47 * Return a new tree gene with the given allele and the <em>local</em> tree
48 * structure.
49 *
50 * @param allele the actual gene allele
51 * @param childOffset the offset of the first node child within the
52 * chromosome
53 * @param childCount the number of children of the new tree gene
54 * @return a new tree gene with the given parameters
55 * @throws IllegalArgumentException if the {@code childCount} is smaller
56 * than zero
57 */
58 G newInstance(
59 final A allele,
60 final int childOffset,
61 final int childCount
62 );
63
64 /**
65 * Return a new tree gene from the given flat tree node.
66 *
67 * @since 6.0
68 *
69 * @param tree the flat tree node
70 * @return a new tree gene from the given flat tree node
71 * @throws NullPointerException if the given {@code tree} node is
72 * {@code null}
73 */
74 default G newInstance(final FlatTree<? extends A, ?> tree) {
75 return newInstance(
76 tree.value(),
77 tree.childOffset(),
78 tree.childCount()
79 );
80 }
81
82 }
|