PersistentSolverBase

(类来自 pyomo.contrib.solver.base)

class pyomo.contrib.solver.base.PersistentSolverBase(**kwds)[source]

基础：SolverBase

持久性求解器可以构建的基类。这个类继承了求解器基类的方法，并添加了持久性求解器所需的方法。

示例用法可以在Gurobi界面中看到。

__init__(**kwds) → None

方法

__init__(**kwds)

add_block(block)

向模型添加一个块

add_constraints(cons)

向模型添加约束

add_parameters(params)

向模型添加参数

add_variables(variables)

向模型添加变量

available()

测试此系统上是否可用的求解器。

is_persistent()

remove_block(block)

从模型中移除一个块

remove_constraints(cons)

从模型中移除约束

remove_parameters(params)

从模型中移除参数

remove_variables(variables)

从模型中移除变量

set_instance(model)

设置模型的实例

set_objective(obj)

设置模型的当前目标

solve(model, **kwargs)

update_parameters()

更新模型上的参数

update_variables(variables)

更新模型上的变量

version()

属性

CONFIG

成员文档

enum Availability(value)

基础：IntEnum

用于捕获求解器可能存在的不同状态的类，以记录其可用性。

as_integer_ratio()

返回整数比率。

返回一对整数，其比例完全等于原始整数，并且分母为正数。

>>> (10).as_integer_ratio()
(10, 1)
>>> (-10).as_integer_ratio()
(-10, 1)
>>> (0).as_integer_ratio()
(0, 1)
bit_count()

自身绝对值的二进制表示中1的数量。

也被称为人口计数。

>>> bin(13)
'0b1101'
>>> (13).bit_count()
3
bit_length()

表示自身所需的二进制位数。

>>> bin(37)
'0b100101'
>>> (37).bit_length()
6
conjugate()

返回自身，即任何整数的复共轭。

classmethod from_bytes(bytes, byteorder='big', *, signed=False)

返回由给定字节数组表示的整数。

bytes

保存要转换的字节数组。参数必须支持缓冲区协议或是一个生成字节的可迭代对象。Bytes 和 bytearray 是支持缓冲区协议的内置对象的示例。

byteorder

用于表示整数的字节顺序。如果字节顺序是‘big’，最高有效字节位于字节数组的开头。如果字节顺序是‘little’，最高有效字节位于字节数组的末尾。要请求主机系统的本机字节顺序，请使用sys.byteorder作为字节顺序值。默认是使用‘big’。

signed

指示是否使用二进制补码来表示整数。

to_bytes(length=1, byteorder='big', *, signed=False)

返回表示整数的字节数组。

length

要使用的字节对象的长度。如果整数不能用给定的字节数表示，则会引发OverflowError。默认长度为1。

byteorder

用于表示整数的字节顺序。如果字节顺序是‘big’，最高有效字节位于字节数组的开头。如果字节顺序是‘little’，最高有效字节位于字节数组的末尾。要请求主机系统的本机字节顺序，请使用sys.byteorder作为字节顺序值。默认是使用‘big’。

signed

确定是否使用二进制补码来表示整数。 如果 signed 为 False 并且给出了负整数，则会引发 OverflowError。

denominator

最低项有理数的分母

imag

复数的虚部

numerator

最低项有理数的分子

real

复数的实部

abstract add_block(block: BlockData)[来源]

向模型添加一个块

abstract add_constraints(cons: List[ConstraintData])[source]

向模型添加约束

abstract add_parameters(params: List[ParamData])[source]

向模型添加参数

abstract add_variables(variables: List[VarData])[source]

向模型添加变量

abstract available() → bool

测试此系统上是否可用的求解器。

名义上，如果求解器接口有效并可用于解决问题，则返回True；如果不能，则返回False。

请注意，对于有许可证的求解器，有多个“级别”的可用性：根据许可证的不同，求解器可能在问题大小或运行时间上有限制（例如，‘demo’ vs. ‘community’ vs. ‘full’）。在这些情况下，求解器可能会返回一个enum.IntEnum的子类，如果求解器可用（可能有限制），则其成员解析为True。该枚举也可能有多个成员，所有成员都解析为False，表示接口不可用的原因（未找到、许可证无效、版本不受支持等）。

Returns:

available – 一个枚举，表示求解器的“可用性”。 请注意，该枚举可以转换为布尔值，如果求解器可以运行，则为 True，否则为 False。

Return type:

SolverBase.Availability

is_persistent()[source]
Returns:

is_persistent – 如果求解器是持久求解器，则为True。

Return type:

bool

abstract remove_block(block: BlockData)[source]

从模型中移除一个块

abstract remove_constraints(cons: List[ConstraintData])[source]

