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

Class ImmutableNSGA2Selection<T extends Comparable<T>>

java.lang.Object

net.bmahe.genetics4j.moo.nsga2.spec.NSGA2Selection<T>

net.bmahe.genetics4j.moo.nsga2.spec.ImmutableNSGA2Selection<T>

All Implemented Interfaces:

SelectionPolicy

@Generated(from="NSGA2Selection",
           generator="Immutables")
@Generated("org.immutables.processor.ProxyProcessor")
public final class ImmutableNSGA2Selection<T extends Comparable<T>>
extends NSGA2Selection<T>

Immutable implementation of NSGA2Selection.

Use the builder to create immutable instances: new NSGA2Selection.Builder(). Use the static factory method to create immutable instances: ImmutableNSGA2Selection.of().

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ImmutableNSGA2Selection.Builder<T extends Comparable<T>>	Builds instances of type NSGA2Selection.
private final class	ImmutableNSGA2Selection.InitShim

Field Summary

Fields

Modifier and Type	Field	Description
private final Comparator<Genotype>	deduplicate
private final ObjectiveDistance<T>	distance
private final Comparator<T>	dominance
private ImmutableNSGA2Selection<T>.InitShim	initShim
private final int	numberObjectives
private final Function<Integer,Comparator<T>>	objectiveComparator
private static final byte	STAGE_INITIALIZED
private static final byte	STAGE_INITIALIZING
private static final byte	STAGE_UNINITIALIZED

Constructor Summary

Constructors

Modifier	Constructor	Description
private	ImmutableNSGA2Selection(int numberObjectives, Comparator<T> dominance, Comparator<Genotype> deduplicate, Function<Integer,Comparator<T>> objectiveComparator, ObjectiveDistance<T> distance)
private	ImmutableNSGA2Selection(int numberObjectives, Function<Integer,Comparator<T>> objectiveComparator, ObjectiveDistance<T> distance)
private	ImmutableNSGA2Selection(ImmutableNSGA2Selection.Builder<T> builder)

Method Summary

Modifier and Type	Method	Description
static <T extends Comparable<T>> NSGA2Selection<T>	copyOf(NSGA2Selection<T> instance)	Creates an immutable copy of a NSGA2Selection value.
Optional<Comparator<Genotype>>	deduplicate()	Comparator used for deduplication of solution prior to processing
ObjectiveDistance<T>	distance()	Define how to compute distances between fitness scores along their objectives
Comparator<T>	dominance()	Override the dominance operator.
boolean	equals(Object another)	This instance is equal to all instances of ImmutableNSGA2Selection that have equal attribute values.
private boolean	equalsByValue(ImmutableNSGA2Selection<?> another)
int	hashCode()	Computes a hash code from attributes: numberObjectives, dominance, deduplicate, objectiveComparator, distance.
int	numberObjectives()	Number of objectives
Function<Integer,Comparator<T>>	objectiveComparator()	Sort T based on the objective passed as a parameter
static <T extends Comparable<T>> NSGA2Selection<T>	of(int numberObjectives, Function<Integer,Comparator<T>> objectiveComparator, ObjectiveDistance<T> distance)	Construct a new immutable NSGA2Selection instance.
String	toString()	Prints the immutable value NSGA2Selection with attribute values.
final ImmutableNSGA2Selection<T>	withDeduplicate(Comparator<Genotype> value)	Copy the current immutable object by setting a present value for the optional deduplicate attribute.
final ImmutableNSGA2Selection<T>	withDeduplicate(Optional<? extends Comparator<Genotype>> optional)	Copy the current immutable object by setting an optional value for the deduplicate attribute.
final ImmutableNSGA2Selection<T>	withDistance(ObjectiveDistance<T> value)	Copy the current immutable object by setting a value for the distance attribute.
final ImmutableNSGA2Selection<T>	withDominance(Comparator<T> value)	Copy the current immutable object by setting a value for the dominance attribute.
final ImmutableNSGA2Selection<T>	withNumberObjectives(int value)	Copy the current immutable object by setting a value for the numberObjectives attribute.
final ImmutableNSGA2Selection<T>	withObjectiveComparator(Function<Integer,Comparator<T>> value)	Copy the current immutable object by setting a value for the objectiveComparator attribute.

Methods inherited from class net.bmahe.genetics4j.moo.nsga2.spec.NSGA2Selection

builder, ofFitnessVector, ofFitnessVector

Methods inherited from class java.lang.Object

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

Field Details

numberObjectives

private final int numberObjectives

dominance

private final Comparator<T extends Comparable<T>> dominance

deduplicate

private final Comparator<Genotype> deduplicate

objectiveComparator

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

distance

private final ObjectiveDistance<T extends Comparable<T>> distance

STAGE_INITIALIZING

private static final byte STAGE_INITIALIZING

See Also:

• Constant Field Values

STAGE_UNINITIALIZED

private static final byte STAGE_UNINITIALIZED

See Also:

