LinearExpression.h

/*
 * Copyright 2007-2024, 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 <string>
#include <unordered_map>
 
#include <antares/solver/optim-model-filler/FullKey.h>
 
namespace Antares::Optimization
{
 
template<typename T>
struct IdentityFunction
{
    const T& operator()(const T& t)
    {
        return t;
    }
};
 
using FullKeyMap = std::unordered_map<FullKey, double, FullKeyHash>;
 
template<typename Key,
         typename Value,
         typename UnaryOp = IdentityFunction<Value>,
         typename HashType = std::hash<Key>>
std::unordered_map<Key, Value, HashType> add_maps(
  const std::unordered_map<Key, Value, HashType>& left,
  const std::unordered_map<Key, Value, HashType>& right,
  UnaryOp op = IdentityFunction<Value>{})
{
    auto result(left);
    for (auto [key, value]: right)
    {
        if (result.contains(key))
        {
            result[key] += op(value);
        }
        else
        {
            result[key] = op(value);
        }
    }
    return result;
}
 
FullKeyMap scale_map(const FullKeyMap& map, double scale);
 
class LinearExpression
{
public:
    LinearExpression() = default;
    LinearExpression(double offset, FullKeyMap coef_per_var);
    LinearExpression operator+(const LinearExpression& other) const;
    LinearExpression operator-(const LinearExpression& other) const;
    LinearExpression operator*(const LinearExpression& other) const;
    LinearExpression operator/(const LinearExpression& other) const;
    LinearExpression operator-() const;
 
    double offset() const;
 
    const FullKeyMap& coefPerVar() const;
 
    LinearExpression& operator+=(const LinearExpression& value);
 
private:
    double offset_ = 0;
    FullKeyMap coef_per_var_;
};
 
} // namespace Antares::Optimization