Record Class Knapsack.KnapsackResult

java.lang.Object
java.lang.Record
io.openml.gearbox.algorithms.Knapsack.KnapsackResult
Enclosing class:
Knapsack
public static record Knapsack.KnapsackResult(int maxValue, List<Integer> packedItemIndices, int totalWeight) extends Record
A record to hold the result of the Knapsack.knapsack(List, List, int) calculation as concise way to create immutable data carrier classes.

  • Constructor Summary

    Constructors
    Constructor
    Description
    KnapsackResult(int maxValue, List<Integer> packedItemIndices, int totalWeight)
    Creates an instance of a KnapsackResult record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    int
    maxValue()
    Returns the value of the maxValue record component.
    List<Integer>
    packedItemIndices()
    Returns the value of the packedItemIndices record component.
    final String
    toString()
    Returns a string representation of this record class.
    int
    totalWeight()
    Returns the value of the totalWeight record component.

    Methods inherited from class Object

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

  • Constructor Details

    • KnapsackResult

      public KnapsackResult(int maxValue, List<Integer> packedItemIndices, int totalWeight)
      Creates an instance of a KnapsackResult record class.
      Parameters:
      maxValue - the value for the maxValue record component
      packedItemIndices - the value for the packedItemIndices record component
      totalWeight - the value for the totalWeight record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • maxValue

      public int maxValue()
      Returns the value of the maxValue record component.
      Returns:
      the value of the maxValue record component

    • packedItemIndices

      public List<Integer> packedItemIndices()
      Returns the value of the packedItemIndices record component.
      Returns:
      the value of the packedItemIndices record component

    • totalWeight

      public int totalWeight()
      Returns the value of the totalWeight record component.
      Returns:
      the value of the totalWeight record component