io.jenetics.ext.TreeGene Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jenetics.ext Show documentation
Jenetics Extension
The newest version!
/*
 * Java Genetic Algorithm Library (jenetics-8.1.0).
 * Copyright (c) 2007-2024 Franz Wilhelmstötter
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * Author:
 *    Franz Wilhelmstötter ([email protected])
 */
package io.jenetics.ext;

import io.jenetics.Gene;

import io.jenetics.ext.util.FlatTree;

/**
 * Representation of tree shaped gene. Since the genes are part of a chromosome,
 * they are implementing the {@link FlatTree} interface, which makes the required
 * storage layout explicit.
 *
 * @author Franz Wilhelmstötter
 * @version 6.0
 * @since 3.9
 */
public interface TreeGene>
	extends
		Gene,
		FlatTree
{

	@Override
	default A value() {
		return allele();
	}

	/**
	 * Return a new tree gene with the given allele and the local tree
	 * structure.
	 *
	 * @param allele the actual gene allele
	 * @param childOffset the offset of the first node child within the
	 *        chromosome
	 * @param childCount the number of children of the new tree gene
	 * @return a new tree gene with the given parameters
	 * @throws IllegalArgumentException  if the {@code childCount} is smaller
	 *         than zero
	 */
	G newInstance(
		final A allele,
		final int childOffset,
		final int childCount
	);

	/**
	 * Return a new tree gene from the given flat tree node.
	 *
	 * @since 6.0
	 *
	 * @param tree the flat tree node
	 * @return a new tree gene from the given flat tree node
	 * @throws NullPointerException if the given {@code tree} node is
	 *         {@code null}
	 */
	default G newInstance(final FlatTree tree) {
		return newInstance(
			tree.value(),
			tree.childOffset(),
			tree.childCount()
		);
	}

}