ortools.math_opt.solvers.xpress_pb2
@generated by mypy-protobuf. Do not edit manually! isort:skip_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.
1# -*- coding: utf-8 -*- 2# Generated by the protocol buffer compiler. DO NOT EDIT! 3# NO CHECKED-IN PROTOBUF GENCODE 4# source: ortools/math_opt/solvers/xpress.proto 5# Protobuf Python Version: 6.33.1 6"""Generated protocol buffer code.""" 7from google.protobuf import descriptor as _descriptor 8from google.protobuf import descriptor_pool as _descriptor_pool 9from google.protobuf import runtime_version as _runtime_version 10from google.protobuf import symbol_database as _symbol_database 11from google.protobuf.internal import builder as _builder 12_runtime_version.ValidateProtobufRuntimeVersion( 13 _runtime_version.Domain.PUBLIC, 14 6, 15 33, 16 1, 17 '', 18 'ortools/math_opt/solvers/xpress.proto' 19) 20# @@protoc_insertion_point(imports) 21 22_sym_db = _symbol_database.Default() 23 24 25 26 27DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n%ortools/math_opt/solvers/xpress.proto\x12\x1coperations_research.math_opt\"F\n\x16XpressInitializerProto\x12\x1a\n\rextract_names\x18\x01 \x01(\x08H\x00\x88\x01\x01\x42\x10\n\x0e_extract_names\"\x94\x01\n\x15XpressParametersProto\x12Q\n\nparameters\x18\x01 \x03(\x0b\x32=.operations_research.math_opt.XpressParametersProto.Parameter\x1a(\n\tParameter\x12\x0c\n\x04name\x18\x01 \x01(\t\x12\r\n\x05value\x18\x02 \x01(\tb\x06proto3') 28 29_globals = globals() 30_builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals) 31_builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'ortools.math_opt.solvers.xpress_pb2', _globals) 32if not _descriptor._USE_C_DESCRIPTORS: 33 DESCRIPTOR._loaded_options = None 34 _globals['_XPRESSINITIALIZERPROTO']._serialized_start=71 35 _globals['_XPRESSINITIALIZERPROTO']._serialized_end=141 36 _globals['_XPRESSPARAMETERSPROTO']._serialized_start=144 37 _globals['_XPRESSPARAMETERSPROTO']._serialized_end=292 38 _globals['_XPRESSPARAMETERSPROTO_PARAMETER']._serialized_start=252 39 _globals['_XPRESSPARAMETERSPROTO_PARAMETER']._serialized_end=292 40# @@protoc_insertion_point(module_scope)
Parameters used to initialize the Xpress solver.
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).
Abstract base class for protocol messages.
Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.