Enum StrParam

pub enum StrParam {
    NodefileDir,
    SolFiles,
    WorkerPool,
    WorkerPassword,
    ComputeServer,
    TokenServer,
    ServerPassword,
    CSRouter,
    CSGroup,
    CloudAccessID,
    CloudSecretKey,
    CloudPool,
    CloudHost,
    CSManager,
    CSAuthToken,
    CSAPIAccessID,
    CSAPISecret,
    Username,
    CSAppName,
    LogFile,
    ResultFile,
    Dummy,
    JobID,
    UserName,
    WLSAccessID,
    WLSSecret,
    WLSToken,
}

Variants

NodefileDir

• Type: string (String)
• Default: “.”

Determines the directory into which nodes are written when node memory usage exceeds the specified NodefileStart value.

Note: Only affects mixed integer programming (MIP) models

Reference manual.

SolFiles

• Type: string (String)
• Default: “”

During the MIP solution process, multiple incumbent solutions are typically found on the path to finding a proven optimal solution. Setting this parameter to a non-empty string causes these solutions to be written to files (in .sol format) as they are found. The MIP solver will append _n.sol to the value of the parameter to form the name of the file that contains solution number $n$. For example, setting the parameter to value solutions/mymodel will create files mymodel_0.sol, mymodel_1.sol, etc., in directory solutions.

Note that intermediate solutions can be retrieved as they are generated through a callback (by requesting the MIPSOL_SOL in a MIPSOL callback). This parameter makes the process simpler.

Note: Only affects mixed integer programming (MIP) models

Reference manual.

WorkerPool

• Type: string (String)
• Default: “”

When using a distributed algorithm (distributed MIP, distributed concurrent, or distributed tuning), this parameter allows you to specify a Remote Services cluster that will provide distributed workers. You should also specify the access password for that cluster, if there is one, in the WorkerPassword parameter. Note that you don’t need to set either of these parameters if your job is running on a Compute Server node and you want to use the same cluster for the distributed workers.

You can provide a comma-separated list of machines for added robustness. If the first node in the list is unavailable, the client will attempt to contact the second node, etc.

To give an example, if you have a Remote Services cluster that uses port 61000 on a pair of machines named server1 and server2, you could set WorkerPool to “server1:61000” or “server1:61000,server2:61000”.

Reference manual.

WorkerPassword

• Type: string (String)
• Default: “”

When using a distributed algorithm (distributed MIP, distributed concurrent, or distributed tuning), this parameter allows you to specify the password for the distributed worker cluster provided in the WorkerPool parameter.

Reference manual.

ComputeServer

• Type: string (String)
• Default: “”

Set this parameter to the name of a node in the Remote Services cluster where you’d like your Compute Server job to run. You can refer to the server using its name or its IP address. If you are using a non-default port, the server name should be followed by the port number (e.g., server1:61000).

You will also need to set the ServerPassword parameter to supply the client password for the specified cluster.

You can provide a comma-separated list of nodes to increase robustness. If the first node in the list doesn’t respond, the second will be tried, etc.

Refer to the Gurobi Remote Services Reference Manual for more information on starting Compute Server jobs.

You must set this parameter through either a gurobi.lic file (using COMPUTESERVER=server) or an empty environment. Changing the parameter after your environment has been created will have no effect.

Reference manual.

TokenServer

• Type: string (String)
• Default: “”

When using a token license, set this parameter to the name of the token server. You can refer to the server using its name or its IP address.

You can provide a comma-separated list of token servers to increase robustness. If the first server in the list doesn’t respond, the second will be tried, etc.

You must set this parameter through either a gurobi.lic file (using TOKENSERVER=server) or an empty environment. Changing the parameter after your environment has been created will have no effect.

Reference manual.

ServerPassword

• Type: string (String)
• Default: “”

The password for connecting to the server (either a Compute Server or a token server).

For connecting to the Remote Services cluster referred to by the ComputeServer parameter, you’ll need to supply the client password. Refer to the Gurobi Remote Services Reference Manual for more information on starting Compute Server jobs.

