flixOpt.solvers

This module contains the solvers of the flixOpt framework, making them available to the end user in a compact way.

Classes

CbcSolver

CbcSolver(mip_gap: float = 0.01, time_limit_seconds: int = 300, logfile_name: str = 'cbc.log', solver_output_to_console: bool = True)

Bases: Solver

Solver implementation for CBC. Also Look in class Solver for more details

Attributes: time_limit_seconds (int): Time limit for the solver. After this time, the solver takes the currently best solution, ignoring the mip_gap.

CplexSolver

CplexSolver(mip_gap: float = 0.01, time_limit_seconds: int = 300, logfile_name: str = 'cplex.log', solver_output_to_console: bool = True)

Bases: Solver

Solver implementation for CPLEX. Also Look in class Solver for more details

Attributes: time_limit_seconds (int): Time limit for the solver. After this time, the solver takes the currently best solution, ignoring the mip_gap.

GlpkSolver

GlpkSolver(mip_gap: float = 0.01, logfile_name: str = 'glpk.log', solver_output_to_console: bool = True)

Bases: Solver

Solver implementation for Glpk. Also Look in class Solver for more details

GurobiSolver

GurobiSolver(mip_gap: float = 0.01, time_limit_seconds: int = 300, logfile_name: str = 'gurobi.log', solver_output_to_console: bool = True)

Bases: Solver

Solver implementation for Gurobi. Also Look in class Solver for more details

Attributes: time_limit_seconds (int): Time limit for the solver. After this time, the solver takes the currently best solution, ignoring the mip_gap.

HighsSolver

HighsSolver(mip_gap: float = 0.01, time_limit_seconds: int = 300, logfile_name: str = 'highs.log', solver_output_to_console: bool = True, threads: int = 4)

Bases: Solver

Solver implementation for HIGHS. Also Look in class Solver for more details

Attributes: time_limit_seconds (int): Time limit for the solver. After this time, the solver takes the currently best solution, ignoring the mip_gap. threads (int): Number of threads to use for the solver.

Solver

Solver(mip_gap: float, solver_output_to_console: bool, logfile_name: str)

Bases: ABC

Abstract base class for solvers.

Attributes: mip_gap (float): Solver's mip gap setting. The MIP gap describes the accepted (MILP) objective, and the lower bound, which is the theoretically optimal solution (LP) solver_output_to_console (bool): Whether to display solver output. logfile_name (str): Filename for saving the solver log. objective (Optional[float]): Objective value from the solution. best_bound (Optional[float]): Best bound from the solver. termination_message (Optional[str]): Solver's termination message.