Module org.maxicp
Package org.maxicp

Class ModelDispatcher

java.lang.Object
org.maxicp.ModelDispatcher
All Implemented Interfaces:
AutoCloseable, ModelProxyInstantiatorWithCP, ModelProxy, ModelProxyInstantiator
public class ModelDispatcher extends Object implements ModelProxyInstantiator, AutoCloseable, ModelProxyInstantiatorWithCP, ModelProxy
A class that allows to create symbolic models

  • Constructor Details

    • ModelDispatcher

      public ModelDispatcher()

    • ModelDispatcher

      public ModelDispatcher(boolean rawSolver)

  • Method Details

    • isRawSolver

      public boolean isRawSolver()

    • getModel

      public Model getModel()
      Specified by:
      getModel in interface ModelProxy
      Returns:
      the current model

    • setModel

      public <T extends Model> T setModel(T m)
      Set the current model to m. m should have this base model as origin.
      Specified by:
      setModel in interface ModelProxy
      Parameters:
      m -

    • getConstraints

      public Iterable<Constraint> getConstraints()
      Shortcut for baseModel.getModel().getConstraints();
      Returns:
      an iterable with all the constraints in the current model

    • getDecisionVariables

      public List<IntExpression> getDecisionVariables()
      Infers the decision variables from the constraint graph of the current model.

      A variable is considered a decision variable when it appears as an "index / choice" argument in a constraint or expression that implements DecisionVarsProvider. Examples: the index variable of an Element1D/2D expression, or any variable in the scope of an AllDifferent, Circuit, Table, etc.

      Only leaf IntVar instances are returned – derived expressions (sums, element results, views) are always excluded.

      The returned list is ordered by first-seen occurrence during a depth-first walk of the constraint graph and contains no duplicates (identity-based).

      Returns:
      unmodifiable list of candidate decision variables
      See Also:

    • getIntervalVariables

      public List<IntervalVar> getIntervalVariables()
      Infers the interval variables from the constraint graph and variable registrations of the current model.
      Returns:
      unmodifiable list of interval variables

    • getRegisteredIntVars

      public List<IntVar> getRegisteredIntVars()
      Returns all non-constant IntVar instances created on this model dispatcher.

    • getRegisteredIntervalVars

      public List<IntervalVar> getRegisteredIntervalVars()
      Returns all IntervalVar instances created on this model dispatcher.

    • registerRawIntVar

      public <T extends IntVar> T registerRawIntVar(T v)

    • registerRawIntervalVar

      public <T extends IntervalVar> T registerRawIntervalVar(T v)

    • intVarArray

      public IntVar[] intVarArray(int n, int domSize)
      Create an array of n IntVars with domain between 0 and domSize-1, inclusive.
      Parameters:
      n - size of the array, number of IntVars
      domSize - size of the domains. Domains are [0, domsize-1]

    • intVarArray

      public IntExpression[] intVarArray(int n, Function<Integer,IntExpression> body)

    • intVar

      public IntVar intVar(int min, int max)

    • intVar

      public IntVar intVar(String id, int min, int max)

    • intVar

      public IntVar intVar(int[] values)

    • intVar

      public IntVar intVar(Set<Integer> values)

    • intVar

      public IntVar intVar(String id, int[] values)

    • constant

      public IntVar constant(int value)

    • intervalVar

      public IntervalVar intervalVar(int startMin, int startMax, int endMin, int endMax, int lengthMin, int lengthMax, boolean isPresent)

    • intervalVar

      public IntervalVar intervalVar(boolean isPresent)

    • intervalVar

      public IntervalVar intervalVar(int duration, boolean isPresent)

    • intervalVar

      public IntervalVar intervalVar(int startMin, int endMax, int duration, boolean isPresent)

    • intervalVarArray

      public IntervalVar[] intervalVarArray(int n, boolean present)

    • intervalVarArray

      public IntervalVar[] intervalVarArray(int n, Function<Integer,IntervalVar> body)

    • boolVarArray

      public BoolVar[] boolVarArray(int n)

    • boolVar

      public BoolVar boolVar()

    • seqVar

      public SeqVar seqVar(int nNode, int begin, int end)

    • close

      public void close() throws Exception
      Specified by:
      close in interface AutoCloseable
      Throws:
      Exception

    • minimize

      public Objective minimize(Expression v)

    • maximize

      public Objective maximize(Expression v)

    • dfSearch

      public DFSearch dfSearch(Supplier<Runnable[]> branching)

    • concurrentDFSearch

      public ConcurrentDFSearch concurrentDFSearch(Supplier<SymbolicModel[]> symbolicBranching)

    • bestFirstSearch

      public <U extends Comparable<U>> BestFirstSearch<U> bestFirstSearch(Supplier<Runnable[]> branching, Supplier<U> nodeEvaluator)

    • blackBoxSearch

      public BlackBoxSearch blackBoxSearch()
      Creates a black-box search that automatically discovers the model's decision variables (either IntervalVars for scheduling models or IntVars for combinatorial models).

    • blackBoxSearch

      public BlackBoxSearch blackBoxSearch(IntExpression... vars)
      Creates a black-box search over the specified integer decision variables.

    • blackBoxSearch

      public BlackBoxSearch blackBoxSearch(IntervalVar... intervals)
      Creates a black-box search over the specified interval variables.

    • blackBoxSearch

      public BlackBoxSearch blackBoxSearch(IntervalVar[][] intervals)
      Creates a black-box search over the specified 2D matrix of interval variables.

    • solve

      public SearchStatistics solve()
      Instantiates the model and solves it using black-box search.

    • solve

      public SearchStatistics solve(int timeLimitInSeconds)
      Instantiates the model and solves it using black-box search within the given time limit (in seconds).

    • solve

      public SearchStatistics solve(Predicate<SearchStatistics> limit)
      Instantiates the model and solves it using black-box search with a stopping predicate.

    • optimize

      public SearchStatistics optimize(Objective objective)
      Instantiates the model and optimizes the given objective using black-box search.

    • optimize

      public SearchStatistics optimize(Objective objective, int timeLimitInSeconds)
      Instantiates the model and optimizes the given objective using black-box search within the given time limit (in seconds).

    • optimize

      public SearchStatistics optimize(Objective objective, Predicate<SearchStatistics> limit)
      Instantiates the model and optimizes the given objective using black-box search with a stopping predicate.

    • addVariableGroup

      public void addVariableGroup(List<IntExpression> group)