• Constant Field Values

STAGE_INITIALIZED

private static final byte STAGE_INITIALIZED

See Also:

• Constant Field Values

initShim

private transient volatile ImmutableNSGA2Selection<T extends Comparable<T>>.InitShim initShim

Constructor Details

ImmutableNSGA2Selection

private ImmutableNSGA2Selection(int numberObjectives,
 Function<Integer,Comparator<T>> objectiveComparator,
 ObjectiveDistance<T> distance)

ImmutableNSGA2Selection

private ImmutableNSGA2Selection(ImmutableNSGA2Selection.Builder<T> builder)

ImmutableNSGA2Selection

private ImmutableNSGA2Selection(int numberObjectives,
 Comparator<T> dominance,
 Comparator<Genotype> deduplicate,
 Function<Integer,Comparator<T>> objectiveComparator,
 ObjectiveDistance<T> distance)

Method Details

numberObjectives

public int numberObjectives()

Number of objectives

Specified by:

numberObjectives in class NSGA2Selection<T extends Comparable<T>>

Returns:

dominance

public Comparator<T> dominance()

Override the dominance operator.

If not specified, it assumes the default comparator conforms to the Pareto dominance relation

Overrides:

dominance in class NSGA2Selection<T extends Comparable<T>>

Returns:

deduplicate

public Optional<Comparator<Genotype>> deduplicate()

Comparator used for deduplication of solution prior to processing

If not specified, it defaults to not do any deduplication

Overrides:

deduplicate in class NSGA2Selection<T extends Comparable<T>>

Returns:

objectiveComparator

public Function<Integer,Comparator<T>> objectiveComparator()

Sort T based on the objective passed as a parameter

Specified by:

objectiveComparator in class NSGA2Selection<T extends Comparable<T>>

Returns:

distance

public ObjectiveDistance<T> distance()

Define how to compute distances between fitness scores along their objectives

Specified by:

distance in class NSGA2Selection<T extends Comparable<T>>

Returns:

Distance computation method

withNumberObjectives

public final ImmutableNSGA2Selection<T> withNumberObjectives(int value)

Copy the current immutable object by setting a value for the numberObjectives attribute. A value equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for numberObjectives

Returns:

A modified copy or the this object

withDominance

public final ImmutableNSGA2Selection<T> withDominance(Comparator<T> value)

Copy the current immutable object by setting a value for the dominance attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for dominance

Returns:

A modified copy or the this object

withDeduplicate

public final ImmutableNSGA2Selection<T> withDeduplicate(Comparator<Genotype> value)

Copy the current immutable object by setting a present value for the optional deduplicate attribute.

Parameters:

value - The value for deduplicate

Returns:

A modified copy or this if not changed

withDeduplicate

public final ImmutableNSGA2Selection<T> withDeduplicate(Optional<? extends Comparator<Genotype>> optional)

Copy the current immutable object by setting an optional value for the deduplicate attribute. A shallow reference equality check is used on unboxed optional value to prevent copying of the same value by returning this.

Parameters:

optional - An optional value for deduplicate

Returns:

A modified copy or this if not changed

withObjectiveComparator

public final ImmutableNSGA2Selection<T> withObjectiveComparator(Function<Integer,Comparator<T>> value)

Copy the current immutable object by setting a value for the objectiveComparator attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for objectiveComparator

Returns:

A modified copy or the this object

withDistance

public final ImmutableNSGA2Selection<T> withDistance(ObjectiveDistance<T> value)

Copy the current immutable object by setting a value for the distance attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for distance

Returns:

A modified copy or the this object

equals

public boolean equals(Object another)

This instance is equal to all instances of ImmutableNSGA2Selection that have equal attribute values.

Overrides:

equals in class Object

Returns:

true if this is equal to another instance

equalsByValue

private boolean equalsByValue(ImmutableNSGA2Selection<?> another)

hashCode

public int hashCode()

Computes a hash code from attributes: numberObjectives, dominance, deduplicate, objectiveComparator, distance.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value NSGA2Selection with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

of

public static <T extends Comparable<T>>
NSGA2Selection<T> of(int numberObjectives,
 Function<Integer,Comparator<T>> objectiveComparator,
 ObjectiveDistance<T> distance)

Construct a new immutable NSGA2Selection instance.

Type Parameters:

T - generic parameter T

Parameters:

numberObjectives - The value for the numberObjectives attribute

objectiveComparator - The value for the objectiveComparator attribute

distance - The value for the distance attribute

Returns:

An immutable NSGA2Selection instance

copyOf

public static <T extends Comparable<T>>
NSGA2Selection<T> copyOf(NSGA2Selection<T> instance)

Creates an immutable copy of a NSGA2Selection value. Uses accessors to get values to initialize the new immutable instance. If an instance is already immutable, it is returned as is.

Type Parameters:

T - generic parameter T

Parameters:

instance - The instance to copy

Returns:

A copied immutable NSGA2Selection instance