idol::PADM Class Reference

Inheritance diagram for idol::PADM:

Collaboration diagram for idol::PADM:

Public Member Functions
	PADM (Annotation< unsigned int > t_decomposition)
	PADM (Annotation< unsigned int > t_decomposition, Annotation< double > t_penalized_constraints)
	PADM (const PADM &t_src)
	PADM (PADM &&)=default
PADM &	operator= (const PADM &)=delete
PADM &	operator= (PADM &&)=default
PADM &	with_default_sub_problem_spec (ADM::SubProblem t_sub_problem)
PADM &	with_sub_problem_spec (unsigned int t_id, ADM::SubProblem t_sub_problem)
PADM &	with_rescaling_threshold (double t_threshold)
PADM &	with_penalty_update (const PenaltyUpdate &t_penalty_update)
PADM &	with_feasible_solution_status (SolutionStatus t_status)
PADM &	with_iteration_plot (Plots::Manager &t_manager)
Optimizer *	operator() (const Model &t_model) const override
OptimizerFactory *	clone () const override
PADM &	with_logs (bool t_value)
PADM &	with_time_limit (double t_time_limit)
PADM &	with_thread_limit (unsigned int t_max_n_threads)
PADM &	with_iteration_limit (unsigned int t_iteration_count_limit)
PADM &	with_best_bound_stop (double t_best_bound_stop)
PADM &	with_best_obj_stop (double t_user_best_obj)
PADM &	with_relative_gap_tolerance (double t_relative_gap_tolerance)
PADM &	with_absolute_gap_tolerance (double t_absolute_gap_tolerance)
PADM &	with_presolve (bool t_value)
PADM &	with_infeasible_or_unbounded_info (bool t_value)
PADM &	conditional (bool t_conditional_value, const std::function< void(PADM &)> &t_if)
PADM &	conditional (bool t_conditional_value, const std::function< void(PADM &)> &t_if, const std::function< void(PADM &)> &t_else)
template<class T >
T &	as ()
template<class T >
const T &	as () const
template<class T >
bool	is () const

Protected Member Functions
PADM &	crtp ()
const PADM &	crtp () const
void	handle_default_parameters (Optimizer *t_optimizer) const

Detailed Description

Definition at line 21 of file PADM.h.

Member Function Documentation

as() [1/2]

template<class T >

T & idol::OptimizerFactory::as ( )

inlineinherited

Definition at line 44 of file OptimizerFactory.h.

as() [2/2]

template<class T >

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

inlineinherited

Definition at line 52 of file OptimizerFactory.h.

clone()

OptimizerFactory * idol::PADM::clone ( ) const

overridevirtual

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() [1/2]

PADM & idol::OptimizerFactoryWithDefaultParameters< PADM >::conditional ( bool  t_conditional_value, const std::function< void(PADM &)> &  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 238 of file OptimizerFactory.h.

conditional() [2/2]

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

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); },
                                         [](auto& x){ x.with_presolve(false); })
      model.use(algorithm);
      model.optimize();
}

Parameters

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

Returns

the optimizer factory itself

Definition at line 260 of file OptimizerFactory.h.

crtp() [1/2]

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

inlineprotectedinherited

Definition at line 78 of file OptimizerFactory.h.

crtp() [2/2]

const PADM & idol::OptimizerFactoryWithDefaultParameters< PADM >::crtp ( ) const

inlineprotectedinherited

Definition at line 79 of file OptimizerFactory.h.

handle_default_parameters()

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

protectedinherited

Definition at line 81 of file OptimizerFactory.h.

is()

template<class T >

bool idol::OptimizerFactory::is ( ) const

inlineinherited

Definition at line 60 of file OptimizerFactory.h.

operator()()

Optimizer * idol::PADM::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()

PADM & idol::OptimizerFactoryWithDefaultParameters< PADM >::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 192 of file OptimizerFactory.h.

with_best_bound_stop()

PADM & idol::OptimizerFactoryWithDefaultParameters< PADM >::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 149 of file OptimizerFactory.h.

with_best_obj_stop()

PADM & idol::OptimizerFactoryWithDefaultParameters< PADM >::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 164 of file OptimizerFactory.h.

with_infeasible_or_unbounded_info()

PADM & idol::OptimizerFactoryWithDefaultParameters< PADM >::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 219 of file OptimizerFactory.h.

with_iteration_limit()

PADM & idol::OptimizerFactoryWithDefaultParameters< PADM >::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 134 of file OptimizerFactory.h.

with_logs()

PADM & idol::OptimizerFactoryWithDefaultParameters< PADM >::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 95 of file OptimizerFactory.h.

with_presolve()

PADM & idol::OptimizerFactoryWithDefaultParameters< PADM >::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 205 of file OptimizerFactory.h.

with_relative_gap_tolerance()

PADM & idol::OptimizerFactoryWithDefaultParameters< PADM >::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 178 of file OptimizerFactory.h.

with_thread_limit()

PADM & idol::OptimizerFactoryWithDefaultParameters< PADM >::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 121 of file OptimizerFactory.h.

with_time_limit()

PADM & idol::OptimizerFactoryWithDefaultParameters< PADM >::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 108 of file OptimizerFactory.h.