io.jenetics.ext

Class AbstractTreeGene<A,G extends AbstractTreeGene<A,G>>

java.lang.Object

io.jenetics.ext.AbstractTreeGene<A,G>

All Implemented Interfaces:

TreeGene<A,G>, FlatTree<A,G>, Tree<A,G>, Gene<A,G>, Factory<G>, Verifiable, Serializable, Iterable<G>

public abstract class AbstractTreeGene<A,G extends AbstractTreeGene<A,G>>
extends Object
implements TreeGene<A,G>, Serializable

Abstract implementation of the TreeGene interface..

Since:

3.9

Version:

4.1

Author:

Franz Wilhelmstötter

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractTreeGene(A allele, int childOffset, int childCount) Creates a new tree-gene from the given data.

Method Summary

Modifier and Type	Method and Description
protected void	bind(ISeq<G> genes) This method is used by the AbstractTreeChromosome to attach itself to this gene.
protected void	checkTreeState()
int	childCount() Return the number of children this tree node consists of.
int	childOffset() Return the index of the first child node in the underlying node array.
boolean	equals(Object obj)
ISeq<G>	flattenedNodes() Return the whole flattened tree values in breadth-first order.
A	getAllele()
G	getChild(int index) Return the child gene with the given index.
Optional<G>	getParent() Return the parent node of this tree node.
G	getRoot() Returns the root of the tree that contains this node.
int	hashCode()
boolean	identical(Tree<?,?> other) Tests whether this node is the same as the other node.
boolean	isRoot() Returns true if this node is the root of the tree.
boolean	isValid()
int	size() Return the number of nodes of this node (sub-tree).
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.jenetics.ext.TreeGene

getValue, newInstance

Methods inherited from interface io.jenetics.Gene

newInstance, newInstance

Methods inherited from interface io.jenetics.util.Factory

instances

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

breadthFirstIterator, breadthFirstStream, childAfter, childBefore, childIterator, childStream, depth, depthFirstIterator, depthFirstStream, equals, firstChild, firstLeaf, getIndex, getPath, hashCode, isAncestor, isChild, isDescendant, isLeaf, isRelated, isSibling, iterator, lastChild, lastLeaf, leafCount, level, nextLeaf, nextNode, nextSibling, pathFromAncestorIterator, postorderIterator, postorderStream, preorderIterator, preorderStream, previousLeaf, previousNode, previousSibling, sharedAncestor, siblingCount, stream, toCompactString, toDottyString, toString

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

AbstractTreeGene

protected AbstractTreeGene(A allele,
                           int childOffset,
                           int childCount)

Creates a new tree-gene from the given data.

Parameters:

allele - the actual value (allele) of the tree-gene

childOffset - the offset index of the child in the containing chromosome. If this node has no child, the value should be set to zero.

childCount - the number of children of this gene

Throws:

IllegalArgumentException - if the childCount is smaller than zero

Method Detail

flattenedNodes

public ISeq<G> flattenedNodes()

Return the whole flattened tree values in breadth-first order. This method will always return the same ISeq instance.

Specified by:

flattenedNodes in interface FlatTree<A,G extends AbstractTreeGene<A,G>>

Returns:

the whole flattened tree values

getRoot

public G getRoot()

Description copied from interface: Tree

Returns the root of the tree that contains this node. The root is the ancestor with no parent.

Specified by:

getRoot in interface Tree<A,G extends AbstractTreeGene<A,G>>

Returns:

the root of the tree that contains this node

isRoot

public boolean isRoot()

Description copied from interface: Tree

Returns true if this node is the root of the tree.

Specified by:

isRoot in interface Tree<A,G extends AbstractTreeGene<A,G>>

Returns:

true if this node is the root of its tree, false otherwise

size

public int size()

Description copied from interface: Tree

Return the number of nodes of this node (sub-tree).

Specified by:

size in interface Tree<A,G extends AbstractTreeGene<A,G>>

Returns:

the number of nodes of this node (sub-tree)

checkTreeState

protected void checkTreeState()

bind

protected void bind(ISeq<G> genes)

This method is used by the AbstractTreeChromosome to attach itself to this gene.

Parameters:

genes - the genes of the attached chromosome

childOffset

public int childOffset()

Description copied from interface: FlatTree

Return the index of the first child node in the underlying node array. -1 is returned if this node is a leaf.

Specified by:

childOffset in interface FlatTree<A,G extends AbstractTreeGene<A,G>>

Returns:

Return the index of the first child node in the underlying node array, or -1 if this node is a leaf

getAllele

public A getAllele()

Specified by:

getAllele in interface Gene<A,G extends AbstractTreeGene<A,G>>

getParent

public Optional<G> getParent()

Return the parent node of this tree node.

Specified by:

getParent in interface Tree<A,G extends AbstractTreeGene<A,G>>

Returns:

the parent node, or Optional.empty() if this node is the root of the tree

Throws:

IllegalStateException - if this gene is not part of a chromosome

getChild

public G getChild(int index)

Return the child gene with the given index.

Specified by:

getChild in interface Tree<A,G extends AbstractTreeGene<A,G>>

Parameters:

index - the child index

Returns:

the child node with the given index

Throws:

IndexOutOfBoundsException - if the index is out of bounds ([0, childCount()))

IllegalStateException - if this gene is not part of a chromosome

childCount

public int childCount()

Description copied from interface: Tree

Return the number of children this tree node consists of.

Specified by:

childCount in interface Tree<A,G extends AbstractTreeGene<A,G>>

Returns:

the number of children this tree node consists of

isValid

public boolean isValid()

Specified by:

isValid in interface Verifiable

identical

public boolean identical(Tree<?,?> other)

Description copied from interface: Tree

Tests whether this node is the same as the other node. The default implementation returns the object identity, this == other, of the two objects, but other implementations may use different criteria for checking the identity.

Specified by:

identical in interface Tree<A,G extends AbstractTreeGene<A,G>>

Parameters:

other - the other node

Returns:

true if the other node is the same as this node.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object