Supply the token server password (if needed) when connecting to the server referred to by the TokenServer parameter,

You must set this parameter through either a gurobi.lic file (using PASSWORD=pwd) or an empty environment. Changing the parameter after your environment has been created will have no effect.

Reference manual.

CSRouter

• Type: string (String)
• Default: “”

The router node for a Remote Services cluster. A router can be used to improve the robustness of a Compute Server deployment. You can refer to the router using either its name or its IP address. A typical Remote Services deployment won’t use a router, so you typically won’t need to set this parameter.

Refer to the Gurobi Remote Services Reference Manual for more information on starting Compute Server jobs.

You must set this parameter through either a gurobi.lic file (using ROUTER=name) or an empty environment. Changing the parameter after your environment has been created will have no effect.

Reference manual.

CSGroup

• Type: string (String)
• Default: “”

Specifies one or more groups of cluster nodes to control the placement of the job. The list is a comma-separated string of group names, with optionally a priority for a group. For example, specifying group1:10,group2:50 means that the job will run on machines of group1 or group2, and if the job is queued, it will have priority 10 on group1 and 50 on group2. Note that if the group is not specified, the job may run on any node. If there are no nodes in the cluster having the specified groups, the job will be rejected.

Refer to the Gurobi Remote Services Reference Manual for more information on starting Compute Server jobs and in particular to Gurobi Remote Services cluster Grouping for more information on grouping cluster nodes.

You must set this parameter through either a license file (using GROUP=name) or an empty environment. Changing the parameter after your environment has been created will have no effect.

Reference manual.

CloudAccessID

• Type: string (String)
• Default: “”

Set this parameter to the Access ID for your Instant Cloud license when launching a new instance. You can retrieve this string from your account on the Gurobi Instant Cloud Manager website.

You must set this parameter through either a gurobi.lic file (using CLOUDACCESSID=id) or an empty environment. Changing the parameter after your environment has been created will have no effect.

Reference manual.

CloudSecretKey

• Type: string (String)
• Default: “”

Set this parameter to the Secret Key for your Instant Cloud license when launching a new instance. You can retrieve this string from your account on the Gurobi Instant Cloud Manager website.

You must set this parameter through either a gurobi.lic file (using CLOUDSECRETKEY=key) or an empty environment. Changing the parameter after your environment has been created will have no effect.

Reference manual.

CloudPool

• Type: string (String)
• Default: “”

Set this parameter to the name of the cloud pool you would like to use for your new Instant Cloud instance. You can browse your existing cloud pools or create new ones from your account on the Gurobi Instant Cloud Manager website.

You must set this parameter through either a gurobi.lic file (using CLOUDPOOL=pool) or an empty environment. Changing the parameter after your environment has been created will have no effect.

Reference manual.

CloudHost

• Type: string (String)
• Default: “”

Set this parameter to the host name of the Gurobi Cloud entry point. Currently cloud.gurobi.com.

You must set this parameter through either a gurobi.lic file (using CLOUDHOST=host) or an empty environment. Changing the parameter after your environment has been started will result in an error.

Reference manual.

CSManager

• Type: string (String)
• Default: “”

URL of the Cluster Manager for the Remote Services cluster.

You must set this parameter through either a gurobi.lic file (using CSMANAGER=YOUR_MANAGER_URL) or an empty environment. Changing the parameter after your environment has been started will result in an error.

Note: Cluster Manager only

Reference manual.

CSAuthToken

• Type: string (String)
• Default: “”

When a client authenticates with a Cluster Manager using a username and password, a signed token is returned by the server to be used in further calls or command-line operations. It is used internally.

Note: Cluster Manager only

Reference manual.

CSAPIAccessID

• Type: string (String)
• Default: “”

A unique identifier used to authenticate an application on a Gurobi Cluster Manager.

You can provide either an access ID and a secret key, or a username and password, to authenticate your connection to a Cluster Manager.

