LSPModeler (LocalSolver 11.0 API)

java.lang.Object
- localsolver.modeler.LSPModeler

All Implemented Interfaces:

java.lang.AutoCloseable
```
public class LSPModeler
extends java.lang.Object
implements java.lang.AutoCloseable
```
Modeler environment. Main class of the modeler library which enables the creation and manipulation of a virtual machine that can load and execute programs written in the LSP language. The creation of an LSPModeler environment results in the creation of a dedicated LocalSolver environment as well. For more information on how to use the solver's API, see the LocalSolver class.

Since:

10.0

See Also:

LocalSolver, LSPModule

Constructor Summary

Constructors
Constructor and Description

LSPModeler()
Constructs a complete modeler environment.

Constructors
Constructor and Description
`LSPModeler()` Constructs a complete modeler environment.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()`
`LSPValue`	`createBool(boolean value)` Creates a boolean value.
`LSPValue`	`createDouble(double value)` Creates a double value.
`LSPFunction`	`createFunction(LSPFunctor functor)` Creates an external LSPFunction.
`LSPFunction`	`createFunction(java.lang.String name, LSPFunctor functor)` Creates an external LSPFunction.
`LSPValue`	`createInt(long value)` Creates an integer value.
`LSPMap`	`createMap()` Creates an `LSPMap`.
`<E> LSPMap`	`createMap(java.util.List<E> values)` Creates a `LSPMap` and fills it with the contents of the provided list.
`LSPModule`	`createModule(java.lang.String moduleName)` Creates an empty module with the given name.
`LSPValue`	`createNil()` Creates a nil value.
`LSPValue`	`createString(java.lang.String value)` Creates a string value.
`void`	`delete()` Deletes this modeler environment and all associated objects (this includes the solver environment as well, see `LocalSolver.delete()`).
`boolean`	`equals(java.lang.Object obj)`
`LocalSolver`	`getSolver()` Returns a reference to the LocalSolver environment associated with this modeler instance.
`java.io.PrintStream`	`getStdErr()` Returns the stream used by the modeler for its standard error output.
`java.io.PrintStream`	`getStdOut()` Returns the stream used by the modeler for its standard output methods like `print` or `println`.
`int`	`hashCode()`
`LSPModule`	`loadModule(java.lang.String filePath)` Loads a program written in LSP format into a `LSPModule` whose name corresponds to the provided filename (without path and .lsp extension).
`void`	`setStdErr(java.io.PrintStream stream)` Sets the stream used by the modeler for its standard error output.
`void`	`setStdOut(java.io.PrintStream stream)` Sets the stream used by the modeler for its standard output methods like `print` or `println`.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - LSPModeler
```
public LSPModeler()
```
    Constructs a complete modeler environment. This has the effect of also creating a dedicated LocalSolver environment (see LocalSolver()). A reference to the solver environment can be obtained via getSolver().
    
    See Also:
    
    LocalSolver
- Method Detail
  - delete
```
public void delete()
```
    Deletes this modeler environment and all associated objects (this includes the solver environment as well, see LocalSolver.delete()).
  - close
```
public void close()
```
    Specified by:
    
    close in interface java.lang.AutoCloseable
  - loadModule
```
public LSPModule loadModule(java.lang.String filePath)
```
    Loads a program written in LSP format into a LSPModule whose name corresponds to the provided filename (without path and .lsp extension). The variables of the module can be manipulated through the associated LSPModule object.
    
    Parameters:
    
    filePath - Path to the file.
    
    Returns:
    
    Module created.
    
    See Also:
    
    LSPModule
  - createModule
```
public LSPModule createModule(java.lang.String moduleName)
```
    Creates an empty module with the given name. The variables of the module can then be manipulated through the associated LSPModule object.
    
    Parameters:
    
    moduleName - Module name.
    
    Returns:
    
    Module created.
    
    See Also:
    
    LSPModule
  - getSolver
```
public LocalSolver getSolver()
```
    Returns a reference to the LocalSolver environment associated with this modeler instance.
    
    See Also:
    
    LocalSolver
  - createFunction
```
public LSPFunction createFunction(java.lang.String name,
                                  LSPFunctor functor)
```
    Creates an external LSPFunction. The argument must be derived from LSPFunctor. When the function is called, the modeler instance will be made accessible to the function, as well as the arguments. For instance, the following example creates a simple function that accepts two arguments and returns the sum of both values. The generated function is then exposed in an LSP module under the name "myCustomFunction".
```
 public class MyCustomFunction extends LSPFunctor {
     @Override
     LSPValue call(LSPModeler modeler, List<LSPValue> arguments) override {
         return modeler.createDouble(arguments.get(0).asDouble() + arguments.get(1).asDouble());
     }
 }
 
 MyCustomFunction customFunctor = new MyCustomFunction();
 module.setFunction("myCustomFunction", modeler.createFunction(customFunctor));
 
