Antares Xpansion
Investment simulations for Antares studies
Loading...
Searching...
No Matches
Public Member Functions | List of all members
Outerloop::BendersMpiOuterLoop Class Reference
Inheritance diagram for Outerloop::BendersMpiOuterLoop:
BendersMpi BendersBase

Public Member Functions

 BendersMpiOuterLoop (const BendersBaseOptions &options, Logger logger, std::shared_ptr< Output::OutputWriter > writer, mpi::environment &env, mpi::communicator &world, std::shared_ptr< MathLoggerDriver > mathLoggerDriver)
 
void launch () override
 
- Public Member Functions inherited from BendersMpi
 BendersMpi (const BendersBaseOptions &options, Logger logger, std::shared_ptr< Output::OutputWriter > writer, mpi::environment &env, mpi::communicator &world, std::shared_ptr< MathLoggerDriver > mathLoggerDriver)
 
std::string BendersName () const override
 
- Public Member Functions inherited from BendersBase
 BendersBase (BendersBaseOptions options, Logger logger, std::shared_ptr< Output::OutputWriter > writer, std::shared_ptr< MathLoggerDriver > mathLoggerDriver)
 
void set_solver_log_file (const std::filesystem::path &log_file)
 
std::filesystem::path solver_log_file () const
 
double execution_time () const
 
WorkerMasterDataVect AllCuts () const
 
LogData GetBestIterationData () const
 
void set_input_map (const CouplingMap &coupling_map)
 set the input
 
int MasterRowIndex (const std::string &row_name) const
 
void MasterChangeRhs (int id_row, double val) const
 
void MasterGetRhs (double &rhs, int id_row) const
 
const VariableMap & MasterVariables () const
 
std::vector< double > MasterObjectiveFunctionCoeffs () const
 
void MasterRowsCoeffs (std::vector< int > &mstart, std::vector< int > &mclind, std::vector< double > &dmatval, int size, std::vector< int > &nels, int first, int last) const
 
int MasterGetNElems () const
 
void MasterAddRows (const std::vector< char > &qrtype_p, const std::vector< double > &rhs_p, const std::vector< double > &range_p, const std::vector< int > &mstart_p, const std::vector< int > &mclind_p, const std::vector< double > &dmatval_p, const std::vector< std::string > &row_names={}) const
 
void MasterGetRowType (std::vector< char > &qrtype, int first, int last) const
 
void ResetMasterFromLastIteration ()
 
std::filesystem::path LastMasterPath () const
 
bool MasterIsEmpty () const
 
void DoFreeProblems (bool free_problems)
 
int MasterGetnrows () const
 
int MasterGetncols () const
 
WorkerMasterData BestIterationWorkerMaster () const
 
void SetMasterObjectiveFunctionCoeffsToZeros () const
 
void SetMasterObjectiveFunction (const double *coeffs, int first, int last) const
 
void SetMaxIteration (int max_iteration)
 
BendersBaseOptions Options () const
 
int GetBendersRunNumber () const
 
CurrentIterationData GetCurrentIterationData () const
 
CriteriaCurrentIterationData GetOuterLoopData () const
 
std::vector< double > GetOuterLoopCriterionAtBestBenders () const
 
virtual void init_data ()
 Initialize set of data used in the loop.
 
void init_data (double external_loop_lambda, double external_loop_lambda_min, double external_loop_lambda_max)
 
Output::SolutionData GetOuterLoopSolution () const
 
void SaveOuterLoopSolutionInOutputFile () const
 
void SaveCurrentOuterLoopIterationInOutputFile () const
 
void SetBilevelBestub (double bilevel_best_ub)
 
void UpdateOuterLoopSolution ()
 
bool isExceptionRaised () const
 
void UpdateOverallCosts ()
 
void setCriterionComputationInputs (const Benders::Criterion::CriterionInputData &criterion_input_data)
 

Additional Inherited Members

- Public Attributes inherited from BendersMpi
const int rank_0 = 0
 
- Public Attributes inherited from BendersBase
Logger _logger
 
std::shared_ptr< Output::OutputWriter > _writer
 
std::shared_ptr< MathLoggerDriver > mathLoggerDriver_
 
- Protected Member Functions inherited from BendersMpi
void free () override
 Method to free the memory used by each problem.
 
void Run () override
 Run Benders algorithm in parallel.
 
void InitializeProblems () override
 Method to load each problem in a thread.
 
void BroadcastXCut ()
 
bool shouldParallelize () const final
 
void PreRunInitialization ()
 
int Rank () const
 
template<typename T >
void BroadCast (T &value, int root) const
 
template<typename T >
void BroadCast (T *values, int n, int root) const
 
template<typename T >
void Gather (const T &value, std::vector< T > &vector_of_values, int root) const
 
void BuildMasterProblem ()
 
int WorldSize () const
 
void Barrier () const
 
template<typename T , typename Op >
void Reduce (const T &in_value, T &out_value, Op op, int root) const
 
template<typename T , typename Op >
void AllReduce (const T &in_value, T &out_value, Op op) const
 
virtual void GatherCuts (const SubProblemDataMap &subproblem_data_map, const Timer &walltime)
 
