ULSAlgorithms.Optimization Namespace Reference

Namespaces
namespace	Adapters
namespace	Execution
namespace	External
namespace	Modeling

Classes
class	DefaultSolverAdapterRegistry
	Creates the built-in concrete solver-adapter registry. More...
interface	IOptimizationSolverAdapter
	Defines the common metadata and availability contract implemented by every optimization-solver adapter used by solver-backed ULS algorithms. More...
class	OptimizationSolverDiscovery
	High-level entry point used by solver-backed ULS algorithms to discover and select a mathematical optimizer automatically. More...
class	SolverAdapterRegistry
	Stores optimization-solver adapters and provides deterministic lookup by adapter identifier and solver kind. More...
class	SolverAvailabilityInfo
	Describes solver availability and the installation selected by an adapter. More...
class	SolverDiscoveryReport
	Complete availability snapshot for all built-in solver adapters. More...
class	SolverExecutionInfo
	Serializable-style immutable snapshot of the solver selected for one solver-backed ULS execution. More...
class	SolverSelectionOptions
	Configures automatic or explicit optimization-solver selection. More...
class	SolverSelectionResult
	Describes the outcome of optimization-solver selection. More...
class	SolverSelectionService
	Selects a usable optimization solver by capability, machine availability, and deterministic priority. More...

Enumerations
enum	SolverAvailabilityStatus {   Unknown = 0 , NotInstalled = 1 , LibrariesMissing = 2 , LoadFailure = 3 ,   LicenseUnavailable = 4 , AvailableWithLimitations = 5 , Available = 6 }
	Describes whether a solver can currently be used on the current computer. More...
enum	SolverCapability {   Unknown = 0 , LinearProgramming = 1 , MixedIntegerLinearProgramming = 2 , QuadraticProgramming = 3 ,   MixedIntegerQuadraticProgramming = 4 , ProgressCallbacks = 5 , IncumbentCallbacks = 6 , UserCutCallbacks = 7 ,   LazyConstraintCallbacks = 8 , HeuristicCallbacks = 9 , BranchCallbacks = 10 , NodeCallbacks = 11 ,   Interruption = 12 , WarmStart = 13 , SolutionPool = 14 , LpExport = 15 ,   MpsExport = 16 , LpImport = 17 , MpsImport = 18 , InfeasibilityAnalysis = 19 ,   ConflictRefinement = 20 , DeterministicParallelism = 21 , LogCapture = 22 , OptimalityGapReporting = 23 ,   SearchStatistics = 24 }
	Identifies an optional capability exposed by an optimization-solver adapter. More...
enum	SolverKind {   Unknown = 0 , Automatic = 1 , Cplex = 2 , Gurobi = 3 ,   Xpress = 4 , CoinOrCbc = 5 }
	Identifies a mathematical optimization solver that can be used by solver-backed ULS algorithms. More...

Enumeration Type Documentation

SolverAvailabilityStatus

enum ULSAlgorithms.Optimization.SolverAvailabilityStatus

Describes whether a solver can currently be used on the current computer.

Enumerator
Unknown	Availability has not been checked.
NotInstalled	The solver is not installed or cannot be located.
LibrariesMissing	Required managed or native libraries are missing.
LoadFailure	Solver libraries were found but could not be loaded.
LicenseUnavailable	The solver is installed but no usable license is available.
AvailableWithLimitations	The solver is usable with functional or licensing limitations.
Available	The solver is installed, loadable and usable.

Definition at line 6 of file SolverAvailabilityStatus.cs.

SolverCapability

enum ULSAlgorithms.Optimization.SolverCapability

Identifies an optional capability exposed by an optimization-solver adapter.

Enumerator
Unknown	No capability has been specified.
LinearProgramming	Continuous linear programming.
MixedIntegerLinearProgramming	Mixed-integer linear programming.
QuadraticProgramming	Quadratic programming.
MixedIntegerQuadraticProgramming	Mixed-integer quadratic programming.
ProgressCallbacks	Progress callbacks.
IncumbentCallbacks	Incumbent callbacks.
UserCutCallbacks	User-defined cutting-plane callbacks.
LazyConstraintCallbacks	Lazy-constraint callbacks.
HeuristicCallbacks	Heuristic-solution callbacks.
BranchCallbacks	Branching callbacks.
NodeCallbacks	Search-tree node callbacks.
Interruption	Cooperative interruption.
WarmStart	Warm starts or MIP starts.
SolutionPool	Multiple-solution retrieval.
LpExport	LP-format export.
MpsExport	MPS-format export.
LpImport	LP-format import.
MpsImport	MPS-format import.
InfeasibilityAnalysis	Infeasibility analysis such as IIS extraction.
ConflictRefinement	Conflict refinement.
DeterministicParallelism	Deterministic parallel optimization.
LogCapture	Solver-native log capture.
OptimalityGapReporting	Best-bound and optimality-gap reporting.
SearchStatistics	Search-node and iteration statistics.

Definition at line 6 of file SolverCapability.cs.

SolverKind

enum ULSAlgorithms.Optimization.SolverKind

Identifies a mathematical optimization solver that can be used by solver-backed ULS algorithms.

Automatic follows the same default priority as LotSizingDataModel: CPLEX, Gurobi, FICO Xpress, then COIN-OR CBC.

Enumerator
Unknown	No solver has been specified.
Automatic	Select the first usable solver according to the configured priority.
Cplex	IBM ILOG CPLEX Optimization Studio.
Gurobi	Gurobi Optimizer.
Xpress	FICO Xpress Optimizer.
CoinOrCbc	COIN-OR CBC mixed-integer programming solver.

Definition at line 14 of file SolverKind.cs.