```
    Note: This method should only be used to expose functions used during the modeling process. You should not use this method to create a function that will be used during the resolution as an external function. In this case, you should instead use the solver API directly (see LSIntExternalFunction or LSDoubleExternalFunction)
    Parameters:
    
    name - Name of the function. The name is only used to identify the function in the generated stack trace when an exception occurs. Once created, the function can be associated with any variable in any module, regardless of its name.
    
    functor - Implementation of the external function.
    
    Returns:
    
    Function created.
    
    See Also:
    
    LSPFunctor, LSPFunction
  - createFunction
```
public LSPFunction createFunction(LSPFunctor functor)
```
    Creates an external LSPFunction. The argument must be derived from LSPFunctor. When the function is called, the modeler instance will be made accessible to the function, as well as the arguments. For instance, the following example creates a simple function that accepts two arguments and returns the sum of both values. The generated function is then exposed in an LSP module under the name "myCustomFunction".
```
 public class MyCustomFunction extends LSPFunctor {
     @Override
     LSPValue call(LSPModeler modeler, List<LSPValue> arguments) override {
         return modeler.createDouble(arguments.get(0).asDouble() + arguments.get(1).asDouble());
     }
 }
 
 MyCustomFunction customFunctor = new MyCustomFunction();
 module.setFunction("myCustomFunction", modeler.createFunction(customFunctor));
 
```
    Note: This method should only be used to expose functions used during the modeling process. You should not use this method to create a function that will be used during the resolution as an external function. In this case, you should instead use the solver API directly (see LSIntExternalFunction or LSDoubleExternalFunction)
    Parameters:
    
    functor - Implementation of the external function.
    
    Returns:
    
    Function created.
    
    See Also:
    
    LSPFunctor, LSPFunction
  - createMap
```
public LSPMap createMap()
```
    Creates an LSPMap. A map is a data structure mapping keys to values that can also be used as an array-like structure. Keys and values can be of any type except nil. The map can be assigned to any variable in a module with LSPModule.setMap(java.lang.String, localsolver.modeler.LSPMap) or can be part of another map with LSPMap.setMap(java.lang.String, localsolver.modeler.LSPMap).
    
    Returns:
    
    Map created.
    
    See Also:
    
    LSPMap
  - createMap
```
public <E> LSPMap createMap(java.util.List<E> values)
```
    Creates a LSPMap and fills it with the contents of the provided list. The keys in the map will correspond to the indices of the values in the list. This method only supports types that can be added to a LSPMap (such as integer, double, strings, LSExpression, LSPMap, LSPModule or LSPFunction) A map is a data structure mapping keys to values that can also be used as an array-like structure. The map can be assigned to any variable in a module with LSPModule.setMap(java.lang.String, localsolver.modeler.LSPMap) or can be part of another map with LSPMap.setMap(java.lang.String, localsolver.modeler.LSPMap).
    
    Parameters:
    
    values - List of values to place in the map.
    
    Returns:
    
    Map created containing all the values in the list.
  - createNil
```
public LSPValue createNil()
```
    Creates a nil value.
    
    Returns:
    
    Created nil value.
    
    See Also:
    
    LSPValue
  - createInt
```
public LSPValue createInt(long value)
```
    Creates an integer value. The value can be assigned to any variable in a module with LSPModule.setValue(java.lang.String, localsolver.modeler.LSPValue) or can be part of a map as key or value.
    
    Returns:
    
    Created integer value.
    
    See Also:
    
    LSPValue
  - createDouble
```
public LSPValue createDouble(double value)
```
    Creates a double value. The value can be assigned to any variable in a module with LSPModule.setValue(java.lang.String, localsolver.modeler.LSPValue) or can be part of a map as key or value.
    
    Returns:
    
    Created double value.
    
    See Also:
    
    LSPValue
  - createBool
```
public LSPValue createBool(boolean value)
```
    Creates a boolean value. Please note that there is no dedicated type for booleans in the modeler. They are simulated with integers: 1 denotes true and 0 denotes false. The created value can be assigned to any variable in a module with LSPModule.setValue(java.lang.String, localsolver.modeler.LSPValue) or can be part of a map as key or value.
    
    Returns:
    
    Created boolean value.
    
    See Also:
    
    LSPValue
  - createString
```
public LSPValue createString(java.lang.String value)
```
    Creates a string value. The value can be assigned to any variable in a module with LSPModule.setValue(java.lang.String, localsolver.modeler.LSPValue) or can be part of a map as key or value.
    
    Returns:
    
    Created string value.
    
    See Also:
    
    LSPValue
  - getStdOut
```
public java.io.PrintStream getStdOut()
```
    Returns the stream used by the modeler for its standard output methods like print or println. The default stream used by the modeler corresponds to the Java standard output, retrieved with System.out.
    
    Returns:
    
    The stream used by the modeler for its standard output or null if the standard output is disabled.
  - setStdOut
```
public void setStdOut(java.io.PrintStream stream)
```
    Sets the stream used by the modeler for its standard output methods like print or println. The default is to redirect all the modeler's outputs to the Java standard output. If the given stream is null, the standard output of the modeler will be disabled and all calls to the print/println related functions will do nothing.
    
    Parameters:
    
    stream - Stream to use for the standard output or null to disable standard output.
  - getStdErr
```
public java.io.PrintStream getStdErr()
```
    Returns the stream used by the modeler for its standard error output. The default stream used by the modeler corresponds to the Java standard error output, retrieved with System.err.
    
    Returns:
    
    The stream used by the modeler for its standard error output or null if the standard error output is disabled.
  - setStdErr
```
public void setStdErr(java.io.PrintStream stream)
```
    Sets the stream used by the modeler for its standard error output. The default is to redirect the standard error output stream to the Java standard error output stream. If the given stream is null, the standard error output of the modeler will be disabled.
    
    Parameters:
    
    stream - Stream to use for the standard error output or null to disable standard error output.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object

Class LSPModeler

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

LSPModeler

Method Detail

delete

close

loadModule

createModule

getSolver

createFunction

createFunction

createMap

createMap

createNil

createInt

createDouble

createBool

createString

getStdOut

setStdOut

getStdErr

setStdErr

hashCode

equals