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

Record Class PhysicalNode.Solve

java.lang.Object
java.lang.Record
com.darkcollective.relix.plan.PhysicalNode.Solve
All Implemented Interfaces:
PhysicalNode
Enclosing interface:
PhysicalNode
public static record PhysicalNode.Solve(Schema schema, List<SolveEquation> equations, List<String> groupingKeys, Optional<BigDecimal> tolerance, Optional<Integer> maxRounds, List<SolveStart> starts, PhysicalNode input) extends Record implements PhysicalNode
Goal-seek (SOLVE): for each row of input, fills the NULL columns participating in equations — one equation by inverting its arithmetic, several linear ones by elimination, anything else by Newton's method. With groupingKeys the input is buffered and the unknowns are fitted across each group by least squares. tolerance and maxRounds govern the iteration, empty for the engine's defaults, and starts says where it begins for the unknowns it names, every other unknown starting at 1. Rows that cannot be posed pass through unchanged. Output schema equals the input schema.

The equations are the planned form: every call to a user-defined function has been expanded into the arithmetic of its body.

  • Constructor Details

    • Solve

      public Solve(Schema schema, List<SolveEquation> equations, List<String> groupingKeys, Optional<BigDecimal> tolerance, Optional<Integer> maxRounds, List<SolveStart> starts, PhysicalNode input)
      Creates an instance of a Solve record class.
      Parameters:
      schema - the value for the schema record component
      equations - the value for the equations record component
      groupingKeys - the value for the groupingKeys record component
      tolerance - the value for the tolerance record component
      maxRounds - the value for the maxRounds record component
      starts - the value for the starts 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

    • equations

      public List<SolveEquation> equations()
      Returns the value of the equations record component.
      Returns:
      the value of the equations record component

    • groupingKeys

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

    • tolerance

      public Optional<BigDecimal> tolerance()
      Returns the value of the tolerance record component.
      Returns:
      the value of the tolerance record component

    • maxRounds

      public Optional<Integer> maxRounds()
      Returns the value of the maxRounds record component.
      Returns:
      the value of the maxRounds record component

    • starts

      public List<SolveStart> starts()
      Returns the value of the starts record component.
      Returns:
      the value of the starts record component

    • input

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