Documentation

Next: GRBEnv.dispose() Up: GRBEnv Previous: GRBEnv

GRBEnv()

Environment constructor.

Constructor for GRBEnv object. If the constructor is called with no arguments, no log file will be written for the environment.

You have the option of constructing either a local environment, which solves Gurobi models on the local machine, or a client environment for a Gurobi compute server, which will solve Gurobi models on a server machine. For the latter, choose the signature that allows you to specify the names of the Gurobi compute servers and the priority of the associated job.

Note that the GRBEnv constructor will check the current working directory for a file named gurobi.env, and it will attempt to read parameter settings from this file if it exists. The file should be in PRM format (briefly, each line should contain a parameter name, followed by the desired value for that parameter).

In general, you should aim to create a single Gurobi environment object in your program, even if you plan to work with multiple models. Reusing one environment is much more efficient than creating and destroying multiple environments.

Create a Gurobi environment (with logging disabled).

Return value:

An environment object (with no associated log file).

Create a Gurobi environment (with logging enabled).

Arguments:

logFileName: The desired log file name.

Return value:

An environment object.

Create a client Gurobi environment on a compute server.

Arguments:

logFileName: The name of the log file for this environment. Pass an empty string for no log file.

computeserver: A comma-separated list of Gurobi compute servers. You can refer to compute server machines using their names or their IP addresses.

port: The port number used to connect to the compute server. You should pass a -1 value, which indicates that the default port should be used, unless your server administrator has changed our recommended port settings.

password: The password for gaining access to the specified compute servers. Pass an empty string if no password is required.

priority: The priority of the job. Priorities must be between -100 and 100, with a default value of 0 (by convention). Higher priority jobs are chosen from the server job queue before lower priority jobs. A job with priority 100 runs immediately, bypassing the job queue and ignoring the job limit on the server. You should exercise caution with priority 100 jobs, since they can severely overload a server, which can cause jobs to fail, and in extreme cases can cause the server to crash.

timeout: Job timeout (in seconds). If the job doesn't reach the front of the queue before the specified timeout, the constructor will throw a JOB_REJECTED exception. Use a negative value to indicate that the call should never timeout.

Return value:

An environment object.

---

Next: GRBEnv.dispose() Up: GRBEnv Previous: GRBEnv