Description

Definition at line 15 of file GLPK.h.

Public Methods
	GLPK (const GLPK &)=default
	GLPK (GLPK &&) noexcept=default
GLPK &	operator= (const GLPK &)=delete
GLPK &	operator= (GLPK &&) noexcept=delete
Optimizer *	operator() (const Model &t_model) const override
GLPK *	clone () const override
GLPK &	with_continuous_relaxation_only (bool t_value)
GLPK &	with_logs (bool t_value)
GLPK &	with_time_limit (double t_time_limit)
GLPK &	with_thread_limit (unsigned int t_max_n_threads)
GLPK &	with_iteration_limit (unsigned int t_iteration_count_limit)
GLPK &	with_best_bound_stop (double t_best_bound_stop)
GLPK &	with_best_obj_stop (double t_user_best_obj)
GLPK &	with_relative_gap_tolerance (double t_relative_gap_tolerance)
GLPK &	with_absolute_gap_tolerance (double t_absolute_gap_tolerance)
GLPK &	with_presolve (bool t_value)
GLPK &	with_infeasible_or_unbounded_info (bool t_value)
GLPK &	conditional (bool t_conditional_value, const std::function< void(GLPK &)> &t_if)
template<class T>
T &	as ()
template<class T>
const T &	as () const
template<class T>
bool	is () const

Public Static Methods
static GLPK	ContinuousRelaxation ()
static Model	read_from_file (Env &t_env, const std::string &t_filename)

Protected Methods
GLPK &	crtp ()
void	handle_default_parameters (Optimizer *t_optimizer) const

Methods Documentation

◆ as() [1/2]

template<class T>

T & idol::OptimizerFactory::as ( )

inlineinherited

Definition at line 45 of file OptimizerFactory.h.

◆ as() [2/2]

template<class T>

const T & idol::OptimizerFactory::as ( ) const

inlineinherited

Definition at line 53 of file OptimizerFactory.h.

◆ clone()

GLPK * idol::GLPK::clone ( ) const

nodiscardoverridevirtual

Creates and return a copy of the optimizer factory. This is used for polymorphism.

Returns: A copied object of the current object (i.e., *this)

Implements idol::OptimizerFactory.

◆ conditional()

GLPK & idol::OptimizerFactoryWithDefaultParameters< GLPK >::conditional	(	bool	t_conditional_value,
		const std::function< void(GLPK &)> &	t_if )

inherited

Executes the lambda function given as second parameter if and only if its first argument is true. This function can be used to build different optimizer factories depending on some external variable.

Example:

for (const bool use_presolve : {true, false}) {
     auto algorithm = GLPK()
                         .conditional(use_presolve, [](auto& x){ x.with_presolve(true); })
      model.use(algorithm);
      model.optimize();
}

Parameters

t_conditional_value	if true, the t_if lambda function is executed, if false, nothing happens.
t_if	lambda function to execute in case t_conditional_value is true

Returns: the optimizer factory itself

Definition at line 239 of file OptimizerFactory.h.

◆ crtp()

GLPK & idol::OptimizerFactoryWithDefaultParameters< GLPK >::crtp ( )

inlineprotectedinherited

Definition at line 79 of file OptimizerFactory.h.

◆ handle_default_parameters()

void idol::OptimizerFactoryWithDefaultParameters< GLPK >::handle_default_parameters ( Optimizer * t_optimizer ) const

protectedinherited

Definition at line 82 of file OptimizerFactory.h.

◆ is()

template<class T>

bool idol::OptimizerFactory::is ( ) const

inlinenodiscardinherited

Definition at line 61 of file OptimizerFactory.h.

◆ operator()()

Optimizer * idol::GLPK::operator() ( const Model & t_model ) const

overridevirtual

Creates and returns a new optimizer to solve the model given as parameter.

Parameters

t_model The model which the optimizer will solve

Returns: A new optimizer for the model

Implements idol::OptimizerFactory.

◆ with_absolute_gap_tolerance()

GLPK & idol::OptimizerFactoryWithDefaultParameters< GLPK >::with_absolute_gap_tolerance ( double t_absolute_gap_tolerance )

inherited

Sets the absolute gap tolerance for the optimizer. When the optimizer proves that the absolute optimality gap is less than this threshold, the optimizer stops.

Example:

auto algorithm = GLPK()

.with_absolute_gap_tolerance(1e-4);

Parameters

t_absolute_gap_tolerance the absolute gap tolerance

Returns: the optimizer factory itself

Definition at line 193 of file OptimizerFactory.h.

◆ with_best_bound_stop()

GLPK & idol::OptimizerFactoryWithDefaultParameters< GLPK >::with_best_bound_stop ( double t_best_bound_stop )

inherited

Sets a threshold on the best bound for stopping the optimizer. When the optimizer have found a best bound which is greater than this threshold, the optimizer stops.

Example:

