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

Record Class AlwaysIn

java.lang.Object
java.lang.Record
org.maxicp.modeling.constraints.scheduling.AlwaysIn
Record Components:
expr - the cumulative function to constrain
minValue - the minimum allowed value of the function at any time point
maxValue - the maximum allowed value of the function at any time point
All Implemented Interfaces:
Constraint, org.maxicp.modeling.constraints.helpers.CacheScope, org.maxicp.modeling.constraints.helpers.ConstraintFromRecord
public record AlwaysIn(CumulFunction expr, int minValue, int maxValue) extends Record implements org.maxicp.modeling.constraints.helpers.ConstraintFromRecord
Constraint that enforces a CumulFunction to remain within bounds at every point overlapping the execution of at least one interval.

Specifically, for all time points t overlapping at least one interval: 

   minValue invalid input: '<'= expr(t) invalid input: '<'= maxValue

This is typically used in cumulative scheduling to enforce resource capacity limits, e.g. a resource that can handle at most maxValue concurrent tasks and must never drop below minValue (e.g. for inventory or stock constraints).

  • 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
    AlwaysIn(CumulFunction expr, int minValue, int maxValue)
    Creates an instance of a AlwaysIn record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    CumulFunction
    expr()
    Returns the value of the expr record component.
    final int
    hashCode()
    Returns a hash code value for this object.
    int
    maxValue()
    Returns the value of the maxValue record component.
    int
    minValue()
    Returns the value of the minValue record component.
    final String
    toString()
    Returns a string representation of this record class.

    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

    • AlwaysIn

      public AlwaysIn(CumulFunction expr, int minValue, int maxValue)
      Creates an instance of a AlwaysIn record class.
      Parameters:
      expr - the value for the expr record component
      minValue - the value for the minValue record component
      maxValue - the value for the maxValue record component

  • Method Details

    • 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      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.

    • expr

      public CumulFunction expr()
      Returns the value of the expr record component.
      Returns:
      the value of the expr record component

    • minValue

      public int minValue()
      Returns the value of the minValue record component.
      Returns:
      the value of the minValue record component

    • maxValue

      public int maxValue()
      Returns the value of the maxValue record component.
      Returns:
      the value of the maxValue record component