public abstract static class IloCP.IntParam
extends java.lang.Object
IloCP parameters.| Modifier and Type | Field and Description |
|---|---|
static IloCP.IntParam |
AllDiffInferenceLevel
Integer control parameter.
|
static IloCP.IntParam |
AllMinDistanceInferenceLevel
Integer control parameter.
|
static IloCP.IntParam |
BranchLimit
Integer control parameter.
|
static IloCP.IntParam |
ChoicePointLimit
Integer control parameter.
|
static IloCP.IntParam |
ConflictRefinerBranchLimit
This parameter limits the total number of branches that are made before
terminating the conflict refiner.
|
static IloCP.IntParam |
ConflictRefinerFailLimit
This parameter limits the total number of failures that can occur before
terminating the conflict refiner.
|
static IloCP.IntParam |
ConflictRefinerIterationLimit
This parameter limits the number of iterations that are made before
terminating the conflict refiner.
|
static IloCP.IntParam |
ConflictRefinerOnVariables
This parameter specifies whether the conflict refiner should refine variables
domains.
|
static IloCP.IntParam |
CountDifferentInferenceLevel
Integer control parameter.
|
static IloCP.IntParam |
CountInferenceLevel
Integer control parameter.
|
static IloCP.IntParam |
CumulFunctionInferenceLevel
Integer control parameter.
|
static IloCP.IntParam |
DefaultInferenceLevel
Integer control parameter.
|
static IloCP.IntParam |
DistributeInferenceLevel
Integer control parameter.
|
static IloCP.IntParam |
DynamicProbing
Integer control parameter.
|
static IloCP.IntParam |
ElementInferenceLevel
Integer control parameter.
|
static IloCP.IntParam |
FailLimit
Integer control parameter.
|
static IloCP.IntParam |
FailureDirectedSearch
This parameter controls usage of failure-directed search.
|
static IloCP.IntParam |
FailureDirectedSearchMaxMemory
This parameter controls the maximum amount of memory (in bytes)
available to failure-directed search.
|
static IloCP.IntParam |
IntervalSequenceInferenceLevel
Integer control parameter.
|
static IloCP.IntParam |
KPIDisplay
Integer control parameter that determines how KPIs are displayed during the search.
|
static IloCP.IntParam |
LogPeriod
Integer control parameter.
|
static IloCP.IntParam |
LogSearchTags
Integer control parameter.
|
static IloCP.IntParam |
LogVerbosity
Integer control parameter.
|
static IloCP.IntParam |
ModelAnonymizer
This parameter controls anonymization of a model
dumped via
dumpModel. |
static IloCP.IntParam |
MultiPointNumberOfSearchPoints
Integer control parameter.
|
static IloCP.IntParam |
NoOverlapInferenceLevel
Integer control parameter.
|
static IloCP.IntParam |
ParallelSynchronizationSolutionCapacity |
static IloCP.IntParam |
PrecedenceInferenceLevel
Integer control parameter.
|
static IloCP.IntParam |
Presolve
Integer control parameter.
|
static IloCP.IntParam |
PrintModelDetailsInMessages
Whenever CP Optimizer prints an error or warning message, it can also
print the relevant part of the input model (in CPO file format).
|
static IloCP.IntParam |
RandomSeed
Integer control parameter.
|
static IloCP.IntParam |
RestartFailLimit
Integer control parameter.
|
static IloCP.IntParam |
SearchType
Integer control parameter.
|
static IloCP.IntParam |
SequenceInferenceLevel
Integer control parameter.
|
static IloCP.IntParam |
SolutionLimit
Integer control parameter.
|
static IloCP.IntParam |
StateFunctionInferenceLevel
Integer control parameter.
|
static IloCP.IntParam |
TemporalRelaxation
Integer control parameter.
|
static IloCP.IntParam |
TimeMode
Integer control parameter.
|
static IloCP.IntParam |
UseFileLocations
This parameter controls whether CP Optimizer processes file locations.
|
static IloCP.IntParam |
WarningLevel
This parameter controls the level of warnings issued by CP
Optimizer when a solve is launched.
|
static IloCP.IntParam |
Workers
Integer control parameter.
|
| Constructor and Description |
|---|
IloCP.IntParam() |
| Modifier and Type | Method and Description |
|---|---|
abstract int |
getValue() |
public static final IloCP.IntParam DefaultInferenceLevel
IloCP.ParameterValues.Default. Possible values for this parameter (in increasing order of inference strength) are
IloCP.ParameterValues.Low, IloCP.ParameterValues.Basic, IloCP.ParameterValues.Medium, and
IloCP.ParameterValues.Extended. The default value is IloCP.ParameterValues.Basic.public static final IloCP.IntParam AllDiffInferenceLevel
IloAllDiff constraint extracted to the invoking
IloCP instance. Possible values for this parameter are IloCP.ParameterValues.Default,
IloCP.ParameterValues.Low, IloCP.ParameterValues.Basic, IloCP.ParameterValues.Medium, and
IloCP.ParameterValues.Extended. The default value is IloCP.ParameterValues.Default, which allows the inference
strength of all IloAllDiff constraints to be controlled via IloCP.ParameterValues.DefaultInferenceLevel.public static final IloCP.IntParam DistributeInferenceLevel
IloDistribute constraint extracted to the invoking
IloCP instance. Possible values for this parameter are IloCP.ParameterValues.Default,
IloCP.ParameterValues.Low, IloCP.ParameterValues.Basic, IloCP.ParameterValues.Medium, and
IloCP.ParameterValues.Extended. The default value is IloCP.ParameterValues.Default, which allows the inference
strength of all IloDistribute constraints to be controlled via IloCP.ParameterValues.DefaultInferenceLevel.public static final IloCP.IntParam CountInferenceLevel
IloCount constraint extracted to the invoking
IloCP instance. Possible values for this parameter are IloCP.ParameterValues.Default,
IloCP.ParameterValues.Low, IloCP.ParameterValues.Basic, IloCP.ParameterValues.Medium, and
IloCP.ParameterValues.Extended. The default value is IloCP.ParameterValues.Default, which allows the inference
strength of all IloCount constraints to be controlled via IloCP.ParameterValues.DefaultInferenceLevel.public static final IloCP.IntParam SequenceInferenceLevel
IloSequence constraint extracted to the invoking
IloCP instance. Possible values for this parameter are IloCP.ParameterValues.Default,
IloCP.ParameterValues.Low, IloCP.ParameterValues.Basic, IloCP.ParameterValues.Medium, and
IloCP.ParameterValues.Extended. The default value is IloCP.ParameterValues.Default, which allows the inference
strength of all IloSequence constraints to be controlled via IloCP.ParameterValues.DefaultInferenceLevel.public static final IloCP.IntParam AllMinDistanceInferenceLevel
IloAllMinDistance constraint extracted to the invoking
IloCP instance. Possible values for this parameter are IloCP.ParameterValues.Default,
IloCP.ParameterValues.Low, IloCP.ParameterValues.Basic, IloCP.ParameterValues.Medium, and
IloCP.ParameterValues.Extended. The default value is IloCP.ParameterValues.Default, which allows the inference
strength of all IloAllMinDistance constraints to be controlled via IloCP.ParameterValues.DefaultInferenceLevel.public static final IloCP.IntParam ElementInferenceLevel
IloCP instance. Possible values for this parameter are IloCP.ParameterValues.Default,
IloCP.ParameterValues.Low, IloCP.ParameterValues.Basic, IloCP.ParameterValues.Medium, and
IloCP.ParameterValues.Extended. The default value is IloCP.ParameterValues.Default, which allows the inference
strength of all element constraints to be controlled via IloCP.ParameterValues.DefaultInferenceLevel.public static final IloCP.IntParam FailLimit
IloCP.IntMax. A value of IloCP.IntMax does not set any limit.
The value IloCP.IntMax is the default value.public static final IloCP.IntParam ChoicePointLimit
IloCP.IntMax. A value of IloCP.IntMax does not set any limit.
The value IloCP.IntMax is the default value.public static final IloCP.IntParam LogVerbosity
IloCP.ParameterValues.Quiet, IloCP.ParameterValues.Terse, IloCP.ParameterValues.Normal,
and IloCP.ParameterValues.Verbose. Mode IloCP.ParameterValues.Quiet does not display any information,
the other modes display progressively more information. The default value is IloCP.ParameterValues.Normal.
public static final IloCP.IntParam LogPeriod
k, the log is displayed every k branches (search decisions).public static final IloCP.IntParam SearchType
IloCP.ParameterValues.DepthFirst, a regular depth-first search is applied. When set to
IloCP.ParameterValues.Restart, a depth-first search that restarts from time to time is applied.
When set to IloCP.ParameterValues.IterativeDiving on scheduling problems
(ones with at least one interval variable), a more aggressive diving technique is applied in order to find solutions
to large problems more quickly. When set to IloCP.ParameterValues.MultiPoint, a method that combines
a set of - possibly partial - solutions is applied.
When set to IloCP::Neighborhood, a local neighborhood search is applied (feature in beta).
When set to IloCP.ParameterValues.Auto,
CP Optimizer uses a blend of the above search types which it believes appropriate for the problem being solved,
taking into account other parameter settings. The default value is IloCP.ParameterValues.Auto.public static final IloCP.IntParam RandomSeed
IloCP.IntMax. The default value is 0.public static final IloCP.IntParam RestartFailLimit
IloCP.ParameterValues.SearchType is set to IloCP.ParameterValues.Restart,
a depth-first search is restarted after a certain number of failures. This parameter controls the number of failures that must
occur before restarting search. Possible values range from 0 to IloCP.IntMax. The default value is 100. This value can increase after each restart:
see the parameter RestartGrowthFactor.public static final IloCP.IntParam MultiPointNumberOfSearchPoints
public static final IloCP.IntParam Workers
Auto. This amounts to using as many workers as there are CPU cores available on
the machine.
Note that the memory required by CP Optimizer grows roughly linearly as the number of workers is increased. If
you are solving a very large model on a multi-core processor and memory usage is an issue, it is advisable to
specify a reduced number of workers, or even one worker, rather than use the default value.public static final IloCP.IntParam BranchLimit
x == value and x != value. A branch is only counted at the
moment a decision is executed, not when the two branches of the choice point are decided. A branch is counted
even if the decision leads to an inconsistency (failure). The possible values of this parameter range from
0 to IloCP.IntMax. A value of IloCP.IntMax does not set any limit. The value of IloCP.IntMax
is the default value.public static final IloCP.IntParam DynamicProbing
IloCP.ParameterValues.On
(dynamic probing is activated with a constant strength), IloCP.ParameterValues.Auto
(dynamic probing is activated and its strength is adjusted adaptively) and
IloCP.ParameterValues.Off (dynamic probing is deactivated). The strength of
probing can be defined by parameter DynamicProbingStrength. Dynamic probing only has an
effect when using the "Restart" (IloCP.ParameterValues.Restart) search type, on
problems without interval variables. The default value of this parameter is
IloCP.ParameterValues.Auto.public static final IloCP.IntParam SolutionLimit
IloCP.IntMax. A value of IloCP.IntMax does not set any limit. The
value IloCP.IntMax is the default value.public static final IloCP.IntParam PrecedenceInferenceLevel
IloCP instance.
Possible values for this parameter are IloCP.ParameterValues.Default,
IloCP.ParameterValues.Low, IloCP.ParameterValues.Basic,
IloCP.ParameterValues.Medium, and IloCP.ParameterValues.Extended. The default
value is IloCP.ParameterValues.Default, which allows the inference strength for precedence
constraints between interval variables to be controlled via IloCP.ParameterValues.DefaultInferenceLevel.public static final IloCP.IntParam IntervalSequenceInferenceLevel
IloIntervalSequenceVar extracted to the invoking IloCP instance.
Possible values for this parameter are IloCP.ParameterValues.Default,
IloCP.ParameterValues.Low, IloCP.ParameterValues.Basic,
IloCP.ParameterValues.Medium, and IloCP.ParameterValues.Extended. The default
value is IloCP.ParameterValues.Default, which allows the inference strength of all
IloIntervalSequenceVar to be controlled via IloCP.ParameterValues.DefaultInferenceLevel.
For more information on interval sequence variables see the concept
Interval variable sequencing in CP Optimizer.public static final IloCP.IntParam NoOverlapInferenceLevel
IloNoOverlap constraint extracted to the invoked IloCP instance.
Possible values for this parameter are IloCP.ParameterValues.Default,
IloCP.ParameterValues.Low, IloCP.ParameterValues.Basic,
IloCP.ParameterValues.Medium, and IloCP.ParameterValues.Extended. The default
value is IloCP.ParameterValues.Default, which allows the inference strength of all IloNoOverlap
constraints to be controlled via IloCP.ParameterValues.DefaultInferenceLevel.
For more information on no-overlap constraints see the concept
Interval variable sequencing in CP Optimizer.public static final IloCP.IntParam CumulFunctionInferenceLevel
IloCumulFunctionExpr extracted to the invoked IloCP instance.
Possible values for this parameter are IloCP.ParameterValues.Default,
IloCP.ParameterValues.Low, IloCP.ParameterValues.Basic,
IloCP.ParameterValues.Medium, and IloCP.ParameterValues.Extended. The default
value is IloCP.ParameterValues.Default, which allows the inference strength of all constraints
on IloCumulFunctionExpr to be controlled via IloCP.ParameterValues.DefaultInferenceLevel.
For more information on no-overlap constraints see the concept
Cumul functions in CP Optimizer.public static final IloCP.IntParam StateFunctionInferenceLevel
IloStateFunction extracted to the invoked IloCP instance.
Possible values for this parameter are IloCP.ParameterValues.Default,
IloCP.ParameterValues.Low, IloCP.ParameterValues.Basic,
IloCP.ParameterValues.Medium, and IloCP.ParameterValues.Extended. The default
value is IloCP.ParameterValues.Default, which allows the inference strength of
all constraints on state functions IloStateFunction to be controlled via
IloCP.ParameterValues.DefaultInferenceLevel.
For more information on no-overlap constraints see the concept
State functions in CP Optimizer.public static final IloCP.IntParam TimeMode
IloCP.ParameterValues.ElapsedTime and
IloCP.ParameterValues.CPUTime. CP Optimizer uses time for both display
purposes and for limiting the search via IloCP.NumParam.TimeLimit. Note that when multiple
processors are available and the number of workers (IloCP.IntParam.Workers) is greater than
one, then the CPU time can be greater than the elapsed time by a factor up to the number of workers.
The default value is IloCP.ParameterValues.ElapsedTime.public static final IloCP.IntParam TemporalRelaxation
IloCP engine. This parameter can take values
IloCP.ParameterValues.On or IloCP.ParameterValues.Off, with
IloCP.ParameterValues.On being the default, meaning the relaxation is used in
the engine when needed. For some models, using the relaxation becomes inefficient, and you
may deactivate the use of the temporal relaxation using value IloCP.ParameterValues.Off.public static final IloCP.IntParam Presolve
IloCP.ParameterValues.On
(presolve is activated) and IloCP.ParameterValues.Off
(presolve is deactivated).
The default value is IloCP.ParameterValues.On.public static final IloCP.IntParam ConflictRefinerIterationLimit
IloCP.IntMax. A value of IloCP.IntMax does not set any limit.
The value IloCP.IntMax is the default value.public static final IloCP.IntParam ConflictRefinerBranchLimit
IloCP.IntMax. A value of IloCP.IntMax does not set any limit.
The value IloCP.IntMax is the default value.public static final IloCP.IntParam ConflictRefinerFailLimit
IloCP.IntMax. A value of IloCP.IntMax does not set any limit.
The value IloCP.IntMax is the default value.public static final IloCP.IntParam ConflictRefinerOnVariables
IloCP.ParameterValues.On
(conflict refiner will refine both constraints and variables domains) and
IloCP.ParameterValues.Off (conflict refiner will only refine constraints).
The default value is IloCP.ParameterValues.Off.public static final IloCP.IntParam ModelAnonymizer
dumpModel.
The legal values of this parameter are IloCP.ParameterValues.Off
and IloCP.ParameterValues.On. The default is
IloCP.ParameterValues.Off.
When the anonymizer is off, then names of variables and constraints
in the model may be found in the output file. When the anonymizer
is on, names given to variables or constraints in the model will
not be reflected in the output file and standard anonymized names
will be used.public static final IloCP.IntParam FailureDirectedSearch
IloCP.IntParam.SearchType is set to
IloCP.ParameterValues.Restart or
IloCP.ParameterValues.Auto.
Legal values for the IloCP.IntParam.FailureDirectedSearch
parameter are IloCP.ParameterValues.On (the default)
and IloCP.ParameterValues.Off. When the value is
IloCP.ParameterValues.On then CP Optimizer starts
failure-directed search when other search strategies are (no longer)
successful and when the memory necessary for the search does not
exceed the value set by parameter
IloCP.IntParam.FailureDirectedSearchMaxMemory.
Setting IloCP.IntParam.FailureDirectedSearch to
IloCP.ParameterValues.Off disables the feature.public static final IloCP.IntParam FailureDirectedSearchMaxMemory
IloCP.IntParam.FailureDirectedSearch.
Failure-directed search can sometimes consume a lot of memory,
especially when end times of interval variables are not bounded.
Therefore it is usually not started immediately, but only when the effective
horizon (time period over which CP Optimizer must reason) becomes small
enough for failure-directed search to operate inside the memory limit
specified by this parameter. For many types of scheduling problems, the
effective horizon tends to reduce when CP Optimizer finds a better solution
(often most significantly when the initial solution is found). Therefore,
when each new solution is found, CP Optimizer decides whether or not
to turn on failure-directed search.
Note that this parameter does not influence the effectiveness
of failure-directed search, once started. Its purpose is only to control
the point at which failure-directed search will begin to function.public static final IloCP.IntParam WarningLevel
This parameter controls the level of warnings issued by CP Optimizer when a solve is launched. Specifically, all warnings of level higher than this parameter are masked. Since CP Optimizer warning levels run from 1 to 4, setting this parameter to 0 turns off all warnings. Warnings issued may indicate potential errors or inefficiencies in your model. The default value of this parameter is 2.
public static final IloCP.IntParam UseFileLocations
This parameter controls whether CP Optimizer processes file locations.
With each constraint, variable or expression it is possible to
associate a source file location (file name and line
number). CP Optimizer can use locations later for reporting
errors and conflicts. Locations are also included in exported/dumped
models (#line directives).
Source file locations can be provided to CP Optimizer in the following ways:
ILOADD and
ILOSETLOCATION.
#line directives.
IloCP.add,
IloCP.intVar,
IloCP.intervalVar,
IloCP.intervalSequenceVar,
and IloCP.stateFunction
unless this parameter is Off. The calling class must
be compiled with debug information about line numbers and source
files.
Legal values for this parameter are
IloCP.ParameterValues.On (the default) and
IloCP.ParameterValues.Off. When the value is
IloCP.ParameterValues.Off then CP Optimizer ignores
locations in the input model and also does not export them in CPO
file format (functions and
IloCP.dumpModel(java.lang.String)).
IloCP.exportModel(java.lang.String)
public static final IloCP.IntParam PrintModelDetailsInMessages
Whenever CP Optimizer prints an error or warning message, it can also
print the relevant part of the input model (in CPO file format).
This parameter controls printing of this additional information.
Possible values are IloCP.ParameterValues.On and IloCP.ParameterValues.Off
the default value is IloCP.ParameterValues.On.
public static final IloCP.IntParam CountDifferentInferenceLevel
IloCountDifferent constraint extracted to the invoking
IloCP instance. Possible values for this parameter are IloCP.ParameterValues.Default,
IloCP.ParameterValues.Low, IloCP.ParameterValues.Basic, IloCP.ParameterValues.Medium, and
IloCP.ParameterValues.Extended. The default value is IloCP.ParameterValues.Default, which allows the inference
strength of all IloCountDifferent constraints to be controlled via IloCP.ParameterValues.DefaultInferenceLevel.public static final IloCP.IntParam LogSearchTags
IloCP.ParameterValues.On, the engine
will display failure tags (indices) in the engine log when solving the model. To specify the
failures to explain, the member functions IloCP.explainFailure(int failureTag)
or IloCP.explainFailure(int[] tagArray)
needs to be called with the failure tags as the parameter. Several failures tags can be added.
The member function IloCP.clearExplanations() is used to clear the set of failure tags to be
explained. To be able to see failure tags and explanations, the parameter IloCP.IntParam.SearchType
must be set to IloCP.ParameterValues.DepthFirst and the parameter IloCP.IntParam.Workers to 1.
The default value of this parameter is IloCP.ParameterValues.Off.public static final IloCP.IntParam KPIDisplay
IloCP.ParameterValues.SingleLine: all KPIs are displayed on a single line.
The alternative value is IloCP.ParameterValues.MultipleLines: each KPI is displayed on its own line.public static final IloCP.IntParam ParallelSynchronizationSolutionCapacity