lucid::Optimiser Class Reference

Base class for optimisation solvers. More...

#include <Optimiser.h>

Inheritance diagram for lucid::Optimiser:

Public Types
using	SolutionCallback = std::function<void(bool, double, const Vector&, double, double, double)>
	Callback function called when the optimisation is done.

Public Member Functions
bool	solve_fourier_barrier_synthesis (const FourierBarrierSynthesisProblem &problem, const SolutionCallback &cb) const
	Solve the Fourier barrier synthesis problem.
const std::string &	problem_log_file () const
	Get read-only access to the problem log file of the solver.
const std::string &	iis_log_file () const
	Get read-only access to the irreducible infeasible set log file of the solver.
bool	has_problem_log_file () const
	Get read-only access to the problem log file of the solver.
bool	has_iis_log_file () const
	Get read-only access to the irreducible infeasible set log file of the solver.
std::string &	m_problem_log_file ()
	Get read-write access to the problem log file of the solver.
std::string &	m_iis_log_file ()
	Get read-write access to the irreducible infeasible set log file of the solver.
bool	should_log_problem () const
	Check whether the solver is configured to log the lp problem.
bool	should_log_iis () const
	Check whether the solver is configured to log the iis.
virtual std::string	to_string () const
	Get string representation of the optimiser.

Protected Attributes
std::string	problem_log_file_
	File to log the problem to, if provided.
std::string	iis_log_file_
	File to log the IIS (Irreducible Inconsistent Subsystem) to, if found.

Detailed Description

Base class for optimisation solvers.

This class provides a common interface for different optimisation backends (Gurobi, HiGHS, ALGLIB, SoPlex) used in the verification process.

Member Typedef Documentation

SolutionCallback

using lucid::Optimiser::SolutionCallback = std::function<void(bool, double, const Vector&, double, double, double)>

Callback function called when the optimisation is done.

Parameters

success	true if the optimisation was successful, false if no solution was found
obj_val	objective value. 0 if no solution was found
eta	eta value. 0 if no solution was found
c	c value. 0 if no solution was found
norm	actual norm of the barrier function. 0 if no solution was found

Member Function Documentation

has_iis_log_file()

bool lucid::Optimiser::has_iis_log_file ( ) const

inlinenodiscard

Get read-only access to the irreducible infeasible set log file of the solver.

Returns

irreducible infeasible set log file of the solver

has_problem_log_file()

bool lucid::Optimiser::has_problem_log_file ( ) const

inlinenodiscard

Get read-only access to the problem log file of the solver.

Returns

problem log file of the solver

iis_log_file()

const std::string & lucid::Optimiser::iis_log_file ( ) const

inlinenodiscard

Get read-only access to the irreducible infeasible set log file of the solver.

Returns

irreducible infeasible set log file of the solver

m_iis_log_file()

std::string & lucid::Optimiser::m_iis_log_file ( )

inline

Get read-write access to the irreducible infeasible set log file of the solver.

Returns

irreducible infeasible set log file of the solver

m_problem_log_file()

std::string & lucid::Optimiser::m_problem_log_file ( )

inline

Get read-write access to the problem log file of the solver.

Returns

problem log file of the solver

problem_log_file()

const std::string & lucid::Optimiser::problem_log_file ( ) const

inlinenodiscard

Get read-only access to the problem log file of the solver.

Returns

problem log file of the solver

should_log_iis()

bool lucid::Optimiser::should_log_iis ( ) const

inlinenodiscard

Check whether the solver is configured to log the iis.

Returns

true if the solver is configured to log the iis

false if the solver is not configured to log the iis

should_log_problem()

bool lucid::Optimiser::should_log_problem ( ) const

inlinenodiscard

Check whether the solver is configured to log the lp problem.

Returns

true if the solver is configured to log the lp problem

false if the solver is not configured to log the lp problem

solve_fourier_barrier_synthesis()

bool lucid::Optimiser::solve_fourier_barrier_synthesis	(	const FourierBarrierSynthesisProblem &	problem,
		const SolutionCallback &	cb ) const

Solve the Fourier barrier synthesis problem.

Parameters

problem	problem definition
cb	callback function called when the optimisation is done

Returns

true if the optimisation was successful

false if no solution was found (i.e., the problem is infeasible)

to_string()

std::string lucid::Optimiser::to_string ( ) const

nodiscardvirtual

Get string representation of the optimiser.

Returns

string representation Obtain the string representation of this object.

string representation of this object

Reimplemented in lucid::AlglibOptimiser, lucid::GurobiOptimiser, lucid::HighsOptimiser, and lucid::SoplexOptimiser.

---

The documentation for this class was generated from the following files:

• lucid/verification/Optimiser.h
• lucid/verification/Optimiser.cpp