org.jenetics.prog

Class ProgramGene<A>

java.lang.Object

org.jenetics.ext.AbstractTreeGene<Op<A>,ProgramGene<A>>

org.jenetics.prog.ProgramGene<A>

All Implemented Interfaces:

Iterable<ProgramGene<A>>, Function<A[],A>, TreeGene<Op<A>,ProgramGene<A>>, FlatTree<Op<A>,ProgramGene<A>>, Tree<Op<A>,ProgramGene<A>>, Gene<Op<A>,ProgramGene<A>>, Factory<ProgramGene<A>>, Verifiable

public final class ProgramGene<A>
extends AbstractTreeGene<Op<A>,ProgramGene<A>>
implements Gene<Op<A>,ProgramGene<A>>, Function<A[],A>

This gene represents a program, build upon an AST of Op functions. Because of the tight coupling with the ProgramChromosome, a ProgramGene can't be created directly. This reduces the the possible error space. Since the ProgramGene also is a Tree, it can be easily used as result.

final ProgramGene<Double> program = engine.stream() .limit(300) .collect(EvolutionResult.toBestGenotype()) .getGene(); final double result = program.eval(3.4);

Since:

3.9

Version:

3.9

Author:

Franz Wilhelmstötter

Method Summary

Modifier and Type	Method and Description
A	apply(A[] args) Evaluates this program gene (recursively) with the given variable values.
A	eval(A... args) Convenient method, which lets you apply the program function without explicitly create a wrapper array.
ISeq<? extends Op<A>>	getOperations() Return the allowed operations.
ISeq<? extends Op<A>>	getTerminals() Return the allowed terminal operations.
ProgramGene<A>	newInstance()
ProgramGene<A>	newInstance(Op<A> op) Create a new program gene with the given operation.
ProgramGene<A>	newInstance(Op<A> op, int childOffset, int childCount) Return a new program gene with the given operation and the local tree structure.

Methods inherited from class org.jenetics.ext.AbstractTreeGene

bind, checkTreeState, childCount, childOffset, equals, flattenedNodes, getAllele, getChild, getParent, getRoot, hashCode, identical, isRoot, isValid, size, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jenetics.Gene

getAllele

Methods inherited from interface org.jenetics.util.Factory

instances

Methods inherited from interface org.jenetics.util.Verifiable

isValid

Methods inherited from interface java.util.function.Function

andThen, compose, identity

Methods inherited from interface org.jenetics.ext.TreeGene

getValue

Methods inherited from interface org.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

Method Detail

apply

public A apply(A[] args)

Evaluates this program gene (recursively) with the given variable values.

Specified by:

apply in interface Function<A[],A>

Parameters:

args - the input variables

Returns:

the evaluated value

Throws:

NullPointerException - if the given variable array is null

See Also:

eval(Object[]), ProgramChromosome.eval(Object[])

eval

@SafeVarargs
public final A eval(A... args)

Convenient method, which lets you apply the program function without explicitly create a wrapper array.

Parameters:

args - the function arguments

Returns:

the evaluated value

Throws:

NullPointerException - if the given variable array is null

See Also:

apply(Object[]), ProgramChromosome.eval(Object[])

getOperations

public ISeq<? extends Op<A>> getOperations()

Return the allowed operations.

Returns:

the allowed operations

getTerminals

public ISeq<? extends Op<A>> getTerminals()

Return the allowed terminal operations.

Returns:

the allowed terminal operations

newInstance

public ProgramGene<A> newInstance()

Specified by:

newInstance in interface Gene<Op<A>,ProgramGene<A>>

Specified by:

newInstance in interface Factory<ProgramGene<A>>

newInstance

public ProgramGene<A> newInstance(Op<A> op)

Create a new program gene with the given operation.

Specified by:

newInstance in interface Gene<Op<A>,ProgramGene<A>>

Parameters:

op - the operation of the new program gene

Returns:

a new program gene with the given operation

Throws:

NullPointerException - if the given op is null

IllegalArgumentException - if the arity of the given operation is different from the arity of current operation. This restriction ensures that only valid program genes are created by this method.

newInstance

public ProgramGene<A> newInstance(Op<A> op,
                                  int childOffset,
                                  int childCount)

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

Specified by:

newInstance in interface TreeGene<Op<A>,ProgramGene<A>>

Parameters:

op - the new operation

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

IllegalArgumentException - if the operation arity is different from the childCount.

NullPointerException - if the given op is null