xpress.proto

Go to the documentation of this file.

// Copyright 2010-2025 Google LLC
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
 
// Proto messages specific to Xpress.
syntax = "proto3";
 
package operations_research.math_opt;
 
// Parameters used to initialize the Xpress solver.
message XpressInitializerProto {
  optional bool extract_names = 1;
}
 
// Xpress specific parameters for solving. See
//   https://www.fico.com/fico-xpress-optimization/docs/latest/solver/optimizer/HTML/chapter7.html
// for a list of possible parameters (called "controls" in Xpress).
// In addition to all Xpress controls, the following special parameters are
// also supported:
//   "EXPORT_MODEL"(string)  If present then the low level Xpress model
//                           (the XPRSprob instance) is written to that file
//                           right before XPRSoptimize() is called. This can
//                           be useful for debugging.
//   "FORCE_POSTSOLVE"(int)  If set to a non-zero value then the low-level code
//                           will call XPRSpostsolve() right after calling
//                           XPRSoptimize(). If not set or set to zero then
//                           calling XPRSpostsolve() is delayed to the latest
//                           possible point in time to enable incremental
//                           solves.
//    "STOP_AFTER_LP"(int)   If set to a non-zero value then the solve will be
//                           stopped right after solving the root relaxation.
//                           This is the same as passing the ' l' (ell) flag
//                           to XPRSoptimize() and stops the process earlier
//                           than a limit like MAXNODE=0.
//
// Example use:
//   XpressParameters xpress;
//   xpress.param_values["BarIterLimit"] = "10";
//
// Parameters are applied in the following order:
//  * Any parameters derived from ortools parameters (like LP algorithm).
//  * param_values in iteration order (insertion order).
message XpressParametersProto {
  message Parameter {
    string name = 1;
    string value = 2;
  }
  repeated Parameter parameters = 1;
}