Module io.jenetics.ext

Package io.jenetics.ext

Interface TreeGene<A,G extends TreeGene<A,G>>

All Superinterfaces:

Factory<G>, FlatTree<A,G>, Gene<A,G>, Iterable<G>, Self<G>, Tree<A,G>, Verifiable

All Known Implementing Classes:

AbstractTreeGene

public interface TreeGene<A,G extends TreeGene<A,G>>
extends Gene<A,G>, FlatTree<A,G>

Representation of tree shaped gene. Since the genes are part of a chromosome, they are implementing the FlatTree interface, which makes the required storage layout explicit.

Since:

3.9

Version:

6.0

Nested Class Summary

Nested classes/interfaces inherited from interface io.jenetics.ext.util.Tree

Tree.Path

Method Summary

Modifier and Type	Method	Description
G	newInstance(A allele, int childOffset, int childCount)	Return a new tree gene with the given allele and the local tree structure.
default G	newInstance(FlatTree<? extends A,?> tree)	Return a new tree gene from the given flat tree node.
default A	value()	Return the value of the current Tree node.

Methods inherited from interface io.jenetics.util.Factory

instances

Methods inherited from interface io.jenetics.ext.util.FlatTree

childOffset, flattenedNodes

Methods inherited from interface io.jenetics.Gene

allele, newInstance, newInstance

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface io.jenetics.util.Self

self

Methods inherited from interface io.jenetics.ext.util.Tree

breadthFirstIterator, breadthFirstStream, childAfter, childAt, childAtPath, childAtPath, childBefore, childCount, childIterator, childPath, childStream, depth, depthFirstIterator, depthFirstStream, firstChild, firstLeaf, identical, indexOf, isAncestor, isChild, isDescendant, isEmpty, isLeaf, isRelated, isRoot, isSibling, iterator, lastChild, lastLeaf, leafCount, leaves, level, nextLeaf, nextNode, nextSibling, parent, path, pathElements, pathFromAncestorIterator, postorderIterator, postorderStream, preorderIterator, preorderStream, previousLeaf, previousNode, previousSibling, reduce, root, sharedAncestor, siblingCount, size, stream, toParenthesesString, toParenthesesString

Methods inherited from interface io.jenetics.util.Verifiable

isValid

Method Details

value

default A value()

Description copied from interface: Tree

Return the value of the current Tree node. The value may be null.

Specified by:

value in interface Tree<A,G extends TreeGene<A,G>>

Returns:

the value of the current Tree node

newInstance

G newInstance(A allele,
 int childOffset,
 int childCount)

Return a new tree gene with the given allele and the local tree structure.

Parameters:

allele - the actual gene allele

childOffset - the offset of the first node child within the chromosome

childCount - the number of children of the new tree gene

Returns:

a new tree gene with the given parameters

Throws:

IllegalArgumentException - if the childCount is smaller than zero

newInstance

default G newInstance(FlatTree<? extends A,?> tree)

Return a new tree gene from the given flat tree node.

Parameters:

tree - the flat tree node

Returns:

a new tree gene from the given flat tree node

Throws:

NullPointerException - if the given tree node is null

Since:

6.0