void BroadCastVariablesIndices ()
 
virtual void ComputeSubproblemsContributionToCriteria (const SubProblemDataMap &subproblem_data_map)
 
void SolveSubproblem (PlainData::SubProblemData &subproblem_data, const std::string &name, const std::shared_ptr< SubproblemWorker > &worker) override
 
void UpdateMaxCriterionArea ()
 
- Protected Member Functions inherited from BendersBase
void update_best_ub ()
 Update best upper bound and best optimal variables.
 
bool ShouldBendersStop ()
 
bool is_initial_relaxation_requested () const
 
bool SwitchToIntegerMaster (bool is_relaxed) const
 
virtual void UpdateTrace ()
 Update trace of the Benders for the current iteration.
 
virtual void ComputeXCut ()
 
void ComputeInvestCost ()
 
virtual void compute_ub ()
 
virtual void get_master_value ()
 Solve and get optimal variables of the Master Problem.
 
void GetSubproblemCut (SubProblemDataMap &subproblem_data_map)
 Solve and store optimal variables of all Subproblem Problems.
 
virtual void post_run_actions () const
 
void BuildCutFull (const SubProblemDataMap &subproblem_data_map)
 Add cuts in master problem.
 
virtual void DeactivateIntegrityConstraints () const
 
virtual void ActivateIntegrityConstraints () const
 
virtual void SetDataPreRelaxation ()
 
virtual void ResetDataPostRelaxation ()
 
std::filesystem::path GetSubproblemPath (const std::string &subproblem_name) const
 Get path to subproblem mps file from options.
 
double SubproblemWeight (int subproblem_count, const std::string &name) const
 Return subproblem weight value.
 
std::filesystem::path get_master_path () const
 Get path to master problem mps file from options.
 
std::filesystem::path get_structure_path () const
 
LogData bendersDataToLogData (const CurrentIterationData &data) const
 
template<typename T , typename... Args>
void reset_master (Args &&... args)
 
void free_master ()
 
void free_subproblems ()
 
void AddSubproblem (const std::pair< std::string, VariableMap > &kvp)
 
virtual WorkerMasterPtr get_master () const
 
void MatchProblemToId ()
 
void AddSubproblemName (const std::string &name)
 
std::string get_master_name () const
 
std::string get_solver_name () const
 
int get_log_level () const
 
bool is_trace () const
 
Point get_x_cut () const
 
void set_x_cut (const Point &x0)
 
Point get_x_out () const
 
void set_x_out (const Point &x0)
 
double GetSubproblemCost () const
 
void SetSubproblemCost (const double &subproblem_cost)
 
bool IsResumeMode () const
 
std::filesystem::path LastIterationFile () const
 
void UpdateMaxNumberIterationResumeMode (int nb_iteration_done)
 
void SaveCurrentIterationInOutputFile () const
 
void SaveSolutionInOutputFile () const
 
void PrintCurrentIterationCsv ()
 
void OpenCsvFile ()
 
void CloseCsvFile ()
 
void ChecksResumeMode ()
 
virtual void SaveCurrentBendersData ()
 
void ClearCurrentIterationCutTrace ()
 
virtual void EndWritingInOutputFile () const
 
int GetNumIterationsBeforeRestart () const
 
double GetBendersTime () const
 
virtual void write_basis () const
 
SubproblemsMapPtr GetSubProblemMap () const
 
StrVector GetSubProblemNames () const
 
double AbsoluteGap () const
 
double RelativeGap () const
 
double RelaxedGap () const
 
DblVector GetAlpha_i () const
 
void SetAlpha_i (const DblVector &single_subpb_costs_under_approx)
 
int ProblemToId (const std::string &problem_name) const
 
virtual void UpdateStoppingCriterion ()
 Update stopping criterion.
 
virtual bool ShouldRelaxationStop () const
 Check if initial relaxation should stop.
 
int GetNumOfSubProblemsSolvedBeforeResume ()
 
void BoundSimplexIterations (int subproblem_iteration)
 
void ResetSimplexIterationsBounds ()
 
void SetSubproblemsVariablesIndices ()
 
- Protected Attributes inherited from BendersMpi
mpi::communicator & _world
 
- Protected Attributes inherited from BendersBase
bool exception_raised_ = false
 
CurrentIterationData _data
 
WorkerMasterDataVect workerMasterDataVect_
 
VariableMap master_variable_map_
 
CouplingMap coupling_map_
 
BendersRelevantIterationsData relevantIterationData_ = {WorkerMasterData(), WorkerMasterData()}
 
bool init_data_ = true
 
bool init_problems_ = true
 
bool free_problems_ = true
 
std::vector< std::vector< double > > criteria_vector_for_each_iteration_
 
bool is_bilevel_check_all_ = false
 
SubproblemsMapPtr subproblem_map
 
SolverLogManager solver_log_manager_
 
Benders::Criterion::CriterionComputation criterion_computation_
 

Member Function Documentation

◆ launch()

void Outerloop::BendersMpiOuterLoop::launch ( )
overridevirtual

Reimplemented from BendersMpi.

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