picos.solvers

This package contains the interfaces to the optimization solvers that PICOS uses as its backend. You do not need to instanciate any of the solver classes directly; if you want to select a particular solver, it is most convenient to supply it to Problem.solve via the solver keyword argument.

Functions

all_solvers()

returns

A dictionary mapping solver names to implementation classes.

available_solvers([problem])

returns

A list of names of available solvers.

get_solver(name)

returns

Implementation class of the solver of the given name.

potential_solvers(problem)

returns

A list of names of solvers that support the given problem.

suggested_solver(problem[, order, returnClass])

returns

The name or class of an available solver that can handle the given

supportLevelString(level)

Classes

CPLEXSolver(problem)

Implementation of the CPLEX solver.

CVXOPTSolver(problem)

ConflictingOptionsError

An exception raised by implementations of _solve to signal to the user that two options they specified cannot be used in conjunction.

DependentOptionError

An exception raised by implementations of _solve to signal to the user that an option they specified needs another option to also be set.

ECOSSolver(problem)

GLPKSolver(problem)

GurobiSolver(problem)

InappropriateSolverError

An exception raised by implementations of _solve to signal to the user that the solver (or its requested sub-solver) does not support the given problem type.

MOSEKFusionSolver(problem)

MOSEKSolver(problem)

NoAppropriateSolverError

An exception raised when no fitting solver is available.

OptionError

Base class for solver option related errors.

OptionValueError

An exception raised by implementations of _solve to signal to the user that they have set an option to an invalid value.

ProblemUpdateError

An exception raised by implementations of _update_problem to signal to the method _load_problem that the problem needs to be re-imported.

SCIPSolver(problem)

SMCPSolver(problem)

Solver(problem, displayName, longDisplayName)

Abstract base class for a wrapper around the internal problem representation of solvers.

SolverError

Base class for solver-specific exceptions.

UnsupportedOptionError

An exception raised by implementations of _solve to signal to the user that an option they specified is not supported by the solver or the requested sub-solver, or in conjunction with the given problem type or with another option.

Variables

SUPPORT_LEVEL_EXPERIMENTAL

int([x]) -> integer int(x, base=10) -> integer

SUPPORT_LEVEL_LIMITED

int([x]) -> integer int(x, base=10) -> integer

SUPPORT_LEVEL_NATIVE

int([x]) -> integer int(x, base=10) -> integer

SUPPORT_LEVEL_NONE

int([x]) -> integer int(x, base=10) -> integer

SUPPORT_LEVEL_SECONDARY

int([x]) -> integer int(x, base=10) -> integer

order

The default preference list for solver selection.