LSBBEvaluationPoint Class

class localsolverblackbox::LSBBEvaluationPoint

An evaluation point associated with a native function.

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.

This information may be used by the solver to drive the solution process. The exact behaviour is implementation-defined and the solver may perform the exact same call a second time or ignore the values altogether.

See:LSBBModel

Summary

Functions
addArgumentInt Adds an integer argument with the given value.
addArgumentDouble Adds a double argument with the given value.
setReturnedValue Sets the returned value for this point.
getArgumentInt Returns the value of the argument at the given position.
getArgumentDouble Returns the value of the argument at the given position.
isArgumentInt Returns true if the argument at the given position is an integer, false otherwise.
isArgumentDouble Returns true if the argument at the given position is a double, false otherwise.
setArgumentInt Sets the value of the argument at the given position.
setArgumentDouble Sets the value of the argument at the given position.
getReturnedValue Gets the returned value for this point.

Functions

void addArgumentInt(lsint value)

Adds an integer argument with the given value.

Only allowed in state S_Stopped.

See:LSBBEvaluationPoint::getArgumentInt()
Parameters:value - Value of the argument.

void addArgumentDouble(lsdouble value)

Adds a double argument with the given value.

Only allowed in state S_Stopped.

See:LSBBEvaluationPoint::getArgumentDouble()
Parameters:value - Value of the argument.

void setReturnedValue(lsdouble value)

Sets the returned value for this point.

Only allowed in state S_Stopped.

See:LSBBEvaluationPoint::getReturnedValue()
Parameters:value - Returned value at this point.

lsint getArgumentInt(unsigned int pos)

Returns the value of the argument at the given position.

Only allowed in state S_Stopped. Only allowed if this argument is an integer.

See:LSBBEvaluationPoint::addArgumentInt()
See:LSBBEvaluationPoint::isArgumentInt()
See:LSBBEvaluationPoint::setArgumentInt()
Return:Value of the argument.
Parameters:pos - Position in the argument list.

lsdouble getArgumentDouble(unsigned int pos)

Returns the value of the argument at the given position.

Only allowed in state S_Stopped. Only allowed if this argument is a double.

See:LSBBEvaluationPoint::addArgumentDouble()
See:LSBBEvaluationPoint::isArgumentDouble()
See:LSBBEvaluationPoint::setArgumentDouble()
Return:Value of the argument.
Parameters:pos - Position in the argument list.

bool isArgumentInt(unsigned int pos)

Returns true if the argument at the given position is an integer, false otherwise.

Only allowed in state S_Stopped.

Parameters:pos - Position in the argument list.

bool isArgumentDouble(unsigned int pos)

Returns true if the argument at the given position is a double, false otherwise.

Only allowed in state S_Stopped.

Parameters:pos - Position in the argument list.

void setArgumentInt(unsigned int pos, lsint value)

Sets the value of the argument at the given position.

Only allowed in state S_Stopped.

See:

LSBBEvaluationPoint::getArgumentInt()

Parameters:
  • pos - Position in the argument list.
  • value - Value of the argument.

void setArgumentDouble(unsigned int pos, lsdouble value)

Sets the value of the argument at the given position.

Only allowed in state S_Stopped.

See:

LSBBEvaluationPoint::getArgumentDouble()

Parameters:
  • pos - Position in the argument list.
  • value - Value of the argument.

lsdouble getReturnedValue()

Gets the returned value for this point.

If the value was not set by the user, this defaults to NaN. Only allowed in state S_Stopped.

See:LSBBEvaluationPoint::setReturnedValue()
Return:Returned value for this evaluation point.