Record Class ExcludesConstantValue

java.lang.Object
java.lang.Record
org.ek9lang.compiler.phase5.flow.ExcludesConstantValue
All Implemented Interfaces:
AbstractValue
public record ExcludesConstantValue(long excludedValue, boolean mayBeUnset) extends Record implements AbstractValue
Represents a variable known to hold any value except a specific constant.

Created by condition narrowing on the false branch of equality: when if x == 5 is not taken, the else branch narrows x to "anything except 5". This cannot be expressed as a contiguous range, so this lattice type fills the gap.

Only evaluates == and <>/!= conditions — all other operators return UNKNOWN because the excluded-constant does not carry range information.

  • Constructor Details

    • ExcludesConstantValue

      public ExcludesConstantValue(long excludedValue)
      An exclusion on a value that is known set.

    • ExcludesConstantValue

      public ExcludesConstantValue(long excludedValue, boolean mayBeUnset)
      Creates an instance of a ExcludesConstantValue record class.
      Parameters:
      excludedValue - the value for the excludedValue record component
      mayBeUnset - the value for the mayBeUnset record component

  • Method Details

    • join

      public AbstractValue join(AbstractValue other)
      Description copied from interface: AbstractValue
      Join this value with another at a branch convergence point. Returns the least upper bound of the two values. Every implementation delegates to LatticeJoin, THE join, so the result never depends on which of the two values is the receiver.

      Key rules:

      • BOTTOM join X = X (unreachable path is ignored)
      • X join BOTTOM = X
      • TOP join X = TOP
      • Constant(a) join Constant(a) = Constant(a) (both agree)
      • Constant(a) join Constant(b) = TOP (disagreement)
      Specified by:
      join in interface AbstractValue

    • evaluateCondition

      public ConditionResult evaluateCondition(String operator, AbstractValue operand)
      Description copied from interface: AbstractValue
      Evaluate whether this abstract value satisfies a comparison condition.
      Specified by:
      evaluateCondition in interface AbstractValue
      Parameters:
      operator - the comparison operator (==, <>, <, >, etc.)
      operand - the right-hand side value to compare against
      Returns:
      TRUE if condition is always satisfied, FALSE if never satisfied, UNKNOWN if indeterminate

    • isKnown

      public boolean isKnown()
      Description copied from interface: AbstractValue
      Check if this value represents a known state (not TOP and not BOTTOM).
      Specified by:
      isKnown in interface AbstractValue

    • isBottom

      public boolean isBottom()
      Description copied from interface: AbstractValue
      Check if this value represents an unreachable program point.
      Specified by:
      isBottom in interface AbstractValue

    • toString

      public 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 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.

    • excludedValue

      public long excludedValue()
      Returns the value of the excludedValue record component.
      Returns:
      the value of the excludedValue record component

    • mayBeUnset

      public boolean mayBeUnset()
      Returns the value of the mayBeUnset record component.
      Returns:
      the value of the mayBeUnset record component