LSBlackBoxArgumentValues Class¶

class localsolver.LSBlackBoxArgumentValues¶

Argument values for black-box functions. Argument values are used to query the values of the arguments passed to black-box functions.

Since:	9.5
See:	LSBlackBoxFunction

Summary¶

Methods¶
`GetLocalSolver`	Returns the LocalSolver object associated to the argument values.
`IsBool`	Returns true if the value at the given position is a boolean.
`IsInt`	Returns true if the value at the given position is an integer.
`IsDouble`	Returns true if the value at the given position is a double.
`GetIntValue`	Returns the integer value at the given position.
`GetDoubleValue`	Returns the double value at the given position.
`Count`	Returns the number of values in the current argument values.

LocalSolver GetLocalSolver()¶

Returns the LocalSolver object associated to the argument values.

Returns:	LocalSolver object
Return type:	LocalSolver

bool IsBool(int pos)¶

Returns true if the value at the given position is a boolean. You can retrieve the value with LSBlackBoxArgumentValues.GetIntValue().

Arguments:	pos (int) – Position of the value to query.
Returns:	True if the value at the given position is a boolean.
Return type:	bool

bool IsInt(int pos)¶

Returns true if the value at the given position is an integer. You can retrieve the value with LSBlackBoxArgumentValues.GetIntValue().

Arguments:	pos (int) – Position of the value to query.
Returns:	True if the value at the given position is an integer.
Return type:	bool

bool IsDouble(int pos)¶

Returns true if the value at the given position is a double. You can retrieve the value with LSBlackBoxArgumentValues.GetDoubleValue().

Arguments:	pos (int) – Position of the value to query.
Returns:	True if the value at the given position is a double.
Return type:	bool

long GetIntValue(int pos)¶

Returns the integer value at the given position. If the value is neither an integer nor a boolean, an exception is thrown.

Arguments:	pos (int) – Position of the value to query.
Returns:	Integer value.
Return type:	long

double GetDoubleValue(int pos)¶

Returns the double value at the given position. If the value is not a double, an exception is thrown.

Arguments:	pos (int) – Position of the value to query.
Returns:	Double value.
Return type:	double

int Count()¶: Returns the number of values in the current argument values.