Package net.bmahe.genetics4j.moo.nsga2.spec

Class ImmutableTournamentNSGA2Selection.Builder<T extends Comparable<T>>

java.lang.Object

net.bmahe.genetics4j.moo.nsga2.spec.ImmutableTournamentNSGA2Selection.Builder<T>

Direct Known Subclasses:

TournamentNSGA2Selection.Builder

Enclosing class:

ImmutableTournamentNSGA2Selection<T extends Comparable<T>>

public static class ImmutableTournamentNSGA2Selection.Builder<T extends Comparable<T>>
extends Object

Builds instances of type ImmutableTournamentNSGA2Selection. Initialize attributes and then invoke the build() method to create an immutable instance.

Builder is not thread-safe and generally should not be stored in a field or collection, but instead used immediately to create instances.

Field Summary

Fields

Modifier and Type	Field	Description
private Optional<Comparator<Genotype>>	deduplicate
private ObjectiveDistance<T>	distance
private Comparator<T>	dominance
private static final long	INIT_BIT_DISTANCE
private static final long	INIT_BIT_NUM_CANDIDATES
private static final long	INIT_BIT_NUMBER_OBJECTIVES
private static final long	INIT_BIT_OBJECTIVE_COMPARATOR
private long	initBits
private int	numberObjectives
private int	numCandidates
private Function<Integer,Comparator<T>>	objectiveComparator

Constructor Summary

Constructors

Constructor	Description
Builder()	Creates a builder for ImmutableTournamentNSGA2Selection instances.

Method Summary

Modifier and Type	Method	Description
ImmutableTournamentNSGA2Selection<T>	build()	Builds a new ImmutableTournamentNSGA2Selection.
final TournamentNSGA2Selection.Builder<T>	deduplicate(Optional<Comparator<Genotype>> deduplicate)	Initializes the value for the deduplicate attribute.
final TournamentNSGA2Selection.Builder<T>	distance(ObjectiveDistance<T> distance)	Initializes the value for the distance attribute.
final TournamentNSGA2Selection.Builder<T>	dominance(Comparator<T> dominance)	Initializes the value for the dominance attribute.
private String	formatRequiredAttributesMessage()
final TournamentNSGA2Selection.Builder<T>	from(TournamentNSGA2Selection<T> instance)	Fill a builder with attribute values from the provided TournamentNSGA2Selection instance.
final TournamentNSGA2Selection.Builder<T>	numberObjectives(int numberObjectives)	Initializes the value for the numberObjectives attribute.
final TournamentNSGA2Selection.Builder<T>	numCandidates(int numCandidates)	Initializes the value for the numCandidates attribute.
final TournamentNSGA2Selection.Builder<T>	objectiveComparator(Function<Integer,Comparator<T>> objectiveComparator)	Initializes the value for the objectiveComparator attribute.

Methods inherited from class java.lang.Object

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

Field Details

INIT_BIT_NUMBER_OBJECTIVES

private static final long INIT_BIT_NUMBER_OBJECTIVES

See Also:

• Constant Field Values

INIT_BIT_OBJECTIVE_COMPARATOR

private static final long INIT_BIT_OBJECTIVE_COMPARATOR

See Also:

• Constant Field Values

INIT_BIT_DISTANCE

private static final long INIT_BIT_DISTANCE

See Also:

• Constant Field Values

INIT_BIT_NUM_CANDIDATES

private static final long INIT_BIT_NUM_CANDIDATES

See Also:

• Constant Field Values

initBits

private long initBits

numberObjectives

private int numberObjectives

dominance

private Comparator<T extends Comparable<T>> dominance

deduplicate

private Optional<Comparator<Genotype>> deduplicate

objectiveComparator

private Function<Integer,Comparator<T extends Comparable<T>>> objectiveComparator

distance

private ObjectiveDistance<T extends Comparable<T>> distance

numCandidates

private int numCandidates

Constructor Details

Builder

public Builder()

Creates a builder for ImmutableTournamentNSGA2Selection instances.

 new TournamentNSGA2Selection.Builder<T>()
    .numberObjectives(int) // required numberObjectives
    .dominance(Comparator<T>) // optional dominance
    .deduplicate(Optional<Comparator<net.bmahe.genetics4j.core.Genotype>>) // optional deduplicate
    .objectiveComparator(function.Function<Integer, Comparator<T>>) // required objectiveComparator
    .distance(net.bmahe.genetics4j.moo.ObjectiveDistance<T>) // required distance
    .numCandidates(int) // required numCandidates
    .build();
 

Method Details

from

public final TournamentNSGA2Selection.Builder<T> from(TournamentNSGA2Selection<T> instance)

Fill a builder with attribute values from the provided TournamentNSGA2Selection instance. Regular attribute values will be replaced with those from the given instance. Absent optional values will not replace present values.

Parameters:

instance - The instance from which to copy values

Returns:

this builder for use in a chained invocation

numberObjectives

public final TournamentNSGA2Selection.Builder<T> numberObjectives(int numberObjectives)

Initializes the value for the numberObjectives attribute.

Parameters:

numberObjectives - The value for numberObjectives

Returns:

this builder for use in a chained invocation

dominance

public final TournamentNSGA2Selection.Builder<T> dominance(Comparator<T> dominance)

Initializes the value for the dominance attribute.

If not set, this attribute will have a default value as returned by the initializer of dominance.

Parameters:

dominance - The value for dominance

Returns:

this builder for use in a chained invocation

deduplicate

public final TournamentNSGA2Selection.Builder<T> deduplicate(Optional<Comparator<Genotype>> deduplicate)

Initializes the value for the deduplicate attribute.

If not set, this attribute will have a default value as returned by the initializer of deduplicate.

Parameters:

deduplicate - The value for deduplicate

Returns:

this builder for use in a chained invocation

objectiveComparator

public final TournamentNSGA2Selection.Builder<T> objectiveComparator(Function<Integer,Comparator<T>> objectiveComparator)

Initializes the value for the objectiveComparator attribute.

Parameters:

objectiveComparator - The value for objectiveComparator

Returns:

this builder for use in a chained invocation

distance

public final TournamentNSGA2Selection.Builder<T> distance(ObjectiveDistance<T> distance)

Initializes the value for the distance attribute.

Parameters:

distance - The value for distance

Returns:

this builder for use in a chained invocation

numCandidates

public final TournamentNSGA2Selection.Builder<T> numCandidates(int numCandidates)

Initializes the value for the numCandidates attribute.

Parameters:

numCandidates - The value for numCandidates

Returns:

this builder for use in a chained invocation

build

public ImmutableTournamentNSGA2Selection<T> build()

Builds a new ImmutableTournamentNSGA2Selection.

Returns:

An immutable instance of TournamentNSGA2Selection

Throws:

IllegalStateException - if any required attributes are missing

formatRequiredAttributesMessage

private String formatRequiredAttributesMessage()