io.jenetics.engine

Class EvolutionDurations

java.lang.Object

io.jenetics.engine.EvolutionDurations

All Implemented Interfaces:

Serializable, Comparable<EvolutionDurations>

public final class EvolutionDurations
extends Object
implements Comparable<EvolutionDurations>, Serializable

This class contains timing information about one evolution step.

Since:

3.0

Version:

3.0

Author:

Franz Wilhelmstötter

See Also:

Serialized Form

Implementation Note:

This class is immutable and thread-safe.

Field Summary

Fields

Modifier and Type	Field and Description
static EvolutionDurations	ZERO Constant for zero evolution durations.

Method Summary

Modifier and Type	Method and Description
int	compareTo(EvolutionDurations other) Compares two durations objects.
boolean	equals(Object obj)
Duration	getEvaluationDuration() Return the duration needed for evaluating the fitness function of the new individuals.
Duration	getEvolveDuration() Return the duration needed for the whole evolve step.
Duration	getOffspringAlterDuration() Return the duration needed for altering the offspring population.
Duration	getOffspringFilterDuration() Return the duration needed for removing and replacing invalid offspring individuals.
Duration	getOffspringSelectionDuration() Return the duration needed for selecting the offspring population.
Duration	getSurvivorFilterDuration() Return the duration needed for removing and replacing old and invalid survivor individuals.
Duration	getSurvivorsSelectionDuration() Return the duration needed for selecting the survivors population.
int	hashCode()
static EvolutionDurations	of(Duration offspringSelectionDuration, Duration survivorsSelectionDuration, Duration offspringAlterDuration, Duration offspringFilterDuration, Duration survivorFilterDuration, Duration evaluationDuration, Duration evolveDuration) Return an new EvolutionDurations object with the given values.
EvolutionDurations	plus(EvolutionDurations other) Returns a copy of this duration with the specified duration added.

Methods inherited from class java.lang.Object

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

Field Detail

ZERO

public static final EvolutionDurations ZERO

Constant for zero evolution durations.

Method Detail

getOffspringSelectionDuration

public Duration getOffspringSelectionDuration()

Return the duration needed for selecting the offspring population.

Returns:

the duration needed for selecting the offspring population

getSurvivorsSelectionDuration

public Duration getSurvivorsSelectionDuration()

Return the duration needed for selecting the survivors population.

Returns:

the duration needed for selecting the survivors population

getOffspringAlterDuration

public Duration getOffspringAlterDuration()

Return the duration needed for altering the offspring population.

Returns:

the duration needed for altering the offspring population

getOffspringFilterDuration

public Duration getOffspringFilterDuration()

Return the duration needed for removing and replacing invalid offspring individuals.

Returns:

the duration needed for removing and replacing invalid offspring individuals

getSurvivorFilterDuration

public Duration getSurvivorFilterDuration()

Return the duration needed for removing and replacing old and invalid survivor individuals.

Returns:

the duration needed for removing and replacing old and invalid survivor individuals

getEvaluationDuration

public Duration getEvaluationDuration()

Return the duration needed for evaluating the fitness function of the new individuals.

Returns:

the duration needed for evaluating the fitness function of the new individuals

getEvolveDuration

public Duration getEvolveDuration()

Return the duration needed for the whole evolve step.

Returns:

the duration needed for the whole evolve step

plus

public EvolutionDurations plus(EvolutionDurations other)

Returns a copy of this duration with the specified duration added.

This instance is immutable and unaffected by this method call.

Parameters:

other - the duration to add

Returns:

a EvolutionDurations based on this duration with the specified duration added

Throws:

NullPointerException - if the other duration is null

ArithmeticException - if numeric overflow occurs

compareTo

public int compareTo(EvolutionDurations other)

Compares two durations objects. Only the getEvolveDuration() property is taken into account for the comparison.

Specified by:

compareTo in interface Comparable<EvolutionDurations>

Parameters:

other - the other durations object this object is compared with

Returns:

a integer smaller/equal/greater than 0 if the getEvolveDuration() property of this object is smaller/equal/greater than the corresponding property of the other project.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

of

public static EvolutionDurations of(Duration offspringSelectionDuration,
                                    Duration survivorsSelectionDuration,
                                    Duration offspringAlterDuration,
                                    Duration offspringFilterDuration,
                                    Duration survivorFilterDuration,
                                    Duration evaluationDuration,
                                    Duration evolveDuration)

Return an new EvolutionDurations object with the given values.

Parameters:

offspringSelectionDuration - the duration needed for selecting the offspring population

survivorsSelectionDuration - the duration needed for selecting the survivors population

offspringAlterDuration - the duration needed for altering the offspring population

offspringFilterDuration - the duration needed for removing and replacing invalid offspring individuals

survivorFilterDuration - the duration needed for removing and replacing old and invalid survivor individuals

evaluationDuration - the duration needed for evaluating the fitness function of the new individuals

evolveDuration - the duration needed for the whole evolve step

Returns:

an new durations object

Throws:

NullPointerException - if one of the arguments is null