Module org.maxicp
Package org.maxicp.modeling.constraints

Record Class Table

java.lang.Object
java.lang.Record
org.maxicp.modeling.constraints.Table
Record Components:
x - the array of integer expressions
array - the table of allowed tuples
starred - optional wildcard value representing any value in a tuple
All Implemented Interfaces:
Constraint, org.maxicp.modeling.constraints.helpers.CacheScope, org.maxicp.modeling.constraints.helpers.ConstraintFromRecord, DecisionVarsProvider
public record Table(IntExpression[] x, int[][] array, Optional<Integer> starred) extends Record implements org.maxicp.modeling.constraints.helpers.ConstraintFromRecord, org.maxicp.modeling.constraints.helpers.CacheScope, DecisionVarsProvider
Positive table constraint ensuring that the tuple of values assigned to x belongs to the set of allowed tuples in array.

  • Nested Class Summary

    Nested classes/interfaces inherited from interface org.maxicp.modeling.constraints.helpers.ConstraintFromRecord

    org.maxicp.modeling.constraints.helpers.ConstraintFromRecord.IgnoreScope

  • Constructor Summary

    Constructors
    Constructor
    Description
    Table(IntExpression[] x, int[][] array)
    Creates a positive table constraint without wildcard values.
    Table(IntExpression[] x, int[][] array, Optional<Integer> starred)
    Creates an instance of a Table record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    int[][]
    array()
    Returns the value of the array record component.
    Collection<IntExpression>
    decisionVariables()
    Returns the sub-expressions of this node that should be considered decision variables (i.e., variables to branch on / freeze in LNS).
    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.
    Optional<Integer>
    starred()
    Returns the value of the starred record component.
    final String
    toString()
    Returns a string representation of this record class.
    IntExpression[]
    x()
    Returns the value of the x record component.

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.maxicp.modeling.constraints.helpers.CacheScope

    scope

    Methods inherited from interface org.maxicp.modeling.constraints.helpers.ConstraintFromRecord

    computeScope

  • Constructor Details

    • Table

      public Table(IntExpression[] x, int[][] array)
      Creates a positive table constraint without wildcard values.
      Parameters:
      x - the array of integer expressions
      array - the table of allowed tuples

    • Table

      public Table(IntExpression[] x, int[][] array, Optional<Integer> starred)
      Creates an instance of a Table record class.
      Parameters:
      x - the value for the x record component
      array - the value for the array record component
      starred - the value for the starred record component

  • Method Details

    • decisionVariables

      public Collection<IntExpression> decisionVariables()
      Description copied from interface: DecisionVarsProvider
      Returns the sub-expressions of this node that should be considered decision variables (i.e., variables to branch on / freeze in LNS).
      Specified by:
      decisionVariables in interface DecisionVarsProvider
      Returns:
      immutable collection of candidate decision variables; never null, may be empty

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

    • x

      public IntExpression[] x()
      Returns the value of the x record component.
      Returns:
      the value of the x record component

    • array

      public int[][] array()
      Returns the value of the array record component.
      Returns:
      the value of the array record component

    • starred

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