This page is for an old version of Hexaly Optimizer. We recommend that you update your version and read the documentation for the latest stable release.

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

Summary

Functions
count Returns the number of values in the current 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.

Functions

int count() const

Returns the number of values in the current argument values.

Values are indexed from 0 to count() - 1.

bool isBool(int pos) const

Returns true if the value at the given position is a boolean.

You can retrieve the value with getIntValue.

Return:True if the value at the given position is a boolean.
Parameters:pos - Position of the value to query.

bool isInt(int pos) const

Returns true if the value at the given position is an integer.

You can retrieve the value with getIntValue.

Return:True if the value at the given position is an integer.
Parameters:pos - Position of the value to query.

bool isDouble(int pos) const

Returns true if the value at the given position is a double.

You can retrieve the value with getDoubleValue.

Return:True if the value at the given position is a double.
Parameters:pos - Position of the value to query.

lsint getIntValue(int pos) const

Returns the integer value at the given position.

If the value is neither an integer nor a boolean, an exception is thrown.

Return:Integer value.
Parameters:pos - Position of the value to query.

lsdouble getDoubleValue(int pos) const

Returns the double value at the given position.

If the value is not a double, an exception is thrown.

Return:Double value.
Parameters:pos - Position of the value to query.