Class ArgMin

All Implemented Interfaces:
SatisfiedPresent

public class ArgMin extends Constraint implements SatisfiedPresent
ArgMin constraint provides the index of the maximum variable from all variables on the list.
Version:
4.9
  • Field Details

    • idNumber

      static final AtomicInteger idNumber
    • firstConsistencyCheck

      boolean firstConsistencyCheck
    • list

      public final IntVar[] list
      It specifies a list of variables among which a maximum value is being searched for.
    • minIndex

      public final IntVar minIndex
      It specifies variable max which stores the maximum value present in the list.
    • indexOffset

      public int indexOffset
      It specifies indexOffset within an element constraint list[index-indexOffset] = value.
  • Constructor Details

    • ArgMin

      public ArgMin(IntVar[] list, IntVar minIndex, int indexOffset)
      It constructs max constraint.
      Parameters:
      list - the array of variables for which the index of the maximum value is imposed.
      minIndex - variable denoting the index of the maximum value
      indexOffset - the offset for the index that is computed from 1 by default (if needed from 0, use -1 for this parameter)
    • ArgMin

      public ArgMin(IntVar[] list, IntVar minIndex)
    • ArgMin

      public ArgMin(List<? extends IntVar> variables, IntVar minIndex, int indexOffset)
      It constructs max constraint.
      Parameters:
      variables - the array of variables for which the minimum value is imposed.
      minIndex - variable denoting the index of minimum value
      indexOffset - the offset for the index that is computed from 1 by default (if needed from 0, use -1 for this parameter)
    • ArgMin

      public ArgMin(List<? extends IntVar> variables, IntVar minIndex)
  • Method Details

    • consistency

      public void consistency(Store store)
      Description copied from class: Constraint
      It is a (most probably incomplete) consistency function which removes the values from variables domains. Only values which do not have any support in a solution space are removed.
      Specified by:
      consistency in class Constraint
      Parameters:
      store - constraint store within which the constraint consistency is being checked.
    • getDefaultConsistencyPruningEvent

      public int getDefaultConsistencyPruningEvent()
      Specified by:
      getDefaultConsistencyPruningEvent in class Constraint
    • getConsistencyPruningEvent

      public int getConsistencyPruningEvent(Var var)
      Description copied from class: Constraint
      It retrieves the pruning event which causes reevaluation of the constraint.
      Overrides:
      getConsistencyPruningEvent in class Constraint
      Parameters:
      var - variable for which pruning event is retrieved
      Returns:
      it returns the int code of the pruning event (GROUND, BOUND, ANY, NONE)
    • satisfied

      public boolean satisfied()
      Description copied from interface: SatisfiedPresent
      It checks if the constraint is satisfied. It can return false even if constraint is satisfied but not all variables in its scope are grounded. It needs to return true if all variables in its scope are grounded and constraint is satisfied.

      Implementations of this interface for constraints that are not PrimitiveConstraint may require constraint imposition and consistency check as a requirement to work correctly.

      Specified by:
      satisfied in interface SatisfiedPresent
      Returns:
      true if constraint is possible to verify that it is satisfied.
    • toString

      public String toString()
      Description copied from class: Constraint
      It produces a string representation of a constraint state.
      Overrides:
      toString in class Constraint