const double my_known_best_obj = 0.;
auto algorithm = GLPK()
                     .with_best_bound_stop(my_known_best_obj);

Parameters

t_best_bound_stop the threshold

Returns: the optimizer factory itself

Definition at line 150 of file OptimizerFactory.h.

◆ with_best_obj_stop()

GLPK & idol::OptimizerFactoryWithDefaultParameters< GLPK >::with_best_obj_stop ( double t_user_best_obj )

inherited

Sets a threshold on the best objective value for stopping the optimizer. When the optimizer have found a best objective value which is less than this threshold, the optimizer stops.

Example:

const double my_known_best_bound = 0;
auto algorithm = GLPK()
                     .with_best_obj_stop(my_known_best_bound);

Parameters

t_user_best_obj the threshold

Returns: the optimizer factory itself

Definition at line 165 of file OptimizerFactory.h.

◆ with_infeasible_or_unbounded_info()

GLPK & idol::OptimizerFactoryWithDefaultParameters< GLPK >::with_infeasible_or_unbounded_info ( bool t_value )

inherited

Sets the behaviour of the optimizer when a model is shown to be infeasible or unbounded. When set to true, the optimizer is forced to prove feasibility or unboundedness by providing a certificate.

Example:

auto algorithm = GLPK()

.with_infeasible_or_unbounded_info(true);

Parameters

t_value the activation level

Returns: the optimizer factory itself

Definition at line 220 of file OptimizerFactory.h.

◆ with_iteration_limit()

GLPK & idol::OptimizerFactoryWithDefaultParameters< GLPK >::with_iteration_limit ( unsigned int t_iteration_count_limit )

inherited

Sets the maximum number of iterations which the optimizer go through

Example:

auto algorithm = GLPK()

.with_iteration_limit(200);

Parameters

t_iteration_count_limit the maximum number of iterations

Returns: the optimizer factory itself

Definition at line 135 of file OptimizerFactory.h.

◆ with_logs()

GLPK & idol::OptimizerFactoryWithDefaultParameters< GLPK >::with_logs ( bool t_value )

inherited

Sets the log_master level and color for the optimizer

Example:

auto algorithm = GLPK()

.with_logs(true);

Parameters

t_log_level	the log_master level
t_log_color	the output color

Returns: the optimizer factory itself

Definition at line 96 of file OptimizerFactory.h.

◆ with_presolve()

GLPK & idol::OptimizerFactoryWithDefaultParameters< GLPK >::with_presolve ( bool t_value )

inherited

Sets the get_param_presolve activation for the optimizer.

Example:

auto algorithm = GLPK()

.with_presolve(false); // turns off get_param_presolve phase

Parameters

t_value the activation level for the optimizer's get_param_presolve (0 for disabling, 1 for enabling)

Returns: the optimizer factory itself

Definition at line 206 of file OptimizerFactory.h.

◆ with_relative_gap_tolerance()

GLPK & idol::OptimizerFactoryWithDefaultParameters< GLPK >::with_relative_gap_tolerance ( double t_relative_gap_tolerance )

inherited

Sets the relative gap tolerance for the optimizer. When the optimizer proves that the relative optimality gap is less than this threshold, the optimizer stops.

Example:

auto algorithm = GLPK()

.with_relative_gap_tolerance(.05); // sets a gap tolerance of 5%

Parameters

t_relative_gap_tolerance the relative gap tolerance

Returns: the optimizer factory itself

Definition at line 179 of file OptimizerFactory.h.

◆ with_thread_limit()

GLPK & idol::OptimizerFactoryWithDefaultParameters< GLPK >::with_thread_limit ( unsigned int t_max_n_threads )

inherited

Sets the maximum number of threads which the optimizer can use

Example:

auto algorithm = GLPK()

.with_thread_limit(5);

Parameters

t_max_n_threads the number of threads which can be used

Returns: the optimizer factory itself

Definition at line 122 of file OptimizerFactory.h.

◆ with_time_limit()

GLPK & idol::OptimizerFactoryWithDefaultParameters< GLPK >::with_time_limit ( double t_time_limit )

inherited

Sets the time limit for the optimizer

Example:

auto algorithm = GLPK()

.with_time_limit(3600);

Parameters

t_time_limit the time limit (in seconds)

Returns: the optimizer factory itself

Definition at line 109 of file OptimizerFactory.h.

Description

Public Methods

Public Static Methods

Protected Methods

Methods Documentation

◆ as() [1/2]

◆ as() [2/2]

◆ clone()

◆ conditional()

◆ crtp()

◆ handle_default_parameters()

◆ is()

◆ operator()()

◆ with_absolute_gap_tolerance()

◆ with_best_bound_stop()

◆ with_best_obj_stop()

◆ with_infeasible_or_unbounded_info()

◆ with_iteration_limit()

◆ with_logs()

◆ with_presolve()

◆ with_relative_gap_tolerance()

◆ with_thread_limit()

◆ with_time_limit()