从模型中移除约束

abstract remove_parameters(params: List[ParamData])[source]

从模型中移除参数

abstract remove_variables(variables: List[VarData])[source]

从模型中移除变量

abstract set_instance(model)[源代码]

设置模型的实例

abstract set_objective(obj: ObjectiveData)[来源]

设置模型的当前目标

abstract solve(model: BlockData, **kwargs) → Results[source]
Keyword Arguments:

  • tee (TextIO_or_Logger, default=False) – tee 接受 bool, io.TextIOBase, 或 logging.Logger（或这些类型的列表）。True 被映射到 sys.stdout。求解器日志将被打印到每个 这些流/目的地。

  • working_dir (Path, optional) – 生成文件应保存的目录。这将替换keepfiles选项。

  • load_solutions (Bool, default=True) – 如果为True，原始变量的值将被加载到模型中。

  • raise_exception_on_nonoptimal_result (Bool, default=True) – 如果为False，solve方法将继续处理，即使返回的结果是非最优的。

  • symbolic_solver_labels (Bool, default=False) – 如果为True，求解器的名称将反映Pyomo组件的名称。在调用set_instance后无法更改。

  • timer (可选) – 用于记录相关过程计时数据的计时器对象。

  • threads (NonNegativeInt, optional) – 求解器使用的线程数。

  • time_limit (NonNegativeFloat, optional) – 应用于求解器的时间限制（以秒为单位）。

  • solver_options (dict, optional) – 传递给求解器的选项。

  • auto_updates (dict, optional) –

    用于检测模型在求解之间变化的配置选项

    check_for_new_or_removed_constraints: bool, 默认=True

    如果为False，新的/旧的约束将不会在后续求解中自动检测到。仅在手动使用opt.add_constraints()和opt.remove_constraints()更新求解器时，或确定模型中没有添加/删除约束时使用False。

    check_for_new_or_removed_vars: bool, 默认=True

    如果为False，新的/旧的变量将不会在后续求解中自动检测到。仅在手动使用opt.add_variables()和opt.remove_variables()更新求解器时，或确定模型中没有添加/删除变量时使用False。

    check_for_new_or_removed_params: bool, 默认=True

    如果为False，新的/旧的参数将不会在后续求解中自动检测到。仅在手动使用opt.add_parameters()和opt.remove_parameters()更新求解器时，或确定模型中没有添加/删除参数时使用False。

    check_for_new_objective: bool, 默认=True

    如果为False，新的/旧的目标将不会在后续求解中自动检测到。仅在手动使用opt.set_objective()更新求解器时，或确定模型中没有添加/删除目标时使用False。

    update_constraints: bool, 默认=True

    如果为False，现有约束的更改将不会在后续求解中自动检测到。这包括约束的lower、body和upper属性的更改。仅在手动使用opt.remove_constraints()和opt.add_constraints()更新求解器时，或确定约束未被修改时使用False。

    update_vars: bool, 默认=True

    如果为False，现有变量的更改将不会在后续求解中自动检测到。这包括变量的lb、ub、domain和fixed属性的更改。仅在手动使用opt.update_variables()更新求解器时，或确定变量未被修改时使用False。

    update_parameters: bool, 默认=True

    如果为False，参数值的更改将不会在后续求解中自动检测到。仅在手动使用opt.update_parameters()更新求解器时，或确定参数未被修改时使用False。

    update_named_expressions: bool, 默认=True

    如果为False，表达式的更改将不会在后续求解中自动检测到。仅在手动使用opt.remove_constraints()和opt.add_constraints()更新求解器时，或确定表达式未被修改时使用False。

    update_objective: bool, 默认=True

    如果为False，目标的更改将不会在后续求解中自动检测到。这包括目标的expr和sense属性。仅在手动使用opt.set_objective()更新求解器时，或确定目标未被修改时使用False。

    treat_fixed_vars_as_params: bool, 默认=True

    [高级选项]

    这是一个高级选项，仅在特殊情况下使用。默认设置为True时，固定变量将被视为参数。这意味着如果x或y是固定的，z == x*y将是线性的，并且约束可以写入LP文件。如果固定变量的值发生变化，我们必须完全重新处理所有使用该变量的约束。如果treat_fixed_vars_as_params为False，则约束将被处理为固定变量未固定，并且求解器将被告知变量是固定的。这意味着即使x和/或y是固定的，z == x*y也不能写入LP文件。然而，这种方式更新固定变量的值要快得多。

abstract update_parameters()[source]

更新模型上的参数

abstract update_variables(variables: List[VarData])[source]

更新模型上的变量

abstract version() → Tuple
Returns:

version – 表示版本的元组

Return type:

tuple