Module com.darkcollective.relix.plan
Package com.darkcollective.relix.plan

Record Class PhysicalNode.Optimize

java.lang.Object
java.lang.Record
com.darkcollective.relix.plan.PhysicalNode.Optimize
All Implemented Interfaces:
PhysicalNode
Enclosing interface:
PhysicalNode
public static record PhysicalNode.Optimize(Schema schema, ObjectiveSense sense, Operand objective, List<OptimizeConstraint> constraints, List<String> groupingKeys, Optional<AllocationSpec> allocation, PhysicalNode input) extends Record implements PhysicalNode
Declarative optimisation (OPTIMIZE): within each group (by groupingKeys) either selects the optimal subset (MIP, when allocation is empty) or assigns continuous allocations (LP, when allocation is present).

MIP: emits chosen input rows unchanged; output schema equals input schema. LP: emits all input rows with the allocation value appended; output schema = input + 1 column.

  • Constructor Details

    • Optimize

      public Optimize(Schema schema, ObjectiveSense sense, Operand objective, List<OptimizeConstraint> constraints, List<String> groupingKeys, Optional<AllocationSpec> allocation, PhysicalNode input)
      Creates an instance of a Optimize record class.
      Parameters:
      schema - the value for the schema record component
      sense - the value for the sense record component
      objective - the value for the objective record component
      constraints - the value for the constraints record component
      groupingKeys - the value for the groupingKeys record component
      allocation - the value for the allocation record component
      input - the value for the input record component

  • Method Details

    • children

      public List<PhysicalNode> children()
      Description copied from interface: PhysicalNode
      Direct child plans, left-to-right; empty for a PhysicalNode.Scan.
      Specified by:
      children in interface PhysicalNode

    • 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. All components in this record class are compared with Objects::equals(Object,Object).
      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.

    • schema

      public Schema schema()
      Returns the value of the schema record component.
      Specified by:
      schema in interface PhysicalNode
      Returns:
      the value of the schema record component

    • sense

      public ObjectiveSense sense()
      Returns the value of the sense record component.
      Returns:
      the value of the sense record component

    • objective

      public Operand objective()
      Returns the value of the objective record component.
      Returns:
      the value of the objective record component

    • constraints

      public List<OptimizeConstraint> constraints()
      Returns the value of the constraints record component.
      Returns:
      the value of the constraints record component

    • groupingKeys

      public List<String> groupingKeys()
      Returns the value of the groupingKeys record component.
      Returns:
      the value of the groupingKeys record component

    • allocation

      public Optional<AllocationSpec> allocation()
      Returns the value of the allocation record component.
      Returns:
      the value of the allocation record component

    • input

      public PhysicalNode input()
      Returns the value of the input record component.
      Returns:
      the value of the input record component