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

Methods
count Returns the number of values in the current argument values.
is_bool Returns true if the value at the given position is a boolean.
is_int Returns true if the value at the given position is an integer.
is_double Returns true if the value at the given position is a double.
get Returns the value at the given position.
Special methods
__len__ Returns the number of values in the current argument values.
__getitem__ Returns the value at the given position.

Instance methods

LSBlackBoxArgumentValues.count()

Returns the number of values in the current argument values.

LSBlackBoxArgumentValues.is_bool(pos)

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

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

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

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

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

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

Returns the value at the given position. The returned value can be a double or an integer depending on the type of the value.

Parameters:pos – Position of the value to query.
Returns:Value
Return type:int or double

Special operators and methods

LSBlackBoxArgumentValues.__len__()

Returns the number of values in the current argument values. This method allows users to call len() function directly on the black-box argument values without using the count() method.

LSBlackBoxArgumentValues.__getitem__(pos)

Returns the value at the given position. This method allows users to use [] operator directly on the black-box argument values without using the get() method.

Parameters:pos – Position of the value to query.
Returns:Value
Return type:int or double