RotateIndex.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/ILinearProblemData.h"
 
inline int rotatedIndex(unsigned key,
                        int shift,
                        const Antares::Optimisation::LinearProblemApi::FillContext& fillContext)
{
    unsigned rangeSize = fillContext.getLocalNumberOfTimeSteps();
 
    // Normalize shift within bounds (to prevent negative indexing)
    shift = (shift % static_cast<int>(rangeSize) + rangeSize) % static_cast<int>(rangeSize);
 
    // Compute which key's value should be assigned to `key`
    return fillContext.getLocalFirstTimeStep()
           + (key - fillContext.getLocalFirstTimeStep() + shift) % rangeSize;
}