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

Record Class Cumulative

java.lang.Object
java.lang.Record
org.maxicp.modeling.constraints.Cumulative
Record Components:
start - the start time expressions of the activities
duration - the duration expressions of the activities
end - the end time expressions of the activities (or empty if not explicitly provided)
demand - the resource demand expressions of the activities
capa - the resource capacity expression
All Implemented Interfaces:
Constraint, org.maxicp.modeling.constraints.helpers.CacheScope, org.maxicp.modeling.constraints.helpers.ConstraintFromRecord, DecisionVarsProvider
public record Cumulative(IntExpression[] start, IntExpression[] duration, IntExpression[] end, IntExpression[] demand, IntExpression capa) extends Record implements org.maxicp.modeling.constraints.helpers.ConstraintFromRecord, DecisionVarsProvider
Cumulative scheduling constraint ensuring that at any point in time, the total resource demand of overlapping activities does not exceed the resource capacity capa.

  • 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
    Cumulative(IntExpression[] start, int[] duration, int[] demand, int capa)
    Creates a Cumulative constraint with constant durations, demands, and capacity.
    Cumulative(IntExpression[] start, IntExpression[] duration, IntExpression[] end, IntExpression[] demand, IntExpression capa)
    Creates an instance of a Cumulative record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    IntExpression
    capa()
    Returns the value of the capa 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).
    IntExpression[]
    demand()
    Returns the value of the demand record component.
    IntExpression[]
    duration()
    Returns the value of the duration record component.
    IntExpression[]
    end()
    Returns the value of the end record component.
    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.
    IntExpression[]
    start()
    Returns the value of the start 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

    • Cumulative

      public Cumulative(IntExpression[] start, IntExpression[] duration, IntExpression[] end, IntExpression[] demand, IntExpression capa)
      Creates an instance of a Cumulative record class.
      Parameters:
      start - the value for the start record component
      duration - the value for the duration record component
      end - the value for the end record component
      demand - the value for the demand record component
      capa - the value for the capa record component

    • Cumulative

      public Cumulative(IntExpression[] start, int[] duration, int[] demand, int capa)
      Creates a Cumulative constraint with constant durations, demands, and capacity.
      Parameters:
      start - the start time expressions of the activities
      duration - the durations of the activities
      demand - the resource demands of the activities
      capa - the resource capacity

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

    • start

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

    • duration

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

    • end

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

    • demand

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

    • capa

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