LSBlackBoxContext (LocalSolver 9.5 API)

java.lang.Object
- localsolver.LSBlackBoxContext

```
public class LSBlackBoxContext
extends java.lang.Object
```
Context of a black-box function. Black-box contexts can be used to query and set properties of the associated black-box function. If you know the bounds of your black-box 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.getBlackBoxContext()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`double`	`getDoubleLowerBound()` Gets the lower bound of the black-box function.
`double`	`getDoubleUpperBound()` Gets the upper bound of the black-box function.
`int`	`getEvaluationLimit()` Returns the maximum number of black-box evaluations.
`long`	`getIntLowerBound()` Gets the lower bound of the black-box function.
`long`	`getIntUpperBound()` Gets the upper bound of the black-box function.
`boolean`	`isNanable()` Returns true if the function can return a NaN value.
`void`	`setDoubleLowerBound(double lowerBound)` Sets the lower bound of the black-box function.
`void`	`setDoubleUpperBound(double upperBound)` Sets the upper bound of the black-box function.
`void`	`setEvaluationLimit(int evaluationLimit)` Sets the maximum number of black-box evaluations.
`void`	`setIntLowerBound(long lowerBound)` Sets the lower bound of the black-box function.
`void`	`setIntUpperBound(long upperBound)` Sets the upper bound of the black-box function.
`void`	`setLowerBound(double lowerBound)` Sets the lower bound of the black-box function.
`void`	`setLowerBound(long lowerBound)` Sets the lower bound of the black-box 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 black-box function.
`void`	`setUpperBound(long upperBound)` Sets the upper bound of the black-box 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 black-box function. Only allowed if the black-box 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 black-box function. Only allowed if the black-box 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 black-box function. Only allowed if the black-box 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 black-box function. Only allowed if the black-box 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 black-box function. Only allowed if the black-box 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 black-box function. Only allowed if the black-box 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 black-box function. Only allowed if the black-box 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 black-box function. Only allowed if the black-box 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 black-box function. Only allowed if the black-box 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 black-box function. Only allowed if the black-box 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 black-box function. Only allowed if the black-box 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 black-box function. Only allowed if the black-box 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 black-box 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 black-box function is a double function. Only allowed in state LSState.Modeling.
    
    Parameters:
    
    nanable - True if the function can return a NaN value, false otherwise.
  - getEvaluationLimit
```
public int getEvaluationLimit()
```
    Returns the maximum number of black-box evaluations. The default number of evaluations is set to the largest positive integer on 32 bits, that is 2^32-1 = 2,147,483,647 > 10^9.
    
    Returns:
    
    The maximum number of calls to the black-box function.
  - setEvaluationLimit
```
public void setEvaluationLimit(int evaluationLimit)
```
    Sets the maximum number of black-box evaluations. The default number of evaluations is set to the largest positive integer on 32 bits, that is 2^32-1 = 2,147,483,647 > 10^9. Only allowed in state LSState.Stopped.
    
    Parameters:
    
    evaluationLimit - The maximum number of calls to the black-box function.

Class LSBlackBoxContext

Method Summary

Methods inherited from class java.lang.Object

Method Detail

setLowerBound

setLowerBound

setUpperBound

setUpperBound

getIntLowerBound

setIntLowerBound

getIntUpperBound

setIntUpperBound

getDoubleLowerBound

setDoubleLowerBound

getDoubleUpperBound

setDoubleUpperBound

isNanable

setNanable

getEvaluationLimit

setEvaluationLimit