linearProblem.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 <antares/optimisation/linear-problem-api/linearProblem.h>
#include <antares/optimisation/linear-problem-mpsolver-impl/mipConstraint.h>
#include <antares/optimisation/linear-problem-mpsolver-impl/mipSolution.h>
 
namespace operations_research
{
class MPSolver;
class MPSolverParameters;
class MPObjective;
} // namespace operations_research
 
namespace Antares::Optimisation::LinearProblemMpsolverImpl
{
 
class OrtoolsLinearProblem: public LinearProblemApi::ILinearProblem
{
public:
    OrtoolsLinearProblem(bool isMip, const std::string& solverName);
    ~OrtoolsLinearProblem() override = default;
 
    LinearProblemApi::IMipVariable* addNumVariable(double lb,
                                                   double ub,
                                                   const std::string& name) override;
 
    LinearProblemApi::IMipVariable* addIntVariable(double lb,
                                                   double ub,
                                                   const std::string& name) override;
 
    LinearProblemApi::IMipVariable* addVariable(double lb,
                                                double ub,
                                                bool integer,
                                                const std::string& name) override;
    [[nodiscard]] const std::vector<std::unique_ptr<LinearProblemApi::IMipVariable>>& getVariables()
      const override;
    [[nodiscard]] LinearProblemApi::IMipVariable* getVariable(std::size_t index) const override;
    [[nodiscard]] LinearProblemApi::IMipVariable* lookupVariable(
      const std::string& name) const override;
 
    [[nodiscard]] int variableCount() const override;
 
    LinearProblemApi::IMipConstraint* addConstraint(double lb,
                                                    double ub,
                                                    const std::string& name) override;
    [[nodiscard]] const std::vector<std::unique_ptr<LinearProblemApi::IMipConstraint>>&
    getConstraints() const override;
    [[nodiscard]] LinearProblemApi::IMipConstraint* getConstraint(std::size_t index) const override;
    [[nodiscard]] LinearProblemApi::IMipConstraint* lookupConstraint(
      const std::string& name) const override;
    [[nodiscard]] int constraintCount() const override;
 
    void setObjectiveCoefficient(LinearProblemApi::IMipVariable* var, double coefficient) override;
    double getObjectiveCoefficient(const LinearProblemApi::IMipVariable* var) const override;
 
    void setObjectiveOffset(double objectiveOffset) override;
 
    [[nodiscard]] double getObjectiveOffset() const override;
 
    void setMinimization() override;
    void setMaximization() override;
 
    [[nodiscard]] bool isMinimization() const override;
    [[nodiscard]] bool isMaximization() const override;
 
    OrtoolsMipSolution* solve(bool verboseSolver) override;
 
    OrtoolsMipSolution* solution(bool verboseSolver);
    double objectiveValue() const override;
 
    [[nodiscard]] double infinity() const override;
    [[nodiscard]] bool isLP() const override;
 
    friend void Write(const OrtoolsLinearProblem& problem, const std::filesystem::path& path);
 
protected:
    [[nodiscard]] operations_research::MPSolver* MpSolver() const;
 
private:
    operations_research::MPSolver* mpSolver_{nullptr};
    operations_research::MPObjective* objective_{nullptr};
    operations_research::MPSolverParameters params_;
 
    std::vector<std::unique_ptr<LinearProblemApi::IMipVariable>> variables_;
    std::vector<std::unique_ptr<LinearProblemApi::IMipConstraint>> constraints_;
 
    std::unique_ptr<OrtoolsMipSolution> solution_;
    bool isLP_{true};
};
 
} // namespace Antares::Optimisation::LinearProblemMpsolverImpl