LSSurrogateParameters Class¶

class LSSurrogateParameters¶

Parameters specific to the surrogate modeling feature. Surrogate parameters can be used to query and set the evaluation budget and the evaluation points of the associated external function.

See: LSExternalContext::enableSurrogateModeling()
Since: 9.5

Summary¶

Functions¶
`getEvaluationLimit`	Returns the maximum number of evaluations.
`setEvaluationLimit`	Sets the maximum number of evaluations.
`createEvaluationPoint`	Creates an evaluation point for the external function.
`getNbEvaluationPoints`	Returns the number of evaluation points.
`getEvaluationPoint`	Returns the evaluation point at the given position.

Functions¶

int LSSurrogateParameters::getEvaluationLimit() const¶

Returns the maximum number of evaluations. By default, the maximum number of evaluations is set to the largest positive integer on 32 bits, that is 2^31-1 = 2,147,483,647 > 10^9.

Returns: Maximum number of calls to the external function.

void LSSurrogateParameters::setEvaluationLimit(int evaluationLimit)¶

Sets the maximum number of evaluations. By default, the maximum 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 states S_Modeling or S_Stopped.

Parameters: evaluationLimit – Maximum number of calls to the external function.

LSEvaluationPoint LSSurrogateParameters::createEvaluationPoint()¶

Creates an evaluation point for the external function. It consists of a list of values corresponding to the function’s arguments and return value.

Evaluation points are used to specify known points for a function in advance. It can be useful to warm-start the solver when the function is particularly expensive to evaluate, or if you already have a good estimate of the optimal point. Only allowed in states S_Modeling or S_Stopped.

Returns: Evaluation point.
See: LSEvaluationPoint

int LSSurrogateParameters::getNbEvaluationPoints() const¶

Returns the number of evaluation points.

Returns: Number of evaluation points.

lsint LSSurrogateParameters::getEvaluationPoint(int pos) const¶

Returns the evaluation point at the given position.

Parameters: pos – Position of the evaluation point.
Returns: Evaluation point at the given position.
See: LSEvaluationPoint