Module io.jenetics.base

Package io.jenetics

Class CombineAlterer<G extends Gene<?,G>,C extends Comparable<? super C>>

java.lang.Object

io.jenetics.AbstractAlterer<G,C>

io.jenetics.Recombinator<G,C>

io.jenetics.CombineAlterer<G,C>

All Implemented Interfaces:

Alterer<G,C>

Direct Known Subclasses:

MeanAlterer

public class CombineAlterer<G extends Gene<?,G>,C extends Comparable<? super C>>
extends Recombinator<G,C>

Alters a chromosome by replacing two genes by the result of a given combiner function.

The order (Recombinator.order()) of this recombination implementation is two.

Since:

6.0

Version:

6.0

Field Summary

Fields inherited from class io.jenetics.AbstractAlterer

_probability

Fields inherited from interface io.jenetics.Alterer

DEFAULT_ALTER_PROBABILITY

Constructor Summary

Constructors

Constructor	Description
CombineAlterer(BinaryOperator<G> combiner)	Create a new combiner alterer with the given arguments.
CombineAlterer(BinaryOperator<G> combiner, double probability)	Create a new combiner alterer with the given arguments.

Method Summary

Modifier and Type	Method	Description
BinaryOperator<G>	combiner()	Return the combiner function, used by this alterer.
protected int	recombine(MSeq<Phenotype<G,C>> population, int[] individuals, long generation)	Recombination template method.
String	toString()

Methods inherited from class io.jenetics.Recombinator

alter, order

Methods inherited from class io.jenetics.AbstractAlterer

probability

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.jenetics.Alterer

andThen, compose

Constructor Details

CombineAlterer

public CombineAlterer(BinaryOperator<G> combiner,
 double probability)

Create a new combiner alterer with the given arguments.

Parameters:

combiner - the function used for combining two genes

probability - The recombination probability.

Throws:

IllegalArgumentException - if the probability is not in the valid range of [0, 1]

NullPointerException - if the given combiner is null

CombineAlterer

public CombineAlterer(BinaryOperator<G> combiner)

Create a new combiner alterer with the given arguments.

Parameters:

combiner - the function used for combining two genes

Throws:

IllegalArgumentException - if the probability is not in the valid range of [0, 1]

NullPointerException - if the given combiner is null

Method Details

combiner

public BinaryOperator<G> combiner()

Return the combiner function, used by this alterer.

Returns:

the combiner function, used by this alterer

recombine

protected int recombine(MSeq<Phenotype<G,C>> population,
 int[] individuals,
 long generation)

Description copied from class: Recombinator

Recombination template method. This method is called 0 to n times. It is guaranteed that this method is only called by one thread.

Specified by:

recombine in class Recombinator<G extends Gene<?,G>,C extends Comparable<? super C>>

Parameters:

population - the population to recombine

individuals - the array with the indexes of the individuals which are involved in the recombination step. The length of the array is Recombinator.order(). The first individual is the primary individual.

generation - the current generation.

Returns:

the number of genes that has been altered.

toString

public String toString()

Overrides:

toString in class Object