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

Record Class Among

java.lang.Object
java.lang.Record
org.maxicp.modeling.constraints.Among
Record Components:
x - the array of integer expressions
values - the set of target values
count - the expression representing the number of expressions in x taking a value in values
All Implemented Interfaces:
Constraint, org.maxicp.modeling.constraints.helpers.CacheScope, org.maxicp.modeling.constraints.helpers.ConstraintFromRecord, DecisionVarsProvider
public record Among(IntExpression[] x, Set<Integer> values, IntExpression count) extends Record implements org.maxicp.modeling.constraints.helpers.ConstraintFromRecord, DecisionVarsProvider
Among constraint ensuring that exactly count expressions in x take a value in values.

  • 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
    Among(IntExpression[] x, Set<Integer> values, IntExpression count)
    Creates an instance of a Among record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    IntExpression
    count()
    Returns the value of the count 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.
    final String
    toString()
    Returns a string representation of this record class.
    Set<Integer>
    values()
    Returns the value of the values record component.
    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

    • Among

      public Among(IntExpression[] x, Set<Integer> values, IntExpression count)
      Creates an instance of a Among record class.
      Parameters:
      x - the value for the x record component
      values - the value for the values record component
      count - the value for the count 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

    • values

      public Set<Integer> values()
      Returns the value of the values record component.
      Returns:
      the value of the values record component

    • count

      public IntExpression count()
      Returns the value of the count record component.
      Returns:
      the value of the count record component