Package net.bmahe.genetics4j.moo.spea2.spec.replacement

Class ImmutableSPEA2Replacement<T extends Comparable<T>>

java.lang.Object

net.bmahe.genetics4j.moo.spea2.spec.replacement.SPEA2Replacement<T>

net.bmahe.genetics4j.moo.spea2.spec.replacement.ImmutableSPEA2Replacement<T>

All Implemented Interfaces:

ReplacementStrategy

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

Immutable implementation of SPEA2Replacement.

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

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
private final Comparator<Genotype>	deduplicate
private final BiFunction<T,T,Double>	distance
private final Comparator<T>	dominance
private ImmutableSPEA2Replacement<T>.InitShim	initShim
private final Integer	k
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	ImmutableSPEA2Replacement(Comparator<T> dominance, Comparator<Genotype> deduplicate, Integer k, BiFunction<T,T,Double> distance)
private	ImmutableSPEA2Replacement(BiFunction<T,T,Double> distance)
private	ImmutableSPEA2Replacement(ImmutableSPEA2Replacement.Builder<T> builder)

Method Summary

Modifier and Type	Method	Description
static <T extends Comparable<T>> SPEA2Replacement<T>	copyOf(SPEA2Replacement<T> instance)	Creates an immutable copy of a SPEA2Replacement value.
Optional<Comparator<Genotype>>	deduplicate()	Comparator used for deduplication of solution prior to processing
BiFunction<T,T,Double>	distance()	Define how to compute distances in objective space between two solutions
Comparator<T>	dominance()	Defines the Pareto dominance relation
boolean	equals(Object another)	This instance is equal to all instances of ImmutableSPEA2Replacement that have equal attribute values.
private boolean	equalsByValue(ImmutableSPEA2Replacement<?> another)
int	hashCode()	Computes a hash code from attributes: dominance, deduplicate, k, distance.
Optional<Integer>	k()	Determine the k-nearest distance to compute.
static <T extends Comparable<T>> SPEA2Replacement<T>	of(BiFunction<T,T,Double> distance)	Construct a new immutable SPEA2Replacement instance.
String	toString()	Prints the immutable value SPEA2Replacement with attribute values.
final ImmutableSPEA2Replacement<T>	withDeduplicate(Comparator<Genotype> value)	Copy the current immutable object by setting a present value for the optional deduplicate attribute.
final ImmutableSPEA2Replacement<T>	withDeduplicate(Optional<? extends Comparator<Genotype>> optional)	Copy the current immutable object by setting an optional value for the deduplicate attribute.
final ImmutableSPEA2Replacement<T>	withDistance(BiFunction<T,T,Double> value)	Copy the current immutable object by setting a value for the distance attribute.
final ImmutableSPEA2Replacement<T>	withDominance(Comparator<T> value)	Copy the current immutable object by setting a value for the dominance attribute.
final ImmutableSPEA2Replacement<T>	withK(int value)	Copy the current immutable object by setting a present value for the optional k attribute.
final ImmutableSPEA2Replacement<T>	withK(Optional<Integer> optional)	Copy the current immutable object by setting an optional value for the k attribute.

Methods inherited from class net.bmahe.genetics4j.moo.spea2.spec.replacement.SPEA2Replacement

builder, ofFitnessVector, ofFitnessVector

Methods inherited from class java.lang.Object

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

Field Details

dominance

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

deduplicate

private final Comparator<Genotype> deduplicate

k

private final Integer k

distance

private final BiFunction<T extends Comparable<T>,T extends Comparable<T>,Double> 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 ImmutableSPEA2Replacement<T extends Comparable<T>>.InitShim initShim

Constructor Details

ImmutableSPEA2Replacement

private ImmutableSPEA2Replacement(BiFunction<T,T,Double> distance)

ImmutableSPEA2Replacement

private ImmutableSPEA2Replacement(ImmutableSPEA2Replacement.Builder<T> builder)

ImmutableSPEA2Replacement

private ImmutableSPEA2Replacement(Comparator<T> dominance,
 Comparator<Genotype> deduplicate,
 Integer k,
 BiFunction<T,T,Double> distance)

Method Details

dominance

public Comparator<T> dominance()

Defines the Pareto dominance relation

Overrides:

dominance in class SPEA2Replacement<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 SPEA2Replacement<T extends Comparable<T>>

Returns:

k

public Optional<Integer> k()

Determine the k-nearest distance to compute.

It will default to sqrt(|archive| + |population|)

Overrides:

k in class SPEA2Replacement<T extends Comparable<T>>

Returns:

distance

public BiFunction<T,T,Double> distance()

Define how to compute distances in objective space between two solutions

Specified by:

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

Returns:

Distance

withDominance

public final ImmutableSPEA2Replacement<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 ImmutableSPEA2Replacement<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 ImmutableSPEA2Replacement<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

withK

public final ImmutableSPEA2Replacement<T> withK(int value)

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

Parameters:

value - The value for k

Returns:

A modified copy or this if not changed

withK

public final ImmutableSPEA2Replacement<T> withK(Optional<Integer> optional)

Copy the current immutable object by setting an optional value for the k attribute. An equality check is used on inner value to prevent copying of the same value by returning this.

Parameters:

optional - An optional value for k

Returns:

A modified copy or this if not changed

withDistance

public final ImmutableSPEA2Replacement<T> withDistance(BiFunction<T,T,Double> 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 ImmutableSPEA2Replacement that have equal attribute values.

Overrides:

equals in class Object

Returns:

true if this is equal to another instance

equalsByValue

private boolean equalsByValue(ImmutableSPEA2Replacement<?> another)

hashCode

public int hashCode()

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

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value SPEA2Replacement with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

of

public static <T extends Comparable<T>>
SPEA2Replacement<T> of(BiFunction<T,T,Double> distance)

Construct a new immutable SPEA2Replacement instance.

Type Parameters:

T - generic parameter T

Parameters:

distance - The value for the distance attribute

Returns:

An immutable SPEA2Replacement instance

copyOf

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

Creates an immutable copy of a SPEA2Replacement 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 SPEA2Replacement instance