LSNativeContext Class

class localsolver.LSNativeContext

Context for native functions. Native context are used to query the values of the arguments passed to native functions.

Since:6.0

Summary

Methods
count Returns the number of values in the current context.
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 context.
__getitem__ Returns the value at the given position.

Instance methods

LSNativeContext.count()

Returns the number of values in the current context.

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

LSNativeContext.__len__()

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

LSNativeContext.__getitem__(pos)

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

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