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.

LSExternalArgumentValues Class

class localsolver.LSExternalArgumentValues

Argument values for external functions. Argument values are used to query the values of the arguments passed to external 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.

is_interval

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

is_collection

Returns true if the value at the given position is a collection (list or set).

is_array

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

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

LSExternalArgumentValues.count()

Returns the number of values in the current argument values.

LSExternalArgumentValues.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

LSExternalArgumentValues.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

LSExternalArgumentValues.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

LSExternalArgumentValues.is_interval(pos)

Returns true if the value at the given position is an interval. 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 interval.

Return type:

bool

LSExternalArgumentValues.is_collection(pos)

Returns true if the value at the given position is a collection (list or set). 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 array.

Return type:

bool

LSExternalArgumentValues.is_array(pos)

Returns true if the value at the given position is an array. 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 array.

Return type:

bool

LSExternalArgumentValues.get(pos)

Returns the value at the given position. The returned value can be a boolean, an integer, a double, a LSInterval, a LSCollection or a LSArray.

Parameters:

pos – Position of the value to query.

Returns:

Value

Return type:

bool, int, double, LSInterval, LSCollection or LSArray

Special operators and methods

LSExternalArgumentValues.__len__()

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

LSExternalArgumentValues.__getitem__(pos)

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

Parameters:

pos – Position of the value to query.

Returns:

Value

Return type:

int, double, LSArray or LSCollection