ortools_utils.h

/*
** Copyright 2007-2025, RTE (https://www.rte-france.com)
** See AUTHORS.txt
** SPDX-License-Identifier: MPL-2.0
** This file is part of Antares-Simulator,
** Adequacy and Performance assessment for interconnected energy networks.
**
** Antares_Simulator is free software: you can redistribute it and/or modify
** it under the terms of the Mozilla Public Licence 2.0 as published by
** the Mozilla Foundation, either version 2 of the License, or
** (at your option) any later version.
**
** Antares_Simulator is distributed in the hope that it will be useful,
** but WITHOUT ANY WARRANTY; without even the implied warranty of
** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
** Mozilla Public Licence 2.0 for more details.
**
** You should have received a copy of the Mozilla Public Licence 2.0
** along with Antares_Simulator. If not, see <https://opensource.org/license/mpl-2-0/>.
*/
#pragma once
 
#include <map>
#include <string>
 
#include <antares/writer/i_writer.h>
 
// ignore unused parameters warnings from ortools
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wunused-parameter"
#include "ortools/linear_solver/linear_solver.h"
#pragma GCC diagnostic pop
 
#include "ortools_wrapper.h"
 
namespace operations_research::math_opt
{
enum class SolverType;
}
 
using namespace operations_research;
 
// TODO use Objective().Value() instead
// This is a temporary workaround for Windows
double getObjectiveValue(const MPSolver* solver);
 
void ORTOOLS_EcrireJeuDeDonneesLineaireAuFormatMPS(MPSolver* solver,
                                                   Antares::Solver::IResultWriter& writer,
                                                   const std::string& filename);
 
std::string toString(const std::list<std::string>& solverList);
 
std::list<std::string> availableLinearSolversList();
 
std::list<std::string> availableQuadraticSolversList();
 
bool isLinearSolverAvailable(const std::string& solverName);
 
MPSolver* MPSolverFactory(const bool isMip, const std::string& solverName);
 
std::string generateTempPath(const std::string& filename);
void removeTemporaryFile(const std::string& tmpPath);
 
class OrtoolsUtils final
{
public:
    struct SolverNames
    {
        std::optional<std::string> LPSolverName, MIPSolverName;
    };
 
    static const std::map<std::string, SolverNames> mpSolverMap;
    static const std::map<std::string, math_opt::SolverType> mathoptSolverMap;
};