LSBBEvaluationPoint Class

class localsolverblackbox.LSBEvaluationPoint

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.

Summary

Methods
AddArgumentInt Adds an argument with the given value.
AddArgumentDouble Adds an 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.

Instance methods

void AddArgumentInt(long value)

Adds an argument with the given value. Only allowed in state LSBBState.Stopped.

Arguments:value (long) – Value of the argument
void AddArgumentDouble(double value)

Adds an argument with the given value. Only allowed in state LSBBState.Stopped.

Arguments:value (double) – Value of the argument
void SetReturnedValue(double value)

Sets the returned value for this point. Only allowed in state LSBBState.Stopped.

Arguments:value (double) – Returned value at this point
int GetArgumentInt(int pos)

Returns the value of the argument at the given position. Only allowed in state LSBBState.Stopped. Only allowed if this argument is an integer.

Arguments:pos (int) – Position in the argument list.
Returns:Value of the argument
Return type:long
double GetArgumentDouble(int pos)

Returns the value of the argument at the given position. Only allowed in state LSBBState.Stopped. Only allowed if this argument is a double.

Arguments:pos (int) – Position in the argument list.
Returns:Value of the argument
Return type:double
bool IsArgumentInt(int pos)

Returns true if the argument at the given position is an integer, false otherwise. Only allowed in state LSBBState.Stopped.

Arguments:pos (int) – Position in the argument list.
Return type:bool
bool IsArgumentDouble(int pos)

Returns true if the argument at the given position is a double, false otherwise. Only allowed in state LSBBState.Stopped.

Arguments:pos (int) – Position in the argument list.
Return type:bool
void SetArgumentInt(int pos, long value)

Sets the value of the argument at the given position. Only allowed in state LSBBState.Stopped.

Arguments:
  • pos (int) – Position in the argument list.
  • value (long) – Value of the argument.
void SetArgumentDouble(int pos, double value)

Sets the value of the argument at the given position. Only allowed in state LSBBState.Stopped.

Arguments:
  • pos (int) – Position in the argument list.
  • value (double) – Value of the argument.
double 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 LSBBState.Stopped.

Returns:Returned value for this evaluation point.
Return type:double