SimplexSolverParams Class

[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]

Defines the parameters used by the simplex solver.

Inheritance Hierarchy

System.Object
  Microsoft.SolverFoundation.Solvers.SimplexSolverParams

Namespace:  Microsoft.SolverFoundation.Solvers
Assembly:  Microsoft.Solver.Foundation (in Microsoft.Solver.Foundation.dll)

Syntax

'Declaration
Public Class SimplexSolverParams _
    Implements ISolverParameters, ISolverEvents
public class SimplexSolverParams : ISolverParameters, 
    ISolverEvents
public ref class SimplexSolverParams : ISolverParameters, 
    ISolverEvents
type SimplexSolverParams =  
    class
        interface ISolverParameters
        interface ISolverEvents
    end
public class SimplexSolverParams implements ISolverParameters, ISolverEvents

The SimplexSolverParams type exposes the following members.

Constructors

  Name Description
Public method SimplexSolverParams() Initializes a new instance of the SimplexSolverParams class.
Public method SimplexSolverParams(Func<TResult>) Initializes a new instance of the SimplexSolverParams class.
Public method SimplexSolverParams(Directive) Initializes a new instance of the SimplexSolverParams class using the specified directive.
Public method SimplexSolverParams(SimplexSolverParams) Initializes a new instance of the SimplexSolverParams class.

Top

Properties

  Name Description
Public property Abort Gets or sets a value that specifies whether the solver should stop.
Public property Algorithm Gets or sets the type of simplex algorithm to use.
Public property Costing Gets or sets the simplex costing.
Public property CostTolerance Gets or sets the numeric tolerance for simplex pricing.
Public property CutKinds Gets or sets the kinds of cuts that are generated.
Public property GeometricScalingThreshold Gets or sets the threshold of geometric scaling in the reduced model.
Public property GetInfeasibilityReport Gets or sets a value that specifies whether to create an infeasibility report.
Public property GetSensitivityReport Gets or sets a value that specifies whether to create a sensitivity report.
Public property InitialBasisKind Gets or sets the initial basis for the simplex solver.
Public property KindOfSolver Gets the type of solver to use.
Public property MaxGeometricScalingIterations Gets or sets the upper limit for geometric scaling in the reduced model.
Public property MaxPivotCount Gets or sets the upper limit for pivot count.
Public property MixedIntegerBranchingStrategyPostFeasibility Gets or sets the method that the solver uses after feasibility to select variables to branch on.
Public property MixedIntegerBranchingStrategyPreFeasibility Gets or sets the method that the solver uses before feasibility to select variables to branch on.
Public property MixedIntegerGapTolerance Gets or sets the tolerance to declare an integer solution optimal.
Public property MixedIntegerGenerateCuts Gets or sets a value that specifies whether to generate cuts.
Public property MixedIntegerGomoryCutRoundLimit Gets or sets the limit on generating cutting planes.
Public property MixedIntegerNodePresolve Gets or sets a value that indicates whether to perform presolve during a search.
Public property MixedIntegerPresolve Gets or sets a value that specifies whether to presolve a model.
Public property MixedIntegerSearchStrategy Gets or sets the search strategy for finding an optimal integer solution.
Public property PresolveLevel Gets or sets the level of presolve that the simplex solver applies.
Public property QueryAbort Gets or sets the callback function that determines when to stop a computation.
Public property ShiftBounds Gets or sets a value that specifies whether to shift variable bounds.
Public property Solving Gets or sets the callback function that is called during the solve process.
Public property UseDouble Gets or sets a value that indicates whether to use double arithmetic.
Public property UseExact Gets or sets a value that specifies whether to use exact arithmetic.
Public property VariableFeasibilityTolerance Gets or sets the numerical tolerance for variables.

Top

Methods

  Name Description
Public method Equals Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method NotifyEndFactorization Defines the callback function called after matrix factorization.
Public method NotifyEndPivot Defines the callback function called after the pivot.
Public method NotifyFindNext Defines the callback function called when the simplex solver find the next pair of pivoting variables.
Public method NotifyStartFactorization Defines the callback function called before matrix factorization.
Public method NotifyStartPivot Defines the callback function called before the pivot.
Public method NotifyStartSolve Defines the callback function called before a solver starts.
Public method ShouldAbort Returns a value that indicates whether the solver should stop.
Public method ToString Returns a string that represents the current object. (Inherited from Object.)

Top

Remarks

The properties in the SimplexSolverParams object are examined once by the solver when the SimplexSolver::Solve(ISolverParameters) or SimplexSolver::Solve(array<SimplexSolverParams>) method is invoked. To adjust these properties during the solve process, stop the solver by using the Abort property, modify the properties, and then re-invoke the SimplexSolver::Solve(ISolverParameters) or SimplexSolver::Solve(array<SimplexSolverParams>) method.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.SolverFoundation.Solvers Namespace