Class GurobiSolverConfiguration

The gurobi solver configuration.

Inheritance
System.Object
SolverConfiguration
GurobiSolverConfiguration
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: OPTANO.Modeling.Optimization.Solver.Gurobi1300
Assembly: Optimization.Solver.Gurobi1300.dll
Syntax
public class GurobiSolverConfiguration : SolverConfiguration

Properties

AggFill

Presolve aggregation fill level: Controls the amount of fill allowed during presolve aggregation. Larger values generally lead to presolved models with fewer rows and columns, but with more constraint matrix non-zeros. The default value chooses automatically, and usually works well. One important note about integer-valued parameters: while the maximum value that can be stored in a signed integer is(2^{31}-1), we use a MAXINT value of 2,000,000,000. Attempting to set an integer parameter to a value larger than this maximum will produce an error. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? AggFill { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

Aggregate

Presolve aggregation: Controls the aggregation level in presolve. The options are off (0), moderate (1), or aggressive (2). In rare instances, aggregation can lead to an accumulation of numerical errors. Turning it off can sometimes improve solution accuracy. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? Aggregate { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

ApplicationName

In case you are using a Gurobi application license, use this property to set your application name

Declaration
public string ApplicationName { get; set; }
Property Value
Type Description
System.String

ApplyParameterFileBeforeModelingConfiguration

Gets or sets a value indicating whether the file specified in ParameterFilePath is applied before (true) or after (false) the other settings in GurobiSolverConfiguration.

Declaration
public bool ApplyParameterFileBeforeModelingConfiguration { get; set; }
Property Value
Type Description
System.Boolean

BarConvTol

Barrier convergence tolerance: The barrier solver terminates with aGRB_OPTIMALstatus when some solution quality attributes are less than the specified tolerance. The algorithm considers the relative difference between the primal and dual objective values, relative primal and dual feasiblity, and complementarity. Tightening this tolerance often produces a more accurate solution, which can sometimes reduce the time spent in crossover. Be aware that such tightening may result in an increase of barrier iterations and hence computation time spent therein. Loosening it causes the barrier algorithm to terminate with a less accurate solution, which can be useful when barrier is making very slow progress in later iterations but increases chances of prolonged runtime in crossover. This parameter does not affect models with quadratic constraints. For these models useBarQCPConvTol. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public double? BarConvTol { get; set; }
Property Value
Type Description
System.Nullable<System.Double>

BarCorrectors

Barrier central corrections: Limits the number of central corrections performed in each barrier iteration. The default value chooses automatically, depending on problem characteristics. The automatic strategy generally works well, although it is often possible to obtain higher performance on a specific model by selecting a value manually. One important note about integer-valued parameters: while the maximum value that can be stored in a signed integer is(2^{31}-1), we use a MAXINT value of 2,000,000,000. Attempting to set an integer parameter to a value larger than this maximum will produce an error. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? BarCorrectors { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

BarHomogeneous

Barrier homogeneous algorithm: Determines whether to use the homogeneous barrier algorithm. At the default setting (-1), it is only used when barrier solves a node relaxation for a MIP model. Setting the parameter to 0 turns it off, and setting it to 1 forces it on. The homogeneous algorithm is useful for recognizing infeasibility or unboundedness. It is a bit slower than the default algorithm. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? BarHomogeneous { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

BarIterLimit

Barrier iteration limit: Limits the number of barrier iterations performed. This parameter is rarely used. If you would like barrier to terminate early, it is almost always better to use theBarConvTolparameter instead. Optimization returns with anITERATION_LIMITstatus if the limit is exceeded. This parameter iscallback settable. It can be changed from within a callback when thewherevalue isPRESOLVED,SIMPLEX,MIP,MIPSOL,MIPNODE,BARRIER, orMULTIOBJ(see theCallback Codessection for more information). How to do that for the different APIs is illustratedhere. In case of a remote server, the change of a parameter from within a callback may not be taken into account immediately. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? BarIterLimit { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

BarOrder

Barrier ordering algorithm: Chooses the barrier sparse matrix fill-reducing algorithm. A value of 0 chooses Approximate Minimum Degree ordering, while a value of 1 chooses Nested Dissection ordering. The default value of -1 chooses automatically. You should only modify this parameter if you notice that the barrier ordering phase is consuming a significant fraction of the overall barrier runtime. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? BarOrder { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

BarQCPConvTol

Barrier convergence tolerance for QCP models: When solving a QCP model, the barrier solver terminates with aGRB_OPTIMALstatus when some solution quality attributes are less than the specified tolerance. The algorithm considers the relative difference between the primal and dual objective values, relative primal and dual feasiblity, and complementarity. Tightening this tolerance may lead to a more accurate solution, but it may also lead to a failure to converge. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public double? BarQCPConvTol { get; set; }
Property Value
Type Description
System.Nullable<System.Double>

BestBdStop

Objective bound to stop optimization: Terminates as soon as the engine determines that the best bound on the objective value is at least as good as the specified value. Optimization returns with anUSER_OBJ_LIMITstatus in this case. Note that you should always include a small tolerance in this value. Without this, a bound that satisfies the intended termination criterion may not actually lead to termination due to numerical round-off in the bound. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public double? BestBdStop { get; set; }
Property Value
Type Description
System.Nullable<System.Double>

BestObjStop

Objective value to stop optimization: Terminate as soon as the engine finds a feasible solution whose objective value is at least as good as the specified value. Optimization returns with anUSER_OBJ_LIMITstatus in this case. Note that you should always include a small tolerance in this value. Without this, a solution that satisfies the intended termination criterion may not actually lead to termination due to numerical round-off in the objective. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public double? BestObjStop { get; set; }
Property Value
Type Description
System.Nullable<System.Double>

BQPCuts

BQP cut generation: Controls Boolean Quadric Polytope (BQP) cut generation. Use 0 to disable these cuts, 1 for moderate cut generation, or 2 for aggressive cut generation. The default -1 value chooses automatically. Overrides theCutsparameter. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? BQPCuts { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

BranchDir

Preferred branch direction: Determines which child node is explored first in the branch-and-cut search. The default value chooses automatically. A value of -1 will always explore the down branch first, while a value of 1 will always explore the up branch first. Changing the value of this parameter rarely produces a significant benefit. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? BranchDir { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

CliqueCuts

Clique cut generation: Controls clique cut generation. Use 0 to disable these cuts, 1 for moderate cut generation, or 2 for aggressive cut generation. The default -1 value choose automatically. Overrides theCutsparameter. We have observed that setting this parameter to its aggressive setting can produce a significant benefit for some large set partitioning models. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? CliqueCuts { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

CloudAccessID

Access ID for Gurobi Instant Cloud: 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 theGurobi Instant Cloud Managerwebsite. You must set this parameter through either agurobi.licfile (usingCLOUDACCESSID=id) or anempty environment. Changing the parameter after your environment has been created will have no effect. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public string CloudAccessID { get; set; }
Property Value
Type Description
System.String

CloudHost

Host for the Gurobi Cloud entry point: Set this parameter to the host name of the Gurobi Cloud entry point. Currentlycloud.gurobi.com. You must set this parameter through either agurobi.licfile (usingCLOUDHOST=host) or anempty environment. Changing the parameter after your environment has been started will result in an error. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public string CloudHost { get; set; }
Property Value
Type Description
System.String

CloudPool

Cloud pool to use for Gurobi Instant Cloud instance: 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 theGurobi Instant Cloud Managerwebsite. You must set this parameter through either agurobi.licfile (usingCLOUDPOOL=pool) or anempty environment. Changing the parameter after your environment has been created will have no effect. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public string CloudPool { get; set; }
Property Value
Type Description
System.String

CloudSecretKey

Secret Key for Gurobi Instant Cloud: 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 theGurobi Instant Cloud Managerwebsite. You must set this parameter through either agurobi.licfile (usingCLOUDSECRETKEY=key) or anempty environment. Changing the parameter after your environment has been created will have no effect. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public string CloudSecretKey { get; set; }
Property Value
Type Description
System.String

ComputeIIS

Specifies whether the IIS should be computed or not. You will find the IIS in the returned solution.

Declaration
[Display(Name = "Compute IIS", ShortName = "Compute IIS", Description = "Specifies whether the IIS should be computed or not - you will find the IIS in the returned solution ")]
public bool ComputeIIS { get; set; }
Property Value
Type Description
System.Boolean

ComputeServer

Name of a node in the Remote Services cluster: 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 theServerPasswordparameter 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 theGurobi Remote Services Reference Manualfor more information on starting Compute Server jobs. You must set this parameter through either agurobi.licfile (usingCOMPUTESERVER=server) or anempty environment. Changing the parameter after your environment has been created will have no effect. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public string ComputeServer { get; set; }
Property Value
Type Description
System.String

ConcurrentJobs

Distributed concurrent optimizer job count: Enables distributed concurrent optimization, which can be used to solve LP or MIP models on multiple machines. A value ofncauses the solver to createnindependent models, using different parameter settings for each. Each of these models is sent to a distributed worker for processing. Optimization terminates when the first solve completes. Use theComputeServerparameter to indicate the name of the cluster where you would like your distributed concurrent job to run (or useWorkerPoolif your client machine will act as manager and you just need a pool of workers). By default, Gurobi chooses the parameter settings used for each independent solve automatically. You can create concurrent environments to choose your own parameter settings (refer to theconcurrent optimizationsection for details). The intent of concurrent MIP solving is to introduce additional diversity into the MIP search. By bringing the resources of multiple machines to bear on a single model, this approach can sometimes solve models much faster than a single machine. The distributed concurrent solver produces a slightly different log from the standard solver, and provides different callbacks as well. Please refer to theDistributedAlgorithmssection of theGurobi Remote Services Reference Manualfor additional details. One important note about integer-valued parameters: while the maximum value that can be stored in a signed integer is(2^{31}-1), we use a MAXINT value of 2,000,000,000. Attempting to set an integer parameter to a value larger than this maximum will produce an error. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? ConcurrentJobs { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

ConcurrentMethod

Controls the methods used by the concurrent continuous solver: This parameter is only evaluated when solving an LP with a concurrent solver (Method= 3 or 4). It controls which methods are run concurrently by the concurrent solver. Options are: Which methods are actually run also depends on the number of threads available. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? ConcurrentMethod { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

ConcurrentMIP

Enables the concurrent MIP solver: This parameter enables the concurrent MIP solver. When the parameter is set to valuen, the MIP solver performsnindependent MIP solves in parallel, with different parameter settings for each. Optimization terminates when the first solve completes. By default, Gurobi chooses the parameter settings used for each independent solve automatically. You can create concurrent environments to choose your own parameter settings (refer to theconcurrent optimizationsection for details). The intent of concurrent MIP solving is to introduce additional diversity into the MIP search. This approach can sometimes solve models much faster than applying all available threads to a single MIP solve, especially on very large parallel machines. The concurrent MIP solver divides available threads evenly among the independent solves. For example, if you have 6 threads available and you setConcurrentMIPto 2, the concurrent MIP solver will allocate 3 threads to each independent solve. Note that the number of independent solves launched will not exceed the number of available threads. The concurrent MIP solver produces a slightly different log from the standard MIP solver, and provides different callbacks as well. Please refer to theconcurrent optimizerdiscussion for additional details. Concurrent MIP is not deterministic. If runtimes for different independent solves are very similar, and if the model has multiple optimal solutions, you may get slightly different results from multiple runs on the same model. One important note about integer-valued parameters: while the maximum value that can be stored in a signed integer is(2^{31}-1), we use a MAXINT value of 2,000,000,000. Attempting to set an integer parameter to a value larger than this maximum will produce an error. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? ConcurrentMIP { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

ConstraintBatchSize

Gets or sets the batch size for adding constraints to the Gurobi.GRBModel. Decrease this value, if you experience IDLE_TIMEOUT errors during the transformation of the "modeling model" to the "gurobi model", while using a gurobi cloud solver instance.

Declaration
public int ConstraintBatchSize { get; set; }
Property Value
Type Description
System.Int32

CoverCuts

Cover cut generation: Controls cover cut generation. Use 0 to disable these cuts, 1 for moderate cut generation, or 2 for aggressive cut generation. The default -1 value chooses automatically. Overrides theCutsparameter. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? CoverCuts { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

Crossover

Barrier crossover strategy: Determines the crossover strategy used to transform the interior solution produced by barrier or PDHG into a basic solution (note that crossover is not available for QP or QCP models). Crossover consists of three phases: (i) aprimal pushphase, where primal variables are pushed to bounds, (ii) adual pushphase, where dual variables are pushed to bounds, and (iii) acleanupphase, where simplex is used to remove any primal or dual infeasibilities that remain after the push phases are complete. The order of the first two phases and the algorithm used for the third phase are both controlled by theCrossoverparameter: The default value of -1 chooses the strategy automatically. Use value 0 to disable crossover; this setting returns the interior solution computed by barrier or PDHG. Since an interior solution is typically less accurate than a basic solution after crossover, disabling crossover may sometimes result in barrier or PDHG performing more iterations to improve the returned interior solution. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? Crossover { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

CrossoverBasis

Crossover basis construction strategy: Determines the initial basis construction strategy for crossover. A value of 0 chooses an initial basis quickly. A value of 1 can take much longer, but often produces a more numerically stable start basis. The default value of -1 makes an automatic choice. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? CrossoverBasis { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

CSAPIAccessID

Access ID for Gurobi Cluster Manager: A unique identifier used to authenticate an application on a Gurobi Cluster Manager. You can provide either an access ID and asecret key, or ausernameandpassword, to authenticate your connection to a Cluster Manager. You must set this parameter through either agurobi.licfile (usingCSAPIACCESSID=YOUR_API_ID) or anempty environment. Changing the parameter after your environment has been started will result in an error. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public string CSAPIAccessID { get; set; }
Property Value
Type Description
System.String

CSAPISecret

Secret key for Gurobi Cluster Manager: The secret password associated with an API access ID. You can provide either anaccess IDand a secret key, or ausernameandpassword, to authenticate your connection to a Cluster Manager. You must set this parameter through either agurobi.licfile (usingCSAPISECRET=YOUR_API_SECRET_KEY) or anempty environment. Changing the parameter after your environment has been started will result in an error. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public string CSAPISecret { get; set; }
Property Value
Type Description
System.String

CSAppName

Application name of the batches or jobs: The application name which will be sent to the server to track which application is submitting the batches or jobs. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public string CSAppName { get; set; }
Property Value
Type Description
System.String

CSAuthToken

JSON Web Token for accessing the Cluster Manager: 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. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public string CSAuthToken { get; set; }
Property Value
Type Description
System.String

CSBatchMode

Controls Batch-Mode optimization: When set to 1, enable the local creation of models, and later submit batch-optimization jobs to the Cluster Manager. See theBatch Optimizationsection for more details. Note that ifCSBatchModeis enabled, only batch-optimization calls are allowed. You must set this parameter through either agurobi.licfile (usingCSBATCHMODE=1) or anempty environment. Changing the parameter after your environment has been started will result in an error. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public bool? CSBatchMode { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

CSClientLog

Turns logging on or off: Turns logging on or off for Compute Server and the Web License Service (WLS). Options are off (0), only error messages (1), information and error messages (2), or (3) verbose, information, and error messages. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? CSClientLog { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

CSGroup

Group placement request for cluster: 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, specifyinggroup1:10,group2:50means that the job will run on machines ofgroup1orgroup2, 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 theGurobi Remote Services Reference Manualfor more information on starting Compute Server jobs and in particular toGurobi Remote Services Cluster Groupingfor more information on grouping cluster nodes. You must set this parameter through either a license file (usingGROUP=name) or anempty environment. Changing the parameter after your environment has been created will have no effect. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public string CSGroup { get; set; }
Property Value
Type Description
System.String

CSIdleTimeout

Idle time before Compute Server kills a job: This parameter allows you to set a limit on how long a Compute Server job can sit idle before the server kills the job (in seconds). A job is considered idle if the server is not currently performing an optimization and the client has not issued any additional commands. The default value will allow a job to sit idle indefinitely in all but one circumstance. Currently the only exception is the Gurobi Instant Cloud, where the default setting will automatically impose a 30 minute idle time limit (1800 seconds). If you are using an Instant Cloud pool, the actual value will be the maximum between this parameter value and the idle timeout defined by the pool. You must set this parameter through either agurobi.licfile (usingIDLETIMEOUT=n) or anempty environment. Changing the parameter after your environment has been created will have no effect. Refer to theGurobi Remote Services Reference Manualfor more information on starting Compute Server jobs. One important note about integer-valued parameters: while the maximum value that can be stored in a signed integer is(2^{31}-1), we use a MAXINT value of 2,000,000,000. Attempting to set an integer parameter to a value larger than this maximum will produce an error. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? CSIdleTimeout { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

CSManager

URL of the Cluster Manager for the Remote Services cluster: URL of the Cluster Manager for the Remote Services cluster. You must set this parameter through either agurobi.licfile (usingCSMANAGER=YOUR_MANAGER_URL) or anempty environment. Changing the parameter after your environment has been started will result in an error. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public string CSManager { get; set; }
Property Value
Type Description
System.String

CSPriority

Job priority for Remote Services job: The priority of the Compute Server 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. Refer to theGurobi Remote Services Reference Manualfor more information on starting Compute Server jobs. You must set this parameter through either agurobi.licfile (usingPRIORITY=n) or anempty environment. Changing the parameter after your environment has been created will have no effect. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? CSPriority { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

CSQueueTimeout

Queue timeout for new jobs: This parameter allows you to set a limit (in seconds) on how long a new Compute Server job will wait in queue before it gives up (and reports aJOB_REJECTEDerror). Note that there might be a delay of up to 20 seconds for the actual signaling of the time out. Any negative value will allow a job to sit in the Compute Server queue indefinitely. You must set this parameter through agurobi.licfile (usingQUEUETIMEOUT=n) or anempty environment. Changing the parameter after your environment has been created will have no effect. Refer to theGurobi Remote Services Reference Manualfor more information on starting Compute Server jobs. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public double? CSQueueTimeout { get; set; }
Property Value
Type Description
System.Nullable<System.Double>

CSRouter

Router node for Remote Services cluster: 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 theGurobi Remote Services Reference Manualfor more information on starting Compute Server jobs. You must set this parameter through either agurobi.licfile (usingROUTER=name) or anempty environment. Changing the parameter after your environment has been created will have no effect. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public string CSRouter { get; set; }
Property Value
Type Description
System.String

CSTLSInsecure

Use insecure mode in Transport Layer Security (TLS): Indicates whether the Remote Services cluster is using insecure mode in the TLS (Transport Layer Security). Leave this at its default value of 0 unless your server administrator tells you otherwise. Refer to theGurobi Remote Services Reference Manualfor more information on starting Compute Server jobs. You must set this parameter through either agurobi.licfile (usingCSTLSINSECURE) or anempty environment. Changing the parameter after your environment has been created will have no effect. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public bool? CSTLSInsecure { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

CutAggPasses

Constraint aggregation passes in cut generation: A non-negative value indicates the maximum number of constraint aggregation passes performed during cut generation. Overrides theCutsparameter. Changing the value of this parameter rarely produces a significant benefit. One important note about integer-valued parameters: while the maximum value that can be stored in a signed integer is(2^{31}-1), we use a MAXINT value of 2,000,000,000. Attempting to set an integer parameter to a value larger than this maximum will produce an error. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? CutAggPasses { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

Cutoff

Objective cutoff: Indicates that you aren’t interested in solutions whose objective values are worse than the specified value. If the objective value for the optimal solution is equal to or better than the specified cutoff, the solver will return the optimal solution. Otherwise, it will terminate with aCUTOFFstatus. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public double? Cutoff { get; set; }
Property Value
Type Description
System.Nullable<System.Double>

CutPasses

Cutting plane passes: A non-negative value indicates the maximum number of cutting plane passes performed during root cut generation. The default value chooses the number of cut passes automatically. In addition to cutting plane separation, each cut pass also applies heuristics and node probing and also may launch parallel root helper threads. So even when theCutsparameter is set to 0, the cut loop will apply probing, heuristics and parallel root helpers in a single cut loop iteration. You should experiment with different values of this parameter if you notice the MIP solver spending significant time on root cut passes that have little impact on the objective bound. One important note about integer-valued parameters: while the maximum value that can be stored in a signed integer is(2^{31}-1), we use a MAXINT value of 2,000,000,000. Attempting to set an integer parameter to a value larger than this maximum will produce an error. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? CutPasses { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

Cuts

Global cut control: Global cut aggressiveness setting. Use value 0 to shut off cuts, 1 for moderate cut generation, 2 for aggressive cut generation, and 3 for very aggressive cut generation. The default -1 value chooses automatically. This parameter is overridden by the parameters that control individual cut types (e.g.,CliqueCuts). For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? Cuts { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

DateCode

Gets or sets the ISV expiration date. Set as YYYYMMDD.

Declaration
public int DateCode { get; set; }
Property Value
Type Description
System.Int32

DegenMoves

Degenerate simplex moves: Limits degenerate simplex moves. These moves are performed to improve the integrality of the current relaxation solution. By default, the algorithm chooses the number of degenerate move passes to perform automatically. The default setting generally works well, but there can be cases where an excessive amount of time is spent after the initial root relaxation has been solved but before the cut generation process or the root heuristics have started. If you see multiple ‘Total elapsed time’ messages in the log immediately after the root relaxation log, you may want to try setting this parameter to 0. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? DegenMoves { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

Disconnected

Disconnected component strategy: A MIP or an LP model can sometimes be made up of multiple, completely independent sub-models. This parameter controls how aggressively we try to exploit this structure. A value of 0 ignores this structure entirely, while larger values try more aggressive approaches. The default value of -1 chooses automatically. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? Disconnected { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

DisplayInterval

Frequency of log lines: Determines the frequency at which log lines are printed (in seconds). One important note about integer-valued parameters: while the maximum value that can be stored in a signed integer is(2^{31}-1), we use a MAXINT value of 2,000,000,000. Attempting to set an integer parameter to a value larger than this maximum will produce an error. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? DisplayInterval { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

DistributedMIPJobs

Distributed MIP job count: Enables distributed MIP. A value ofncauses the MIP solver to divide the work of solving a MIP model amongnmachines. Use theComputeServerparameter to indicate the name of the cluster where you would like your distributed MIP job to run (or useWorkerPoolif your client machine will act as manager and you just need a pool of workers). The distributed MIP solver produces a slightly different log from the standard MIP solver, and provides different callbacks as well. Please refer to theDistributedAlgorithmssection of theGurobi Remote Services Reference Manualfor additional details. One important note about integer-valued parameters: while the maximum value that can be stored in a signed integer is(2^{31}-1), we use a MAXINT value of 2,000,000,000. Attempting to set an integer parameter to a value larger than this maximum will produce an error. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? DistributedMIPJobs { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

DualImpliedCuts

Dual implied bound cut generation: Controls dual implied bound cut generation. Use 0 to disable these cuts, 1 for moderate cut generation, or 2 for aggressive cut generation. The default -1 value chooses automatically. Overrides theCutsparameter. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? DualImpliedCuts { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

DualReductions

Controls dual reductions: Determines whether dual reductions are performed during the optimization process. You should disable these reductions if you received an optimization status ofINF_OR_UNBDand would like a more definitive conclusion. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public bool? DualReductions { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

EnableSelectiveCallbacks

Gets or sets a value indicating whether to use selective callback functionality introduced in Gurobi 13.0. When enabled, only relevant callback events are invoked, which can significantly improve performance especially for remote workers by reducing unnecessary callback messages. Default is true to take advantage of performance improvements in Gurobi 13.0.

Declaration
public bool EnableSelectiveCallbacks { get; set; }
Property Value
Type Description
System.Boolean

EnableUserSolutionQueue

Enables Gurobi.GRB.Callback.MIPNODE where-Flag during callbacks. If set to false (when using selective callbacks), OPTANO.Modeling.Optimization.Solver.Gurobi1300.GurobiSolver.UserSolutionQueue will be ignored. Only takes effect, if EnableSelectiveCallbacks is true. HINT: Set value to false, if you do not intend to pass user solutions during the solution process. (Default value: true).

Declaration
public bool EnableUserSolutionQueue { get; set; }
Property Value
Type Description
System.Boolean

FeasibilityTol

Primal feasibility tolerance: All constraints must be satisfied to a tolerance ofFeasibilityTol. Tightening this tolerance can produce smaller constraint violations, but for numerically challenging models it can sometimes lead to much larger iteration counts. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public double? FeasibilityTol { get; set; }
Property Value
Type Description
System.Nullable<System.Double>

FeasRelaxBigM

Big-M value for feasibility relaxations: When relaxing a constraint in a feasibility relaxation, it is sometimes necessary to introduce a big-M value. This parameter determines the default magnitude of that value. For details about feasibility relaxations, refer to e.g.GRBfeasrelaxin the C API. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public double? FeasRelaxBigM { get; set; }
Property Value
Type Description
System.Nullable<System.Double>

FixVarsInIndicators

Controls conversion of indicator constraints in the fixed model: Controls how Gurobi deals with indicator constraints when creating the fixed model (e.g.GRBconverttofixedandGRBfixmodelin C, orModel.convertToFixedandModel.fixedin Python). If set to 0 (the default), then an indicator constraint is discarded if its premise is false (i.e., if the associated binary indicator variable is fixed to a value that does not satisfy the premise condition) in the solution or MIP start that is associated to the fixed model. On the other hand, if the premise of the indicator is true, then the implied linear constraint is added as a regular linear constraint to the fixed model. Let’s consider the case whereFixVarsInIndicatorsis set to 0. If there is an indicator constraint (z = 0 \rightarrow ax \leq b) in the model and variable(z)has value 1 in the solution for which the fixed model is created, then the indicator constraint is not active and it is therefore discarded from the fixed model. If the indicator variable(z)has value 0, then the indicator is active and the linear constraint(ax \leq b)is added to the fixed model. If theFixVarsInIndicatorsparameter is set to 1, then all variables (including continuous variables) in the indicator constraint are fixed to their solution value, independent of whether the indicator is active or not in the associated solution.

Declaration
public bool? FixVarsInIndicators { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

FlowCoverCuts

Flow cover cut generation: Controls flow cover cut generation. Use 0 to disable these cuts, 1 for moderate cut generation, or 2 for aggressive cut generation. The default -1 value chooses automatically. Overrides theCutsparameter. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? FlowCoverCuts { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

FlowPathCuts

Flow path cut generation: Controls flow path cut generation. Use 0 to disable these cuts, 1 for moderate cut generation, or 2 for aggressive cut generation. The default -1 value chooses automatically. Overrides theCutsparameter. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? FlowPathCuts { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

FuncMaxVal

Maximum allowed value for x and y variables in function constraints with piecewise-linear approximation: Very large values in piecewise-linear approximations can cause numerical issues. This parameter limits the bounds on the variables that participate in function constraints approximated by a piecewise-linear function. Specifically, any bound larger thanFuncMaxVal(in absolute value) on the variables participating in such a function constraint will be truncated. If theFuncNonlinear attributeof the constraint is set to 1, or if it is set to -1 and the globalFuncNonlinear parameteris set to 1, the function constraint is not approximated by a piecewise-linear function and theFuncMaxValparameter does not apply. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public double? FuncMaxVal { get; set; }
Property Value
Type Description
System.Nullable<System.Double>

FuncNonlinear

Chooses the approximation approach used to handle function constraints: This parameter controls whether general function constraints with theirFuncNonlinear attributeset to -1 are replaced with a static piecewise-linear approximation (0), or handled inside the branch-and-bound tree using a dynamic outer-approximation approach (1). See the discussion offunction constraintsfor more information. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public bool? FuncNonlinear { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

FuncPieceError

Error allowed for PWL translation of function constraints: If theFuncPiecesparameter is set to value(-1)or(-2), this attribute provides the maximum allowed error (absolute for(-1), relative for(-2)) in the piecewise-linear approximation. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public double? FuncPieceError { get; set; }
Property Value
Type Description
System.Nullable<System.Double>

FuncPieceLength

Piece length for PWL translation of function constraints: If theFuncPiecesparameter is set to value(1), this parameter gives the length of each piece of the piecewise-linear approximation. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public double? FuncPieceLength { get; set; }
Property Value
Type Description
System.Nullable<System.Double>

FuncPieceRatio

Control whether to under- or over-estimate function values in PWL approximation: This parameter controls whether the piecewise-linear approximation of a function constraint is an underestimate of the function, an overestimate, or somewhere in between. A value of(0.0)will always underestimate, while a value of(1.0)will always overestimate. A value in between will interpolate between the underestimate and the overestimate. A special value of -1 chooses points that are on the original function. The behaviour is not defined for other negative values. See the discussion offunction constraintsfor more information. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public double? FuncPieceRatio { get; set; }
Property Value
Type Description
System.Nullable<System.Double>

FuncPieces

Sets strategy for PWL function approximation: This parameter sets the strategy used for performing a piecewise-linear approximation of a function constraint. There are a few options: This parameter only applies to function constraints whoseFuncPiecesattribute has been set to(0). See the discussion offunction constraintsfor more information. One important note about integer-valued parameters: while the maximum value that can be stored in a signed integer is(2^{31}-1), we use a MAXINT value of 2,000,000,000. Attempting to set an integer parameter to a value larger than this maximum will produce an error. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? FuncPieces { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

GomoryPasses

Gomory cut passes: A non-negative value indicates the maximum number of Gomory cut passes performed. Overrides theCutsparameter. One important note about integer-valued parameters: while the maximum value that can be stored in a signed integer is(2^{31}-1), we use a MAXINT value of 2,000,000,000. Attempting to set an integer parameter to a value larger than this maximum will produce an error. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? GomoryPasses { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

GUBCoverCuts

GUB cover cut generation: Controls GUB cover cut generation. Use 0 to disable these cuts, 1 for moderate cut generation, or 2 for aggressive cut generation. The default -1 value chooses automatically. Overrides theCutsparameter. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? GUBCoverCuts { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

Heuristics

Time spent in feasibility heuristics: Determines the amount of time spent in MIP heuristics. You can think of the value as the desired fraction of total MIP runtime devoted to heuristics (so by default, we aim to spend 5% of runtime on heuristics). Larger values produce more and better feasible solutions, at a cost of slower progress in the best bound. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public double? Heuristics { get; set; }
Property Value
Type Description
System.Nullable<System.Double>

IgnoreNames

Indicates whether to ignore names provided by users.: This parameter affects how Gurobi deals with names. If set to 1, subsequent calls to add variables or constraints to the model will ignore the associated names. Names for objectives and the model will also be ignored. In addition, subsequent calls to modify name attributes will have no effect. Note that variables or constraints that had names at the point this parameter was changed to 1 will retain their names. If you wish to discard all name information, you should set this parameter to 1 before adding variables or constraints to the model. In addition, the parameter affects the behavior of the write functions (e.g.GRBwritein C, orModel.writein Python). IfIgnoreNamesis set to 1, Gurobi uses default names when writing the file. This can be useful if you have a model with names and want to write the model, the attributes, a MIP start file, or other information to disk without including variable and constraint names in the files. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public bool? IgnoreNames { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

IISMethod

Selects method used to compute IIS: Chooses the IIS method to use. To compute an IIS for an LP, it is sufficient to solve an LP with dimensions similar to the dual of the original model. If the solve time for that LP is excessive, setting the IISMethod parameter to 1 may offer a faster alternative; other settings do not alter the default approach for infeasible LPs. For MIPs, filtering of constraints and variables is required, which involves solving a series of related MIP subproblems. Methods 0-2 all use filtering techniques. Method 0 is often faster than method 1, but may produce a larger IIS. Method 2 ignores the bound constraints. It therefore tends to be faster than methods 0-1, but will fail if these bounds are necessary to make the problem infeasible. Method 3 will return the IIS for the LP relaxation of a MIP model if the relaxation is infeasible, even though the result may not be minimal when integrality constraints are included. The default value of -1 chooses automatically. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? IISMethod { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

ImpliedCuts

Implied bound cut generation: Controls implied bound cut generation. Use 0 to disable these cuts, 1 for moderate cut generation, or 2 for aggressive cut generation. The default -1 value chooses automatically. Overrides theCutsparameter. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? ImpliedCuts { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

ImproveStartGap

Solution improvement strategy control: The MIP solver can change parameter settings in the middle of the search in order to adopt a strategy that gives up on moving the best bound and instead devotes all of its effort towards finding better feasible solutions. This parameter allows you to specify an optimality gap at which the MIP solver switches to this solution improvement strategy. For example, setting this parameter to 0.1 will cause the MIP solver to switch strategies once the relative optimality gap is smaller than 0.1. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public double? ImproveStartGap { get; set; }
Property Value
Type Description
System.Nullable<System.Double>

ImproveStartNodes

Solution improvement strategy control: The MIP solver can change parameter settings in the middle of the search in order to adopt a strategy that gives up on moving the best bound and instead devotes all of its effort towards finding better feasible solutions. This parameter allows you to specify the node count at which the MIP solver switches to this solution improvement strategy. For example, setting this parameter to 10 will cause the MIP solver to switch strategies once the node count is larger than 10, provided that at least one feasible solution has been found. If no incumbent solution exists when the specified node count is reached, the strategy switch will occur as soon as the first feasible solution is discovered. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public double? ImproveStartNodes { get; set; }
Property Value
Type Description
System.Nullable<System.Double>

ImproveStartTime

Solution improvement strategy control: The MIP solver can change parameter settings in the middle of the search in order to adopt a strategy that gives up on moving the best bound and instead devotes all of its effort towards finding better feasible solutions. This parameter allows you to specify the time (in seconds) when the MIP solver switches to this solution improvement strategy. For example, setting this parameter to 10 will cause the MIP solver to switch strategies 10 seconds after starting the optimization, provided that at least one feasible solution has been found. If no incumbent solution exists when the specified time is reached, the strategy switch will occur as soon as the first feasible solution is discovered. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public double? ImproveStartTime { get; set; }
Property Value
Type Description
System.Nullable<System.Double>

ImproveStartWork

Solution improvement strategy control: The MIP solver can change parameter settings in the middle of the search in order to adopt a strategy that gives up on moving the best bound and instead devotes all of its effort towards finding better feasible solutions. This parameter allows you to specify the work (in work units) when the MIP solver switches to this solution improvement strategy. For example, setting this parameter to 10 will cause the MIP solver to switch strategies 10 work units after starting the optimization. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public double? ImproveStartWork { get; set; }
Property Value
Type Description
System.Nullable<System.Double>

InfProofCuts

Infeasibility proof cut generation: Controls infeasibility proof cut generation. Use 0 to disable these cuts, 1 for moderate cut generation, or 2 for aggressive cut generation. The default -1 value chooses automatically. Overrides theCutsparameter. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? InfProofCuts { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

InfUnbdInfo

Additional info for infeasible/unbounded models: Set this parameter if you want to query the unbounded ray for unbounded models (through theUnbdRayattribute), or the infeasibility proof for infeasible models (through theFarkasDualandFarkasProofattributes). When this parameter is set additional information will be computed when a model is determined to be infeasible or unbounded, and a simplex basis is available (from simplex or crossover). Note that if a model is determined to be infeasible or unbounded when solving with barrier, prior to crossover, then this additional information will not be available. Note that if a model is found to be either infeasible or unbounded, and you simply want to know which one it is, you should use theDualReductionsparameter instead. It performs much less additional computation. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public bool? InfUnbdInfo { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

InheritParams

Controls parameter inheritance: Indicates whether parameters from a main environment should be inherited when working withConcurrent EnvironmentsorMultiobjective Environments. If set to 1, parameters are inherited from the main environment: if their value has not been set in the supporting environment, their value in the main environment is considered. If set to 0, parameters are not inherited: only parameters defined on the supporting environment are used. The default value of -1 is equivalent to 0, i.e., parameters are not inherited. This parameter can be set either on the main environment or on the supporting environment. If it is set on both, its value in the supporting environment overrules the value in the main environment. When using the command line parametersMultiObjSettingsorConcurrentSettings, set this parameter to 1 if you want to provide additional parameters valid for all objectives or concurrent settings, respectively. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? InheritParams { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

IntegralityFocus

Integrality focus: One unfortunate reality in MIP is that integer variables don’t always take exact integral values. While this typically doesn’t create significant problems, in some situations the side-effects can be quite undesirable. The best-known example is probably atrickle flow, where a continuous variable that is meant to be zero when an associated binary variable is zero instead takes a non-trivial value. More precisely, given a constraint(y \leq M b), where(y)is a non-negative continuous variable,(b)is a binary variable, and(M)is a constant that captures the largest possible value of(y), the constraint is intended to enforce the relationship that(y)must be zero if(b)is zero. With the defaultinteger feasibility tolerance, the binary variable is allowed to take a value as large as(1e-5)while still being considered as taking value zero. If the(M)value is large, then the(M b)upper bound on the(y)variable can be substantial. Reducing the value of theIntFeasTolparameter can mitigate the effects of such trickle flows, but often at a significant cost, and often with limited success. TheIntegralityFocusparameter provides a better alternative. Setting this parameter to 1 requests that the solver work harder to try to avoid solutions that exploit integrality tolerances. More precisely, the solver tries to find solutions that are still (nearly) feasible if all integer variables are rounded to exact integral values. We should say that the solver won’t always succeed in finding such solutions, and that this setting introduces a modest performance penalty, but the setting will significantly reduce the frequency and magnitude of such violations. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public bool? IntegralityFocus { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

IntFeasTol

Integer feasibility tolerance: An integrality restriction on a variable is considered satisfied when the variable’s value is less thanIntFeasTolfrom the nearest integer value. Tightening this tolerance can produce smaller integrality violations, but very tight tolerances may significantly increase runtime. Loosening this tolerance rarely reduces runtime. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public double? IntFeasTol { get; set; }
Property Value
Type Description
System.Nullable<System.Double>

IsvCode

In case you are using a Gurobi application license, use this property to set your Independent Software Vendor Code provided by Gurobi

Declaration
public string IsvCode { get; set; }
Property Value
Type Description
System.String

IsvName

In case you are using a Gurobi application license, use this property to set your Independent Software Vendor name

Declaration
public string IsvName { get; set; }
Property Value
Type Description
System.String

IterationLimit

Simplex iteration limit: Limits the number of simplex iterations performed. The limit applies to MIP, barrier crossover, and simplex. Optimization returns with anITERATION_LIMITstatus if the limit is exceeded. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public double? IterationLimit { get; set; }
Property Value
Type Description
System.Nullable<System.Double>

JobID

Compute Server Job ID: 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. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public string JobID { get; set; }
Property Value
Type Description
System.String

JSONSolDetail

Level of detail in JSON solution format: This parameter controls the amount of detail included in a JSON solution. For example, when this parameter is set to 1, the JSON string will contain data for all of the variables, even those with solution value 0. For a precise description of the contents of the resulting JSON string, please refer to theJSON solution formatsection. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public bool? JSONSolDetail { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

LazyConstraints

Programs that use lazy constraints must set this parameter: Programs that add lazy constraints through a callback must set this parameter to value 1. The parameter tells the Gurobi algorithms to avoid certain reductions and transformations that are incompatible with lazy constraints. Note that if you use lazy constraints by setting theLazyattribute (and not through a callback), there’s no need to set this parameter. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public bool? LazyConstraints { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

LicenseID

License ID: When using a WLS license, set this parameter to the license ID. You can retrieve this value from your account on theGurobi Web License Managersite. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? LicenseID { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

LiftProjectCuts

Lift-and-project cut generation: Controls lift-and-project cut generation. Use 0 to disable these cuts, 1 for moderate cut generation, or 2 for aggressive cut generation. The default -1 value chooses automatically. Overrides theCutsparameter. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? LiftProjectCuts { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

LimitedLicenseUsage

Controls the usage of the size-limited gurobi license. Default: Fallback

Declaration
public LimitedLicenseUsage LimitedLicenseUsage { get; set; }
Property Value
Type Description
LimitedLicenseUsage

LogToConsole

Control console logging: Enables or disables console logging. Note that this refers to the output of Gurobi to the console. This includes the various display and print functions provided by the API in interactive environments. UseOutputFlagto shut off all logging. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public bool? LogToConsole { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

LPWarmStart

Controls whether and how to warm-start LP optimization: Controls whether and how Gurobi uses warm start information for an LP optimization. A warm start can consist of any combination of basis statuses, a primal start vector, or a dual start vector. It is specified using the attributesVBasisandCBasisorPStartandDStarton the original model. Setting this parameter to 2 is particularly useful for communicating advanced start information while retaining the performance benefits of presolve. The default value of -1 is equivalent to 1 for allMethodchoices except for PDHG, for which it is equivalent to 2. As a general rule, setting this parameter to 0 ignores any start information and solves the model from scratch. Setting it to 1 (the default) uses the provided warm start information to solve the original, unpresolved problem, regardless of whether presolve is enabled. Setting it to 2 uses the start information to solve the presolved problem, assuming that presolve is enabled. This involves mapping the solution of the original problem into an equivalent (or sometimes nearly equivalent) crushed solution of the presolved problem. If presolve is disabled, then setting 2 still prioritizes start vectors, while setting 1 prioritizes basis statuses. Taken together, the LPWarmStart parameter setting, the LP algorithm specified by Gurobi’s Method parameter, and the available advanced start information determine whether Gurobi will use basis statuses only, basis statuses augmented with information from start vectors, or a basis obtained by applying the crossover method to the provided primal and dual start vectors to jump start the optimization. When Gurobi’s Method parameter requests the barrier solver, primal and dual start vectors are prioritized over basis statuses (but only if you provide both). These start vectors are fed to the crossover procedure. This is the same crossover that is used to compute a basic solution from the interior solution produced by the core barrier algorithm, but in this case crossover is started from arbitrary start vectors. If you set the LPWarmStart parameter to 1, crossover will be invoked on the original model using the provided vectors. Any provided basis information will not be used in this case. If you set LPWarmStart to 2, crossover will be invoked on the presolved model using crushed start vectors. If you set the parameter to 2 and provide a basis but no start vectors, the basis will be used to compute the corresponding primal and dual solutions on the original model. Those solutions will then be crushed and used as primal and dual start vectors for the crossover, which will then construct a basis for the presolved model. Note that for all of these settings and start combinations, no barrier algorithm iterations are performed. When the Method parameter selects PDHG, primal and dual start vectors are used to warm start PDHG iterations directly before proceeding to crossover if it is enabled. If a warm start basis is provided, it will be used to construct start vectors for the PDHG solve. If both a basis and vectors are given, vectors are prioritised over basis statuses. If you set LPWarmStart to 1, start vectors will be used to warm-start PDHG on the original model. Otherwise, if presolve is enabled, start vectors will be crushed and used to warm-start PDHG on the presolved model. The simplex algorithms provide more warm-starting options. With a parameter value of 1, simplex will start from a provided basis, if available. Otherwise, it uses a provided start vector to refine the crash basis it computes. Primal simplex will usePStartand dual simplex will useDStartin this refinement process. With a value of 2, simplex will use the crushed start vector on the presolved model (PStartfor primal simplex,DStartfor dual) to refine the crash basis. This is true regardless of whether the start is derived from start vectors or a starting basis from the original model. The difference is that if you provide an advanced basis, the basis will be used to compute the corresponding primal and dual solutions on the original model from which the primal or dual start on the presolved model will be derived. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? LPWarmStart { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

MarkowitzTol

Threshold pivoting tolerance: The Markowitz tolerance is used to limit numerical error in the simplex algorithm. Specifically, larger values reduce the error introduced in the simplex basis factorization. A larger value may avoid numerical problems in rare situations, but it will also harm performance. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public double? MarkowitzTol { get; set; }
Property Value
Type Description
System.Nullable<System.Double>

MasterKnapsackCuts

Master Knapsack cut generation: Controls the generation of cuts derived from the master knapsack polytope. Use 0 to disable these cuts, 1 for moderate cut generation, or 2 for aggressive cut generation. The default -1 value chooses automatically. Overrides theCutsparameter.

Declaration
public int? MasterKnapsackCuts { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

MemLimit

Memory limit: Limits the total amount of memory (in GB, i.e.,(10^9)bytes) available to Gurobi. If more is needed, Gurobi will fail with anOUT_OF_MEMORYerror. Note that it is not possible to retrieve solution information after an error termination. Thus, the behavior of this parameter is different from that of other termination criteria likeSoftMemLimit,TimeLimit, orNodeLimit, where the solver will terminate with aStatus Codeand solution information will still be available. One advantage of using this parameter rather than the similarSoftMemLimitis thatMemLimitis checked after every memory allocation, so Gurobi will terminate at precisely the point where the limit is exceeded. Note that allocated memory is tracked across all models within a Gurobi environment. If you create multiple models in one environment, these additional models will count towards overall memory consumption. Memory usage is also tracked across all threads. One consequence of this is that termination may be non-deterministic for multi-threaded runs. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public double? MemLimit { get; set; }
Property Value
Type Description
System.Nullable<System.Double>

Method

Algorithm used to solve continuous models: Algorithm used to solve continuous models or the initial root relaxation of a MIP model. Options are: Available settings and default behaviour depend on the model type or the type of the initial root relaxation. In the current release, the default Automatic (Method=-1) setting will typically choose non-deterministic concurrent (Method=3) for an LP, barrier (Method=2) for a QP or QCP, and dual (Method=1) for the MIP root relaxation. If the size of the MIP root relaxation is large, then it will often select deterministic concurrent (Method=4) or deterministic concurrent simplex (Method=5). Concurrent methods aren’t available for QP and QCP. Only the simplex and barrier algorithms are available for continuous QP models. If you select barrier (Method=2) to solve the root of an MIQP model, then you need to also select barrier for the node relaxations (i.e. setNodeMethod=2). Only barrier is available for continuous QCP models. However if you choose LP relaxations for solving MIQCP, you can also select the simplex algorithms (Method=0orMethod=1). Concurrent optimizers run multiple solvers on multiple threads simultaneously and choose the one that finishes first. The solvers that are run concurrently can be controlled with theConcurrentMethodparameter. The deterministic options (Method=4andMethod=5) give the exact same result each time, while the non-deterministic option (Method=3) is often faster but can produce different optimal bases when run multiple times. The default setting is rarely significantly slower than the best possible setting, so you generally won’t see a big gain from changing this parameter. There are classes of models where one particular algorithm is consistently fastest, though, so you may want to experiment with different options when confronted with a particularly difficult model. Note that if memory is tight on an LP model, you should consider using the dual simplex method (Method=1). The concurrent optimizer, which is typically chosen when using the default setting, consumes a lot more memory than dual simplex alone. In multi-objective LP optimization: For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? Method { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

MinRelNodes

Minimum relaxation heuristic: Number of nodes to explore in the minimum relaxation heuristic. This heuristic is quite expensive, and generally produces poor quality solutions. You should generally only use it if other means, including exploration of the tree with default settings, fail to produce a feasible solution. The default value automatically chooses whether to apply the heuristic. It will only rarely choose to do so. One important note about integer-valued parameters: while the maximum value that can be stored in a signed integer is(2^{31}-1), we use a MAXINT value of 2,000,000,000. Attempting to set an integer parameter to a value larger than this maximum will produce an error. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? MinRelNodes { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

MIPFocus

MIP solver focus: TheMIPFocusparameter allows you to modify your high-level solution strategy, depending on your goals. By default, the Gurobi MIP solver strikes a balance between finding new feasible solutions and proving that the current solution is optimal. If you are more interested in finding feasible solutions quickly, you can selectMIPFocus=1. If you believe the solver is having no trouble finding good quality solutions, and wish to focus more attention on proving optimality, selectMIPFocus=2. If the best objective bound is moving very slowly (or not at all), you may want to tryMIPFocus=3to focus on the bound. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? MIPFocus { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

MIPSepCuts

MIP separation cut generation: Controls MIP separation cut generation. Use 0 to disable these cuts, 1 for moderate cut generation, or 2 for aggressive cut generation. The default -1 value chooses automatically. Overrides theCutsparameter. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? MIPSepCuts { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

MIQCPMethod

Method used to solve MIQCP models: Controls the method used to solve MIQCP models. Value 1 uses a linearized, outer-approximation approach, while value 0 solves continuous QCP relaxations at each node. The default setting (-1) chooses automatically. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? MIQCPMethod { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

MIRCuts

MIR cut generation: Controls Mixed Integer Rounding (MIR) cut generation. Use 0 to disable these cuts, 1 for moderate cut generation, or 2 for aggressive cut generation. The default -1 value chooses automatically. Overrides theCutsparameter. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? MIRCuts { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

MixingCuts

Mixing cut generation: Controls Mixing cut generation. Use 0 to disable these cuts, 1 for moderate cut generation, or 2 for aggressive cut generation. The default -1 value chooses automatically. Overrides theCutsparameter. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? MixingCuts { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

ModKCuts

Mod-k cut generation: Controls mod-k cut generation. Use 0 to disable these cuts, 1 for moderate cut generation, or 2 for aggressive cut generation. The default -1 value chooses automatically. Overrides theCutsparameter. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? ModKCuts { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

MultiObjMethod

Method used for multi-objective solves: When solving a continuous multi-objective model using a hierarchical approach, the model is solved once for each objective. The algorithm used to solve for the highest priority objective is controlled by theMethodparameter. This parameter determines the algorithm used to solve for subsequent objectives. As with theMethodparameters, values of 0 and 1 use primal and dual simplex, respectively. A value of 2 indicates that warm-start information from previous solves should be discarded, and the model should be solved from scratch (using the algorithm indicated by theMethodparameter). The default setting of -1 usually chooses primal simplex. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? MultiObjMethod { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

MultiObjPre

Initial presolve level on multi-objective models: Controls the initial presolve level used for multi-objective models. Value 0 disables the initial presolve, value 1 applies presolve conservatively, and value 2 applies presolve aggressively. The default -1 value usually applies presolve conservatively. Aggressive presolve may increase the chance of the objective values being slightly different than those for other options. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? MultiObjPre { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

NetworkAlg

Network simplex algorithm: Controls whether to use network simplex. Value 0 doesn’t use network simplex. Value 1 indicates to use network simplex, if an LP is a network problem. The default -1 value chooses automatically. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? NetworkAlg { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

NetworkCuts

Network cut generation: Controls network cut generation. Use 0 to disable these cuts, 1 for moderate cut generation, or 2 for aggressive cut generation. The default -1 value chooses automatically. Overrides theCutsparameter. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? NetworkCuts { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

NLBarCFeasTol

Complementarity tolerance for the NL barrier algorithm: For the NL barrier algorithm, the complementarity error must be smaller thanNLBarCFeasTolin order for a model to be declared locally optimal. Due to problem transformations like presolve or internal scaling, the returned solution’s residuals may deviate from those observed by the algorithm. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public double? NLBarCFeasTol { get; set; }
Property Value
Type Description
System.Nullable<System.Double>

NLBarDFeasTol

Dual feasibility tolerance for the NL barrier algorithm: For the NL barrier algorithm, the dual feasibility error must be smaller thanNLBarDFeasTolin order for a model to be declared locally optimal. Due to problem transformations like presolve or internal scaling, the returned solution’s residuals may deviate from those observed by the algorithm. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public double? NLBarDFeasTol { get; set; }
Property Value
Type Description
System.Nullable<System.Double>

NLBarIterLimit

NL barrier iteration limit: Limits the number of barrier NL iterations performed. Optimization returns with anITERATION_LIMITstatus if the limit is exceeded. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? NLBarIterLimit { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

NLBarPFeasTol

Primal feasibility tolerance for the NL barrier algorithm: For the NL barrier algorithm, the primal feasibility error must be smaller thanNLBarPFeasTolin order for a model to be declared locally optimal. Due to problem transformations like presolve or internal scaling, the returned solution’s residuals may deviate from those observed by the algorithm. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public double? NLBarPFeasTol { get; set; }
Property Value
Type Description
System.Nullable<System.Double>

NLPHeur

Controls the NLP heuristic: The NLP heuristic uses a non-linear barrier solver to find feasible solutions to nonconvex quadratic and nonlinear models during a global optimization solve. It often helps to find solutions quicker, but in some cases it can consume significant runtime without producing a solution. A value of 0 disables the heuristic completely, while larger values call the heuristic more and more aggressively during the optimization process. The default -1 value chooses automatically. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? NLPHeur { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

NodefileDir

Directory for node files: Determines the directory into which nodes are written when node memory usage exceeds the specifiedNodefileStartvalue. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public string NodefileDir { get; set; }
Property Value
Type Description
System.String

NodefileStart

Write MIP nodes to disk: If you find that the Gurobi Optimizer exhausts memory when solving a MIP, you should modify theNodefileStartparameter. When the amount of memory used to store nodes (measured in GB, i.e.,(10^9)bytes) exceeds the specified parameter value, nodes are compressed and written to disk. We recommend a setting of0.5, but you may wish to choose a different value, depending on the memory available in your machine. By default, nodes are written to the current working directory. TheNodefileDirparameter can be used to choose a different location. If you still exhaust memory after setting theNodefileStartparameter to a small value, you should try limiting the thread count. Each thread in parallel MIP requires a copy of the model, as well as several other large data structures. Reducing theThreadsparameter can sometimes significantly reduce memory usage. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public double? NodefileStart { get; set; }
Property Value
Type Description
System.Nullable<System.Double>

NodeLimit

MIP node limit: Limits the number of MIP nodes explored. Optimization returns with anNODE_LIMITstatus if the limit is exceeded. Note that if multiple threads are used for the optimization, the actual number of explored nodes may be slightly larger than the set limit. This parameter iscallback settable. It can be changed from within a callback when thewherevalue isPRESOLVED,SIMPLEX,MIP,MIPSOL,MIPNODE,BARRIER, orMULTIOBJ(see theCallback Codessection for more information). How to do that for the different APIs is illustratedhere. In case of a remote server, the change of a parameter from within a callback may not be taken into account immediately. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public double? NodeLimit { get; set; }
Property Value
Type Description
System.Nullable<System.Double>

NodeMethod

Method used to solve MIP node relaxations: Algorithm used for MIP node relaxations (except for the initial root node relaxation, seeMethod). Options are: -1=automatic, 0=primal simplex, 1=dual simplex, and 2=barrier. Note that barrier is not an option for MIQP node relaxations. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? NodeMethod { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

NonConvex

Strategy for handling non-convex quadratic programs: Sets the strategy for handling non-convex quadratic objectives or non-convex quadratic constraints. With setting 0, an error is reported if the original user model contains non-convex quadratic constructs (unless Q matrix linearization, as controlled by thePreQLinearizeparameter, removes the non-convexity). With setting 1, an error is reported if non-convex quadratic constructs could not be discarded or linearized during presolve. With setting 2, non-convex quadratic problems are solved by translating them into bilinear form and applying spatial branching. The default -1 setting is currently almost equivalent to 2, except that it takes less care to avoid presolve reductions that might transform a convex constraint into one that can no longer be detected to be convex, and thus can sometimes perform more presolve reductions. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? NonConvex { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

NoRelHeurSolutions

Limits the number of solutions found by the NoRel heuristic: Limits the number of solutions found by the NoRel heuristic. This heuristic searches for high-quality feasible solutions. It can be quite useful on models where the root relaxation is particularly expensive. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? NoRelHeurSolutions { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

NoRelHeurTime

Limits the amount of time spent in the NoRel heuristic: Limits the amount of time (in seconds) spent in the NoRel heuristic. This heuristic searches for high-quality feasible solutions before solving the root relaxation. It can be quite useful on models where the root relaxation is particularly expensive. Note that this parameter will introduce non-determinism - different runs may take different paths. Use theNoRelHeurWorkparameter for deterministic results. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public double? NoRelHeurTime { get; set; }
Property Value
Type Description
System.Nullable<System.Double>

NoRelHeurWork

Limits the amount of work spent in the NoRel heuristic: Limits the amount of work spent in the NoRel heuristic. This heuristic searches for high-quality feasible solutions before solving the root relaxation. It can be quite useful on models where the root relaxation is particularly expensive. The work metric used in this parameter is tough to define precisely. A single unit corresponds to roughly a second, but this will depend on the machine, the core count, and in some cases the model. You may need to experiment to find a good setting for your model. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public double? NoRelHeurWork { get; set; }
Property Value
Type Description
System.Nullable<System.Double>

NormAdjust

Choose simplex pricing norm.: Chooses from among multiple pricing norm variants. The details of how this parameter affects the simplex pricing algorithm are subtle and difficult to describe, so we’ve simply labeled the options 0 through 3. The default value of -1 chooses automatically. Changing the value of this parameter rarely produces a significant benefit. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? NormAdjust { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

NumericFocus

Numerical focus: TheNumericFocusparameter controls the degree to which the code attempts to detect and manage numerical issues. The default setting (0) makes an automatic choice, with a slight preference for speed. Settings 1-3 increasingly shift the focus towards being more careful in numerical computations. With higher values, the code will spend more time checking the numerical accuracy of intermediate results, and it will employ more expensive techniques in order to avoid potential numerical issues. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? NumericFocus { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

OBBT

Controls aggressiveness of optimality-based bound tightening: Value 0 disables optimality-based bound tightening (OBBT). Levels 1-3 describe the amount of work allowed for OBBT ranging from moderate to aggressive. The default -1 value is an automatic setting which chooses a rather moderate setting. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? OBBT { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

ObjNumber

Select an objective: When working with multiple objectives, this parameter selects the index of the objective you want to work with. When you query or modify an attribute associated with multiple objectives (ObjN,ObjNWeight, etc.), theObjNumberparameter determines which objective function is actually affected. When you query an attribute associated with multi-objective passes (ObjPassNStatus,ObjPassNObjVal, etc.) and the parameterObjPassNumberis set to -1, theObjNumberparameter determines for which pass the value is returned. The value of this parameter should be less than the value of theNumObjattribute (which captures the number of objectives in the model). Please refer to the discussion ofMultiple Objectivesfor more information on the use of alternative objectives. One important note about integer-valued parameters: while the maximum value that can be stored in a signed integer is(2^{31}-1), we use a MAXINT value of 2,000,000,000. Attempting to set an integer parameter to a value larger than this maximum will produce an error. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? ObjNumber { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

ObjScale

Objective scaling: When positive, divides the model objective by the specified value to avoid numerical issues that may result from very large or very small objective coefficients. The default value of 0 decides on the scaling automatically. A value less than zero uses the maximum coefficient to the specified power as the scaling, e.g., ObjScale=-1 would divide by the largest objective coefficient, while ObjScale=-0.5 would divide by the square root of that coefficient. Note that objective scaling can lead to large dual violations on the original, unscaled objective when the optimality tolerance with the scaled objective is barely satisfied, so it should be used sparingly. Note also that scaling will be more effective when all objective coefficients are of similar orders of magnitude, as opposed to objectives with a wide range of coefficients. In the latter case, consider using theMultiple Objectivesfeature instead. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public double? ObjScale { get; set; }
Property Value
Type Description
System.Nullable<System.Double>

OptimalityTarget

Controls the strategy to solve continuous nonlinear nonconvex models: Specifies the optimality target for nonlinear continuous problems (NLP), including nonconvex QP and QCP models. Available options are Automatic (-1), Global Optimum (0), and Local Optimum (1). Currently, the automatic choice always selects the search for a global optimum (0). For Option 0, the linearized outer-approximation branch-and-bound approach seeks a feasible point with the best possible objective value and provides an optimality gap. For Option 1, the nonlinear (NL) barrier algorithm seeks a local optimum, i.e., a feasible point that has the best possible objective value among the feasible points within a local neighborhood. This alternative typically converges faster and is able to handle larger instances than a global search, but it does not provide an optimality gap. Upon success, the NL barrier algorithm concludes with statusLOCALLY_OPTIMAL. If it terminates withLOCALLY_INFEASIBLE, the method found a point that is an infeasible local minimizer of the constraint violation. This is an indication that the problem might be infeasible. Note that the search for a local optimum can only be selected if the model has no discrete variables or SOS constraints, and does not include nondifferentiable functions, such as PWL functions, Max-, Min-, Abs-operators, or the 1- or Infinity-norm. The V13 preview version of the NL barrier algorithm does not yet support all solution and quality attributes. In particular, the optimal values of dual variables and some quality attributes (such as scaled violations) are not yet available. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? OptimalityTarget { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

OutputFlag

Controls Gurobi output: Enables or disables solver output. UseLogFileandLogToConsolefor finer-grain control. SettingOutputFlagto 0 is equivalent to settingLogFileto""andLogToConsoleto 0. Note that server-side logging is always active for remote jobs run on Gurobi Instant Cloud, Compute Server, or Cluster Manager. This is not impacted by any user parameter settings. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public bool? OutputFlag { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

ParameterFilePath

Gets or sets the path to a gurobi parameter file to load parameters from. needs to be .prm.

Declaration
public FileInfo ParameterFilePath { get; set; }
Property Value
Type Description
System.IO.FileInfo

PartitionPlace

Controls where the partition heuristic runs: Setting thePartitionattribute on at least one variable in a model enables the partitioning heuristic, which uses large-neighborhood search to try to improve the current incumbent solution. This parameter determines where that heuristic runs. Options are: The parameter value is a bit vector, where each bit turns the heuristic on or off at that place. The numerical values next to the options listed above indicate which bit controls the corresponding option. Thus, for example, to enable the heuristic at the beginning and end of the root cut loop (and nowhere else), you would set the 8 bit and the 4 bit to 1, which would correspond to a parameter value of 12. The default value of 15 indicates that we enable every option except the first one listed above. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? PartitionPlace { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

PDHGAbsTol

PDHG absolute feasibility tolerance: The PDHG algorithm will terminate if both of the following conditions are satisfied: You can set PDHGAbsTol to loosen or tighten the second termination criterion. Note though that relative tolerances typically lead to earlier termination than absolute tolerances. If you wish to terminate PDHG based solely on absolute tolerances, you should setPDHGRelTolto zero (0). The first criterion is controlled byPDHGConvTol.

Declaration
public double? PDHGAbsTol { get; set; }
Property Value
Type Description
System.Nullable<System.Double>

PDHGConvTol

PDHG convergence tolerance: The PDHG algorithm will terminate if both of the following conditions are satisfied: You can set PDHGConvTol to loosen or tighten the first termination criterion. The second criterion is controlled byPDHGAbsTolandPDHGRelTol.

Declaration
public double? PDHGConvTol { get; set; }
Property Value
Type Description
System.Nullable<System.Double>

PDHGGPU

Enables PDHG on GPU on compatible systems: By default, the PDHG algorithm runs on the CPU. You can set this parameter to 1 to have PDHG run on the GPU instead, if your Gurobi build has GPU support and your system has compatible hardware. Note that you must additionally set theMethodparameter toGRB_METHOD_PDHG(6) to enable PDHG.

Declaration
public bool? PDHGGPU { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

PDHGIterLimit

PDHG iteration limit: Limits the number of PDHG iterations performed. The PDHG algorithm will terminate if this limit is exceeded. If crossover is enabled, it will start from the final PDHG iterate. If crossover is disabled, optimization will return with anITERATION_LIMITstatus.

Declaration
public double? PDHGIterLimit { get; set; }
Property Value
Type Description
System.Nullable<System.Double>

PDHGRelTol

PDHG relative feasibility tolerance: The PDHG algorithm will terminate if both of the following conditions are satisfied: You can set PDHGRelTol to loosen or tighten the second termination criterion. If you set PDHGRelTol to the special value zero (0), then only the absolute feasibility tolerances are considered. Specifically, primal and dual solutions are considered feasible only if the residuals of all primal and dual equations are belowPDHGAbsTol. The first criterion is controlled byPDHGConvTol.

Declaration
public double? PDHGRelTol { get; set; }
Property Value
Type Description
System.Nullable<System.Double>

PerturbValue

Simplex perturbation: Magnitude of the simplex perturbation. Note that perturbation is only applied when progress has stalled, so the parameter will often have no effect. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public double? PerturbValue { get; set; }
Property Value
Type Description
System.Nullable<System.Double>

PoolGap

Maximum relative gap for stored solutions: Determines how large a (relative) gap to tolerate in stored solutions. When this parameter is set to a non-default value, solutions whose objective values exceed that of the best known solution by more than the specified (relative) gap are discarded. For example, if the MIP solver has found a solution at objective 100, then a setting ofPoolGap=0.2would discard solutions with objective worse than 120 (assuming a minimization objective). For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public double? PoolGap { get; set; }
Property Value
Type Description
System.Nullable<System.Double>

PoolGapAbs

Maximum absolute gap for stored solutions: Determines how large a (absolute) gap to tolerate in stored solutions. When this parameter is set to a non-default value, solutions whose objective values exceed that of the best known solution by more than the specified (absolute) gap are discarded. For example, if the MIP solver has found a solution at objective 100, then a setting ofPoolGapAbs=20would discard solutions with objective worse than 120 (assuming a minimization objective). For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public double? PoolGapAbs { get; set; }
Property Value
Type Description
System.Nullable<System.Double>

PoolSearchMode

Selects different modes for exploring the MIP search tree: Selects different modes for exploring the MIP search tree. With the default setting (PoolSearchMode=0), the MIP solver tries to find an optimal solution to the model. It keeps other solutions found along the way, but those are incidental. By setting this parameter to a non-default value, the MIP search will continue after the optimal solution has been found in order to find additional, high-quality solutions. With a non-default value (PoolSearchMode=1orPoolSearchMode=2), the MIP solver will try to findnsolutions, wherenis determined by the value of thePoolSolutionsparameter. With a setting of 1, there are no guarantees about the quality of the extra solutions, while with a setting of 2, the solver will find thenbest solutions. The cost of the solve will increase with increasing values of this parameter. Once optimization is complete, thePoolObjBoundattribute can be used to evaluate the quality of the solutions that were found. For example, a value ofPoolObjBound=100indicates that there are no other solutions with objective better 100, and thus that any known solutions with objective better than 100 are better than any as-yet undiscovered solutions. SeeSolution Poolfor more information about solution pools, including subtleties and limitations. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? PoolSearchMode { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

PoolSolutions

Number of MIP solutions to store: Determines how many MIP solutions are stored. For the default value ofPoolSearchMode, these are just the solutions that are found along the way in the process of exploring the MIP search tree. For other values ofPoolSearchMode, this parameter sets a target for how many solutions to find, so larger values will impact performance. One important note about integer-valued parameters: while the maximum value that can be stored in a signed integer is(2^{31}-1), we use a MAXINT value of 2,000,000,000. Attempting to set an integer parameter to a value larger than this maximum will produce an error. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? PoolSolutions { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

PreCrush

Controls presolve reductions that affect user cuts: Shuts off a few reductions in order to allow presolve to transform any constraint on the original model into an equivalent constraint on the presolved model. You should consider setting this parameter to 1 if you are using callbacks to add your own cuts. A cut that cannot be applied to the presolved model will be silently ignored. The impact on the size of the presolved problem is usually small. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public bool? PreCrush { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

PreDepRow

Controls the presolve dependent row reduction: Controls the presolve dependent row reduction, which eliminates linearly dependent constraints from the constraint matrix. The default setting (-1) applies the reduction to continuous models but not to MIP models. Setting 0 turns the reduction off for all models. Setting 1 turns it on for all models. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? PreDepRow { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

PreDual

Controls presolve model dualization: Controls whether presolve forms the dual of a continuous model. Depending on the structure of the model, solving the dual can reduce overall solution time. The default setting uses a heuristic to decide. Setting 0 forbids presolve from forming the dual, while setting 1 forces it to take the dual. Setting 2 employs a more expensive heuristic that forms both the presolved primal and dual models (on two threads), and heuristically chooses one of them. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? PreDual { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

PreMIQCPForm

Format of presolved MIQCP model: Determines the format of the presolved version of an MIQCP model. Option 0 leaves the model in MIQCP form, so the branch-and-cut algorithm will operate on a model with arbitrary quadratic constraints. Option 1 always transforms the model into MISOCP form; quadratic constraints are transformed into second-order cone constraints. Option 2 always transforms the model into disaggregated MISOCP form; quadratic constraints are transformed into rotated cone constraints, where each rotated cone contains two terms and involves only three variables. The default setting (-1) choose automatically. The automatic setting works well, but there are cases where forcing a different form can be beneficial. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? PreMIQCPForm { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

PrePasses

Presolve pass limit: Limits the number of passes performed by presolve. The default setting (-1) chooses the number of passes automatically. You should experiment with this parameter when you find that presolve is consuming a large fraction of total solve time. One important note about integer-valued parameters: while the maximum value that can be stored in a signed integer is(2^{31}-1), we use a MAXINT value of 2,000,000,000. Attempting to set an integer parameter to a value larger than this maximum will produce an error. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? PrePasses { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

PreQLinearize

Presolve quadratic linearization: Controls presolve Q matrix linearization. Binary variables in quadratic expressions provide some freedom to state the same expression in multiple different ways. Options 1 and 2 of this parameter attempt to linearize quadratic constraints or a quadratic objective, replacing quadratic terms with linear terms, using additional variables and linear constraints. This can potentially transform an MIQP or MIQCP model into an MILP. Option 1 focuses on producing an MILP reformulation with a strong LP relaxation, with a goal of limiting the size of the MIP search tree. Option 2 aims for a compact reformulation, with a goal of reducing the cost of each node. Option 0 attempts to leave Q matrices unmodified; it won’t add variables or constraints, but it may still perform adjustments on quadratic objective functions to make them positive semi-definite (PSD). The default setting (-1) chooses automatically. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? PreQLinearize { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

Presolve

Controls the presolve level: Controls the presolve level. A value of -1 corresponds to an automatic setting. Other options are off (0), conservative (1), or aggressive (2). More aggressive application of presolve takes more time, but can sometimes lead to a significantly tighter model. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? Presolve { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

PreSOS1BigM

Threshold for SOS1-to-binary reformulation: Controls the automatic reformulation of SOS1 constraints into binary form. SOS1 constraints are often handled more efficiently using a binary representation. The reformulation often requiresbig-Mvalues to be introduced as coefficients. This parameter specifies the largestbig-Mthat can be introduced by presolve when performing this reformulation. Larger values increase the chances that an SOS1 constraint will be reformulated, but very large values (e.g., 1e8) can lead to numerical issues. The default value of -1 chooses a threshold automatically. You should set the parameter to 0 to shut off SOS1 reformulation entirely, or a large value to force reformulation. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples. Please refer tothis sectionfor more information on SOS constraints.

Declaration
public double? PreSOS1BigM { get; set; }
Property Value
Type Description
System.Nullable<System.Double>

PreSOS1Encoding

Encoding used for SOS1 reformulation: Controls the automatic reformulation of SOS1 constraints. Such constraints can be handled directly by the MIP branch-and-cut algorithm, but they are often handled more efficiently by reformulating them using binary or integer variables. There are several diffent ways to perform this reformulation; they differ in their size and strength. Smaller reformulations add fewer variables and constraints to the model. Stronger reformulations reduce the number of branch-and-cut nodes required to solve the resulting model. Options 0 and 1 of this parameter encode an SOS1 constraint using a formulation whose size is linear in the number of SOS members. Option 0 uses a so-called multiple choice model. It usually produces an LP relaxation that is easier to solve. Option 1 uses an incremental model. It often gives a stronger representation, reducing the amount of branching required to solve harder problems. Options 2 and 3 of this parameter encode the SOS1 using a formulation of logarithmic size. They both only apply when all the variables in the SOS1 are non-negative. Option 3 additionally requires that the sum of the variables in the SOS1 is equal to 1. Logarithmic formulations are often advantageous when the SOS1 constraint has a large number of members. Option 2 focuses on a formulation whose LP relaxation is easier to solve, while option 3 has better branching behavior. The default value of -1 chooses a reformulation for each SOS1 constraint automatically. Note that the reformulation of SOS1 constraints is also influenced by thePreSOS1BigMparameter. To shut off the reformulation entirely you should set that parameter to 0. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples. Please refer tothis sectionfor more information on SOS constraints.

Declaration
public int? PreSOS1Encoding { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

PreSOS2BigM

Threshold for SOS2-to-binary reformulation: Controls the automatic reformulation of SOS2 constraints into binary form. SOS2 constraints are often handled more efficiently using a binary representation. The reformulation often requiresbig-Mvalues to be introduced as coefficients. This parameter specifies the largestbig-Mthat can be introduced by presolve when performing this reformulation. Larger values increase the chances that an SOS2 constraint will be reformulated, but very large values (e.g., 1e8) can lead to numerical issues. The default value of -1 chooses a threshold automatically. You should set the parameter to 0 to shut off SOS2 reformulation entirely, or a large value to force reformulation. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples. Please refer tothis sectionfor more information on SOS constraints.

Declaration
public double? PreSOS2BigM { get; set; }
Property Value
Type Description
System.Nullable<System.Double>

PreSOS2Encoding

Encoding used for SOS2 reformulation: Controls the automatic reformulation of SOS2 constraints. Such constraints can be handled directly by the MIP branch-and-cut algorithm, but they are often handled more efficiently by reformulating them using binary or integer variables. There are several diffent ways to perform this reformulation; they differ in their size and strength. Smaller reformulations add fewer variables and constraints to the model. Stronger reformulations reduce the number of branch-and-cut nodes required to solve the resulting model. Options 0 and 1 of this parameter encode an SOS2 constraint using a formulation whose size is linear in the number of SOS members. Option 0 uses a so-called multiple choice model. It usually produces an LP relaxation that is easier to solve. Option 1 uses an incremental model. It often gives a stronger representation, reducing the amount of branching required to solve harder problems. Options 2 and 3 of this parameter encode the SOS2 using a formulation of logarithmic size. They both only apply when all the variables in the SOS2 are non-negative. Option 3 additionally requires that the sum of the variables in the SOS2 is equal to 1. Logarithmic formulations are often advantageous when the SOS2 constraint has a large number of members. Option 2 focuses on a formulation whose LP relaxation is easier to solve, while option 3 has better branching behavior. The default value of -1 chooses a reformulation for each SOS2 constraint automatically. Note that the reformulation of SOS2 constraints is also influenced by thePreSOS2BigMparameter. To shut off the reformulation entirely you should set that parameter to 0. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples. Please refer tothis sectionfor more information on SOS constraints.

Declaration
public int? PreSOS2Encoding { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

PreSparsify

Controls the presolve sparsify reduction: Controls the presolve sparsify reduction. This reduction can sometimes significantly reduce the number of non-zero values in the presolved model. Value 0 shuts off the reduction, while value 1 forces it on for mixed integer programming (MIP) models and value 2 forces it on for all types of models, including linear programming (LP) models, and MIP relaxations. The default value of -1 chooses automatically. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? PreSparsify { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

ProjImpliedCuts

Projected implied bound cut generation: Controls projected implied bound cut generation. Use 0 to disable these cuts, 1 for moderate cut generation, or 2 for aggressive cut generation. The default -1 value chooses automatically. Overrides theCutsparameter. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? ProjImpliedCuts { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

PSDCuts

PSD cut generation: Controls PSD cut generation. Use 0 to disable these cuts, 1 for moderate cut generation, or 2 for aggressive cut generation. The default -1 value chooses automatically. Overrides theCutsparameter. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? PSDCuts { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

PSDTol

Positive semi-definite tolerance: Sets a limit on the amount of diagonal perturbation that the optimizer is allowed to perform on a Q matrix in order to correct minor PSD violations. If a larger perturbation is required, the optimizer will terminate with aQ_NOT_PSDerror. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public double? PSDTol { get; set; }
Property Value
Type Description
System.Nullable<System.Double>

PumpPasses

Passes of the feasibility pump heuristic: Number of passes of the feasibility pump heuristic. This heuristic is quite expensive, and generally produces poor quality solutions. You should generally only use it if other means, including exploration of the tree with default settings, fail to produce a feasible solution. One important note about integer-valued parameters: while the maximum value that can be stored in a signed integer is(2^{31}-1), we use a MAXINT value of 2,000,000,000. Attempting to set an integer parameter to a value larger than this maximum will produce an error. This parameter iscallback settable. It can be changed from within a callback when thewherevalue isPRESOLVED,SIMPLEX,MIP,MIPSOL,MIPNODE,BARRIER, orMULTIOBJ(see theCallback Codessection for more information). How to do that for the different APIs is illustratedhere. In case of a remote server, the change of a parameter from within a callback may not be taken into account immediately. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? PumpPasses { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

QCPDual

Dual variables for QCP models: Determines whether dual variable values are computed for QCP models. Computing them can add significant time to the optimization, so you should only set this parameter to 1 if you need them. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public bool? QCPDual { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

Quad

Controls quad precision in simplex: Enables or disables quad precision computation in simplex. The -1 default setting allows the algorithm to decide. Quad precision can sometimes help solve numerically challenging models, but it can also significantly increase runtime. Quad precision is only available on processors that support quadruple precision, e.g., common Intel processors. On other processors, the parameter has no effect. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? Quad { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

Record

Enables API call recording: Enables API call recording. When enabled, Gurobi will write one or more files (namedgurobi000.grbror similar) that capture the sequence of Gurobi commands that your program issued. This file can subsequently be replayed using theGurobi command-line tool. Replaying the file will repeat the exact same sequence of commands, and when completed will show the time spent in Gurobi API routines, the time spent in Gurobi algorithms, and will indicate whether any Gurobi environments or models were leaked by your program. Replay files are particularly useful in tech support situations. They provide an easy way to relay to Gurobi tech support the exact sequence of Gurobi commands that led to a question or issue. This parameter must be set before starting anempty environment(or in agurobi.envfile). All Gurobi commands will be recorded until the environment is freed or the program ends. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public bool? Record { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

RelaxLiftCuts

Relax-and-lift cut generation: Controls relax-and-lift cut generation. Use 0 to disable these cuts, 1 for moderate cut generation, or 2 for aggressive cut generation. The default -1 value chooses automatically. Overrides theCutsparameter. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? RelaxLiftCuts { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

ResultFile

Write a result file upon completion of optimization: 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.ilpfile (to capture the IIS for an infeasible model), or a.mps,.rew,.lp, or.rlpfile (to capture the original model), or a.duaor.dlpfile (to capture the dual of a pure LP model). The file suffix may optionally be followed by.zip,.gz,.bz2,.7zor.xz, which produces a compressed result. More information on the file formats can be found in theFile Formatsection. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public string ResultFile { get; set; }
Property Value
Type Description
System.String

RINS

Relaxation Induced Neighborhood Search (RINS) heuristic frequency: Frequency of the RINS heuristic. Default value (-1) chooses automatically. A value of 0 shuts off RINS. A positive valuenapplies RINS at everyn-thnode of the MIP search tree. Increasing the frequency of the RINS heuristic shifts the focus of the MIP search away from proving optimality, and towards finding good feasible solutions. We recommend that you tryMIPFocus,ImproveStartGap,ImproveStartTime,ImproveStartWork, orImproveStartNodesbefore experimenting with this parameter. One important note about integer-valued parameters: while the maximum value that can be stored in a signed integer is(2^{31}-1), we use a MAXINT value of 2,000,000,000. Attempting to set an integer parameter to a value larger than this maximum will produce an error. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? RINS { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

RLTCuts

RLT cut generation: Controls Relaxation Linearization Technique (RLT) cut generation. Use 0 to disable these cuts, 1 for moderate cut generation, or 2 for aggressive cut generation. The default -1 value chooses automatically. Overrides theCutsparameter. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? RLTCuts { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

ScaleFlag

Model scaling: Controls model scaling. By default, the rows and columns of the model are scaled in order to improve the numerical properties of the constraint matrix. The scaling is removed before the final solution is returned. Scaling typically reduces solution times, but it may lead to larger constraint violations in the original, unscaled model. Turning off scaling (ScaleFlag=0) can sometimes produce smaller constraint violations. Choosing a different scaling option can sometimes improve performance for particularly numerically difficult models. Using geometric mean scaling (ScaleFlag=2) is especially well suited for models with a wide range of coefficients in the constraint matrix rows or columns. Settings 1 and 3 are not as directly connected to any specific model characteristics, so experimentation with both settings may be needed to assess performance impact. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? ScaleFlag { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

ScenarioNumber

Selects scenario index of multi-scenario models: When working with multiple scenarios, this parameter selects the index of the scenario you want to work with. When you query or modify an attribute associated with multiple scenarios (ScenNLB,ScenNUB,ScenNObj,ScenNRHS, etc.), theScenarioNumberparameter will determine which scenario is actually affected. The value of this parameter should be less than the value of theNumScenariosattribute (which captures the number of scenarios in the model). Please refer to the discussion ofMultiple Scenariosfor more information on the use of alternative scenarios. One important note about integer-valued parameters: while the maximum value that can be stored in a signed integer is(2^{31}-1), we use a MAXINT value of 2,000,000,000. Attempting to set an integer parameter to a value larger than this maximum will produce an error. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? ScenarioNumber { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

Seed

Random number seed: Modifies the random number seed. This acts as a small perturbation to the solver, and typically leads to different solution paths. One important note about integer-valued parameters: while the maximum value that can be stored in a signed integer is(2^{31}-1), we use a MAXINT value of 2,000,000,000. Attempting to set an integer parameter to a value larger than this maximum will produce an error. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? Seed { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

ServerPassword

Client password for Remote Services cluster or token server: 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 theComputeServerparameter, you’ll need to supply the client password. Refer to theGurobi Remote Services Reference Manualfor more information on starting Compute Server jobs. Supply the token server password (if needed) when connecting to the server referred to by theTokenServerparameter, You must set this parameter through either agurobi.licfile (usingPASSWORD=pwd) or anempty environment. Changing the parameter after your environment has been created will have no effect. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public string ServerPassword { get; set; }
Property Value
Type Description
System.String

ServerTimeout

Network timeout: Network time-out for Compute Server and token server (in seconds). If the client program is unable to contact the server for more than the specified amount of time, the client will quit with a network error. Refer to theGurobi Remote Services Reference Manualfor more information on starting Compute Server jobs. You must set this parameter using anempty environment. Changing the parameter after your environment has been created will have no effect. One important note about integer-valued parameters: while the maximum value that can be stored in a signed integer is(2^{31}-1), we use a MAXINT value of 2,000,000,000. Attempting to set an integer parameter to a value larger than this maximum will produce an error. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? ServerTimeout { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

Sifting

Controls sifting within dual simplex: Enables or disables sifting within dual simplex. Sifting can be useful for LP models where the number of variables is many times larger than the number of constraints (we typically only see significant benefits when the ratio is 100 or more). Options are Automatic (-1), Off (0), Moderate (1), and Aggressive (2). With a Moderate setting, sifting will be applied to LP models and to the initial root relaxation for MIP models. With an Aggressive setting, sifting will be applied any time dual simplex is used, including at the nodes of a MIP. Note that this parameter has no effect if you aren’t using dual simplex. Note also that Gurobi will ignore this parameter in cases where sifting is obviously a worse choice than dual simplex. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? Sifting { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

SiftMethod

LP method used to solve sifting sub-problems: LP method used to solve sifting sub-problems. Options are Automatic (-1), Primal Simplex (0), Dual Simplex (1), and Barrier (2). Note that this parameter only has an effect when you are using dual simplex and sifting has been selected (either automatically by dual simplex, or through theSiftingparameter). Changing the value of this parameter rarely produces a significant benefit. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? SiftMethod { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

SimplexPricing

Simplex pricing strategy: Determines the simplex variable pricing strategy. Available options are Automatic (-1), Partial Pricing (0), Steepest Edge (1), Devex (2), and Quick-Start Steepest Edge (3). Changing the value of this parameter rarely produces a significant benefit. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? SimplexPricing { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

SoftMemLimit

Soft memory limit: Limits the total amount of memory (in GB, i.e.,(10^9)bytes) available to Gurobi. If more is needed, Gurobi will terminate with aMEM_LIMITstatus code. In contrast to theMemLimitparameter, theSoftMemLimitparameter leads to a graceful exit of the optimization, such that it is possible to retrieve solution information afterwards or (in the case of a MIP solve) resume the optimization. A disadvantage compared toMemLimitis that theSoftMemLimitis only checked at places where optimization can be terminated gracefully, so memory use may exceed the limit between these checks. Note that allocated memory is tracked across all models within a Gurobi environment. If you create multiple models in one environment, these additional models will count towards overall memory consumption. Memory usage is also tracked across all threads. One consequence of this is that termination may be non-deterministic for multi-threaded runs. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public double? SoftMemLimit { get; set; }
Property Value
Type Description
System.Nullable<System.Double>

SolFiles

Location to store intermediate solution files: 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.solto the value of the parameter to form the name of the file that contains solution number(n). For example, setting the parameter to valuesolutions/mymodelwill create filesmymodel_0.sol,mymodel_1.sol, etc., in directorysolutions. Note that intermediate solutions can be retrieved as they are generated through acallback(by requesting theMIPSOL_SOLin aMIPSOLcallback). This parameter makes the process simpler. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public string SolFiles { get; set; }
Property Value
Type Description
System.String

SolutionLimit

MIP solution limit: Limits the number of feasible MIP solutions found. Optimization returns with aSOLUTION_LIMITstatus once the limit has been reached. To find a feasible solution quickly, Gurobi executes additional feasible point heuristics when the solution limit is set to exactly 1. One important note about integer-valued parameters: while the maximum value that can be stored in a signed integer is(2^{31}-1), we use a MAXINT value of 2,000,000,000. Attempting to set an integer parameter to a value larger than this maximum will produce an error. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? SolutionLimit { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

SolutionNumber

Select a sub-optimal MIP solution: When querying attributePoolNX,ObjNVal,PoolNObjValor any of the solution pool quality attributes (e.g.,PoolNMaxVio) to retrieve information about an alternate MIP solution, this parameter determines for which alternate solution the data are retrieved. The value of this parameter should be less than the value of theSolCountattribute. One important note about integer-valued parameters: while the maximum value that can be stored in a signed integer is(2^{31}-1), we use a MAXINT value of 2,000,000,000. Attempting to set an integer parameter to a value larger than this maximum will produce an error. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? SolutionNumber { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

SolutionTarget

Solution Target for LP: Specifies the solution target for linear programs (LP). Options are Automatic (-1), primal and dual optimal, and basic (0), primal and dual optimal (1). For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? SolutionTarget { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

StartNodeLimit

Limit MIP start sub-MIP nodes: This parameter limits the number of branch-and-bound nodes explored when completing a partial MIP start. The default value of -1 uses the value of theSubMIPNodesparameter. A value of -2 means to only check full MIP starts for feasibility and to ignore partial MIP starts. A value of -3 shuts off MIP start processing entirely. Non-negative values are node limits. One important note about integer-valued parameters: while the maximum value that can be stored in a signed integer is(2^{31}-1), we use a MAXINT value of 2,000,000,000. Attempting to set an integer parameter to a value larger than this maximum will produce an error. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? StartNodeLimit { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

StartNumber

Selects MIP start index: This parameter selects the index of the MIP start you want to work with. When you modify a MIP start value (using theStartattribute) theStartNumberparameter will determine which MIP start is actually affected. The value of this parameter should be less than the value of theNumStartattribute (which captures the number of MIP starts in the model). The special value -1 is meant to append new MIP start to a model, but querying a MIP start when StartNumber is -1 will result in an error. One important note about integer-valued parameters: while the maximum value that can be stored in a signed integer is(2^{31}-1), we use a MAXINT value of 2,000,000,000. Attempting to set an integer parameter to a value larger than this maximum will produce an error. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? StartNumber { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

StartTimeLimit

Limit MIP start sub-MIP time: This parameter limits the total time (in seconds) spent on completing a partial MIP start. Note that this parameter will introduce non-determinism - different runs may take different paths. Use theStartWorkLimitparameter for deterministic results. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public double? StartTimeLimit { get; set; }
Property Value
Type Description
System.Nullable<System.Double>

StartWorkLimit

Limit MIP start sub-MIP work: This parameter limits the total work (in work units) spent on completing a partial MIP start. In contrast to theStartTimeLimit, work limits are deterministic. This means that on the same hardware and with the same parameter and attribute settings, a work limit will stop the optimization of a given model at the exact same point every time. One work unit corresponds very roughly to one second on a single thread, but this greatly depends on the hardware on which Gurobi is running and the model that is being solved. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public double? StartWorkLimit { get; set; }
Property Value
Type Description
System.Nullable<System.Double>

StrongCGCuts

Strong-CG cut generation: Controls Strong Chvátal-Gomory (Strong-CG) cut generation. Use 0 to disable these cuts, 1 for moderate cut generation, or 2 for aggressive cut generation. The default -1 value chooses automatically. Overrides theCutsparameter. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? StrongCGCuts { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

SubMIPCuts

Sub-MIP cut generation: Controls sub-MIP cut generation. Use 0 to disable these cuts, 1 for moderate cut generation, or 2 for aggressive cut generation. The default -1 value chooses automatically. Overrides theCutsparameter. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? SubMIPCuts { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

SubMIPNodes

Nodes explored in sub-MIP heuristics: Limits the number of nodes explored by MIP-based heuristics (such as RINS). Exploring more nodes can produce better solutions, but it generally takes longer. One important note about integer-valued parameters: while the maximum value that can be stored in a signed integer is(2^{31}-1), we use a MAXINT value of 2,000,000,000. Attempting to set an integer parameter to a value larger than this maximum will produce an error. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? SubMIPNodes { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

Symmetry

Symmetry detection: Controls symmetry detection. A value of -1 corresponds to an automatic setting. Other options are off (0), conservative (1), or aggressive (2). Symmetry can impact a number of different parts of the algorithm, including presolve, the MIP tree search, and the LP solution process. Default settings are quite effective, so changing the value of this parameter rarely produces a significant benefit. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? Symmetry { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

ThreadLimit

Thread limit: The ThreadLimit parameter is aconfiguration parameterfor an environment which can be used to limit the number of threads used. This limit is enforced for all optimization calls based on this environment. The default value of 0 implies no limit. If a thread limit is set, trying to set theThreadsparameter above this limit will display a warning and not change the value of the parameter. You must set the ThreadLimit parameter through either agurobi.envfile (usingThreadLimit=limit) or anempty environment. Changing the parameter after the environment has been created will result in an error. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? ThreadLimit { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

Threads

Thread count: Controls the number of threads to apply to parallel algorithms (concurrent LP, parallel barrier, parallel MIP, etc.). The default value of 0 is an automatic setting. It will generally use as many threads as there are virtual processors. The number of virtual processors may exceed the number of cores due to hyperthreading or other similar hardware features. While you will generally get the best performance by using all available cores in your machine, there are a few exceptions. One is of course when you are sharing a machine with other jobs. In this case, you should select a thread count that doesn’t oversubscribe the machine. We have also found that certain classes of MIP models benefit from reducing the thread count, often all the way down to one thread. Starting multiple threads introduces contention for machine resources. For classes of models where the first solution found by the MIP solver is almost always optimal, and that solution isn’t found at the root, it is often better to allow a single thread to explore the search tree uncontested. Another situation where reducing the thread count can be helpful is when memory is tight. Each thread can consume a significant amount of memory. We’ve made the pragmatic choice to impose a soft limit of 32 threads for the automatic setting (0), because usually, Gurobi’s algorithms do not benefit from higher thread counts. Actually, higher thread counts may even hurt performance, because this will often saturate the memory system. If your machine has more virtual processors, and you find that using more threads increases performance, you should feel free to set the parameter to a larger value. Alternatively, you can use the value -1 to indicate that Gurobi should use all available virtual processors, even if the machine has more than 32. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? Threads { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

TokenServer

Name of your token server: 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 agurobi.licfile (usingTOKENSERVER=server) or anempty environment. Changing the parameter after your environment has been created will have no effect. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public string TokenServer { get; set; }
Property Value
Type Description
System.String

TSPort

Port for token server: Port to use when connecting to the Gurobi token server. You should only change this if your network administrator tells you to. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? TSPort { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

TuneCleanup

Enables a tuning cleanup phase: Enables a cleanup phase at the end of tuning. The parameter indicates the percentage of total tuning time to devote to this phase, with a goal of reducing the number of parameter changes required to achieve the best tuning result. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public double? TuneCleanup { get; set; }
Property Value
Type Description
System.Nullable<System.Double>

TuneCriterion

Tuning criterion: Modifies the tuning criterion for the tuning tool. The primary tuning criterion is always to minimize the runtime required to find a proven optimal solution. However, for MIP models that don’t solve to optimality within the specified time limit, a secondary criterion is needed. Set this parameter to 1 to use the optimality gap as the secondary criterion. Choose a value of 2 to use the objective of the best feasible solution found. Choose a value of 3 to use the best objective bound. Choose 0 to ignore the secondary criterion and focus entirely on minimizing the time to find a proven optimal solution. The default value of -1 chooses automatically. Note that values 1 and 3 are unsupported formulti-objectiveproblems. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? TuneCriterion { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

TuneDynamicJobs

Dynamic distributed tuning job count: Enables distributed parallel tuning, which can significantly increase the performance of the tuning tool. A value ofncauses the tuning tool to use a dynamic set of up tonworkers in parallel. These workers are used for a limited amount of time and afterwards potentially released so that they are available for other remote jobs. A value of-1allows the solver to use an unlimited number of workers. Note that this parameter can be combined withTuneJobsto get a static set of workers and a dynamic set of workers for distributed tuning. You can use theWorkerPoolparameter to provide a distributed worker cluster. Note that distributed tuning is most effective when the worker machines have similar performance. Distributed tuning doesn’t attempt to normalize performance by server, so it can incorrectly attribute a boost in performance to a parameter change when the associated setting is tried on a worker that is significantly faster than the others. One important note about integer-valued parameters: while the maximum value that can be stored in a signed integer is(2^{31}-1), we use a MAXINT value of 2,000,000,000. Attempting to set an integer parameter to a value larger than this maximum will produce an error. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? TuneDynamicJobs { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

TuneJobs

Permanent distributed tuning job count: Enables distributed parallel tuning, which can significantly increase the performance of the tuning tool. A value ofncauses the tuning tool to use a static set of up tonworkers in parallel. Such workers are kept for the whole tuning run. Note that this parameter can be combined withTuneDynamicJobsto get a static set of workers and a dynamic set of workers for distributed tuning. You can use theWorkerPoolparameter to provide a distributed worker cluster. Note that distributed tuning is most effective when the worker machines have similar performance. Distributed tuning doesn’t attempt to normalize performance by server, so it can incorrectly attribute a boost in performance to a parameter change when the associated setting is tried on a worker that is significantly faster than the others. One important note about integer-valued parameters: while the maximum value that can be stored in a signed integer is(2^{31}-1), we use a MAXINT value of 2,000,000,000. Attempting to set an integer parameter to a value larger than this maximum will produce an error. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? TuneJobs { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

TuneMetric

Method for aggregating tuning results: A single tuning run typically produces multiple timing results for each candidate parameter set, either as a result of performing multipletrials, or tuning multiple models, or both. This parameter controls how these results are aggregated into a single measure. The default setting (-1) chooses the aggregation automatically; setting 0 computes the average of all individual results; setting 1 takes the maximum. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? TuneMetric { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

TuneOutput

Tuning output level: Controls the amount of output produced by the tuning tool. Level 0 produces no output; level 1 produces tuning summary output only when a new best parameter set is found; level 2 produces tuning summary output for each parameter set that is tried; level 3 produces tuning summary output, plus detailed solver output, for each parameter set tried. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? TuneOutput { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

TuneResults

Number of improved parameter sets returned: The tuning tool often finds multiple parameter sets that improve over the baseline settings. This parameter controls how many of these sets should be retained when tuning is complete. A non-negative value indicates how many sets should be retained. The default value (-1) retains the efficient frontier of parameter sets. That is, it retains the best set for one changed parameter, the best for two changed parameters, etc. Sets that aren’t on the efficient frontier are discarded. If you interested in all the sets, use value -2 for the parameter. Note that the first set in the results is always the set of parameters which was used for the first solve, the baseline settings. This set serves as the base for any improvement. So if you are interested in the best tuned set of parameters you need to request at least 2 tune results. The first one (with index 0) will be the baseline setting and the second one (with index 1) will be the best set found during tuning. One important note about integer-valued parameters: while the maximum value that can be stored in a signed integer is(2^{31}-1), we use a MAXINT value of 2,000,000,000. Attempting to set an integer parameter to a value larger than this maximum will produce an error. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? TuneResults { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

TuneTargetMIPGap

A target gap to be reached: A target gap to be reached. As soon as the tuner has found parameter settings that allow Gurobi to reach the target gap for the given model(s), it stops trying to improve parameter settings further. Instead, the tuner switches into the cleanup phase (seeTuneCleanupparameter). This parameter only applies if no other secondary tuning criterion than MIPGap is set, i.e.,TuneCriterionis at its default value or 1. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public double? TuneTargetMIPGap { get; set; }
Property Value
Type Description
System.Nullable<System.Double>

TuneTargetTime

A target runtime in seconds to be reached: A target runtime in seconds to be reached. As soon as the tuner has found parameter settings that allow Gurobi to solve the model(s) within the target runtime, it stops trying to improve parameter settings further. Instead, the tuner switches into the cleanup phase (seeTuneCleanupparameter). For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public double? TuneTargetTime { get; set; }
Property Value
Type Description
System.Nullable<System.Double>

TuneTimeLimit

Tuning tool time limit: Limits total tuning runtime (in seconds). The default value is 86400 seconds, i.e., 24 hours. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public double? TuneTimeLimit { get; set; }
Property Value
Type Description
System.Nullable<System.Double>

TuneTrials

Perform multiple runs on each parameter set to limit the effect of random noise: Performance on a MIP model can sometimes experience significant variations due to random effects. As a result, the tuning tool may return parameter sets that improve on the baseline only due to randomness. This parameter allows you to perform multiple solves for each parameter set, using differentSeedvalues for each, in order to reduce the influence of randomness on the results. The default value of 0 indicates an automatic choice that depends on model characteristics. One important note about integer-valued parameters: while the maximum value that can be stored in a signed integer is(2^{31}-1), we use a MAXINT value of 2,000,000,000. Attempting to set an integer parameter to a value larger than this maximum will produce an error. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? TuneTrials { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

UpdateMode

Changes the behavior of lazy updates: Determines how newly added variables and linear constraints are handled. The default setting (1) allows you to use new variables and constraints immediately for building or modifying the model. A setting of 0 requires you to callupdatebefore these can be used. Since the vast majority of programs never query Gurobi for details about the optimization models they build, the default setting typically removes the need to callupdate, or even be aware of the details of ourlazy updateapproach for handling model modifications. However, these details will show through when you try to query modified model information. In the Gurobi interface, model modifications (bound changes, right-hand side changes, objective changes, etc.) are placed in a queue. These queued modifications are applied to the model at three times: when you callupdate, when you calloptimize, or when you callwriteto write the model to disk. When you query information about the model, the result will depend on bothwhetherthat information was modified andwhenit was modified. In particular, no matter what setting ofUpdateModeyou use, if the modification is sitting in the queue, you’ll get the result from before the modification. To expand on this a bit, all attribute modifications are actually placed in a queue. This includes attributes that may not traditionally be viewed as being part of the model, including things like variable branching priorities, constraint basis statuses, etc. Querying the values of these attributes will return their previous values if subsequent modifications are still in the queue. The only potential benefit to changing the parameter to 0 is that in unusual cases this setting may allow simplex to make more aggressive use of warm-start information after a model modification. If you want to change this parameter, you need to set it as soon as you create your Gurobi environment. Note that you still need to callupdateto modify an attribute on an SOS constraint, quadratic constraint, or general constraint. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public bool? UpdateMode { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

VarBranch

Branch variable selection strategy: Controls the branch variable selection strategy. The default -1 setting makes an automatic choice, depending on problem characteristics. Available alternatives are Pseudo Reduced Cost Branching (0), Pseudo Shadow Price Branching (1), Maximum Infeasibility Branching (2), and Strong Branching (3). Changing the value of this parameter rarely produces a significant benefit. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? VarBranch { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

WLSAccessID

Web License Service access ID: When using a WLS license, set this parameter to the access ID for your license. You can retrieve this string from your account on theGurobi Web License Managersite. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public string WLSAccessID { get; set; }
Property Value
Type Description
System.String

WLSConfig

Web License Service configuration: When using a WLS On Demand license, this parameter can be used to specify which configuration to use. If not specified, the configuration used will be the default configuration specified for that license. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public string WLSConfig { get; set; }
Property Value
Type Description
System.String

WLSProxy

Web License Service proxy: Comma separated list of addresses of the WLS proxies to connect to. When using a WLS On Demand license, this parameter can be used to specify the URLs to which Gurobi will connect to report usage. The default value (an empty string) is equivalent tohttp://localhost:61099. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public string WLSProxy { get; set; }
Property Value
Type Description
System.String

WLSSecret

Web License Service secret: When using a WLS license, set this parameter to the secret key for your license. You can retrieve this string from your account on theGurobi Web License Managersite. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public string WLSSecret { get; set; }
Property Value
Type Description
System.String

WLSToken

Web License Service token: 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. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public string WLSToken { get; set; }
Property Value
Type Description
System.String

WLSTokenDuration

Web License Service token duration: When using a WLS license, this parameter can be used to adjust the lifespan (in minutes) of a token. A token enables Gurobi to run on that client for the life of the token. Gurobi will automatically request a new token if the current one expires, but it won’t notify the WLS server if it completes its work before the current token expires. A shorter lifespan is better for short-lived usage. A longer lifespan is better for environments where the network connection to the WLS server is unreliable. The default value of 0 means ‘automatic’, and is currently equal to 5 minutes. This value may change in the future. The WLS server will cap the chosen value automatically to be at least 5 minutes and no more than 60 minutes. This behavior may change in the future as well. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? WLSTokenDuration { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

WLSTokenRefresh

Web License Service token refresh interval: The value specifies the fraction of the token duration after which a token refresh is triggered. So, for example, if the token duration is 30 minutes and WLSTokenRefresh is set to 0.6, the token will be refreshed every 18 minutes. The minimum refresh interval is 4 minutes. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public double? WLSTokenRefresh { get; set; }
Property Value
Type Description
System.Nullable<System.Double>

WorkerPassword

Distributed worker password: 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 theWorkerPoolparameter. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public string WorkerPassword { get; set; }
Property Value
Type Description
System.String

WorkerPool

Distributed worker cluster (for distributed algorithms): 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 theWorkerPasswordparameter. 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 namedserver1andserver2, you could setWorkerPoolto"server1:61000"or"server1:61000,server2:61000". For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public string WorkerPool { get; set; }
Property Value
Type Description
System.String

WorkLimit

Work limit: Limits the total work expended (in work units). Optimization returns with aWORK_LIMITstatus if the limit is exceeded. In contrast to theTimeLimit, work limits are deterministic. This means that on the same hardware and with the same parameter and attribute settings, a work limit will stop the optimization of a given model at the exact same point every time. One work unit corresponds very roughly to one second on a single thread, but this greatly depends on the hardware on which Gurobi is running and the model that is being solved. Note that optimization may not stop immediately upon hitting the work limit. It will stop when the optimization is next in a deterministic state, and it will then perform the required additional computations of the attributes associated with the terminated optimization. As a result, theWorkattribute may be larger than the specified WorkLimit upon completion, and repeating the optimization with a WorkLimit set to the Work attribute of the stopped optimization may result in additional computations and a larger attribute value. This parameter iscallback settable. It can be changed from within a callback when thewherevalue isPRESOLVED,SIMPLEX,MIP,MIPSOL,MIPNODE,BARRIER, orMULTIOBJ(see theCallback Codessection for more information). How to do that for the different APIs is illustratedhere. In case of a remote server, the change of a parameter from within a callback may not be taken into account immediately. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public double? WorkLimit { get; set; }
Property Value
Type Description
System.Nullable<System.Double>

ZeroHalfCuts

Zero-half cut generation: Controls zero-half cut generation. Use 0 to disable these cuts, 1 for moderate cut generation, or 2 for aggressive cut generation. The default -1 value chooses automatically. Overrides theCutsparameter. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? ZeroHalfCuts { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

ZeroObjNodes

Zero-objective heuristic: Number of nodes to explore in the zero objective heuristic. This heuristic is quite expensive, and generally produces poor quality solutions. You should generally only use it if other means, including exploration of the tree with default settings, fail to produce a feasible solution. One important note about integer-valued parameters: while the maximum value that can be stored in a signed integer is(2^{31}-1), we use a MAXINT value of 2,000,000,000. Attempting to set an integer parameter to a value larger than this maximum will produce an error. For examples of how to query or modify parameter values from our different APIs, refer to ourParameter Examples.

Declaration
public int? ZeroObjNodes { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

Methods

IsCloudLicenseSpecified()

Checks if all required fields for the CloudServer License are specified in the current configuration. I.e.

CloudAccessID and CloudSecretKey. Does not check CloudPool. According to Gurobi, cloud pool only needs to be set, if it defers from default.)

Declaration
public bool IsCloudLicenseSpecified()
Returns
Type Description
System.Boolean

True, if all required fields are specified. Does NOT check if values are actually valid.

IsComputeServerLicenseSpecified()

Checks if all required fields for the ComputeServer License are specified in the current configuration. I.e.

ComputeServer and ServerPassword.

Declaration
public bool IsComputeServerLicenseSpecified()
Returns
Type Description
System.Boolean

True, if all required fields are specified. Does NOT check if values are actually valid.

IsVendorLicenseSpecified()

Checks if all required fields for the ISV License are specified in the current configuration. I.e. IsvName, ApplicationName and IsvCode.

Declaration
public bool IsVendorLicenseSpecified()
Returns
Type Description
System.Boolean

True, if all required fields are specified. Does NOT check if values are actually valid.

IsWebLicenseServerSpecified()

Checks if all required fields for the Web License Service (WLS) are specified in the current GurobiSolverConfiguration. I.e.

WLSSecret and WLSAccessID OR WLSToken.

Declaration
public bool IsWebLicenseServerSpecified()
Returns
Type Description
System.Boolean

True, if all required fields are specified. Does NOT check if values are actually valid.

Extension Methods