Module io.jenetics.base

Package io.jenetics.engine

Record Class EvolutionDurations

java.lang.Object

java.lang.Record

io.jenetics.engine.EvolutionDurations

Record Components:

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

All Implemented Interfaces:

Serializable, Comparable<EvolutionDurations>

public record EvolutionDurations(Duration offspringSelectionDuration, Duration survivorsSelectionDuration, Duration offspringAlterDuration, Duration offspringFilterDuration, Duration survivorFilterDuration, Duration evaluationDuration, Duration evolveDuration)
extends Record
implements Comparable<EvolutionDurations>, Serializable

This class contains timing information about one evolution step.

Since:

3.0

Version:

7.0

See Also:

• Serialized Form

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
EvolutionDurations(Duration offspringSelectionDuration, Duration survivorsSelectionDuration, Duration offspringAlterDuration, Duration offspringFilterDuration, Duration survivorFilterDuration, Duration evaluationDuration, Duration evolveDuration)	Creates an instance of a EvolutionDurations record class.

Method Summary

Modifier and Type	Method	Description
int	compareTo(EvolutionDurations other)	Compares two durations objects.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
Duration	evaluationDuration()	Returns the value of the evaluationDuration record component.
Duration	evolveDuration()	Returns the value of the evolveDuration record component.
final int	hashCode()	Returns a hash code value for this object.
Duration	offspringAlterDuration()	Returns the value of the offspringAlterDuration record component.
Duration	offspringFilterDuration()	Returns the value of the offspringFilterDuration record component.
Duration	offspringSelectionDuration()	Returns the value of the offspringSelectionDuration record component.
EvolutionDurations	plus(EvolutionDurations other)	Returns a copy of this duration with the specified duration added.
Duration	survivorFilterDuration()	Returns the value of the survivorFilterDuration record component.
Duration	survivorsSelectionDuration()	Returns the value of the survivorsSelectionDuration record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

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

Field Details

ZERO

public static final EvolutionDurations ZERO

Constant for zero evolution durations.

Constructor Details

EvolutionDurations

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

Creates an instance of a EvolutionDurations record class.

Parameters:

offspringSelectionDuration - the value for the offspringSelectionDuration record component

survivorsSelectionDuration - the value for the survivorsSelectionDuration record component

offspringAlterDuration - the value for the offspringAlterDuration record component

offspringFilterDuration - the value for the offspringFilterDuration record component

survivorFilterDuration - the value for the survivorFilterDuration record component

evaluationDuration - the value for the evaluationDuration record component

evolveDuration - the value for the evolveDuration record component

Method Details

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 evolveDuration() 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 evolveDuration() property of this object is smaller/equal/greater than the corresponding property of the other project.

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

offspringSelectionDuration

public Duration offspringSelectionDuration()

Returns the value of the offspringSelectionDuration record component.

Returns:

the value of the offspringSelectionDuration record component

survivorsSelectionDuration

public Duration survivorsSelectionDuration()

Returns the value of the survivorsSelectionDuration record component.

Returns:

the value of the survivorsSelectionDuration record component

offspringAlterDuration

public Duration offspringAlterDuration()

Returns the value of the offspringAlterDuration record component.

Returns:

the value of the offspringAlterDuration record component

offspringFilterDuration

public Duration offspringFilterDuration()

Returns the value of the offspringFilterDuration record component.

Returns:

the value of the offspringFilterDuration record component

survivorFilterDuration

public Duration survivorFilterDuration()

Returns the value of the survivorFilterDuration record component.

Returns:

the value of the survivorFilterDuration record component

evaluationDuration

public Duration evaluationDuration()

Returns the value of the evaluationDuration record component.

Returns:

the value of the evaluationDuration record component

evolveDuration

public Duration evolveDuration()

Returns the value of the evolveDuration record component.

Returns:

the value of the evolveDuration record component