Localsolver  6.5
localsolverblackbox.LSBBParam Class Reference

Detailed Description

Solving parameters.

This class contains some methods allowing you to parameterize the resolution of the model. For the sake of simplicity, only a few parameters are actually offered to tune the search.

Public Member Functions

LocalSolverBlackBox GetLocalSolverBlackBox ()
 Returns the LocalSolverBlackBox object associated to these parameters.
void SetSeed (int seed)
 Sets the seed of the pseudo-random number generator used by the solver.
int GetSeed ()
 Gets the seed of the pseudo-random number generator used by the solver.
void SetTimeLimit (int timeLimit)
 Sets the time limit in seconds.
int GetTimeLimit ()
 Gets the time limit of this phase in seconds.
void SetEvaluationLimit (int evaluationLimit)
 Sets the maximum number of blackbox evaluations.
int GetEvaluationLimit ()
 Gets the maximum number of blackbox evalutions.
void SetObjectiveBound (double bound)
 Sets the objective bound.

Member Function Documentation

LocalSolverBlackBox localsolverblackbox.LSBBParam.GetLocalSolverBlackBox ( )

Returns the LocalSolverBlackBox object associated to these parameters.

Returns
LocalSolverBlackBox object
void localsolverblackbox.LSBBParam.SetSeed ( int  seed)

Sets the seed of the pseudo-random number generator used by the solver.

The seed must be a positive integer. The default seed is set to 0. Only allowed in state LSBBState::Stopped.

Parameters
seedSeed of the pseudo-random number generator.
int localsolverblackbox.LSBBParam.GetSeed ( )

Gets the seed of the pseudo-random number generator used by the solver.

Only allowed in states LSBBState::Paused or LSBBState::Stopped.

Returns
Seed of the pseudo-random number generator.
See Also
LSBBParam.SetSeed
void localsolverblackbox.LSBBParam.SetTimeLimit ( int  timeLimit)

Sets the time limit in seconds.

Note that the "real" time (that is, total time) spent to resolve the model is considered here (and not only the CPU time). The default time limit is set to the largest positive integer on 32 bits, that is 2^31-1 = 2,147,483,647 > 10^9. Only allowed in state LSBBState::Stopped.

Parameters
timeLimitTime limit in seconds.
int localsolverblackbox.LSBBParam.GetTimeLimit ( )

Gets the time limit of this phase in seconds.

Only allowed in states LSBBState::Paused or LSBBState::Stopped.

Returns
Time limit in seconds.
See Also
LSBBParam.SetTimeLimit
void localsolverblackbox.LSBBParam.SetEvaluationLimit ( int  evaluationLimit)

Sets the maximum number of blackbox evaluations.

The default number of evaluations is set to the largest positive integer on 32 bits, that is 2^31-1 = 2,147,483,647 > 10^9. Only allowed in state LSBBState::Stopped.

Parameters
evaluationLimitMaximum number of blackbox evaluation.
int localsolverblackbox.LSBBParam.GetEvaluationLimit ( )

Gets the maximum number of blackbox evalutions.

Only allowed in states LSBBState::Paused or LSBBState::Stopped.

Returns
Evaluation limit.
See Also
LSBBPhase.SetEvaluationLimit
void localsolverblackbox.LSBBParam.SetObjectiveBound ( double  bound)

Sets the objective bound.

If the objective is minimized (resp. maximized), then the optimization of this objective is stopped as soon as this lower (resp. upper) bound is reached. Only allowed in states LSBBState::Stopped.

Parameters
boundObjective bound.