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

Nested Class Summary

Nested classes/interfaces inherited from interface org.maxicp.modeling.ModelProxy

ModelProxy.NotConcreteException

Nested classes/interfaces inherited from interface org.maxicp.modeling.ModelProxyInstantiator

ModelProxyInstantiator.ModelInstantiator<T extends ConcreteModel>

Constructor Summary

Constructors

Constructor	Description
ModelDispatcher()

Method Summary

Modifier and Type	Method	Description
void	addVariableGroup(List<IntExpression> group)
<U extends Comparable<U>> BestFirstSearch<U>	bestFirstSearch(Supplier<Runnable[]> branching, Supplier<U> nodeEvaluator)
BoolVar	boolVar()
BoolVar[]	boolVarArray(int n)
void	close()
ConcurrentDFSearch	concurrentDFSearch(Supplier<SymbolicModel[]> symbolicBranching)
IntVar	constant(int value)
DFSearch	dfSearch(Supplier<Runnable[]> branching)
Iterable<Constraint>	getConstraints()	Shortcut for baseModel.getModel().getConstraints();
List<IntExpression>	getDecisionVariables()	Infers the decision variables from the constraint graph of the current model.
Model	getModel()
IntervalVar	intervalVar(boolean isPresent)
IntervalVar	intervalVar(int duration, boolean isPresent)
IntervalVar	intervalVar(int startMin, int endMax, int duration, boolean isPresent)
IntervalVar	intervalVar(int startMin, int startMax, int endMin, int endMax, int lengthMin, int lengthMax, boolean isPresent)
IntervalVar[]	intervalVarArray(int n, boolean present)
IntervalVar[]	intervalVarArray(int n, Function<Integer,IntervalVar> body)
IntVar	intVar(int[] values)
IntVar	intVar(int min, int max)
IntVar	intVar(String id, int[] values)
IntVar	intVar(String id, int min, int max)
IntVar	intVar(Set<Integer> values)
IntVar[]	intVarArray(int n, int domSize)	Create an array of n IntVars with domain between 0 and domSize-1, inclusive.
IntExpression[]	intVarArray(int n, Function<Integer,IntExpression> body)
Objective	maximize(Expression v)
Objective	minimize(Expression v)
SeqVar	seqVar(int nNode, int begin, int end)
<T extends Model> T	setModel(T m)	Set the current model to m. m should have this base model as origin.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.maxicp.modeling.ModelProxy

add, add, add, add, fixpoint, getConcreteModel, getSymbolicModel, isConcrete, isSymbolic, runWithModel, runWithModel

Methods inherited from interface org.maxicp.modeling.ModelProxyInstantiator

instantiate, runAsConcrete, runAsConcrete, runAsConcrete, runAsConcrete, runAsConcrete, runAsConcrete, runAsConcrete, runAsConcrete

Methods inherited from interface org.maxicp.cp.modeling.ModelProxyInstantiatorWithCP

cpInstantiate, runCP, runCP, runCP, runCP, runCP, runCP, runCP, runCP

Constructor Details

ModelDispatcher

public ModelDispatcher()

Method Details

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:

• DecisionVarCollector

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)

addVariableGroup

public void addVariableGroup(List<IntExpression> group)