localsolver

Class LSExternalContext

java.lang.Object

localsolver.LSExternalContext

public class LSExternalContext
extends java.lang.Object

Context of an external function. External context can be used to query and set properties of the associated external function. If you know the bounds of your external function or if you know it cannot return a NaN value, we recommend you to specify it as LocalSolver is then able to improve its search process. But beware! If the evaluation of the function returns an unexpected value (like a value outside of the bounds), an exception will be thrown during the search.

Since:

9.5

See Also:

LSExpression.getExternalContext()

Method Summary

Modifier and Type	Method and Description
double	getDoubleLowerBound() Gets the lower bound of the external function.
double	getDoubleUpperBound() Gets the upper bound of the external function.
long	getIntLowerBound() Gets the lower bound of the external function.
long	getIntUpperBound() Gets the upper bound of the external function.
boolean	isNanable() Returns true if the function can return a NaN value.
void	setDoubleLowerBound(double lowerBound) Sets the lower bound of the external function.
void	setDoubleUpperBound(double upperBound) Sets the upper bound of the external function.
void	setIntLowerBound(long lowerBound) Sets the lower bound of the external function.
void	setIntUpperBound(long upperBound) Sets the upper bound of the external function.
void	setLowerBound(double lowerBound) Sets the lower bound of the external function.
void	setLowerBound(long lowerBound) Sets the lower bound of the external function.
void	setNanable(boolean nanable) Sets whether or not the function can return a NaN value.
void	setUpperBound(double upperBound) Sets the upper bound of the external function.
void	setUpperBound(long upperBound) Sets the upper bound of the external function.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

setLowerBound

public void setLowerBound(long lowerBound)

Sets the lower bound of the external function. Only allowed if the external function is an integer function. Only allowed in state LSState.Modeling. This method has the same behaviour as setIntLowerBound(long)

Parameters:

lowerBound - Lower bound of the function.

setLowerBound

public void setLowerBound(double lowerBound)

Sets the lower bound of the external function. Only allowed if the external function is a double function. Only allowed in state LSState.Modeling. This method has the same behaviour as setDoubleLowerBound(double)

Parameters:

lowerBound - Lower bound of the function.

setUpperBound

public void setUpperBound(long upperBound)

Sets the upper bound of the external function. Only allowed if the external function is an integer function. in state LSState.Modeling. This method has the same behaviour as setIntUpperBound(long)

Parameters:

upperBound - Upper bound of the function.

setUpperBound

public void setUpperBound(double upperBound)

Sets the upper bound of the external function. Only allowed if the external function is a double function. Only allowed in state LSState.Modeling. This method has the same behaviour as setDoubleUpperBound(double)

Parameters:

upperBound - Upper bound of the function.

getIntLowerBound

public long getIntLowerBound()

Gets the lower bound of the external function. Only allowed if the external function is an integer function. By default, this property is set to Long.MIN_VALUE + 1.

Returns:

Lower bound of the function.

setIntLowerBound

public void setIntLowerBound(long lowerBound)

Sets the lower bound of the external function. Only allowed if the external function is an integer function. Only allowed in state LSState.Modeling.

Parameters:

lowerBound - Lower bound of the function.

getIntUpperBound

public long getIntUpperBound()

Gets the upper bound of the external function. Only allowed if the external function is an integer function. By default, this property is set to Long.MAX_VALUE.

Returns:

Upper bound of the function.

setIntUpperBound

public void setIntUpperBound(long upperBound)

Sets the upper bound of the external function. Only allowed if the external function is an integer function. Only allowed in state LSState.Modeling.

Parameters:

upperBound - Upper bound of the function.

getDoubleLowerBound

public double getDoubleLowerBound()

Gets the lower bound of the external function. Only allowed if the external function is a double function. By default, this property is set to Double.NEGATIVE_INFINITY.

Returns:

Lower bound of the function.

setDoubleLowerBound

public void setDoubleLowerBound(double lowerBound)

Sets the lower bound of the external function. Only allowed if the external function is a double function. Only allowed in state LSState.Modeling.

Parameters:

lowerBound - Lower bound of the function.

getDoubleUpperBound

public double getDoubleUpperBound()

Gets the upper bound of the external function. Only allowed if the external function is a double function. By default, this property is set to Double.POSITIVE_INFINITY.

Returns:

Upper bound of the function.

setDoubleUpperBound

public void setDoubleUpperBound(double upperBound)

Sets the upper bound of the external function. Only allowed if the external function is a double function. Only allowed in state LSState.Modeling.

Parameters:

upperBound - Upper bound of the function.

isNanable

public boolean isNanable()

Returns true if the function can return a NaN value. Only allowed if the external function is a double function. By default, this property is set to true.

Returns:

True if the function can return a NaN value.

setNanable

public void setNanable(boolean nanable)

Sets whether or not the function can return a NaN value. Only allowed if the external function is a double function. Only allowed in state LSState.Modeling.

Parameters:

nanable - True if the function can return a NaN value, false otherwise.