You must set this parameter through either a gurobi.lic file (using CSAPIACCESSID=YOUR_API_ID) or an empty environment. Changing the parameter after your environment has been started will result in an error.

Note: Cluster Manager only

Reference manual.

CSAPISecret

• Type: string (String)
• Default: “”

The secret password associated with an API access ID.

You can provide either an access ID and a secret key, or a username and password, to authenticate your connection to a Cluster Manager.

You must set this parameter through either a gurobi.lic file (using CSAPISECRET=YOUR_API_SECRET_KEY) or an empty environment. Changing the parameter after your environment has been started will result in an error.

Note: Cluster Manager only

Reference manual.

Username

TODO : documentation

CSAppName

• Type: string (String)
• Default: “”

The application name which will be sent to the server to track which application is submitting the batches or jobs.

Note: Cluster Manager only

Reference manual.

LogFile

• Type: string (String)
• Default: “”

Determines the name of the Gurobi log file. Modifying this parameter closes the current log file and opens the specified file. Use an empty string for no log file. Use OutputFlag to shut off all logging.

Reference manual.

ResultFile

• Type: string (String)
• Default: “”

Specifies the name of the result file to be written upon completion of optimization. The type of the result file is determined by the file suffix. The most commonly used suffixes are .sol (to capture the solution vector), .bas (to capture the simplex basis), and .mst (to capture the solution vector on the integer variables). You can also write a .ilp file (to capture the IIS for an infeasible model), or a .mps, .rew, .lp, or .rlp file (to capture the original model), or a .dua or .dlp file (to capture the dual of a pure LP model). The file suffix may optionally be followed by .gz, .bz2, or .7z, which produces a compressed result.

More information on the file formats can be found in the File Format section.

Reference manual.

Dummy

TODO : documentation

JobID

• Type: string (String)
• Default: “”

If you are running on a Compute Server, this parameter provides the Compute Server Job ID for the current job. Note that this is a read-only parameter.

Reference manual.

UserName

• Type: string (String)
• Default: “”

Identify the user connecting to the Remote Services Manager.

You can provide either a username and password, or an access ID and a secret key, to authenticate your connection to a Cluster Manager.

You can set this parameter through either a gurobi.lic file (using USERNAME=YOUR_USERNAME) or an empty environment. Changing the parameter after your environment has been started will result in an error.

Note: Cluster Manager only

Reference manual.

WLSAccessID

• Type: string (String)
• Default: “”

When using a WLS license, set this parameter to the access ID for your license. You can retrieve this string from your account on the Gurobi Web License Manager site.

Reference manual.

WLSSecret

• Type: string (String)
• Default: “”

When using a WLS license, set this parameter to the secret key for your license. You can retrieve this string from your account on the Gurobi Web License Manager site.

Reference manual.

WLSToken

• Type: string (String)
• Default: “”

If you are using a WLS license and have retrieved your own token through the WLS REST API, use this parameter to pass that token to the library. If you do this, you don’t need to set any other WLS-related parameters.

Reference manual.

Trait Implementations

impl AsCStr for StrParam

fn as_cstr(&self) -> &'static CStr

Represent self as a &CStr

impl Clone for StrParam

fn clone(&self) -> StrParam

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for StrParam

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl FromCStr for StrParam

type Err = &'static str

The error type returned if parsing fails.

fn from_cstr(s: &CStr) -> Result<Self, Self::Err>

Parse the &CStr for an instance of Self.

impl Hash for StrParam

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl ParamGet<String> for StrParam

fn get(&self, env: &Env) -> Result<String>

This parameter’s value type (string, double, int, char) Query a parameter from an environment

impl ParamSet<String> for StrParam

fn set(&self, env: &mut Env, value: String) -> Result<()>

Set a parameter on an environment

impl PartialEq for StrParam

fn eq(&self, other: &StrParam) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for StrParam

impl Eq for StrParam

impl StructuralPartialEq for StrParam