Package net.bmahe.genetics4j.core.spec.mutation

Class ImmutableRandomMutation

java.lang.Object
net.bmahe.genetics4j.core.spec.mutation.RandomMutation
net.bmahe.genetics4j.core.spec.mutation.ImmutableRandomMutation
All Implemented Interfaces:
MutationPolicy
@Generated("org.immutables.processor.ProxyProcessor") public final class ImmutableRandomMutation extends RandomMutation
Immutable implementation of RandomMutation.

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

  • Field Details

    • populationMutationProbability

      private final double populationMutationProbability

  • Constructor Details

    • ImmutableRandomMutation

      private ImmutableRandomMutation(double populationMutationProbability)

  • Method Details

    • populationMutationProbability

      public double populationMutationProbability()
      Specified by:
      populationMutationProbability in class RandomMutation
      Returns:
      The value of the populationMutationProbability attribute

    • withPopulationMutationProbability

      public final ImmutableRandomMutation withPopulationMutationProbability(double value)
      Copy the current immutable object by setting a value for the populationMutationProbability attribute. A value strict bits equality used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for populationMutationProbability
      Returns:
      A modified copy of the this object

    • equals

      public boolean equals(Object another)
      This instance is equal to all instances of ImmutableRandomMutation that have equal attribute values.
      Overrides:
      equals in class Object
      Returns:
      true if this is equal to another instance

    • equalTo

      private boolean equalTo(int synthetic, ImmutableRandomMutation another)

    • hashCode

      public int hashCode()
      Computes a hash code from attributes: populationMutationProbability.
      Overrides:
      hashCode in class Object
      Returns:
      hashCode value

    • toString

      public String toString()
      Prints the immutable value RandomMutation with attribute values.
      Overrides:
      toString in class Object
      Returns:
      A string representation of the value

    • of

      public static ImmutableRandomMutation of(double populationMutationProbability)
      Construct a new immutable RandomMutation instance.
      Parameters:
      populationMutationProbability - The value for the populationMutationProbability attribute
      Returns:
      An immutable RandomMutation instance

    • validate

      private static ImmutableRandomMutation validate(ImmutableRandomMutation instance)

    • copyOf

      public static ImmutableRandomMutation copyOf(RandomMutation instance)
      Creates an immutable copy of a RandomMutation value. Uses accessors to get values to initialize the new immutable instance. If an instance is already immutable, it is returned as is.
      Parameters:
      instance - The instance to copy
      Returns:
      A copied immutable RandomMutation instance

    • builder

      public static ImmutableRandomMutation.Builder builder()
      Creates a builder for ImmutableRandomMutation. 
       ImmutableRandomMutation.builder()
    .populationMutationProbability(double) // required populationMutationProbability
    .build();
      Returns:
      A new ImmutableRandomMutation builder