ScipSolve(CancellationToken, MathModel) Method

Solves the given model with a cancellationToken and returns:
  • Ok of the solution if the execution is successfully completed,
  • experienced Err otherwise.

Assume we have just tried to solve the model.

C#
Scip scip = new();
var resSolution = await scip.Solve(model);

The result of the solution, resSolution here, can be used in different ways ().

#1: Handle error case and Unwrap

C#
if (resSolution.IsErr)
{
    // do something with the error:
    // * return a proper result
    // * throw an exception using the error message 'resSolution.ErrorMessage().Unwrap()'
}
MathModelSolution solution = resSolution.Unwrap();
// use the solution

#2: Use ThrowIfErr shorthand and Unwrap

C#
MathModelSolution solution = resSolution.ThrowIfErr().Unwrap();
// use the solution

#3: Map the solution to Res of the desired result

C#
Res<double> resObjVal = resSolution.Map(soln => soln.ObjectiveValue.UnwrapOr(double.PositiveInfinity));
// note that soln.ObjectiveValue can be None if the resSolution.IsOk (solver worked properly);
// however, the model is infeasible.

Definition

Namespace: Orx.MathProg.Solvers
Assembly: Orx.MathProg (in Orx.MathProg.dll) Version: 1.0.0
C#
public Task<Res<MathModelSolution>> Solve(
	CancellationToken cancellationToken,
	MathModel model
)

Parameters

cancellationToken  CancellationToken
Cancellation token which allows to terminate the solver externally.
model  MathModel
Mathematical model to solve.

Return Value

TaskResMathModelSolution

Implements

ISolverSolve(CancellationToken, MathModel)

See Also