Package net.bmahe.genetics4j.gp

Class ImmutableOperation<T>

java.lang.Object
net.bmahe.genetics4j.gp.Operation<T>
net.bmahe.genetics4j.gp.ImmutableOperation<T>
@Generated(from="Operation", generator="Immutables") @Generated("org.immutables.processor.ProxyProcessor") public final class ImmutableOperation<T> extends Operation<T>
Immutable implementation of Operation.

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

  • Field Details

    • name

      private final String name

    • acceptedTypes

      private final List<Class> acceptedTypes

    • returnedType

      private final Class returnedType

    • compute

      private final BiFunction<T[],Object[],Object> compute

    • prettyName

      private final String prettyName

  • Constructor Details

  • Method Details

    • getName

      public String getName()
      Returns the name of this operation.
      Specified by:
      getName in class Operation<T>
      Returns:
      the operation name, used for identification and display

    • acceptedTypes

      public List<Class> acceptedTypes()
      Returns the list of types that this operation accepts as arguments.

      For strongly-typed genetic programming, this defines the type constraints for each argument position. The list size determines the operation's arity.

      Specified by:
      acceptedTypes in class Operation<T>
      Returns:
      the list of accepted argument types, empty for terminals

    • returnedType

      public Class returnedType()
      Returns the type that this operation returns.
      Specified by:
      returnedType in class Operation<T>
      Returns:
      the return type of this operation

    • compute

      public BiFunction<T[],Object[],Object> compute()
      Returns the computation function for this operation.
      Specified by:
      compute in class Operation<T>
      Returns:
      a function that takes input arguments and parameters and returns the computed result

    • getPrettyName

      public String getPrettyName()
      Returns a human-readable name for this operation.

      By default, this returns the same value as getName(), but can be overridden to provide more descriptive names for display purposes.

      Overrides:
      getPrettyName in class Operation<T>
      Returns:
      the pretty name for display purposes

    • withName

      public final ImmutableOperation<T> withName(String value)
      Copy the current immutable object by setting a value for the name attribute. An equals check used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for name
      Returns:
      A modified copy or the this object

    • withAcceptedTypes

      public final ImmutableOperation<T> withAcceptedTypes(Class... elements)
      Copy the current immutable object with elements that replace the content of acceptedTypes.
      Parameters:
      elements - The elements to set
      Returns:
      A modified copy of this object

    • withAcceptedTypes

      public final ImmutableOperation<T> withAcceptedTypes(Iterable<? extends Class> elements)
      Copy the current immutable object with elements that replace the content of acceptedTypes. A shallow reference equality check is used to prevent copying of the same value by returning this.
      Parameters:
      elements - An iterable of acceptedTypes elements to set
      Returns:
      A modified copy or this if not changed

    • withReturnedType

      public final ImmutableOperation<T> withReturnedType(Class value)
      Copy the current immutable object by setting a value for the returnedType attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for returnedType
      Returns:
      A modified copy or the this object

    • withCompute

      public final ImmutableOperation<T> withCompute(BiFunction<T[],Object[],Object> value)
      Copy the current immutable object by setting a value for the compute attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for compute
      Returns:
      A modified copy or the this object

    • withPrettyName

      public final ImmutableOperation<T> withPrettyName(String value)
      Copy the current immutable object by setting a value for the prettyName attribute. An equals check used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for prettyName
      Returns:
      A modified copy or the this object

    • equals

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

    • equalsByValue

      private boolean equalsByValue(ImmutableOperation<?> another)

    • hashCode

      public int hashCode()
      Computes a hash code from attributes: name, acceptedTypes, returnedType, prettyName.
      Overrides:
      hashCode in class Object
      Returns:
      hashCode value

    • toString

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

    • of

      public static <T> Operation<T> of(String name, List<Class> acceptedTypes, Class returnedType, BiFunction<T[],Object[],Object> compute)
      Construct a new immutable Operation instance.
      Type Parameters:
      T - generic parameter T
      Parameters:
      name - The value for the name attribute
      acceptedTypes - The value for the acceptedTypes attribute
      returnedType - The value for the returnedType attribute
      compute - The value for the compute attribute
      Returns:
      An immutable Operation instance

    • of

      public static <T> Operation<T> of(String name, Iterable<? extends Class> acceptedTypes, Class returnedType, BiFunction<T[],Object[],Object> compute)
      Construct a new immutable Operation instance.
      Type Parameters:
      T - generic parameter T
      Parameters:
      name - The value for the name attribute
      acceptedTypes - The value for the acceptedTypes attribute
      returnedType - The value for the returnedType attribute
      compute - The value for the compute attribute
      Returns:
      An immutable Operation instance

    • copyOf

      public static <T> Operation<T> copyOf(Operation<T> instance)
      Creates an immutable copy of a Operation 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 Operation instance

    • builder

      public static <T> ImmutableOperation.Builder<T> builder()
      Creates a builder for Operation. 
       ImmutableOperation.<T>builder()
    .name(String) // required name
    .addAcceptedTypes|addAllAcceptedTypes(Class) // acceptedTypes elements
    .returnedType(Class) // required returnedType
    .compute(function.BiFunction<T[], Object[], Object>) // required compute
    .prettyName(String) // optional prettyName
    .build();
      Type Parameters:
      T - generic parameter T
      Returns:
      A new Operation builder

    • createSafeList

      private static <T> List<T> createSafeList(Iterable<? extends T> iterable, boolean checkNulls, boolean skipNulls)

    • createUnmodifiableList

      private static <T> List<T> createUnmodifiableList(boolean clone, List<? extends T> list)