ScipParams Structure

Scip parameters.

Definition

Namespace: Orx.MathProg.Solvers
Assembly: Orx.MathProg (in Orx.MathProg.dll) Version: 1.0.0
C#
public struct ScipParams : IEquatable<ScipParams>
Inheritance
Object    ValueType    ScipParams
Implements
IEquatableScipParams

Constructors

ScipParams Creates the scip parameters with default values. See the complete list and explanations here: https://www.scipopt.org/doc/html/PARAMETERS.php.

Properties

AbsGap Absolute tolerance on the gap between the best integer objective and the objective of the best node remaining (limits/absgap). Default = 0.
Gap Relative tolerance on the gap between the best integer objective and the objective of the best node remaining (limits/gap). Default = 0.
MaxNThreads The maximum number of threads used during parallel solve (parallel/maxnthreads). Default = 8.
MinNThreads The minimum number of threads used during parallel solve (parallel/minnthreads). Default = 1.
ParallelMode Parallelization mode of the solver (parallel/mode).
  • when 0 => opportunistic,
  • when 1 => deterministic.
Default = 1.
Silent The solver will execute silently when set to true; will log solver's output to the stdout when set to false. Default = true.
TimeLimit Time limit in seconds (limits/time). Default = 1e+20.

Methods

GetType
(Inherited from Object)
Validate Validates the values of the scip parameters, and returns Ok if all values are valid. Returns the error explaining values of which setting has an invalid value.
C#
ScipParams pars = new();
Res validation = pars.Validate();
Assert.True(validation.IsOk); // all default values must be valid :)

ScipParams parsBad = new()
{
    TimeLimit = -10 // not a valid time limit
};
Res validationBad = parsBad.Validate();
Assert.True(validationBad.IsErr);
Assert.True(validationBad.ErrorMessage().Unwrap().Contains("TimeLimit")); // error message describing the failing test

See Also