Engine.Builder (Jenetics 3.0.0)

java.lang.Object
- org.jenetics.engine.Engine.Builder<G,C>

Enclosing class:

Engine<G extends Gene<?,G>,C extends Comparable<? super C>>
```
public static final class Engine.Builder<G extends Gene<?,G>,C extends Comparable<? super C>>
extends Object
```
Builder class for building GA Engine instances.

Since:

3.0

Version:

3.0 — $Date: 2014-12-28 $

Author:

Franz Wilhelmstötter

See Also:

Engine

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Engine.Builder<G,C>`	`alterers(Alterer<G,C> first, Alterer<G,C>... rest)` The alterers used for alter the offspring population.
`Engine<G,C>`	`build()` Builds an new `Engine` instance from the set properties.
`Engine.Builder<G,C>`	`clock(Clock clock)` The clock used for calculating the execution durations.
`Engine.Builder<G,C>`	`executor(Executor executor)` The executor used by the engine.
`Engine.Builder<G,C>`	`fitnessFunction(Function<? super Genotype<G>,? extends C> function)` Set the fitness function of the evolution `Engine`.
`Engine.Builder<G,C>`	`fitnessScaler(Function<? super C,? extends C> scaler)` Set the fitness scaler of the evolution `Engine`.
`Engine.Builder<G,C>`	`genotypeFactory(Factory<Genotype<G>> genotypeFactory)` The genotype factory used for creating new individuals.
`Engine.Builder<G,C>`	`maximalPhenotypeAge(long age)` The maximal allowed age of a phenotype.
`Engine.Builder<G,C>`	`offspringFraction(double fraction)` The offspring fraction.
`Engine.Builder<G,C>`	`offspringSelector(Selector<G,C> selector)` The selector used for selecting the offspring population.
`Engine.Builder<G,C>`	`optimize(Optimize optimize)` The optimization strategy used by the engine.
`Engine.Builder<G,C>`	`populationSize(int size)` The number of individuals which form the population.
`Engine.Builder<G,C>`	`selector(Selector<G,C> selector)` The selector used for selecting the survivors and offspring population.
`Engine.Builder<G,C>`	`survivorsSelector(Selector<G,C> selector)` The selector used for selecting the survivors population.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - fitnessFunction
```
public Engine.Builder<G,C> fitnessFunction(Function<? super Genotype<G>,? extends C> function)
```
    Set the fitness function of the evolution Engine.
    
    Parameters:
    
    function - the fitness function to use in the GA Engine
    
    Returns:
    
    this builder, for command chaining
  - fitnessScaler
```
public Engine.Builder<G,C> fitnessScaler(Function<? super C,? extends C> scaler)
```
    Set the fitness scaler of the evolution Engine. Default value is set to the identity function.
    
    Parameters:
    
    scaler - the fitness scale to use in the GA Engine
    
    Returns:
    
    this builder, for command chaining
  - genotypeFactory
```
public Engine.Builder<G,C> genotypeFactory(Factory<Genotype<G>> genotypeFactory)
```
    The genotype factory used for creating new individuals.
    
    Parameters:
    
    genotypeFactory - the genotype factory for creating new individuals.
    
    Returns:
    
    this builder, for command chaining
  - offspringSelector
```
public Engine.Builder<G,C> offspringSelector(Selector<G,C> selector)
```
    The selector used for selecting the offspring population. Default values is set to TournamentSelector<>(3).
    
    Parameters:
    
    selector - used for selecting the offspring population
    
    Returns:
    
    this builder, for command chaining
  - survivorsSelector
```
public Engine.Builder<G,C> survivorsSelector(Selector<G,C> selector)
```
    The selector used for selecting the survivors population. Default values is set to TournamentSelector<>(3).
    
    Parameters:
    
    selector - used for selecting survivors population
    
    Returns:
    
    this builder, for command chaining
  - selector
```
public Engine.Builder<G,C> selector(Selector<G,C> selector)
```
    The selector used for selecting the survivors and offspring population. Default values is set to TournamentSelector<>(3).
    
    Parameters:
    
    selector - used for selecting survivors and offspring population
    
    Returns:
    
    this builder, for command chaining
  - alterers
```
@SafeVarargs
public final Engine.Builder<G,C> alterers(Alterer<G,C> first,
                                                       Alterer<G,C>... rest)
```
    The alterers used for alter the offspring population. Default values is set to new SinglePointCrossover<>(0.2) followed by new Mutator<>(0.15).
    
    Parameters:
    
    first - the first alterer used for alter the offspring population
    
    rest - the rest of the alterers used for alter the offspring population
    
    Returns:
    
    this builder, for command chaining
    
    Throws:
    
    NullPointerException - if one of the alterers is null.
  - optimize
```
public Engine.Builder<G,C> optimize(Optimize optimize)
```
    The optimization strategy used by the engine. Default values is set to Optimize.MAXIMUM.
    
    Parameters:
    
    optimize - the optimization strategy used by the engine
    
    Returns:
    
    this builder, for command chaining
  - offspringFraction
```
public Engine.Builder<G,C> offspringFraction(double fraction)
```
    The offspring fraction. Default values is set to 0.6.
    
    Parameters:
    
    fraction - the offspring fraction
    
    Returns:
    
    this builder, for command chaining
    
    Throws:
    
    IllegalArgumentException - if the fraction is not within the range [0, 1].
  - populationSize
```
public Engine.Builder<G,C> populationSize(int size)
```
    The number of individuals which form the population. Default values is set to 50.
    
    Parameters:
    
    size - the number of individuals of a population
    
    Returns:
    
    this builder, for command chaining
    
    Throws:
    
    IllegalArgumentException - if size < 1
  - maximalPhenotypeAge
```
public Engine.Builder<G,C> maximalPhenotypeAge(long age)
```
    The maximal allowed age of a phenotype. Default values is set to 70.
    
    Parameters:
    
    age - the maximal phenotype age
    
    Returns:
    
    this builder, for command chaining
    
    Throws:
    
    IllegalArgumentException - if age < 1
  - executor
```
public Engine.Builder<G,C> executor(Executor executor)
```
    The executor used by the engine.
    
    Parameters:
    
    executor - the executor used by the engine
    
    Returns:
    
    this builder, for command chaining
  - clock
```
public Engine.Builder<G,C> clock(Clock clock)
```
    The clock used for calculating the execution durations.
    
    Parameters:
    
    clock - the clock used for calculating the execution durations
    
    Returns:
    
    this builder, for command chaining
  - build
```
public Engine<G,C> build()
```
    Builds an new Engine instance from the set properties.
    
    Returns:
    
    an new Engine instance from the set properties

Class Engine.Builder<G extends Gene<?,G>,C extends Comparable<? super C>>

Method Summary

Methods inherited from class java.lang.Object

Method Detail

fitnessFunction

fitnessScaler

genotypeFactory

offspringSelector

survivorsSelector

selector

alterers

optimize

offspringFraction

populationSize

maximalPhenotypeAge

executor

clock

build