Package net.bmahe.genetics4j.core.postevaluationprocess

Class ImmutableFitnessSharing<T extends Comparable<T>>

java.lang.Object

net.bmahe.genetics4j.core.postevaluationprocess.FitnessSharing<T>

net.bmahe.genetics4j.core.postevaluationprocess.ImmutableFitnessSharing<T>

All Implemented Interfaces:

PostEvaluationProcessor<T>

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

Immutable implementation of FitnessSharing.

Use the builder to create immutable instances: ImmutableFitnessSharing.builder(). Use the static factory method to create immutable instances: ImmutableFitnessSharing.of().

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ImmutableFitnessSharing.Builder<T extends Comparable<T>>	Builds instances of type FitnessSharing.

Field Summary

Fields

Modifier and Type	Field	Description
private final BiFunction<Genotype,Genotype,Double>	distance
private final BiFunction<Individual<T>,Double,T>	scaleFitness
private final Function<Double,Double>	sharing

Constructor Summary

Constructors

Modifier	Constructor	Description
private	ImmutableFitnessSharing(BiFunction<Genotype,Genotype,Double> distance, Function<Double,Double> sharing, BiFunction<Individual<T>,Double,T> scaleFitness)
private	ImmutableFitnessSharing(ImmutableFitnessSharing<T> original, BiFunction<Genotype,Genotype,Double> distance, Function<Double,Double> sharing, BiFunction<Individual<T>,Double,T> scaleFitness)

Method Summary

Modifier and Type	Method	Description
static <T extends Comparable<T>> ImmutableFitnessSharing.Builder<T>	builder()	Creates a builder for FitnessSharing.
static <T extends Comparable<T>> FitnessSharing<T>	copyOf(FitnessSharing<T> instance)	Creates an immutable copy of a FitnessSharing value.
BiFunction<Genotype,Genotype,Double>	distance()
boolean	equals(Object another)	This instance is equal to all instances of ImmutableFitnessSharing that have equal attribute values.
private boolean	equalsByValue(ImmutableFitnessSharing<?> another)
int	hashCode()	Computes a hash code from attributes: distance, sharing, scaleFitness.
static <T extends Comparable<T>> FitnessSharing<T>	of(BiFunction<Genotype,Genotype,Double> distance, Function<Double,Double> sharing, BiFunction<Individual<T>,Double,T> scaleFitness)	Construct a new immutable FitnessSharing instance.
BiFunction<Individual<T>,Double,T>	scaleFitness()
Function<Double,Double>	sharing()
String	toString()	Prints the immutable value FitnessSharing with attribute values.
final ImmutableFitnessSharing<T>	withDistance(BiFunction<Genotype,Genotype,Double> value)	Copy the current immutable object by setting a value for the distance attribute.
final ImmutableFitnessSharing<T>	withScaleFitness(BiFunction<Individual<T>,Double,T> value)	Copy the current immutable object by setting a value for the scaleFitness attribute.
final ImmutableFitnessSharing<T>	withSharing(Function<Double,Double> value)	Copy the current immutable object by setting a value for the sharing attribute.

Methods inherited from class net.bmahe.genetics4j.core.postevaluationprocess.FitnessSharing

apply, of, ofFloatFitness, ofStandard, ofStandard

Methods inherited from class java.lang.Object

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

Field Details

distance

private final BiFunction<Genotype,Genotype,Double> distance

sharing

private final Function<Double,Double> sharing

scaleFitness

private final BiFunction<Individual<T extends Comparable<T>>,Double,T extends Comparable<T>> scaleFitness

Constructor Details

ImmutableFitnessSharing

private ImmutableFitnessSharing(BiFunction<Genotype,Genotype,Double> distance,
 Function<Double,Double> sharing,
 BiFunction<Individual<T>,Double,T> scaleFitness)

ImmutableFitnessSharing

private ImmutableFitnessSharing(ImmutableFitnessSharing<T> original,
 BiFunction<Genotype,Genotype,Double> distance,
 Function<Double,Double> sharing,
 BiFunction<Individual<T>,Double,T> scaleFitness)

Method Details

distance

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

Specified by:

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

Returns:

The value of the distance attribute

sharing

public Function<Double,Double> sharing()

Specified by:

sharing in class FitnessSharing<T extends Comparable<T>>

Returns:

The value of the sharing attribute

scaleFitness

public BiFunction<Individual<T>,Double,T> scaleFitness()

Specified by:

scaleFitness in class FitnessSharing<T extends Comparable<T>>

Returns:

The value of the scaleFitness attribute

withDistance

public final ImmutableFitnessSharing<T> withDistance(BiFunction<Genotype,Genotype,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

withSharing

public final ImmutableFitnessSharing<T> withSharing(Function<Double,Double> value)

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

Parameters:

value - A new value for sharing

Returns:

A modified copy or the this object

withScaleFitness

public final ImmutableFitnessSharing<T> withScaleFitness(BiFunction<Individual<T>,Double,T> value)

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

Parameters:

value - A new value for scaleFitness

Returns:

A modified copy or the this object

equals

public boolean equals(Object another)

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

Overrides:

equals in class Object

Returns:

true if this is equal to another instance

equalsByValue

private boolean equalsByValue(ImmutableFitnessSharing<?> another)

hashCode

public int hashCode()

Computes a hash code from attributes: distance, sharing, scaleFitness.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value FitnessSharing with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

of

public static <T extends Comparable<T>>
FitnessSharing<T> of(BiFunction<Genotype,Genotype,Double> distance,
 Function<Double,Double> sharing,
 BiFunction<Individual<T>,Double,T> scaleFitness)

Construct a new immutable FitnessSharing instance.

Type Parameters:

T - generic parameter T

Parameters:

distance - The value for the distance attribute

sharing - The value for the sharing attribute

scaleFitness - The value for the scaleFitness attribute

Returns:

An immutable FitnessSharing instance

copyOf

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

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

builder

public static <T extends Comparable<T>>
ImmutableFitnessSharing.Builder<T> builder()

Creates a builder for FitnessSharing.

 ImmutableFitnessSharing.<T>builder()
    .distance(function.BiFunction<net.bmahe.genetics4j.core.Genotype, net.bmahe.genetics4j.core.Genotype, Double>) // required distance
    .sharing(function.Function<Double, Double>) // required sharing
    .scaleFitness(function.BiFunction<net.bmahe.genetics4j.core.Individual<T>, Double, T>) // required scaleFitness
    .build();
 

Type Parameters:

T - generic parameter T

Returns:

A new FitnessSharing builder