Module org.maxicp
Package org.maxicp.cp.engine.constraints.scheduling

Record Class CPMinusCumulFunction

java.lang.Object
java.lang.Record
org.maxicp.cp.engine.constraints.scheduling.CPMinusCumulFunction
All Implemented Interfaces:
CPCumulFunction, CumulFunction
public record CPMinusCumulFunction(CPCumulFunction left, CPCumulFunction right) extends Record implements CPCumulFunction
CP implementation of a Minus Cumulative Function
Author:
Pierre Schaus, Charles Thomas, Augustin Delecluse

  • Constructor Details

    • CPMinusCumulFunction

      public CPMinusCumulFunction(CPCumulFunction left, CPCumulFunction right)
      Creates an instance of a CPMinusCumulFunction record class.
      Parameters:
      left - the value for the left record component
      right - the value for the right record component

  • Method Details

    • flatten

      public List<Activity> flatten(boolean positive)
      Description copied from interface: CPCumulFunction
      Returns a list of all the activities contributing to this cumulative function. Transformations are applied to the activities following the internal AST of the cumul function.
      Specified by:
      flatten in interface CPCumulFunction
      Parameters:
      positive - A boolean indicating the sign to be applied when flattening the cumul function
      Returns:
      A list of all the flattened activities contributing to this cumulative function.

    • inScope

      public boolean inScope(IntervalVar interval)
      Description copied from interface: CumulFunction
      Returns whether the interval var given in parameter contributes to the cumul function
      Specified by:
      inScope in interface CPCumulFunction
      Specified by:
      inScope in interface CumulFunction
      Parameters:
      interval - an IntervalVar
      Returns:
      a boolean that indicates if interval contributes to the cumul function.

    • heightAtStart

      public CPIntVar heightAtStart(IntervalVar interval)
      Description copied from interface: CumulFunction
      Returns an IntExpression representing the height of the cumul function at the start of the interval variable given in parameter.
      Specified by:
      heightAtStart in interface CPCumulFunction
      Specified by:
      heightAtStart in interface CumulFunction
      Parameters:
      interval - an IntervalVar
      Returns:
      an int expression representing the height of the cumul function at the start of interval

    • heightAtEnd

      public CPIntVar heightAtEnd(IntervalVar interval)
      Description copied from interface: CumulFunction
      Returns an IntExpression representing the height of the cumul function at the end of the interval variable given in parameter.
      Specified by:
      heightAtEnd in interface CPCumulFunction
      Specified by:
      heightAtEnd in interface CumulFunction
      Parameters:
      interval - an IntervalVar
      Returns:
      an int expression representing the height of the cumul function at the end of interval

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

    • left

      public CPCumulFunction left()
      Returns the value of the left record component.
      Returns:
      the value of the left record component

    • right

      public CPCumulFunction right()
      Returns the value of the right record component.
      Returns:
      the value of the right record component