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 <memory>
#include <string>
 
#include "mipConstraint.h"
#include "mipSolution.h"
#include "mipVariable.h"
 
namespace Antares::Optimisation::LinearProblemApi
{
 
class ILinearProblem
{
public:
    virtual ~ILinearProblem() = default;
 
    virtual IMipVariable* addNumVariable(double lb, double ub, const std::string& name) = 0;
 
    virtual IMipVariable* addIntVariable(double lb, double ub, const std::string& name) = 0;
 
    virtual IMipVariable* addVariable(double lb, double ub, bool integer, const std::string& name)
      = 0;
 
    // Variables observers
    [[nodiscard]] virtual const std::vector<std::unique_ptr<IMipVariable>>& getVariables() const
      = 0;
    [[nodiscard]] virtual IMipVariable* getVariable(std::size_t index) const = 0;
    [[nodiscard]] virtual IMipVariable* lookupVariable(const std::string& name) const = 0;
    [[nodiscard]] virtual int variableCount() const = 0;
 
    virtual IMipConstraint* addConstraint(double lb, double ub, const std::string& name) = 0;
 
    // Constraints observers
    [[nodiscard]] virtual const std::vector<std::unique_ptr<IMipConstraint>>& getConstraints() const
      = 0;
    [[nodiscard]] virtual IMipConstraint* getConstraint(std::size_t index) const = 0;
    [[nodiscard]] virtual LinearProblemApi::IMipConstraint* lookupConstraint(
      const std::string& name) const
      = 0;
    [[nodiscard]] virtual int constraintCount() const = 0;
 
    virtual void setObjectiveCoefficient(IMipVariable* var, double coefficient) = 0;
    virtual double getObjectiveCoefficient(const IMipVariable* var) const = 0;
 
    virtual void setObjectiveOffset(double objectiveOffset) = 0;
    virtual double getObjectiveOffset() const = 0;
 
    virtual void setMinimization() = 0;
    virtual void setMaximization() = 0;
 
    [[nodiscard]] virtual bool isMinimization() const = 0;
    [[nodiscard]] virtual bool isMaximization() const = 0;
 
    virtual IMipSolution* solve(bool verboseSolver) = 0;
 
    // Definition of infinity
    [[nodiscard]] virtual double infinity() const = 0;
    virtual bool isLP() const = 0;
 
    virtual double objectiveValue() const = 0;
};
 
} // namespace Antares::Optimisation::LinearProblemApi