Package pl.poznan.put.structure.pseudoknots.dp

Class ImmutableDynamicProgrammingAll

java.lang.Object
pl.poznan.put.structure.pseudoknots.dp.DynamicProgrammingAll
pl.poznan.put.structure.pseudoknots.dp.ImmutableDynamicProgrammingAll
All Implemented Interfaces:
PseudoknotFinder
@ParametersAreNonnullByDefault @Generated("org.immutables.processor.ProxyProcessor") @Immutable public final class ImmutableDynamicProgrammingAll extends DynamicProgrammingAll
Immutable implementation of DynamicProgrammingAll.

Use the builder to create immutable instances: ImmutableDynamicProgrammingAll.builder(). Use the static factory method to get the default singleton instance: ImmutableDynamicProgrammingAll.of().

  • Method Details

    • regionRemover

      protected Optional<RegionRemover> regionRemover()
      Specified by:
      regionRemover in class DynamicProgrammingAll
      Returns:
      An optional region remover to be used if a clique size exceeds maxCliqueSize().

    • maxCliqueSize

      protected int maxCliqueSize()
      Overrides:
      maxCliqueSize in class DynamicProgrammingAll
      Returns:
      The maximum number of conflicts allowed to be in the clique. The algorithm slows down very much when the cliques are getting bigger, so it is advisable to use a heuristic to remove a single regions and decrease clique size significantly.

    • withRegionRemover

      public final ImmutableDynamicProgrammingAll withRegionRemover(RegionRemover value)
      Copy the current immutable object by setting a present value for the optional regionRemover attribute.
      Parameters:
      value - The value for regionRemover
      Returns:
      A modified copy of this object

    • withRegionRemover

      public final ImmutableDynamicProgrammingAll withRegionRemover(Optional<? extends RegionRemover> optional)
      Copy the current immutable object by setting an optional value for the regionRemover attribute. A shallow reference equality check is used on unboxed optional value to prevent copying of the same value by returning this.
      Parameters:
      optional - A value for regionRemover
      Returns:
      A modified copy of this object

    • withMaxCliqueSize

      public final ImmutableDynamicProgrammingAll withMaxCliqueSize(int value)
      Copy the current immutable object by setting a value for the maxCliqueSize attribute. A value equality check is used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for maxCliqueSize
      Returns:
      A modified copy of the this object

    • equals

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

    • hashCode

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

    • toString

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

    • of

      public static ImmutableDynamicProgrammingAll of()
      Returns the default immutable singleton value of DynamicProgrammingAll
      Returns:
      An immutable instance of DynamicProgrammingAll

    • copyOf

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

    • builder

      public static ImmutableDynamicProgrammingAll.Builder builder()
      Creates a builder for ImmutableDynamicProgrammingAll. 
       ImmutableDynamicProgrammingAll.builder()
    .regionRemover(pl.poznan.put.structure.pseudoknots.elimination.RegionRemover) // optional regionRemover
    .maxCliqueSize(int) // optional maxCliqueSize
    .build();
      Returns:
      A new ImmutableDynamicProgrammingAll builder