Highs

(class from pyomo.contrib.solver.solvers.highs)

class pyomo.contrib.solver.solvers.highs.Highs(**kwds)

Bases: PersistentSolverMixin, PersistentSolverUtils, PersistentSolverBase

Interface to HiGHS

__init__(**kwds)

Methods

__init__(**kwds)
add_block(block)	Add a block to the model.
add_constraints(cons)	Add constraints to the model.
add_parameters(params)
add_sos_constraints(cons)
add_variables(variables)
api_version()	Return the public API supported by this interface.
available()	Test if the solver is available on this system.
is_persistent()
remove_block(block)	Remove a block from the model.
remove_constraints(cons)	Remove constraints from the model.
remove_parameters(params)
remove_sos_constraints(cons)
remove_variables(variables)
set_instance(model)	Set an instance of the model.
set_objective(obj)	Set current objective for the model.
solve(model, **kwds)	Solve a Pyomo model.
update([timer])
update_parameters()	Update parameters on the model.
update_variables(variables)	Update variables on the model.
version()	Return the solver version found on the system.

Attributes

CONFIG
name
config	Instance configuration; see CONFIG documentation on derived class

Member Documentation

classmethod api_version()

Return the public API supported by this interface.

Returns:

A solver API enum object

Return type:

SolverAPIVersion

add_block(block)

Add a block to the model.

add_constraints(cons: List[ConstraintData])

Add constraints to the model.

available()

Test if the solver is available on this system.

Nominally, this will return True if the solver interface is valid and can be used to solve problems and False if it cannot. Note that for licensed solvers there are a number of “levels” of available: depending on the license, the solver may be available with limitations on problem size or runtime (e.g., ‘demo’ vs. ‘community’ vs. ‘full’). In these cases, the solver may return a subclass of enum.IntEnum, with members that resolve to True if the solver is available (possibly with limitations). The Enum may also have multiple members that all resolve to False indicating the reason why the interface is not available (not found, bad license, unsupported version, etc).

Returns:

available – An enum that indicates “how available” the solver is. Note that the enum can be cast to bool, which will be True if the solver is runnable at all and False otherwise.

Return type:

Availability

is_persistent() → bool

Returns:

is_persistent – True if the solver is a persistent solver.

Return type:

bool

remove_block(block)

Remove a block from the model.

remove_constraints(cons: List[ConstraintData])

Remove constraints from the model.

set_instance(model)

Set an instance of the model.

set_objective(obj: ObjectiveData)

Set current objective for the model.

solve(model, **kwds) → Results

Solve a Pyomo model.

Parameters:

• model (BlockData) – The Pyomo model to be solved

• **kwargs – Additional keyword arguments (including solver_options - passthrough options; delivered directly to the solver (with no validation))

Returns:

results – A results object

Return type:

Results

update_parameters()

Update parameters on the model.

update_variables(variables: List[VarData])

Update variables on the model.

version()

Return the solver version found on the system.

Returns:

version – A tuple representing the version

Return type:

tuple

config

Instance configuration; see CONFIG documentation on derived class